# Connectors

## GET /connectors

> Get connectors.

```json
{"openapi":"3.0.1","info":{"title":"ilert REST API","version":"v2.2026.3-r.4"},"tags":[{"name":"Connectors"}],"servers":[{"url":"/api"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","description":"The Bearer API key of your user <a href='/api-docs/#section/Authentication'>more info</a>.","name":"Authorization","in":"header"}},"schemas":{"Connector":{"required":["name","type"],"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/ConnectorType"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"params":{"type":"object","oneOf":[{"$ref":"#/components/schemas/EParamsDatadog"},{"$ref":"#/components/schemas/EParamsJira"},{"$ref":"#/components/schemas/EParamsMicrosoftTeams"},{"$ref":"#/components/schemas/EParamsServiceNow"},{"$ref":"#/components/schemas/EParamsSlack"},{"$ref":"#/components/schemas/EParamsZendesk"},{"$ref":"#/components/schemas/EParamsDiscord"},{"$ref":"#/components/schemas/EParamsGithub"},{"$ref":"#/components/schemas/EParamsTopdesk"},{"$ref":"#/components/schemas/EParamsAWSLambda"},{"$ref":"#/components/schemas/EParamsAzureFunction"},{"$ref":"#/components/schemas/EParamsGoogleFunction"},{"$ref":"#/components/schemas/EParamsSysdig"},{"$ref":"#/components/schemas/EParamsStatusPageIO"},{"$ref":"#/components/schemas/EParamsDingTalk"},{"$ref":"#/components/schemas/EParamsZabbix"}]}}},"ConnectorType":{"type":"string","enum":["jira","microsoft_teams_bot","servicenow","slack","zendesk","discord","github","topdesk","zammad","mattermost","zoom_chat","dingtalk","dynamic","zabbix","autotask","google_chat_bot"]},"EParamsDatadog":{"type":"object","properties":{"apiKey":{"type":"string"}}},"EParamsJira":{"type":"object","properties":{"url":{"type":"string"},"email":{"type":"string"},"password":{"type":"string"}}},"EParamsMicrosoftTeams":{"type":"object","properties":{"url":{"type":"string"}}},"EParamsServiceNow":{"type":"object","properties":{"url":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"}}},"EParamsSlack":{"type":"object"},"EParamsZendesk":{"type":"object","properties":{"url":{"type":"string"},"email":{"type":"string"},"apiKey":{"type":"string"}}},"EParamsDiscord":{"type":"object","properties":{"url":{"type":"string"}}},"EParamsGithub":{"type":"object","properties":{"apiKey":{"type":"string"}}},"EParamsTopdesk":{"type":"object","properties":{"url":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"}}},"EParamsAWSLambda":{"type":"object","properties":{"authorization":{"type":"string"}}},"EParamsAzureFunction":{"type":"object","properties":{"authorization":{"type":"string"}}},"EParamsGoogleFunction":{"type":"object","properties":{"authorization":{"type":"string"}}},"EParamsSysdig":{"type":"object","properties":{"apiKey":{"type":"string"}}},"EParamsStatusPageIO":{"type":"object","properties":{"apiKey":{"type":"string"}}},"EParamsDingTalk":{"type":"object","properties":{"url":{"type":"string"},"secret":{"type":"string"}}},"EParamsZabbix":{"type":"object","properties":{"url":{"type":"string"},"apiKey":{"type":"string"}}}}},"paths":{"/connectors":{"get":{"tags":["Connectors"],"summary":"Get connectors.","parameters":[{"name":"start-index","in":"query","description":"an integer specifying the starting point (beginning with 0) when paging through a list of entities","schema":{"type":"integer","format":"int32","default":0}},{"name":"max-results","in":"query","description":"the maximum number of results when paging through a list of entities.","schema":{"maximum":100,"type":"integer","format":"int32","default":50}}],"responses":{"200":{"description":"The connectors","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Connector"}}}}}}}}}}
```

