Skip to main content
Theme
Home

Test Destination

POSThttps://api.coralogix.com/mgmt/openapi/5/notifications/notification-center/v1/destinations:test

Tests a notification destination.

Authorizations

Authorizationstringheaderrequired
API key authentication
The value is a Coralogix API key. Create a personal or team API key and assign its permissions.

Request​

Body

application/json

Request for testing a notification destination.

    The connector config fields.

    Possible values: <= 100

    connectorId#string

    The connector id.

    Possible values: non-empty and <= 128 characters, Value must match regular expression ^[a-zA-Z0-9][a-zA-Z0-9_-]*$

    entitySubType#string

    Entity sub-type to use when testing the destination.

    Possible values: non-empty and <= 100 characters, Value must match regular expression ^[\s\S]*$

    Example: logsImmediateResolved
    entityType#notification_center.EntityType

    Entity type.

    Possible values: [ENTITY_TYPE_UNSPECIFIED, ALERTS, TEST_NOTIFICATIONS, CASES]

    The message config fields.

    Possible values: <= 100

    payloadType#string

    Payload type to use when testing the destination.

    Possible values: non-empty and <= 100 characters, Value must match regular expression ^[\s\S]*$

    Example: default
    presetId#string

    The preset id.

    Possible values: non-empty and <= 128 characters, Value must match regular expression ^[a-zA-Z0-9][a-zA-Z0-9_-]*$

Response

application/json

Response containing the results of a notification destination test.

    result#object

    Result of a notification test, either a success or failure.

    oneOf
    object

    Failure.

    Indicates the notification test succeeded.