connectors-admin
Open an operation to see its authentication, its parameters and the fields of its request and response.
10 operations
GET/v1/connectors
Log connectors of a workspace with status, last activity, events in 24 hours, masked secrets.
/v1/connectorsAuthentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
workspace_idqueryrequired | string |
Response 200
| Name | Type | Description |
|---|---|---|
itemsrequired | array of object | |
items[].idrequired | string | |
items[].workspace_idrequired | string | |
items[].kindrequired | enum | Values sentry | datadog | cloudwatch | endpoint |
items[].namerequired | string | |
items[].statusrequired | enum | Values active | paused | error |
items[].configrequired | object | |
items[].secretsrequired | array of object | |
items[].secrets[].namerequired | enum | Values client_secret | auth_token | api_key | application_key | access_key_id | secret_access_key | token |
items[].secrets[].last4required | string | |
items[].webhook_urlrequired | string | |
items[].ingest_urlrequired | string | |
items[].white_labelrequired | boolean | |
items[].white_label_pendingrequired | boolean | |
items[].key_idrequired | string | |
items[].pollsrequired | boolean | |
items[].last_activity_atrequired | string (date-time) | |
items[].next_poll_atrequired | string (date-time) | |
items[].last_error_coderequired | string | |
items[].last_errorrequired | string | |
items[].events_24hrequired | integer | |
items[].created_atrequired | string (date-time) | |
items[].updated_atrequired | string (date-time) |
POST/v1/connectors
Creates a connector; the generic endpoint token is in this answer only.
/v1/connectorsSettings are validated by kind; refusals carry stable issue codes (`CONNECTOR_CONFIG_ISSUE_CODES`). CloudWatch roles must use the external id of `GET /v1/connectors/setup/cloudwatch`.
Authentication: Dashboard session
Request body
| Name | Type | Description |
|---|---|---|
workspace_idrequired | string | |
kindrequired | enum | Values sentry | datadog | cloudwatch | endpoint |
namerequired | string | |
config | object | |
secrets | object |
Response 201
| Name | Type | Description |
|---|---|---|
connectorrequired | object | |
connector.idrequired | string | |
connector.workspace_idrequired | string | |
connector.kindrequired | enum | Values sentry | datadog | cloudwatch | endpoint |
connector.namerequired | string | |
connector.statusrequired | enum | Values active | paused | error |
connector.configrequired | object | |
connector.secretsrequired | array of object | |
connector.secrets[].namerequired | enum | Values client_secret | auth_token | api_key | application_key | access_key_id | secret_access_key | token |
connector.secrets[].last4required | string | |
connector.webhook_urlrequired | string | |
connector.ingest_urlrequired | string | |
connector.white_labelrequired | boolean | |
connector.white_label_pendingrequired | boolean | |
connector.key_idrequired | string | |
connector.pollsrequired | boolean | |
connector.last_activity_atrequired | string (date-time) | |
connector.next_poll_atrequired | string (date-time) | |
connector.last_error_coderequired | string | |
connector.last_errorrequired | string | |
connector.events_24hrequired | integer | |
connector.created_atrequired | string (date-time) | |
connector.updated_atrequired | string (date-time) | |
tokenrequired | string |
GET/v1/connectors/{id}
One connector.
/v1/connectors/{id}Authentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
idpathrequired | string |
Response 200
| Name | Type | Description |
|---|---|---|
idrequired | string | |
workspace_idrequired | string | |
kindrequired | enum | Values sentry | datadog | cloudwatch | endpoint |
namerequired | string | |
statusrequired | enum | Values active | paused | error |
configrequired | object | |
secretsrequired | array of object | |
secrets[].namerequired | enum | Values client_secret | auth_token | api_key | application_key | access_key_id | secret_access_key | token |
secrets[].last4required | string | |
webhook_urlrequired | string | |
ingest_urlrequired | string | |
white_labelrequired | boolean | |
white_label_pendingrequired | boolean | |
key_idrequired | string | |
pollsrequired | boolean | |
last_activity_atrequired | string (date-time) | |
next_poll_atrequired | string (date-time) | |
last_error_coderequired | string | |
last_errorrequired | string | |
events_24hrequired | integer | |
created_atrequired | string (date-time) | |
updated_atrequired | string (date-time) |
PATCH/v1/connectors/{id}
Changes name, settings or secrets (only those sent are replaced).
/v1/connectors/{id}Authentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
idpathrequired | string |
Request body
| Name | Type | Description |
|---|---|---|
name | string | |
config | object | |
secrets | object |
Response 200
The same fields as GET /v1/connectors/{id}.
DELETE/v1/connectors/{id}
Deletes a connector and its secrets; stored error events stay until retention.
/v1/connectors/{id}Authentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
idpathrequired | string |
Response 200
| Name | Type | Description |
|---|---|---|
okrequired | true |
POST/v1/connectors/{id}/pause
Stops polling and ingestion until it is resumed.
/v1/connectors/{id}/pauseAuthentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
idpathrequired | string |
Response 200
The same fields as GET /v1/connectors/{id}.
POST/v1/connectors/{id}/resume
Resumes a paused connector; polling restarts at once.
/v1/connectors/{id}/resumeAuthentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
idpathrequired | string |
Response 200
The same fields as GET /v1/connectors/{id}.
POST/v1/connectors/{id}/rotate-token
Generic endpoint: a new token, in this answer only; the old one stops working.
/v1/connectors/{id}/rotate-tokenAuthentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
idpathrequired | string |
Response 200
The same fields as POST /v1/connectors.
POST/v1/connectors/{id}/test
Tests the connection with the stored settings and records the outcome.
/v1/connectors/{id}/test`ok` true or false after calling the provider (the status follows). Push-only connectors (Sentry without an auth token, the generic endpoint) have nothing to call: `ok` null with `code` `awaiting_delivery` or `receiving` (`details.last_delivery_at`), status unchanged.
Authentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
idpathrequired | string |
Response 200
| Name | Type | Description |
|---|---|---|
okrequired | boolean | |
coderequired | string | |
messagerequired | string | |
detailsrequired | object | |
connectorrequired | object | |
connector.idrequired | string | |
connector.workspace_idrequired | string | |
connector.kindrequired | enum | Values sentry | datadog | cloudwatch | endpoint |
connector.namerequired | string | |
connector.statusrequired | enum | Values active | paused | error |
connector.configrequired | object | |
connector.secretsrequired | array of object | |
connector.secrets[].namerequired | enum | Values client_secret | auth_token | api_key | application_key | access_key_id | secret_access_key | token |
connector.secrets[].last4required | string | |
connector.webhook_urlrequired | string | |
connector.ingest_urlrequired | string | |
connector.white_labelrequired | boolean | |
connector.white_label_pendingrequired | boolean | |
connector.key_idrequired | string | |
connector.pollsrequired | boolean | |
connector.last_activity_atrequired | string (date-time) | |
connector.next_poll_atrequired | string (date-time) | |
connector.last_error_coderequired | string | |
connector.last_errorrequired | string | |
connector.events_24hrequired | integer | |
connector.created_atrequired | string (date-time) | |
connector.updated_atrequired | string (date-time) |
GET/v1/connectors/setup/cloudwatch
The external id issued for the workspace and the IAM policies of a CloudWatch role.
/v1/connectors/setup/cloudwatchAuthentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
workspace_idqueryrequired | string |
Response 200
| Name | Type | Description |
|---|---|---|
external_idrequired | string | |
principal_arnrequired | string | |
trust_policyrequired | string | |
permissions_policyrequired | string |