## POST /connectors

> Create a new connector.

```json
{"openapi":"3.0.1","info":{"title":"ilert REST API","version":"v2.2026.3-r.4"},"tags":[{"name":"Connectors"}],"servers":[{"url":"/api"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","description":"The Bearer API key of your user <a href='/api-docs/#section/Authentication'>more info</a>.","name":"Authorization","in":"header"}},"schemas":{"Connector":{"required":["name","type"],"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/ConnectorType"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"params":{"type":"object","oneOf":[{"$ref":"#/components/schemas/EParamsDatadog"},{"$ref":"#/components/schemas/EParamsJira"},{"$ref":"#/components/schemas/EParamsMicrosoftTeams"},{"$ref":"#/components/schemas/EParamsServiceNow"},{"$ref":"#/components/schemas/EParamsSlack"},{"$ref":"#/components/schemas/EParamsZendesk"},{"$ref":"#/components/schemas/EParamsDiscord"},{"$ref":"#/components/schemas/EParamsGithub"},{"$ref":"#/components/schemas/EParamsTopdesk"},{"$ref":"#/components/schemas/EParamsAWSLambda"},{"$ref":"#/components/schemas/EParamsAzureFunction"},{"$ref":"#/components/schemas/EParamsGoogleFunction"},{"$ref":"#/components/schemas/EParamsSysdig"},{"$ref":"#/components/schemas/EParamsStatusPageIO"},{"$ref":"#/components/schemas/EParamsDingTalk"},{"$ref":"#/components/schemas/EParamsZabbix"}]}}},"ConnectorType":{"type":"string","enum":["jira","microsoft_teams_bot","servicenow","slack","zendesk","discord","github","topdesk","zammad","mattermost","zoom_chat","dingtalk","dynamic","zabbix","autotask","google_chat_bot"]},"EParamsDatadog":{"type":"object","properties":{"apiKey":{"type":"string"}}},"EParamsJira":{"type":"object","properties":{"url":{"type":"string"},"email":{"type":"string"},"password":{"type":"string"}}},"EParamsMicrosoftTeams":{"type":"object","properties":{"url":{"type":"string"}}},"EParamsServiceNow":{"type":"object","properties":{"url":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"}}},"EParamsSlack":{"type":"object"},"EParamsZendesk":{"type":"object","properties":{"url":{"type":"string"},"email":{"type":"string"},"apiKey":{"type":"string"}}},"EParamsDiscord":{"type":"object","properties":{"url":{"type":"string"}}},"EParamsGithub":{"type":"object","properties":{"apiKey":{"type":"string"}}},"EParamsTopdesk":{"type":"object","properties":{"url":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"}}},"EParamsAWSLambda":{"type":"object","properties":{"authorization":{"type":"string"}}},"EParamsAzureFunction":{"type":"object","properties":{"authorization":{"type":"string"}}},"EParamsGoogleFunction":{"type":"object","properties":{"authorization":{"type":"string"}}},"EParamsSysdig":{"type":"object","properties":{"apiKey":{"type":"string"}}},"EParamsStatusPageIO":{"type":"object","properties":{"apiKey":{"type":"string"}}},"EParamsDingTalk":{"type":"object","properties":{"url":{"type":"string"},"secret":{"type":"string"}}},"EParamsZabbix":{"type":"object","properties":{"url":{"type":"string"},"apiKey":{"type":"string"}}}}},"paths":{"/connectors":{"post":{"tags":["Connectors"],"summary":"Create a new connector.","requestBody":{"description":"the connector","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connector"}}},"required":true},"responses":{"200":{"description":"The newly created connector","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connector"}}}}}}}}}
```

## GET /connectors/{id}

> Get a specific connector.

