Sign in

v1

latestOpenAPI 3.0.22026-08-062794201004.1 KB
Alert Integration

List Alert Integrations

Lists all the alert integrations under the project.

In order to access this endpoint, the provided API key must have at least one of the following roles:

  • Organization Owner
  • Organization Member
  • Project Owner
  • Project Manager
  • Project Viewer

To learn more, see Organization, Project, and Database Access Overview.

get/v4/organizations/{organizationId}/projects/{projectId}/alertIntegrations

Query parameters

pageinteger

Sets the page you would like to view.

perPageinteger

Sets the number of results you would like to have on each page.

sortBystring[]

Sets the order of how you would like to sort the results and the key you would like to order by. Valid fields to sort the results are: id, name.

sortDirection'asc' | 'desc'

The order in which the items will be sorted.

Response

Successfully listed all the alert integrations under the project.

Example response

{
  "data": [
    {
      "id": "ffffffff-aaaa-1414-eeee-000000000000",
      "name": "test alert 1",
      "tenantId": "ffffffff-aaaa-1414-eeee-000000000000",
      "projectId": "ffffffff-aaaa-1414-eeee-000000000000",
      "kind": "teams",
      "configKey": "ffffffff-aaaa-1414-eeee-000000000000-alert-integration",
      "status": "healthy",
      "config": {
        "webhook": {
          "method": "POST",
          "url": "https://company.servicenow.com",
          "exclude": {
            "clusters": [
              "ffffffff-aaaa-1414-eeee-000000000000",
              "..."
            ],
            "appServices": [
              "ffffffff-aaaa-1414-eeee-000000000000",
              "..."
            ]
          }
        },
        "slack": {
          "channel": "#alerts"
        }
      },
      "audit": {
        "createdBy": "ffffffff-aaaa-1414-eeee-000000000000",
        "createdAt": "2021-09-01T12:34:56Z",
        "modifiedBy": "ffffffff-aaaa-1414-eeee-000000000000",
        "modifiedAt": "2021-09-01T12:34:56Z",
        "version": 1
      }
    }
  ],
  "cursor": {
    "pages": {
      "page": 2,
      "next": 3,
      "previous": 1,
      "last": 10,
      "perPage": 10,
      "totalItems": 10
    },
    "hrefs": {
      "first": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "last": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "previous": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "next": "https://cloud.couchbase.com/v4/users?page=1&perPage=10"
    }
  }
}