Test integration

POSThttps://api.eu1.coralogix.com/mgmt/openapi/5/integrations/metadata/v1/test

Tests the integration configuration. A test that runs answers 200 with result.success or result.failure.errorMessage. An invalid integration key or version answers 400 or 404.

Requires the following permissions:

• integrations:ReadConfig

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 an integration configuration.

integrationData# objectrequired
This data structure represents the metadata of an integration. Parameter names are case sensitive.
integrationId#string

ID of the existing integration instance to test.

Possible values: <= 65535 characters, Value must match regular expression ^[\s\S]*$

Response

200400401500application/json

Response containing the results of an integration test.

result#object

Test integration result.

oneOf

• Option 1
• Option 2
• Option 3

object

result.failure# object

Failure.

result.success#object

Success.