```json
{"openapi":"3.0.1","info":{"title":"ilert REST API","version":"v2.2026.3-r.4"},"tags":[{"name":"Connectors"}],"servers":[{"url":"/api"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","description":"The Bearer API key of your user <a href='/api-docs/#section/Authentication'>more info</a>.","name":"Authorization","in":"header"}},"schemas":{"Connector":{"required":["name","type"],"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/ConnectorType"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"params":{"type":"object","oneOf":[{"$ref":"#/components/schemas/EParamsDatadog"},{"$ref":"#/components/schemas/EParamsJira"},{"$ref":"#/components/schemas/EParamsMicrosoftTeams"},{"$ref":"#/components/schemas/EParamsServiceNow"},{"$ref":"#/components/schemas/EParamsSlack"},{"$ref":"#/components/schemas/EParamsZendesk"},{"$ref":"#/components/schemas/EParamsDiscord"},{"$ref":"#/components/schemas/EParamsGithub"},{"$ref":"#/components/schemas/EParamsTopdesk"},{"$ref":"#/components/schemas/EParamsAWSLambda"},{"$ref":"#/components/schemas/EParamsAzureFunction"},{"$ref":"#/components/schemas/EParamsGoogleFunction"},{"$ref":"#/components/schemas/EParamsSysdig"},{"$ref":"#/components/schemas/EParamsStatusPageIO"},{"$ref":"#/components/schemas/EParamsDingTalk"},{"$ref":"#/components/schemas/EParamsZabbix"}]}}},"ConnectorType":{"type":"string","enum":["jira","microsoft_teams_bot","servicenow","slack","zendesk","discord","github","topdesk","zammad","mattermost","zoom_chat","dingtalk","dynamic","zabbix","autotask","google_chat_bot"]},"EParamsDatadog":{"type":"object","properties":{"apiKey":{"type":"string"}}},"EParamsJira":{"type":"object","properties":{"url":{"type":"string"},"email":{"type":"string"},"password":{"type":"string"}}},"EParamsMicrosoftTeams":{"type":"object","properties":{"url":{"type":"string"}}},"EParamsServiceNow":{"type":"object","properties":{"url":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"}}},"EParamsSlack":{"type":"object"},"EParamsZendesk":{"type":"object","properties":{"url":{"type":"string"},"email":{"type":"string"},"apiKey":{"type":"string"}}},"EParamsDiscord":{"type":"object","properties":{"url":{"type":"string"}}},"EParamsGithub":{"type":"object","properties":{"apiKey":{"type":"string"}}},"EParamsTopdesk":{"type":"object","properties":{"url":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"}}},"EParamsAWSLambda":{"type":"object","properties":{"authorization":{"type":"string"}}},"EParamsAzureFunction":{"type":"object","properties":{"authorization":{"type":"string"}}},"EParamsGoogleFunction":{"type":"object","properties":{"authorization":{"type":"string"}}},"EParamsSysdig":{"type":"object","properties":{"apiKey":{"type":"string"}}},"EParamsStatusPageIO":{"type":"object","properties":{"apiKey":{"type":"string"}}},"EParamsDingTalk":{"type":"object","properties":{"url":{"type":"string"},"secret":{"type":"string"}}},"EParamsZabbix":{"type":"object","properties":{"url":{"type":"string"},"apiKey":{"type":"string"}}}}},"paths":{"/connectors/{id}":{"get":{"tags":["Connectors"],"summary":"Get a specific connector.","parameters":[{"name":"id","in":"path","description":"entity ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The requested connector","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connector"}}}}}}}}}
```

## PUT /connectors/{id}

> Update the specific connector. (note: type cannot be changed)

