COcouchbase
Alert Integration

Update Alert Integration

Changed on

Update the details of the given alert integration.

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

  • Organization Owner
  • Project Owner
  • Project Manager

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

put/v4/organizations/{organizationId}/projects/{projectId}/alertIntegrations/{alertIntegrationId}

Request

Request body

kind'webhook' | 'slack' | 'teams'

Type of alert integration. If provided, must match the existing integration's kind. This field cannot be used to change the integration kind.

namestring nullable

Name of the alert integration (up to 1024 characters).

enabledboolean

Enables or disables the integration.

Example request

{
  "kind": "slack",
  "name": "test alert 1",
  "config": {
    "webhook": {
      "method": "POST",
      "url": "https://company.servicenow.com",
      "token": "QktxVUtFU1dKV1FlJBYXdnTVlRemFZdlRDZTg6eFh4dzU4JUYjqdUwwYkJoTjZSTmlzRWFIRHF0b1h4a08yazBpQjJ1bms1OW4yTUhdsfRib3IhVQ==",
      "basicAuth": {
        "user": "username80085",
        "password": "yed69khj420_i"
      },
      "exclude": {
        "clusters": [
          "ffffffff-aaaa-1414-eeee-000000000000",
          "..."
        ],
        "appServices": [
          "ffffffff-aaaa-1414-eeee-000000000000",
          "..."
        ]
      }
    }
  }
}

Response

Successfully updated the metadata for the alert integration.

idstring uuid required

The ID of the alert integration created.

namestring required

Name of the alert integration (up to 1024 characters).

tenantIdstring uuid required

The tenant ID to which the alert integration belongs to.

projectIdstring uuid

The project ID to which the alert integration belongs to.

kind'webhook' | 'slack' | 'teams' required

Type of alert integration.

configKeystring required

ConfigKey is the key that was used to store the alert integration config and secrets.

statusstring required

Status is either healthy or unhealthy showing if the integration is functional or not.

enabledboolean required

Enables or disables the integration. Only 1 integration can be active at any time.

Example response

{
  "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
  }
}

Changes

  • e67df5d1f74eRevision changes
    • breaking

      removed the success response with the status

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property //

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became nullable

    • info

      the request property became optional

    • info

      the request property / became optional

    • info

      added subschema #1 subschema #2 subschema #3 to the request property oneOf list

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status