```json
{"openapi":"3.0.1","info":{"title":"ilert REST API","version":"v2.2026.3-r.4"},"tags":[{"name":"Connectors"}],"servers":[{"url":"/api"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","description":"The Bearer API key of your user <a href='/api-docs/#section/Authentication'>more info</a>.","name":"Authorization","in":"header"}},"schemas":{"Connector":{"required":["name","type"],"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/ConnectorType"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"params":{"type":"object","oneOf":[{"$ref":"#/components/schemas/EParamsDatadog"},{"$ref":"#/components/schemas/EParamsJira"},{"$ref":"#/components/schemas/EParamsMicrosoftTeams"},{"$ref":"#/components/schemas/EParamsServiceNow"},{"$ref":"#/components/schemas/EParamsSlack"},{"$ref":"#/components/schemas/EParamsZendesk"},{"$ref":"#/components/schemas/EParamsDiscord"},{"$ref":"#/components/schemas/EParamsGithub"},{"$ref":"#/components/schemas/EParamsTopdesk"},{"$ref":"#/components/schemas/EParamsAWSLambda"},{"$ref":"#/components/schemas/EParamsAzureFunction"},{"$ref":"#/components/schemas/EParamsGoogleFunction"},{"$ref":"#/components/schemas/EParamsSysdig"},{"$ref":"#/components/schemas/EParamsStatusPageIO"},{"$ref":"#/components/schemas/EParamsDingTalk"},{"$ref":"#/components/schemas/EParamsZabbix"}]}}},"ConnectorType":{"type":"string","enum":["jira","microsoft_teams_bot","servicenow","slack","zendesk","discord","github","topdesk","zammad","mattermost","zoom_chat","dingtalk","dynamic","zabbix","autotask","google_chat_bot"]},"EParamsDatadog":{"type":"object","properties":{"apiKey":{"type":"string"}}},"EParamsJira":{"type":"object","properties":{"url":{"type":"string"},"email":{"type":"string"},"password":{"type":"string"}}},"EParamsMicrosoftTeams":{"type":"object","properties":{"url":{"type":"string"}}},"EParamsServiceNow":{"type":"object","properties":{"url":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"}}},"EParamsSlack":{"type":"object"},"EParamsZendesk":{"type":"object","properties":{"url":{"type":"string"},"email":{"type":"string"},"apiKey":{"type":"string"}}},"EParamsDiscord":{"type":"object","properties":{"url":{"type":"string"}}},"EParamsGithub":{"type":"object","properties":{"apiKey":{"type":"string"}}},"EParamsTopdesk":{"type":"object","properties":{"url":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"}}},"EParamsAWSLambda":{"type":"object","properties":{"authorization":{"type":"string"}}},"EParamsAzureFunction":{"type":"object","properties":{"authorization":{"type":"string"}}},"EParamsGoogleFunction":{"type":"object","properties":{"authorization":{"type":"string"}}},"EParamsSysdig":{"type":"object","properties":{"apiKey":{"type":"string"}}},"EParamsStatusPageIO":{"type":"object","properties":{"apiKey":{"type":"string"}}},"EParamsDingTalk":{"type":"object","properties":{"url":{"type":"string"},"secret":{"type":"string"}}},"EParamsZabbix":{"type":"object","properties":{"url":{"type":"string"},"apiKey":{"type":"string"}}}}},"paths":{"/connectors/{id}":{"put":{"tags":["Connectors"],"summary":"Update the specific connector. (note: type cannot be changed)","parameters":[{"name":"id","in":"path","description":"entity ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"the connector","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connector"}}},"required":true},"responses":{"200":{"description":"The updated connector","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connector"}}}}}}}}}
```

## DELETE /connectors/{id}

> Remove a specific connector.

```json
{"openapi":"3.0.1","info":{"title":"ilert REST API","version":"v2.2026.3-r.4"},"tags":[{"name":"Connectors"}],"servers":[{"url":"/api"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","description":"The Bearer API key of your user <a href='/api-docs/#section/Authentication'>more info</a>.","name":"Authorization","in":"header"}}},"paths":{"/connectors/{id}":{"delete":{"tags":["Connectors"],"summary":"Remove a specific connector.","parameters":[{"name":"id","in":"path","description":"entity ID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty body delete response","content":{}}}}}}}
```