redocly logoAPI docs by Redocly

google/api/client.proto (version not set)

Download OpenAPI specification:Download

EventsService

EventsService_ListEvents

Authorizations:
apiKeyAuth
query Parameters
filter.timestamp.from
required
string <date-time>
filter.timestamp.to
required
string <date-time>
filter.cxEventTypes
required
Array of strings
filter.cxEventKeys
required
Array of strings
filter.cxEventMetadataFilters.operator
required
string
Default: "FILTER_OPERATOR_AND_OR_UNSPECIFIED"
Enum: "FILTER_OPERATOR_AND_OR_UNSPECIFIED" "FILTER_OPERATOR_OR"
pagination.pageSize
integer <int64>
pagination.pageToken
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v3/events?filter.timestamp.from=SOME_STRING_VALUE&filter.timestamp.to=SOME_STRING_VALUE&filter.cxEventTypes=SOME_ARRAY_VALUE&filter.cxEventKeys=SOME_ARRAY_VALUE&filter.cxEventMetadataFilters.operator=SOME_STRING_VALUE&pagination.pageSize=SOME_INTEGER_VALUE&pagination.pageToken=SOME_STRING_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "events": [
    ],
  • "pagination": {
    }
}

EventsService_BatchGetEvent

Authorizations:
apiKeyAuth
query Parameters
ids
Array of strings
pagination.pageSize
integer <int64>
pagination.pageToken
string
filter.timestamp.from
required
string <date-time>
filter.timestamp.to
required
string <date-time>

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v3/events/events:batchGet?ids=SOME_ARRAY_VALUE&pagination.pageSize=SOME_INTEGER_VALUE&pagination.pageToken=SOME_STRING_VALUE&filter.timestamp.from=SOME_STRING_VALUE&filter.timestamp.to=SOME_STRING_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "events": {
    },
  • "notFoundIds": [
    ],
  • "pagination": {
    }
}

EventsService_GetEvent

Authorizations:
apiKeyAuth
path Parameters
id
required
string
query Parameters
pagination.pageSize
integer <int64>
pagination.pageToken
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v3/events/%7Bid%7D?pagination.pageSize=SOME_INTEGER_VALUE&pagination.pageToken=SOME_STRING_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "event": {
    },
  • "pagination": {
    }
}

EventsService_ListEventsCount

Authorizations:
apiKeyAuth
query Parameters
filter.timestamp.from
required
string <date-time>
filter.timestamp.to
required
string <date-time>
filter.cxEventTypes
required
Array of strings
filter.cxEventKeys
required
Array of strings
filter.cxEventMetadataFilters.operator
required
string
Default: "FILTER_OPERATOR_AND_OR_UNSPECIFIED"
Enum: "FILTER_OPERATOR_AND_OR_UNSPECIFIED" "FILTER_OPERATOR_OR"

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v3/events:count?filter.timestamp.from=SOME_STRING_VALUE&filter.timestamp.to=SOME_STRING_VALUE&filter.cxEventTypes=SOME_ARRAY_VALUE&filter.cxEventKeys=SOME_ARRAY_VALUE&filter.cxEventMetadataFilters.operator=SOME_STRING_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "count": 10,
  • "reachedLimit": false
}

EventsService_GetEventsStatistics

Authorizations:
apiKeyAuth
query Parameters
filter.timestamp.from
required
string <date-time>
filter.timestamp.to
required
string <date-time>
filter.cxEventTypes
required
Array of strings
filter.cxEventKeys
required
Array of strings
filter.cxEventMetadataFilters.operator
required
string
Default: "FILTER_OPERATOR_AND_OR_UNSPECIFIED"
Enum: "FILTER_OPERATOR_AND_OR_UNSPECIFIED" "FILTER_OPERATOR_OR"

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v3/events:statistics?filter.timestamp.from=SOME_STRING_VALUE&filter.timestamp.to=SOME_STRING_VALUE&filter.cxEventTypes=SOME_ARRAY_VALUE&filter.cxEventKeys=SOME_ARRAY_VALUE&filter.cxEventMetadataFilters.operator=SOME_STRING_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "cxEventMetadataFieldStatistics": {
    }
}

ServiceSloService

ServiceSloService_BatchGetServiceSlos

Authorizations:
apiKeyAuth
query Parameters
ids
required
Array of strings

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/service_slos?ids=SOME_ARRAY_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "slos": {
    },
  • "notFoundIds": [
    ]
}

ServiceSloService_CreateServiceSlo

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

This data structure represents a request to create a Service SLO.

required
object (Service SLO)

This data structure represents a Service Level Objective (SLO) in Coralogix APM.

Find out more about SLOs in Coralogix APM

Responses

Request samples

Content type
application/json
{
  • "slo": {
    }
}

Response samples

Content type
application/json
{
  • "slo": {
    }
}

ServiceSloService_ReplaceServiceSlo

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

This data structure represents a request to update a Service SLO.

required
object (Service SLO)

This data structure represents a Service Level Objective (SLO) in Coralogix APM.

Find out more about SLOs in Coralogix APM

Responses

Request samples

Content type
application/json
{
  • "slo": {
    }
}

Response samples

Content type
application/json
{
  • "slo": {
    }
}

ServiceSloService_ListServiceSlos

Authorizations:
apiKeyAuth
query Parameters
orderBy.fieldName
required
string
orderBy.direction
required
string
Default: "ORDER_BY_DIRECTION_UNSPECIFIED"
Enum: "ORDER_BY_DIRECTION_UNSPECIFIED" "ORDER_BY_DIRECTION_ASC" "ORDER_BY_DIRECTION_DESC"
serviceNames
required
Array of strings

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/service_slos/all?orderBy.fieldName=SOME_STRING_VALUE&orderBy.direction=SOME_STRING_VALUE&serviceNames=SOME_ARRAY_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "slos": [
    ]
}

ServiceSloService_GetServiceSlo

Authorizations:
apiKeyAuth
path Parameters
id
required
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/service_slos/%7Bid%7D';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "slo": {
    }
}

ServiceSloService_DeleteServiceSlo

Authorizations:
apiKeyAuth
path Parameters
id
required
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/service_slos/%7Bid%7D';

let options = {method: 'DELETE', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{ }

GlobalRoutersService

GlobalRoutersService_ListGlobalRouters

Authorizations:
apiKeyAuth
query Parameters
entityType
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/routers?entityType=SOME_STRING_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "routers": [
    ]
}

GlobalRoutersService_CreateGlobalRouter

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
id
string (A unique identifier automatically generated by the service (do not provide this from the client side))
userFacingId
string (A unique identifier provided by the user)
entityType
required
string (The source of the notification (e.g., "alerts"))
name
required
string
description
string
Array of objects (The routing rules to be applied in order to determine the destinations of the notification, teh first rule that matches will be used)
Array of objects (The fallback destinations to be used if no rule matches)
createTime
string <date-time> (System-generated timestamp for when the router was last updated)
updateTime
string <date-time> (System-generated timestamp for when the router was last updated)
object

Responses

Request samples

Content type
application/json
{
  • "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
  • "userFacingId": "user-provided-id",
  • "entityType": "alerts",
  • "name": "My Router",
  • "description": "string",
  • "rules": [
    ],
  • "fallback": [
    ],
  • "createTime": "2019-08-24T14:15:22Z",
  • "updateTime": "2019-08-24T14:15:22Z",
  • "entityLabels": {
    }
}

Response samples

Content type
application/json
{
  • "router": {
    }
}

GlobalRoutersService_CreateOrReplaceGlobalRouter

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
id
string (A unique identifier automatically generated by the service (do not provide this from the client side))
userFacingId
string (A unique identifier provided by the user)
entityType
required
string (The source of the notification (e.g., "alerts"))
name
required
string
description
string
Array of objects (The routing rules to be applied in order to determine the destinations of the notification, teh first rule that matches will be used)
Array of objects (The fallback destinations to be used if no rule matches)
createTime
string <date-time> (System-generated timestamp for when the router was last updated)
updateTime
string <date-time> (System-generated timestamp for when the router was last updated)
object

Responses

Request samples

Content type
application/json
{
  • "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
  • "userFacingId": "user-provided-id",
  • "entityType": "alerts",
  • "name": "My Router",
  • "description": "string",
  • "rules": [
    ],
  • "fallback": [
    ],
  • "createTime": "2019-08-24T14:15:22Z",
  • "updateTime": "2019-08-24T14:15:22Z",
  • "entityLabels": {
    }
}

Response samples

Content type
application/json
{
  • "router": {
    }
}

GlobalRoutersService_GetGlobalRouter

Authorizations:
apiKeyAuth
path Parameters
identifier.userFacingId
required
string
query Parameters
identifier.id
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/routers/%7Bidentifier.userFacingId%7D?identifier.id=SOME_STRING_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "router": {
    }
}

GlobalRoutersService_DeleteGlobalRouter

Authorizations:
apiKeyAuth
path Parameters
identifier.userFacingId
required
string
query Parameters
identifier.id
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/routers/%7Bidentifier.userFacingId%7D?identifier.id=SOME_STRING_VALUE';

let options = {method: 'DELETE', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{ }

ConnectorsService

ConnectorsService_ReplaceConnector

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
id
string (A unique identifier automatically generated by the service (do not provide this from the client side))
userFacingId
string (A unique identifier provided by the user)
type
required
string (notification_centerConnectorType)
Default: "CONNECTOR_TYPE_UNSPECIFIED"
Enum: "CONNECTOR_TYPE_UNSPECIFIED" "SLACK" "GENERIC_HTTPS" "PAGERDUTY" "AWS" "IBM_EVENT_NOTIFICATIONS"
teamId
integer <int64>
name
required
string <= 200 characters
description
string <= 5000 characters
createTime
string <date-time> (System-generated timestamp for when the connector was last updated)
updateTime
string <date-time> (System-generated timestamp for when the connector was last updated)
required
Array of objects (Connector Config)
Array of objects (Configuration override templates for specific entity types, values from connector_configs will be used if not overridden)

Responses

Request samples

Content type
application/json
{
  • "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
  • "userFacingId": "user-connector-id",
  • "type": "CONNECTOR_TYPE_UNSPECIFIED",
  • "teamId": "12345",
  • "name": "My Slack Connector",
  • "description": "Connector for team notifications",
  • "createTime": "2019-08-24T14:15:22Z",
  • "updateTime": "2019-08-24T14:15:22Z",
  • "connectorConfigs": [
    ],
  • "configOverrides": [
    ]
}

Response samples

Content type
application/json
{
  • "connector": {
    }
}

ConnectorsService_ListConnectors

Authorizations:
apiKeyAuth
query Parameters
connectorType
string
Default: "CONNECTOR_TYPE_UNSPECIFIED"
Enum: "CONNECTOR_TYPE_UNSPECIFIED" "SLACK" "GENERIC_HTTPS" "PAGERDUTY" "AWS" "IBM_EVENT_NOTIFICATIONS"

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/connectors?connectorType=SOME_STRING_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "connectors": [
    ]
}

ConnectorsService_CreateConnector

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
id
string (A unique identifier automatically generated by the service (do not provide this from the client side))
userFacingId
string (A unique identifier provided by the user)
type
required
string (notification_centerConnectorType)
Default: "CONNECTOR_TYPE_UNSPECIFIED"
Enum: "CONNECTOR_TYPE_UNSPECIFIED" "SLACK" "GENERIC_HTTPS" "PAGERDUTY" "AWS" "IBM_EVENT_NOTIFICATIONS"
teamId
integer <int64>
name
required
string <= 200 characters
description
string <= 5000 characters
createTime
string <date-time> (System-generated timestamp for when the connector was last updated)
updateTime
string <date-time> (System-generated timestamp for when the connector was last updated)
required
Array of objects (Connector Config)
Array of objects (Configuration override templates for specific entity types, values from connector_configs will be used if not overridden)

Responses

Request samples

Content type
application/json
{
  • "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
  • "userFacingId": "user-connector-id",
  • "type": "CONNECTOR_TYPE_UNSPECIFIED",
  • "teamId": "12345",
  • "name": "My Slack Connector",
  • "description": "Connector for team notifications",
  • "createTime": "2019-08-24T14:15:22Z",
  • "updateTime": "2019-08-24T14:15:22Z",
  • "connectorConfigs": [
    ],
  • "configOverrides": [
    ]
}

Response samples

Content type
application/json
{
  • "connector": {
    }
}

ConnectorsService_GetConnector

Authorizations:
apiKeyAuth
path Parameters
id
required
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/connectors/%7Bid%7D';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "connector": {
    }
}

ConnectorsService_DeleteConnector

Authorizations:
apiKeyAuth
path Parameters
id
required
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/connectors/%7Bid%7D';

let options = {method: 'DELETE', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{ }

ConnectorsService_BatchGetConnectors

Authorizations:
apiKeyAuth
query Parameters
ids
Array of strings

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/connectors:batchGet?ids=SOME_ARRAY_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "connectors": {
    },
  • "notFoundIds": [
    ]
}

ConnectorsService_BatchGetConnectorSummaries

Authorizations:
apiKeyAuth
query Parameters
ids
Array of strings

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/connectors:batchGetSummaries?ids=SOME_ARRAY_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "connectorSummaries": {
    },
  • "notFoundIds": [
    ]
}

ConnectorsService_GetConnectorTypeSummaries

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/connectors:getTypeSummaries';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "connectorTypeSummaries": [
    ]
}

ConnectorsService_ListConnectorSummaries

Authorizations:
apiKeyAuth
query Parameters
connectorType
string
Default: "CONNECTOR_TYPE_UNSPECIFIED"
Enum: "CONNECTOR_TYPE_UNSPECIFIED" "SLACK" "GENERIC_HTTPS" "PAGERDUTY" "AWS" "IBM_EVENT_NOTIFICATIONS"

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/connectors:listSummaries?connectorType=SOME_STRING_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "connectorSummaries": [
    ]
}

PresetsService

PresetsService_CreateCustomPreset

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
id
string (A unique identifier automatically generated by the service (do not provide this from the client side))
userFacingId
string (A unique identifier provided by the user)
entityType
required
string
connectorType
string (notification_centerConnectorType)
Default: "CONNECTOR_TYPE_UNSPECIFIED"
Enum: "CONNECTOR_TYPE_UNSPECIFIED" "SLACK" "GENERIC_HTTPS" "PAGERDUTY" "AWS" "IBM_EVENT_NOTIFICATIONS"
required
Array of objects (A list of of configuration override templates, each associated with a specific output schema and condition)
parent
object (Preset) Recursive

Set of preconfigured templates for notification content rendering

Find out more about notification center
name
required
string
description
string
createTime
string <date-time> (System-generated timestamp for when the preset was created)
updateTime
string <date-time> (System-generated timestamp for when the preset was last updated)
presetType
string (v1PresetType)
Default: "PRESET_TYPE_UNSPECIFIED"
Enum: "PRESET_TYPE_UNSPECIFIED" "SYSTEM" "CUSTOM"

Responses

Request samples

Content type
application/json
{
  • "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
  • "userFacingId": "user-preset-id",
  • "entityType": "alerts",
  • "connectorType": "CONNECTOR_TYPE_UNSPECIFIED",
  • "configOverrides": [
    ],
  • "parent": { },
  • "name": "My Preset",
  • "description": "Custom preset for alerts",
  • "createTime": "2019-08-24T14:15:22Z",
  • "updateTime": "2019-08-24T14:15:22Z",
  • "presetType": "PRESET_TYPE_UNSPECIFIED"
}

Response samples

Content type
application/json
{
  • "preset": {
    }
}

PresetsService_ReplaceCustomPreset

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
id
string (A unique identifier automatically generated by the service (do not provide this from the client side))
userFacingId
string (A unique identifier provided by the user)
entityType
required
string
connectorType
string (notification_centerConnectorType)
Default: "CONNECTOR_TYPE_UNSPECIFIED"
Enum: "CONNECTOR_TYPE_UNSPECIFIED" "SLACK" "GENERIC_HTTPS" "PAGERDUTY" "AWS" "IBM_EVENT_NOTIFICATIONS"
required
Array of objects (A list of of configuration override templates, each associated with a specific output schema and condition)
parent
object (Preset) Recursive

Set of preconfigured templates for notification content rendering

Find out more about notification center
name
required
string
description
string
createTime
string <date-time> (System-generated timestamp for when the preset was created)
updateTime
string <date-time> (System-generated timestamp for when the preset was last updated)
presetType
string (v1PresetType)
Default: "PRESET_TYPE_UNSPECIFIED"
Enum: "PRESET_TYPE_UNSPECIFIED" "SYSTEM" "CUSTOM"

Responses

Request samples

Content type
application/json
{
  • "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
  • "userFacingId": "user-preset-id",
  • "entityType": "alerts",
  • "connectorType": "CONNECTOR_TYPE_UNSPECIFIED",
  • "configOverrides": [
    ],
  • "parent": { },
  • "name": "My Preset",
  • "description": "Custom preset for alerts",
  • "createTime": "2019-08-24T14:15:22Z",
  • "updateTime": "2019-08-24T14:15:22Z",
  • "presetType": "PRESET_TYPE_UNSPECIFIED"
}

Response samples

Content type
application/json
{
  • "preset": {
    }
}

PresetsService_DeleteCustomPreset

Authorizations:
apiKeyAuth
path Parameters
identifier.userFacingId
required
string

The unique identifier provided by the user

query Parameters
id
string
userFacingId
string
identifier.id
string

The unique identifier automatically generated by the service

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/presets/custom/%7Bidentifier.userFacingId%7D?id=SOME_STRING_VALUE&userFacingId=SOME_STRING_VALUE&identifier.id=SOME_STRING_VALUE';

let options = {method: 'DELETE', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{ }

PresetsService_SetCustomPresetAsDefault

Authorizations:
apiKeyAuth
path Parameters
identifier.userFacingId
required
string

The unique identifier provided by the user

query Parameters
id
string
userFacingId
string
identifier.id
string

The unique identifier automatically generated by the service

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/presets/custom/%7Bidentifier.userFacingId%7D:defaultSet?id=SOME_STRING_VALUE&userFacingId=SOME_STRING_VALUE&identifier.id=SOME_STRING_VALUE';

let options = {method: 'POST', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{ }

PresetsService_GetPreset

Authorizations:
apiKeyAuth
path Parameters
identifier.userFacingId
required
string

The unique identifier provided by the user

query Parameters
id
string
userFacingId
string
identifier.id
string

The unique identifier automatically generated by the service

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/presets/%7Bidentifier.userFacingId%7D?id=SOME_STRING_VALUE&userFacingId=SOME_STRING_VALUE&identifier.id=SOME_STRING_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "preset": {
    }
}

PresetsService_SetPresetAsDefault

Authorizations:
apiKeyAuth
path Parameters
identifier.userFacingId
required
string

The unique identifier provided by the user

query Parameters
identifier.id
string

The unique identifier automatically generated by the service

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/presets/%7Bidentifier.userFacingId%7D:defaultSet?identifier.id=SOME_STRING_VALUE';

let options = {method: 'POST', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{ }

PresetsService_BatchGetPresets

Authorizations:
apiKeyAuth
query Parameters
ids
Array of strings

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/presets:batchGet?ids=SOME_ARRAY_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "presets": {
    },
  • "notFoundIds": [
    ]
}

PresetsService_GetDefaultPresetSummary

Authorizations:
apiKeyAuth
query Parameters
connectorType
string
Default: "CONNECTOR_TYPE_UNSPECIFIED"
Enum: "CONNECTOR_TYPE_UNSPECIFIED" "SLACK" "GENERIC_HTTPS" "PAGERDUTY" "AWS" "IBM_EVENT_NOTIFICATIONS"
entityType
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/presets:defaultSummaryGet?connectorType=SOME_STRING_VALUE&entityType=SOME_STRING_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "presetSummary": {
    }
}

PresetsService_ListPresetSummaries

Authorizations:
apiKeyAuth
query Parameters
connectorType
string
Default: "CONNECTOR_TYPE_UNSPECIFIED"
Enum: "CONNECTOR_TYPE_UNSPECIFIED" "SLACK" "GENERIC_HTTPS" "PAGERDUTY" "AWS" "IBM_EVENT_NOTIFICATIONS"
entityType
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/presets:summariesList?connectorType=SOME_STRING_VALUE&entityType=SOME_STRING_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "presetSummaries": [
    ]
}

PresetsService_GetSystemDefaultPresetSummary

Authorizations:
apiKeyAuth
query Parameters
connectorType
string
Default: "CONNECTOR_TYPE_UNSPECIFIED"
Enum: "CONNECTOR_TYPE_UNSPECIFIED" "SLACK" "GENERIC_HTTPS" "PAGERDUTY" "AWS" "IBM_EVENT_NOTIFICATIONS"
entityType
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/presets:systemDefaultSummaryGet?connectorType=SOME_STRING_VALUE&entityType=SOME_STRING_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "presetSummary": {
    }
}

TestingService

TestingService_TestConnectorConfig

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to test a connector configuration

type
string (notification_centerConnectorType)
Default: "CONNECTOR_TYPE_UNSPECIFIED"
Enum: "CONNECTOR_TYPE_UNSPECIFIED" "SLACK" "GENERIC_HTTPS" "PAGERDUTY" "AWS" "IBM_EVENT_NOTIFICATIONS"
outputSchemaId
string
Array of objects (coralogixapisnotification_centerConnectorConfigField)
entityType
string

Responses

Request samples

Content type
application/json
{
  • "type": "CONNECTOR_TYPE_UNSPECIFIED",
  • "outputSchemaId": "default",
  • "fields": [
    ],
  • "entityType": "alerts"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

TestingService_TestDestination

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
entityType
string
entitySubType
string
connectorId
string
presetId
string
outputSchemaId
string
Array of objects (coralogixapisnotification_centerConnectorConfigField)
Array of objects (Message Config Field)

Responses

Request samples

Content type
application/json
{
  • "entityType": "alerts",
  • "entitySubType": "logsImmediateResolved",
  • "connectorId": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
  • "presetId": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
  • "outputSchemaId": "default",
  • "connectorConfigFields": [
    ],
  • "messageConfigFields": [
    ]
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

TestingService_TestExistingConnector

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
connectorId
string
outputSchemaId
string

Responses

Request samples

Content type
application/json
{
  • "connectorId": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
  • "outputSchemaId": "default"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

TestingService_TestExistingPreset

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
entityType
string
entitySubType
string
presetId
string
connectorId
string

Responses

Request samples

Content type
application/json
{
  • "entityType": "alerts",
  • "entitySubType": "logsImmediateResolved",
  • "presetId": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
  • "connectorId": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

TestingService_TestPresetConfig

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
entityType
string
entitySubType
string
connectorId
string
presetId
string
Array of objects (notification_centerConfigOverrides)

Responses

Request samples

Content type
application/json
{
  • "entityType": "alerts",
  • "entitySubType": "metric",
  • "connectorId": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
  • "presetId": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
  • "configOverrides": [
    ]
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

TestingService_TestRoutingConditionValid

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to check that provided routing condition is valid

entityType
string
template
string

Responses

Request samples

Content type
application/json
{
  • "entityType": "alerts",
  • "template": "alertDef.priority == 'P1'"
}

Response samples

Content type
application/json
{
  • "success": {
    },
  • "failure": {
    }
}

TestingService_TestTemplateRender

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
entityType
string
entitySubType
string
template
string

Responses

Request samples

Content type
application/json
{
  • "entityType": "alerts",
  • "entitySubType": "logsImmediateResolved",
  • "template": "{{ alertDef.name }}"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

EntitiesService

EntitiesService_ListEntityTypes

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/entities:listEntityTypes';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "entityTypes": [
    ]
}

ApiKeysService

ApiKeysService_CreateApiKey

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

This data structure is used to create an API key.

name
required
string
required
object (v3Owner)
required
object (Key Permissions)

This data structure allows to specify loose permissions and permission presets for an API key.

Find out more about api keys
hashed
required
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "my_api_key",
  • "owner": {
    },
  • "keyPermissions": {
    },
  • "hashed": true
}

Response samples

Content type
application/json
{
  • "keyId": "my_key_id",
  • "name": "my_api_key",
  • "value": "my_api_key_value"
}

ApiKeysService_GetSendDataApiKeys

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v3/api_keys/send_data';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "keys": [
    ]
}

ApiKeysService_GetApiKey

Authorizations:
apiKeyAuth
path Parameters
keyId
required
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v3/api_keys/%7BkeyId%7D';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "keyInfo": {
    }
}

ApiKeysService_DeleteApiKey

Authorizations:
apiKeyAuth
path Parameters
keyId
required
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v3/api_keys/%7BkeyId%7D';

let options = {method: 'DELETE', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{ }

ApiKeysService_UpdateApiKey

Authorizations:
apiKeyAuth
path Parameters
keyId
required
string
Request Body schema: application/json
required
newName
string
isActive
boolean
object (Presets)

This data structure represents a set of permissions presets on an API key.

Find out more about api keys
object (Permissions)

This data structure represents a set of permissions on an API key.

Find out more about api keys

Responses

Request samples

Content type
application/json
{
  • "newName": "my_new_name",
  • "isActive": true,
  • "presets": {
    },
  • "permissions": {
    }
}

Response samples

Content type
application/json
{ }

SamlConfigurationService

SamlConfigurationService_SetActive

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

This data structure is used to activate or deactivate a SAML identity provider

teamId
required
integer <int64>
isActive
required
boolean

Responses

Request samples

Content type
application/json
{
  • "teamId": 0,
  • "isActive": true
}

Response samples

Content type
application/json
{ }

SamlConfigurationService_GetConfiguration

Authorizations:
apiKeyAuth
query Parameters
teamId
required
integer <int64>

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/sso/saml/configuration?teamId=SOME_INTEGER_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{}

SamlConfigurationService_SetIDPParameters

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

This data structure is used to set the parameters of a SAML identity provider

teamId
required
integer <int64>
required
object (IDP Parameters)

This data structure represents a set of SAML identity provider parameters

Find out more about enrichments

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{ }

SamlConfigurationService_GetSPParameters

Authorizations:
apiKeyAuth
query Parameters
teamId
required
integer <int64>

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/sso/saml/sp_parameters?teamId=SOME_INTEGER_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{}

AlertDefsInternalService

AlertDefsInternalService_GetAlertDefByVersionIdInternal

Authorizations:
apiKeyAuth
path Parameters
alertVersionId
required
string

The Alert's version ID

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v3/alert-defs-internal/alertVersionId/%7BalertVersionId%7D';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "alertDef": {
    }
}

AlertDefsService

AlertDefsService_ListAlertDefs

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v3/alert-defs';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "alertDefs": [
    ]
}

AlertDefsService_CreateAlertDef

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
name
required
string
description
string
enabled
required
boolean
priority
string (v3AlertDefPriority)
Default: "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
Enum: "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED" "ALERT_DEF_PRIORITY_P4" "ALERT_DEF_PRIORITY_P3" "ALERT_DEF_PRIORITY_P2" "ALERT_DEF_PRIORITY_P1"
object (Activity Schedule)

Defines when an alert should be active based on days of the week and time windows

type
required
string (v3AlertDefType)
Default: "ALERT_DEF_TYPE_LOGS_IMMEDIATE_OR_UNSPECIFIED"
Enum: "ALERT_DEF_TYPE_LOGS_IMMEDIATE_OR_UNSPECIFIED" "ALERT_DEF_TYPE_LOGS_THRESHOLD" "ALERT_DEF_TYPE_LOGS_ANOMALY" "ALERT_DEF_TYPE_LOGS_RATIO_THRESHOLD" "ALERT_DEF_TYPE_LOGS_NEW_VALUE" "ALERT_DEF_TYPE_LOGS_UNIQUE_COUNT" "ALERT_DEF_TYPE_LOGS_TIME_RELATIVE_THRESHOLD" "ALERT_DEF_TYPE_METRIC_THRESHOLD" "ALERT_DEF_TYPE_METRIC_ANOMALY" "ALERT_DEF_TYPE_TRACING_IMMEDIATE" "ALERT_DEF_TYPE_TRACING_THRESHOLD" "ALERT_DEF_TYPE_FLOW"
object (Logs Immediate Alert Type)

Configuration for immediate alerts triggered on log entries matching specific filters

object (Tracing Immediate Alert Type)

Configuration for immediate alerts triggered on trace entries

object (Logs Threshold Alert Type)

Configuration for alerts triggered when log counts exceed or fall below specified thresholds

object (Logs Ratio Threshold Alert Type)

Configuration for alerts based on the ratio between two log queries

object (Logs Time Relative Threshold Alert Type)

Configuration for alerts comparing log counts between different time periods

object (Metric Threshold Alert Type)

Configuration for alerts based on metric threshold violations

object (Tracing Threshold Alert Type)

Configuration for alerts based on trace count thresholds

object (Flow Alert Type)

Configuration for flow-based alerts with multiple stages

object (Logs Anomaly Alert Type)

Configuration for alerts triggered by anomalous log patterns

object (Metric Anomaly Alert Type)

Configuration for alerts triggered by anomalous metric patterns

object (Logs New Value Alert Type)

Configuration for alerts triggered by new values appearing in logs

object (Logs Unique Count Alert Type)

Configuration for alerts based on unique value counts in logs

groupByKeys
Array of strings
object (v3AlertDefIncidentSettings)
object (v3AlertDefNotificationGroup)
Array of objects (v3AlertDefNotificationGroup)
object
phantomMode
boolean
deleted
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "My Alert",
  • "description": "Alert description",
  • "enabled": true,
  • "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED",
  • "activeOn": {
    },
  • "type": "ALERT_DEF_TYPE_LOGS_IMMEDIATE_OR_UNSPECIFIED",
  • "logsImmediate": {
    },
  • "tracingImmediate": {
    },
  • "logsThreshold": {
    },
  • "logsRatioThreshold": {
    },
  • "logsTimeRelativeThreshold": {
    },
  • "metricThreshold": {
    },
  • "tracingThreshold": {
    },
  • "flow": {
    },
  • "logsAnomaly": {
    },
  • "metricAnomaly": {
    },
  • "logsNewValue": {
    },
  • "logsUniqueCount": {
    },
  • "groupByKeys": [
    ],
  • "incidentsSettings": {
    },
  • "notificationGroup": {
    },
  • "notificationGroupExcess": [
    ],
  • "entityLabels": {
    },
  • "phantomMode": true,
  • "deleted": true
}

Response samples

Content type
application/json
{
  • "alertDef": {
    }
}

AlertDefsService_ReplaceAlertDef

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to replace an existing alert definition

required
object (Alert Definition Properties)

User-configurable properties of an alert definition

id
required
string

Responses

Request samples

Content type
application/json
{
  • "alertDefProperties": {
    },
  • "id": "alert-123"
}

Response samples

Content type
application/json
{
  • "alertDef": {
    }
}

AlertDefsService_GetAlertDefByVersionId

Authorizations:
apiKeyAuth
path Parameters
alertVersionId
required
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v3/alert-defs/alertVersionId/%7BalertVersionId%7D';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "alertDef": {
    }
}

Get Alert Def by non changing ID AKA UniqueIdentifier

Authorizations:
apiKeyAuth
path Parameters
id
required
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v3/alert-defs/%7Bid%7D';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "alertDef": {
    }
}

AlertDefsService_DeleteAlertDef

Authorizations:
apiKeyAuth
path Parameters
id
required
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v3/alert-defs/%7Bid%7D';

let options = {method: 'DELETE', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{ }

AlertDefsService_SetActive

Authorizations:
apiKeyAuth
path Parameters
id
required
string
query Parameters
active
required
boolean

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v3/alert-defs/%7Bid%7D:setActive?active=SOME_BOOLEAN_VALUE';

let options = {method: 'POST', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{ }

AlertDefsService_DownloadAlerts

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v3/alerts/download';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "result": {
    },
  • "error": {
    }
}

AlertEventService

AlertEventService_GetAlertEvent

Authorizations:
apiKeyAuth
path Parameters
id
required
string
query Parameters
pagination.pageSize
integer <int64>
pagination.pageToken
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v3/alert_event/%7Bid%7D?pagination.pageSize=SOME_INTEGER_VALUE&pagination.pageToken=SOME_STRING_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "id": "string",
  • "singlePermutation": {
    },
  • "multiplePermutation": {
    },
  • "pagination": {
    }
}

AlertEventService_GetAlertEventsStats

Authorizations:
apiKeyAuth
query Parameters
ids
Array of strings

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v3/alert_event_stats?ids=SOME_ARRAY_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "eventsStats": {
    }
}

DashboardsService

DashboardsService_CreateDashboard

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
requestId
string
object (astDashboard)

Dashboard represents the structure and configuration of a Coralogix Custom Dashboard.

isLocked
boolean

Responses

Request samples

Content type
application/json
{
  • "requestId": "string",
  • "dashboard": {
    },
  • "isLocked": true
}

Response samples

Content type
application/json
{
  • "dashboardId": "string"
}

DashboardsService_ReplaceDashboard

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
requestId
string
object (astDashboard)

Dashboard represents the structure and configuration of a Coralogix Custom Dashboard.

isLocked
boolean

Responses

Request samples

Content type
application/json
{
  • "requestId": "string",
  • "dashboard": {
    },
  • "isLocked": true
}

Response samples

Content type
application/json
{ }

DashboardsService_GetDashboard

Authorizations:
apiKeyAuth
path Parameters
dashboardId
required
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/dashboards/%7BdashboardId%7D';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "dashboard": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updaterAuthorId": "string",
  • "updaterName": "string",
  • "authorId": "string",
  • "authorName": "string",
  • "updatedOriginType": "TOKEN_ORIGIN_TYPE_UNSPECIFIED",
  • "createdOriginType": "TOKEN_ORIGIN_TYPE_UNSPECIFIED",
  • "isLocked": true
}

DashboardsService_DeleteDashboard

Authorizations:
apiKeyAuth
path Parameters
dashboardId
required
string
query Parameters
requestId
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/dashboards/%7BdashboardId%7D?requestId=SOME_STRING_VALUE';

let options = {method: 'DELETE', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{ }

DashboardsService_ReplaceDefaultDashboard

Authorizations:
apiKeyAuth
path Parameters
dashboardId
required
string
Request Body schema: application/json
required
requestId
string

Responses

Request samples

Content type
application/json
{
  • "requestId": "string"
}

Response samples

Content type
application/json
{ }

DashboardsService_AssignDashboardFolder

Authorizations:
apiKeyAuth
path Parameters
dashboardId
required
string
Request Body schema: application/json
required
requestId
string
folderId
string (could be null to assign the dashboard to root)

Responses

Request samples

Content type
application/json
{
  • "requestId": "string",
  • "folderId": "string"
}

Response samples

Content type
application/json
{ }

DashboardsService_PinDashboard

Authorizations:
apiKeyAuth
path Parameters
dashboardId
required
string
Request Body schema: application/json
required
requestId
string

Responses

Request samples

Content type
application/json
{
  • "requestId": "string"
}

Response samples

Content type
application/json
{ }

DashboardsService_UnpinDashboard

Authorizations:
apiKeyAuth
path Parameters
dashboardId
required
string
Request Body schema: application/json
required
requestId
string

Responses

Request samples

Content type
application/json
{
  • "requestId": "string"
}

Response samples

Content type
application/json
{ }

DashboardCatalogService

DashboardCatalogService_GetDashboardCatalog

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/dashboards/catalog';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "items": [
    ]
}

DashboardFoldersService

DashboardFoldersService_ListDashboardFolders

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/dashboards/folders';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "folder": [
    ]
}

DashboardFoldersService_CreateDashboardFolder

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
requestId
string
object (commonDashboardFolder)

Responses

Request samples

Content type
application/json
{
  • "requestId": "string",
  • "folder": {
    }
}

Response samples

Content type
application/json
{ }

DashboardFoldersService_ReplaceDashboardFolder

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
requestId
string
object (commonDashboardFolder)

Responses

Request samples

Content type
application/json
{
  • "requestId": "string",
  • "folder": {
    }
}

Response samples

Content type
application/json
{ }

DashboardFoldersService_GetDashboardFolder

Authorizations:
apiKeyAuth
path Parameters
folderId
required
string
query Parameters
requestId
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/dashboards/folders/%7BfolderId%7D?requestId=SOME_STRING_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "folder": {
    }
}

DashboardFoldersService_DeleteDashboardFolder

Authorizations:
apiKeyAuth
path Parameters
folderId
required
string
query Parameters
requestId
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/dashboards/folders/%7BfolderId%7D?requestId=SOME_STRING_VALUE';

let options = {method: 'DELETE', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{ }

ActionsService

ActionsService_ListActions

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v2/actions';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "actions": [
    ]
}

ActionsService_CreateAction

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
name
string
url
string
isPrivate
boolean
sourceType
string (actionsv2SourceType)
Default: "SOURCE_TYPE_UNSPECIFIED"
Enum: "SOURCE_TYPE_UNSPECIFIED" "SOURCE_TYPE_LOG" "SOURCE_TYPE_DATA_MAP"
applicationNames
Array of strings
subsystemNames
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "url": "string",
  • "isPrivate": true,
  • "sourceType": "SOURCE_TYPE_UNSPECIFIED",
  • "applicationNames": [
    ],
  • "subsystemNames": [
    ]
}

Response samples

Content type
application/json
{
  • "action": {
    }
}

ActionsService_ReplaceAction

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
object (actionsv2Action)

Responses

Request samples

Content type
application/json
{
  • "action": {
    }
}

Response samples

Content type
application/json
{
  • "action": {
    }
}

ActionsService_AtomicBatchExecuteActions

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
Array of objects (v2ActionExecutionRequest)

Responses

Request samples

Content type
application/json
{
  • "requests": [
    ]
}

Response samples

Content type
application/json
{
  • "matchingResponses": [
    ]
}

ActionsService_OrderActions

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
object
object

Responses

Request samples

Content type
application/json
{
  • "privateActionsOrder": {
    },
  • "sharedActionsOrder": {
    }
}

Response samples

Content type
application/json
{ }

ActionsService_GetAction

Authorizations:
apiKeyAuth
path Parameters
id
required
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v2/actions/%7Bid%7D';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "action": {
    }
}

ActionsService_DeleteAction

Authorizations:
apiKeyAuth
path Parameters
id
required
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v2/actions/%7Bid%7D';

let options = {method: 'DELETE', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{ }

Events2MetricService

Events2MetricService_ListE2M

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/api/v2/events2metrics';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "e2m": [
    ]
}

Events2MetricService_CreateE2M

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
name
required
string (Name of E2M to create)
description
string (Description of E2M to create)
permutationsLimit
integer <int32> (The permutation limit of the E2M)
Array of objects (E2M metric labels)
Array of objects (E2M metric fields)
type
string (Enum defining e2m type)
Default: "E2M_TYPE_UNSPECIFIED"
Enum: "E2M_TYPE_UNSPECIFIED" "E2M_TYPE_LOGS2METRICS" "E2M_TYPE_SPANS2METRICS"
object (SpansQuery)

This data structure represents a query for spans.

Find out more about events2metrics
object (SpansQuery)

This data structure represents a query for logs.

Find out more about events2metrics

Responses

Request samples

Content type
application/json
{
  • "name": "Service catalog latency",
  • "description": "avg and max the latency of catalog service",
  • "permutationsLimit": 30000,
  • "metricLabels": [
    ],
  • "metricFields": [
    ],
  • "type": "E2M_TYPE_UNSPECIFIED",
  • "spansQuery": {
    },
  • "logsQuery": {
    }
}

Response samples

Content type
application/json
{
  • "e2m": {
    }
}

Events2MetricService_ReplaceE2M

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
id
string <uuid> (E2M unique ID, required on update requests) = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...
name
required
string (Name of the E2M)
description
string (Description of the E2M)
createTime
string (E2M create time)
updateTime
string (E2M update time)
object (E2M Permutations)

This data structure represents the limit of events2metrics permutations and if the limit was exceeded

Find out more about events2metrics
Array of objects (E2M metric labels)
Array of objects (E2M metric fields) <= 10 items
type
required
string (Enum defining e2m type)
Default: "E2M_TYPE_UNSPECIFIED"
Enum: "E2M_TYPE_UNSPECIFIED" "E2M_TYPE_LOGS2METRICS" "E2M_TYPE_SPANS2METRICS"
object (SpansQuery)

This data structure represents a query for spans.

Find out more about events2metrics
object (SpansQuery)

This data structure represents a query for logs.

Find out more about events2metrics
isInternal
boolean (A flag that represents if the e2m is for internal usage)

Responses

Request samples

Content type
application/json
{
  • "id": "d6a3658e-78d2-47d0-9b81-b2c551f01b09",
  • "name": "Service_catalog_latency",
  • "description": "avg and max the latency of catalog service",
  • "createTime": "2022-06-30T12:30:00Z'",
  • "updateTime": "2022-06-30T12:30:00Z'",
  • "permutations": {
    },
  • "metricLabels": [
    ],
  • "metricFields": [
    ],
  • "type": "E2M_TYPE_UNSPECIFIED",
  • "spansQuery": {
    },
  • "logsQuery": {
    },
  • "isInternal": true
}

Response samples

Content type
application/json
{
  • "e2m": {
    }
}

Events2MetricService_AtomicBatchExecuteE2M

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
Array of objects (represents one of e2m actions create/replace/delete)

Responses

Request samples

Content type
application/json
{
  • "requests": [
    ]
}

Response samples

Content type
application/json
{
  • "matchingResponses": [
    ]
}

Events2MetricService_ListLabelsCardinality

Authorizations:
apiKeyAuth
query Parameters
spansQuery.lucene
string

lucene query

spansQuery.applicationnameFilters
Array of strings

application name filters

spansQuery.subsystemnameFilters
Array of strings

subsystem name filters

spansQuery.actionFilters
Array of strings

action filters

spansQuery.serviceFilters
Array of strings

service filters

logsQuery.lucene
string

lucene query

logsQuery.alias
string

alias

logsQuery.applicationnameFilters
Array of strings

application name filters

logsQuery.subsystemnameFilters
Array of strings

subsystem names filters

logsQuery.severityFilters
Array of strings
Items Enum: "SEVERITY_UNSPECIFIED" "SEVERITY_DEBUG" "SEVERITY_VERBOSE" "SEVERITY_INFO" "SEVERITY_WARNING" "SEVERITY_ERROR" "SEVERITY_CRITICAL"

severity type filters

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/api/v2/events2metrics/labels_cardinality?spansQuery.lucene=SOME_STRING_VALUE&spansQuery.applicationnameFilters=SOME_ARRAY_VALUE&spansQuery.subsystemnameFilters=SOME_ARRAY_VALUE&spansQuery.actionFilters=SOME_ARRAY_VALUE&spansQuery.serviceFilters=SOME_ARRAY_VALUE&logsQuery.lucene=SOME_STRING_VALUE&logsQuery.alias=SOME_STRING_VALUE&logsQuery.applicationnameFilters=SOME_ARRAY_VALUE&logsQuery.subsystemnameFilters=SOME_ARRAY_VALUE&logsQuery.severityFilters=SOME_ARRAY_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "permutations": [
    ]
}

Events2MetricService_GetLimits

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/api/v2/events2metrics/limits';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "companyId": "string",
  • "labelsLimit": 0,
  • "permutationsLimit": {
    },
  • "metricsLimit": {
    }
}

Events2MetricService_GetE2M

Authorizations:
apiKeyAuth
path Parameters
id
required
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/api/v2/events2metrics/%7Bid%7D';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "e2m": {
    }
}

Events2MetricService_DeleteE2M

Authorizations:
apiKeyAuth
path Parameters
id
required
string

id of e2m to be deleted

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/api/v2/events2metrics/%7Bid%7D';

let options = {method: 'DELETE', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "id": "string"
}

ScopesService

ScopesService_GetTeamScopesByIds

Authorizations:
apiKeyAuth
query Parameters
ids
required
Array of strings

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/scopes?ids=SOME_ARRAY_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "scopes": [
    ]
}

ScopesService_CreateScope

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

This data structure represents a request to create a scope

displayName
required
string
description
string
required
Array of objects (Filter)
defaultExpression
string

Responses

Request samples

Content type
application/json
{
  • "displayName": "scope_name",
  • "description": "scope_description",
  • "filters": [
    ],
  • "defaultExpression": "expression"
}

Response samples

Content type
application/json
{
  • "scope": {
    }
}

ScopesService_UpdateScope

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

This data structure represents a request to update a scope

id
required
string
displayName
required
string
description
string
required
Array of objects (Filter)
defaultExpression
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "scope_id",
  • "displayName": "scope_name",
  • "description": "scope_description",
  • "filters": [
    ],
  • "defaultExpression": "expression"
}

Response samples

Content type
application/json
{
  • "scope": {
    }
}

ScopesService_GetTeamScopes

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/scopes/list';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "scopes": [
    ]
}

ScopesService_DeleteScope

Authorizations:
apiKeyAuth
path Parameters
id
required
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/scopes/%7Bid%7D';

let options = {method: 'DELETE', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{ }

IncidentsService

IncidentsService_ListIncidents

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to list incidents with filtering, pagination and ordering options

object (v1IncidentQueryFilter)
object (Pagination Request)

Pagination parameters for list requests

Array of objects (OrderBy)

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "pagination": {
    },
  • "orderBys": [
    ]
}

Response samples

Content type
application/json
{
  • "incidents": [
    ],
  • "pagination": {
    }
}

IncidentsService_GetIncident

Authorizations:
apiKeyAuth
path Parameters
id
required
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/incidents/%7Bid%7D';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "incident": {
    }
}

IncidentsService_GetIncidentEvents

Authorizations:
apiKeyAuth
path Parameters
incidentId
required
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/incidents/%7BincidentId%7D/events';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "incidentEvents": [
    ]
}

IncidentsService_AcknowledgeIncidents

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to acknowledge one or more incidents

incidentIds
required
Array of strings

List of incident IDs to acknowledge

Responses

Request samples

Content type
application/json
{
  • "incidentIds": [
    ]
}

Response samples

Content type
application/json
{
  • "incidents": [
    ]
}

IncidentsService_AssignIncidents

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to assign one or more incidents to a user

incidentIds
required
Array of strings
required
object (v1UserDetails)

Responses

Request samples

Content type
application/json
{
  • "incidentIds": [
    ],
  • "assignedTo": {
    }
}

Response samples

Content type
application/json
{
  • "incidents": [
    ]
}

IncidentsService_BatchGetIncident

Authorizations:
apiKeyAuth
query Parameters
ids
required
Array of strings

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/incidents:batchGet?ids=SOME_ARRAY_VALUE';

let options = {method: 'POST', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "incidents": {
    },
  • "notFoundIds": [
    ]
}

IncidentsService_CloseIncidents

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to close one or more incidents

incidentIds
required
Array of strings

List of incident IDs to close

Responses

Request samples

Content type
application/json
{
  • "incidentIds": [
    ]
}

Response samples

Content type
application/json
{
  • "incidents": [
    ]
}

IncidentsService_GetFilterValues

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to get available filter values for incidents

object (v1IncidentQueryFilter)

Responses

Request samples

Content type
application/json
{
  • "filter": {
    }
}

Response samples

Content type
application/json
{
  • "filtersValues": {
    }
}

This shouldn't be exposed in the docs, it has no external usecase

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to get an incident using a correlation key and timestamp

correlationKey
required
string

Correlation key to identify the incident

incidentPointInTime
required
string <date-time>

Timestamp to identify the specific point in time for the incident

Responses

Request samples

Content type
application/json
{
  • "correlationKey": "correlation_key_123",
  • "incidentPointInTime": "2024-01-01T00:00:00.000Z"
}

Response samples

Content type
application/json
{
  • "incident": {
    }
}

IncidentsService_ListIncidentAggregations

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to get aggregated incident data with filtering and grouping options

object (v1IncidentQueryFilter)
Array of objects (GroupBy)
object (Pagination Request)

Pagination parameters for list requests

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "groupBys": [
    ],
  • "pagination": {
    }
}

Response samples

Content type
application/json
{
  • "incidentAggs": [
    ],
  • "pagination": {
    }
}

IncidentsService_ListIncidentEvents

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to list incident events with filtering, pagination and ordering options

object (v1IncidentEventQueryFilter)
object (Pagination Request)

Pagination parameters for list requests

object (List Incident Event Request Order By)

Ordering configuration for incident events list

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "pagination": {
    },
  • "orderBy": {
    }
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    }
}

IncidentsService_ListIncidentEventsFilterValues

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to get available filter values for incident events

object (v1IncidentEventQueryFilter)

Responses

Request samples

Content type
application/json
{
  • "filter": {
    }
}

Response samples

Content type
application/json
{
  • "filtersValues": {
    }
}

IncidentsService_ListIncidentEventsTotalCount

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to get the total count of incident events matching a filter

object (v1IncidentEventQueryFilter)

Responses

Request samples

Content type
application/json
{
  • "filter": {
    }
}

Response samples

Content type
application/json
{
  • "count": 100,
  • "reachedLimit": false
}

IncidentsService_ResolveIncidents

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to resolve one or more incidents

incidentIds
required
Array of strings

List of incident IDs to resolve

Responses

Request samples

Content type
application/json
{
  • "incidentIds": [
    ]
}

Response samples

Content type
application/json
{
  • "incidents": [
    ]
}

IncidentsService_UnassignIncidents

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to remove assignments from one or more incidents

incidentIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "incidentIds": [
    ]
}

Response samples

Content type
application/json
{
  • "incidents": [
    ]
}

MetricsTcoService

MetricsTcoService_Get

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/metrics-tco';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "rules": 1
}

MetricsTcoService_Add

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

This data structure is used to add a metrics tco rule.

label
required
string
regex
required
string

Responses

Request samples

Content type
application/json
{
  • "label": "rule1",
  • "regex": ".*"
}

Response samples

Content type
application/json
{ }

MetricsTcoService_Delete

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
ruleId
string <uint64>

Responses

Request samples

Content type
application/json
{
  • "ruleId": 1
}

Response samples

Content type
application/json
{ }

MetricsConfiguratorPublicService

MetricsConfiguratorPublicService_GetTenantConfig

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/metrics-archive';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "tenantConfig": {
    }
}

MetricsConfiguratorPublicService_ConfigureTenant

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

This data structure is used to configure a tenant.

required
object (Retenion Policy Request)

This data structure is used to set the retention policy for a tenant.

Find out more about metrics cost optimization
object (IBM Bucket Configuration)

This data structure is used to configure an IBM bucket.

Find out more about metrics cost optimization
object (S3 Configuration)

This data structure represents the S3 configuration for a tenant.

Find out more about metrics cost optimization

Responses

Request samples

Content type
application/json
{
  • "retentionPolicy": {
    },
  • "ibm": {
    },
  • "s3": {
    }
}

Response samples

Content type
application/json
{ }

MetricsConfiguratorPublicService_Update

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

This data structure is used to update the configuration of a tenant.

retentionDays
required
integer <int64>
object (IBM Bucket Configuration)

This data structure is used to configure an IBM bucket.

Find out more about metrics cost optimization
object (S3 Configuration)

This data structure represents the S3 configuration for a tenant.

Find out more about metrics cost optimization

Responses

Request samples

Content type
application/json
{
  • "retentionDays": 0,
  • "ibm": {
    },
  • "s3": {
    }
}

Response samples

Content type
application/json
{ }

MetricsConfiguratorPublicService_DisableArchive

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/metrics-archive:disable';

let options = {method: 'POST', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{ }

MetricsConfiguratorPublicService_EnableArchive

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/metrics-archive:enable';

let options = {method: 'POST', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{ }

MetricsConfiguratorPublicService_ValidateBucket

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

This data structure is used to validate a bucket.

object (IBM Bucket Configuration)

This data structure is used to configure an IBM bucket.

Find out more about metrics cost optimization
object (S3 Configuration)

This data structure represents the S3 configuration for a tenant.

Find out more about metrics cost optimization

Responses

Request samples

Content type
application/json
{
  • "ibm": {
    },
  • "s3": {
    }
}

Response samples

Content type
application/json
{ }

DataUsageService

/ Returns a list of data usage for a given set of teams, time_range and resolution

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
Array of objects (datausagev1Team)
object (datausagev1DateRange)
resolution
string
Array of objects (datausagev1Dimension)

Responses

Request samples

Content type
application/json
{
  • "teamIds": [
    ],
  • "dateRange": {
    },
  • "resolution": "string",
  • "dimensions": [
    ]
}

Response samples

Content type
application/json
{
  • "dataUsage": {
    }
}

/ Returns a list of block events (can be more than one per day) for a list of teams in the requested days

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
object (/ Requests data for a group of teams within a set of days)

Responses

Request samples

Content type
application/json
{
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "events": [
    ]
}

/ Returns a list of quota (units) used per day for a list of teams in the requested days

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
object (/ Requests data for a group of teams within a set of days)

Responses

Request samples

Content type
application/json
{
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "teamsUsage": [
    ]
}

/ Returns the quota plan for a given set of teams at the requested timestamp

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
object (/ Requests data for a group of teams in a particular moment)

Responses

Request samples

Content type
application/json
{
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "teamsQuota": [
    ]
}

/ Returns a list of quota updates (can be more than one per day) for a list of teams in the requested days

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
object (/ Requests data for a group of teams within a set of days)

Responses

Request samples

Content type
application/json
{
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "historyEntries": [
    ]
}

DataUsageService_GetDataUsage

Authorizations:
apiKeyAuth
query Parameters
dateRange.fromDate
string <date-time>
dateRange.toDate
string <date-time>
resolution
string

Aggregation resolution. Minimum supported value is 1h

Do note that to avoid overloading the service we enforce resolution limits that depend on the server configuration. This is configured by the server. This means that, for instance, requests with 1 hour resolution for an interval of 30 days will be rejected but accepted for 1 day interval.

Resolution must be between 1 hour and date_range interval

aggregate
Array of strings
Items Enum: "AGGREGATE_BY_UNSPECIFIED" "AGGREGATE_BY_APPLICATION" "AGGREGATE_BY_SUBSYSTEM" "AGGREGATE_BY_PILLAR" "AGGREGATE_BY_PRIORITY"

List of aggregate parameters. i.e. if AggregateBy is [AGGREGATE_BY_PILLAR, AGGREGATE_BY_PRIORITY], then the response will stream data aggregated by pillar and priority.

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v2/datausage?dateRange.fromDate=SOME_STRING_VALUE&dateRange.toDate=SOME_STRING_VALUE&resolution=SOME_STRING_VALUE&aggregate=SOME_ARRAY_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "result": {
    },
  • "error": {
    }
}

DataUsageService_GetDataUsageMetricsExportStatus

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v2/datausage/exportstatus';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "enabled": true
}

DataUsageService_UpdateDataUsageMetricsExportStatus

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

This data structure is used to update data usage metrics export status.

enabled
boolean

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "enabled": true
}

DataUsageService_GetLogsCount

Authorizations:
apiKeyAuth
query Parameters
dateRange.fromDate
string <date-time>
dateRange.toDate
string <date-time>
resolution
string

Aggregation resolution with second precision.

Resolution must be between 1 second and date_range interval

filters.application
Array of strings
filters.subsystem
Array of strings

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v2/datausage/logscount?dateRange.fromDate=SOME_STRING_VALUE&dateRange.toDate=SOME_STRING_VALUE&resolution=SOME_STRING_VALUE&filters.application=SOME_ARRAY_VALUE&filters.subsystem=SOME_ARRAY_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "result": {
    },
  • "error": {
    }
}

DataUsageService_GetSpansCount

Authorizations:
apiKeyAuth
query Parameters
dateRange.fromDate
string <date-time>
dateRange.toDate
string <date-time>
resolution
string

Aggregation resolution with second precision.

Resolution must be between 1 second and date_range interval

filters.application
Array of strings
filters.subsystem
Array of strings

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v2/datausage/spanscount?dateRange.fromDate=SOME_STRING_VALUE&dateRange.toDate=SOME_STRING_VALUE&resolution=SOME_STRING_VALUE&filters.application=SOME_ARRAY_VALUE&filters.subsystem=SOME_ARRAY_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "result": {
    },
  • "error": {
    }
}

DailyUsageService

/Endpoint to fetch daily usage

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
range
string (datausagev1Range)
Default: "RANGE_UNSPECIFIED"
Enum: "RANGE_UNSPECIFIED" "RANGE_CURRENT_MONTH" "RANGE_LAST_30_DAYS" "RANGE_LAST_90_DAYS" "RANGE_LAST_WEEK"
object (datausagev1DateRange)

Responses

Request samples

Content type
application/json
{
  • "range": "RANGE_UNSPECIFIED",
  • "dateRange": {
    }
}

Response samples

Content type
application/json
{
  • "response": [
    ]
}

/Endpoint to fetch how many units "pay as you go" customers have went over their plan

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
range
string (datausagev1Range)
Default: "RANGE_UNSPECIFIED"
Enum: "RANGE_UNSPECIFIED" "RANGE_CURRENT_MONTH" "RANGE_LAST_30_DAYS" "RANGE_LAST_90_DAYS" "RANGE_LAST_WEEK"
object (datausagev1DateRange)

Responses

Request samples

Content type
application/json
{
  • "range": "RANGE_UNSPECIFIED",
  • "dateRange": {
    }
}

Response samples

Content type
application/json
{
  • "overageDetail": [
    ]
}

RetentionsService

RetentionsService_GetRetentions

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/retentions';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "retentions": [
    ]
}

RetentionsService_UpdateRetentions

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

This data structure is used to update retentions

required
Array of objects (v1RetentionUpdateElement)

Responses

Request samples

Content type
application/json
{
  • "retentionUpdateElements": [
    ]
}

Response samples

Content type
application/json
{
  • "retentions": [
    ]
}

RetentionsService_GetRetentionsEnabled

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/retentions/enabled';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "enableTags": true
}

RetentionsService_ActivateRetentions

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
object (v1ActivateRetentionsRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "activateRetentions": true
}

TargetService

TargetService_GetTarget

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v2/target';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "target": {
    }
}

TargetService_SetTarget

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

This data structure is used to set a storage target for logs.

isActive
required
boolean
object (S3 Target Spec)

This data structure represents an S3 target.

Find out more about archives
object (IBM COS Target Spec)

This data structure represents an IBM COS target.

Find out more about archives

Responses

Request samples

Content type
application/json
{
  • "isActive": true,
  • "s3": {
    },
  • "ibmCos": {}
}

Response samples

Content type
application/json
{
  • "target": {
    }
}

TargetService_ValidateTarget

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

This data structure is used to validate a storage target for logs.

isActive
required
boolean
object (S3 Target Spec)

This data structure represents an S3 target.

Find out more about archives
object (IBM COS Target Spec)

This data structure represents an IBM COS target.

Find out more about archives

Responses

Request samples

Content type
application/json
{
  • "isActive": true,
  • "s3": {
    },
  • "ibmCos": {}
}

Response samples

Content type
application/json
{
  • "isValid": true
}

TeamPermissionsMgmtService

/ Fetch team group by name for authenticated team id

Authorizations:
apiKeyAuth
query Parameters
name
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/teams/groups?name=SOME_STRING_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "group": {
    }
}

/ Creates a new team group and optionally associates roles, users and a scope to it

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to create a new team group with specified name, description, roles, users, and optional scope filters. Can be associated with a specific team or the authenticated team.

name
string (/ Team group name)
object (coralogixpermissionsv1TeamId)
description
string (/ Team group description)
externalId
string

/ Team group external_id. Applies if team is externally defined.

Array of objects (/ Roles to associate with team group)
Array of objects (/ Users to associate with team group)
object (/ Scope filters are currently possible to be defined for subsystems and applications)
nextGenScopeId
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "teamId": {
    },
  • "description": "string",
  • "externalId": "string",
  • "roleIds": [
    ],
  • "userIds": [
    ],
  • "scopeFilters": {
    },
  • "nextGenScopeId": "string"
}

Response samples

Content type
application/json
{
  • "groupId": {
    }
}

/ Updates an existing team group details

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to modify an existing team group's details, including its name, description, roles, users, and scope settings.

object (TeamGroupId)

This data structure represents the information associated with a team group.

Find out more about groups
name
string (/ Updated team group name)
description
string (/ Updated team group description)
externalId
string (/ Updated team group external_id)
object (RoleUpdates)

This data structure represents the information associated with an API key.

Find out more about groups
object (UserUpdates)

This data structure represents the information associated with an API key.

Find out more about groups
object (/ Scope filters are currently possible to be defined for subsystems and applications)
nextGenScopeId
string (/ If set, updates new team group next gen scope)

Responses

Request samples

Content type
application/json
{
  • "groupId": {
    },
  • "name": "string",
  • "description": "string",
  • "externalId": "string",
  • "roleUpdates": {
    },
  • "userUpdates": {
    },
  • "scopeFilters": {
    },
  • "nextGenScopeId": "string"
}

Response samples

Content type
application/json
{ }

/ Fetches all team groups linked with team

Authorizations:
apiKeyAuth
query Parameters
teamId.id
integer <int64>

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/teams/groups/list?teamId.id=SOME_INTEGER_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "groups": [
    ]
}

/ Bulk Remove user accounts to organisation group

Authorizations:
apiKeyAuth
query Parameters
teamId.id
integer <int64>

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/teams/groups/users?teamId.id=SOME_INTEGER_VALUE';

let options = {method: 'DELETE', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{ }

/ Bulk Add users to team groups

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Bulk request to assign users to multiple team groups simultaneously, efficiently managing group memberships at scale.

object (coralogixpermissionsv1TeamId)
Array of objects (AddUsersToTeamGroup)

Responses

Request samples

Content type
application/json
{
  • "teamId": {
    },
  • "addUsersToGroup": [
    ]
}

Response samples

Content type
application/json
{ }

/ Fetch team group for given team id

Authorizations:
apiKeyAuth
path Parameters
groupId.id
required
integer <int64>

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/teams/groups/%7BgroupId.id%7D';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "group": {
    }
}

/ Deletes an existing team group

Authorizations:
apiKeyAuth
path Parameters
groupId.id
required
integer <int64>

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/teams/groups/%7BgroupId.id%7D';

let options = {method: 'DELETE', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{ }

/ Fetches team group scope

Authorizations:
apiKeyAuth
path Parameters
groupId.id
required
integer <int64>

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/teams/groups/%7BgroupId.id%7D/scope';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "scope": {
    }
}

/ Sets team group scope. Replaces it if it already exists.

Authorizations:
apiKeyAuth
path Parameters
groupId.id
required
integer <int64>
Request Body schema: application/json
required
groupId
object (/ Team group to set scope to)
Find out more about groups
object (/ Scope filters are currently possible to be defined for subsystems and applications)

Responses

Request samples

Content type
application/json
{
  • "groupId": { },
  • "scopeFilters": {
    }
}

Response samples

Content type
application/json
{
  • "scopeId": {
    }
}

/ Fetches all users assigned to group

Authorizations:
apiKeyAuth
path Parameters
groupId.id
required
integer <int64>
query Parameters
pageSize
integer <int64>

/ Pagination size. Defaults to 100 if empty

pageToken
string

/ Optional pagination continuation token / Contains an encoded cursor

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/teams/groups/%7BgroupId.id%7D/users?pageSize=SOME_INTEGER_VALUE&pageToken=SOME_STRING_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "users": [
    ],
  • "noMorePages": { },
  • "token": {
    }
}

/ Remove user accounts to organisation group

Authorizations:
apiKeyAuth
path Parameters
groupId.id
required
integer <int64>

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/teams/groups/%7BgroupId.id%7D/users';

let options = {method: 'DELETE', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{ }

/ Add users to team groups

Authorizations:
apiKeyAuth
path Parameters
groupId.id
required
integer <int64>
Request Body schema: application/json
required
groupId
object (/ Team group id to add users to)
Find out more about groups
Array of objects (/ Users to add to group)

Responses

Request samples

Content type
application/json
{
  • "groupId": { },
  • "userIds": [
    ]
}

Response samples

Content type
application/json
{
  • "teamId": {
    }
}

ExtensionService

ExtensionService_GetAllExtensions

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to list all extensions

includeHiddenExtensions
boolean
object (GetAllExtensionsRequest - Filter)

Filter by integration ids

Responses

Request samples

Content type
application/json
{
  • "includeHiddenExtensions": true,
  • "filter": {
    }
}

Response samples

Content type
application/json
{
  • "extensions": [
    ]
}

ExtensionService_GetExtension

Authorizations:
apiKeyAuth
path Parameters
id
required
string
query Parameters
includeDashboardBinaries
boolean

On the frontend, we don't need the dashboard binaries. But we need them for deployment in the extensions-service - so it's kind of temporary argument, so as soon all the deployment logic is moved to the extensions-api, it can be removed.

includeTestingRevision
boolean

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/extensions/v1/%7Bid%7D?includeDashboardBinaries=SOME_BOOLEAN_VALUE&includeTestingRevision=SOME_BOOLEAN_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "image": "string",
  • "darkModeImage": "string",
  • "revisions": [
    ],
  • "isHidden": true,
  • "integrations": [
    ],
  • "keywords": [
    ],
  • "permissionDeniedRevisions": [
    ],
  • "changelog": [
    ],
  • "deprecation": {
    }
}

InternalOnboardingService

InternalOnboardingService_InternalDeployExtension

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
companyId
string
id
string

Responses

Request samples

Content type
application/json
{
  • "companyId": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{ }

ExtensionDeploymentService

ExtensionDeploymentService_DeployExtension

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
id
string
version
string
itemIds
Array of strings
applications
Array of strings
subsystems
Array of strings
object (v1ExtensionDeployment)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "itemIds": [
    ],
  • "applications": [
    ],
  • "subsystems": [
    ],
  • "extensionDeployment": {
    }
}

Response samples

Content type
application/json
{
  • "extensionDeployment": {
    }
}

ExtensionDeploymentService_GetDeployedExtensions

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/extensions-deployment/v1/deployed';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "deployedExtensions": [
    ]
}

ExtensionDeploymentService_UndeployExtension

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
id
string
keptExtensionItems
Array of strings

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "keptExtensionItems": [
    ]
}

Response samples

Content type
application/json
{
  • "failedItems": [
    ],
  • "extensionDeployment": {
    }
}

ExtensionDeploymentService_UpdateExtension

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
id
string
version
string
itemIds
Array of strings
applications
Array of strings
subsystems
Array of strings
object (v1ExtensionDeployment)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "itemIds": [
    ],
  • "applications": [
    ],
  • "subsystems": [
    ],
  • "extensionDeployment": {
    }
}

Response samples

Content type
application/json
{
  • "extensionDeployment": {
    }
}

ExtensionTestingService

ExtensionTestingService_CleanupTestingRevision

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
id
string

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{ }

ExtensionTestingService_InitializeTestingRevision

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
object (ExtensionData)

Response to list all extensions

Responses

Request samples

Content type
application/json
{
  • "extensionData": {
    }
}

Response samples

Content type
application/json
{ }

ExtensionTestingService_TestExtensionRevision

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
object (ExtensionData)

Response to list all extensions

cleanupAfterTest
boolean

Responses

Request samples

Content type
application/json
{
  • "extensionData": {
    },
  • "cleanupAfterTest": true
}

Response samples

Content type
application/json
{ }

QuotaService

QuotaService_GetQuotas

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/quota/v1/quotas';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "companyId": "string",
  • "alert": {
    },
  • "enrichment": {
    },
  • "parsingRule": {
    },
  • "parsingRuleGroup": {
    },
  • "parsingTheme": {
    },
  • "dynamicAlert": {
    },
  • "events2Metrics": {
    }
}

ExtensionContentManagementService

ExtensionContentManagementService_ImportAndReleaseExtensions

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Response to list all extensions (streaming inputs)

id
string
name
string
description
string
excerpt
string
image
string
darkModeImage
string
labels
Array of strings
version
string
Array of objects (v1ExtensionItemData)
Array of objects (v1IntegrationDetail)
isHidden
boolean
Array of objects (v1ExtensionBinary)
integrations
Array of strings
keywords
Array of strings
Array of objects (v1ChangelogEntry)
object (v1Deprecation)

Responses

Request samples

Content type
application/json
{
  • "id": "076f4188-05e0-4ed3-afeb-653ad182ccb7",
  • "name": "I love chocolate",
  • "description": "Chocolate is full of love",
  • "excerpt": "Chocolate is full of love",
  • "image": "string",
  • "darkModeImage": "string",
  • "labels": [
    ],
  • "version": "v1.0.13",
  • "items": [
    ],
  • "integrationDetails": [
    ],
  • "isHidden": false,
  • "binaries": [
    ],
  • "integrations": [
    ],
  • "keywords": [
    ],
  • "changelog": [
    ],
  • "deprecation": {
    }
}

Response samples

Content type
application/json
{ }

ExtensionContentManagementService_ValidateExtensionItems

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Response to list all extensions (streaming inputs)

id
string
name
string
description
string
excerpt
string
image
string
darkModeImage
string
labels
Array of strings
version
string
Array of objects (v1ExtensionItemData)
Array of objects (v1IntegrationDetail)
isHidden
boolean
Array of objects (v1ExtensionBinary)
integrations
Array of strings
keywords
Array of strings
Array of objects (v1ChangelogEntry)
object (v1Deprecation)

Responses

Request samples

Content type
application/json
{
  • "id": "076f4188-05e0-4ed3-afeb-653ad182ccb7",
  • "name": "I love chocolate",
  • "description": "Chocolate is full of love",
  • "excerpt": "Chocolate is full of love",
  • "image": "string",
  • "darkModeImage": "string",
  • "labels": [
    ],
  • "version": "v1.0.13",
  • "items": [
    ],
  • "integrationDetails": [
    ],
  • "isHidden": false,
  • "binaries": [
    ],
  • "integrations": [
    ],
  • "keywords": [
    ],
  • "changelog": [
    ],
  • "deprecation": {
    }
}

Response samples

Content type
application/json
{
  • "invalidExtensions": [
    ]
}

TagsService

TagsService_CreateTag

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
key
string
name
string
companyId
integer <int64>
iconUrl
string
timestamp
string <date-time>
application
Array of strings
subsystem
Array of strings

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "name": "string",
  • "companyId": 0,
  • "iconUrl": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "application": [
    ],
  • "subsystem": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "key": "string",
  • "name": "string",
  • "companyId": 0,
  • "status": "STATUS_UNSPECIFIED",
  • "iconUrl": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "application": [
    ],
  • "subsystem": [
    ],
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "type": {
    }
}

TagsService_DeleteTag

Authorizations:
apiKeyAuth
path Parameters
id
required
string <uint64>

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/api/v1/deletetag/%7Bid%7D';

let options = {method: 'DELETE', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
"string"

TagsService_UpdateTag

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
id
string <uint64>
key
string
name
string
companyId
integer <int64>
status
string (tagsv1Status)
Default: "STATUS_UNSPECIFIED"
Enum: "STATUS_UNSPECIFIED" "STATUS_SUCCESSFUL"
iconUrl
string
timestamp
string <date-time>
application
Array of strings
subsystem
Array of strings
updatedAt
string <date-time>
createdAt
string <date-time>
object (v1TagType)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "key": "string",
  • "name": "string",
  • "companyId": 0,
  • "status": "STATUS_UNSPECIFIED",
  • "iconUrl": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "application": [
    ],
  • "subsystem": [
    ],
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "type": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "key": "string",
  • "name": "string",
  • "companyId": 0,
  • "status": "STATUS_UNSPECIFIED",
  • "iconUrl": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "application": [
    ],
  • "subsystem": [
    ],
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "type": {
    }
}

TagsService_GetTags

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
object (GetTagsRequestQueryDef)

Responses

Request samples

Content type
application/json
{
  • "queryDef": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

TagsService_GetTagAlerts

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
object (tagsv1Query)
object (tagsv1Query)

Responses

Request samples

Content type
application/json
{
  • "compareTag": {
    },
  • "tag": {
    }
}

Response samples

Content type
application/json
{
  • "alertsListInfo": [
    ],
  • "severityInfo": [
    ],
  • "volumeCompareGraph": {
    }
}

TagsService_GetTagErrorVolume

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
object (tagsv1Query)
object (tagsv1Query)

Responses

Request samples

Content type
application/json
{
  • "compareTag": {
    },
  • "tag": {
    }
}

Response samples

Content type
application/json
{
  • "compareTag": [
    ],
  • "tag": [
    ]
}

TagsService_GetTagSummary

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
object (tagsv1Query)
object (tagsv1Query)

Responses

Request samples

Content type
application/json
{
  • "compareTag": {
    },
  • "tag": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

TagsExternalService

TagsExternalService_AddExternalTag2

Authorizations:
apiKeyAuth
query Parameters
name
string
key
string
application
Array of strings
subsystem
Array of strings
iconUrl
string
timestamp
string
type
string
Default: "TYPE_UNSPECIFIED"
Enum: "TYPE_UNSPECIFIED" "TYPE_CUSTOM_EVENT" "TYPE_BITBUCKET" "TYPE_GITLAB" "TYPE_TFS" "TYPE_HEROKU"

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/api/v1/addTag?name=SOME_STRING_VALUE&key=SOME_STRING_VALUE&application=SOME_ARRAY_VALUE&subsystem=SOME_ARRAY_VALUE&iconUrl=SOME_STRING_VALUE&timestamp=SOME_STRING_VALUE&type=SOME_STRING_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "id": "string",
  • "key": "string",
  • "name": "string",
  • "companyId": 0,
  • "status": "STATUS_UNSPECIFIED",
  • "iconUrl": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "application": [
    ],
  • "subsystem": [
    ],
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "type": {
    }
}

TagsExternalService_AddExternalTag3

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
name
string
key
string
application
Array of strings
subsystem
Array of strings
iconUrl
string
timestamp
string
type
string (tagsv1Type)
Default: "TYPE_UNSPECIFIED"
Enum: "TYPE_UNSPECIFIED" "TYPE_CUSTOM_EVENT" "TYPE_BITBUCKET" "TYPE_GITLAB" "TYPE_TFS" "TYPE_HEROKU"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "key": "string",
  • "application": [
    ],
  • "subsystem": [
    ],
  • "iconUrl": "string",
  • "timestamp": "string",
  • "type": "TYPE_UNSPECIFIED"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "key": "string",
  • "name": "string",
  • "companyId": 0,
  • "status": "STATUS_UNSPECIFIED",
  • "iconUrl": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "application": [
    ],
  • "subsystem": [
    ],
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "type": {
    }
}

TagsExternalService_CreateBitbucketTag

Authorizations:
apiKeyAuth
query Parameters
name
string
application
Array of strings
subsystem
Array of strings
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
"string"

TagsExternalService_CreateBitbucketTag2

Authorizations:
apiKeyAuth
query Parameters
name
string
application
Array of strings
subsystem
Array of strings
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
"string"

TagsExternalService_CreateGitlabTag

Authorizations:
apiKeyAuth
query Parameters
name
string
application
Array of strings
subsystem
Array of strings
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
"string"

TagsExternalService_CreateExternalTag

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
name
string
key
string
application
Array of strings
subsystem
Array of strings
iconUrl
string
timestamp
string <date-time>
type
string (tagsv1Type)
Default: "TYPE_UNSPECIFIED"
Enum: "TYPE_UNSPECIFIED" "TYPE_CUSTOM_EVENT" "TYPE_BITBUCKET" "TYPE_GITLAB" "TYPE_TFS" "TYPE_HEROKU"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "key": "string",
  • "application": [
    ],
  • "subsystem": [
    ],
  • "iconUrl": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "type": "TYPE_UNSPECIFIED"
}

Response samples

Content type
application/json
{
  • "tag": {
    }
}

TagsExternalService_AddExternalTag

Authorizations:
apiKeyAuth
query Parameters
name
string
key
string
application
Array of strings
subsystem
Array of strings
iconUrl
string
timestamp
string
type
string
Default: "TYPE_UNSPECIFIED"
Enum: "TYPE_UNSPECIFIED" "TYPE_CUSTOM_EVENT" "TYPE_BITBUCKET" "TYPE_GITLAB" "TYPE_TFS" "TYPE_HEROKU"

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/api/v1/external/tags/add?name=SOME_STRING_VALUE&key=SOME_STRING_VALUE&application=SOME_ARRAY_VALUE&subsystem=SOME_ARRAY_VALUE&iconUrl=SOME_STRING_VALUE&timestamp=SOME_STRING_VALUE&type=SOME_STRING_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "tag": {
    }
}

TagsExternalService_CreateTfsTag

Authorizations:
apiKeyAuth
query Parameters
name
string
application
Array of strings
subsystem
Array of strings
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
"string"

ExternalTokenService

ExternalTokenService_GenerateNewToken

Authorizations:
apiKeyAuth
query Parameters
platform
string
Default: "UNDEFINED"
Enum: "UNDEFINED" "PLATFORM_BITBUCKET" "PLATFORM_GITHUB" "PLATFORM_GITLAB" "PLATFORM_AWS_SNS" "PLATFORM_OPSGENIE" "PLATFORM_PAGERDUTY" "PLATFORM_PROMETHEUS" "PLATFORM_SLACK" "PLATFORM_INTERCOM"

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/external-tokens?platform=SOME_STRING_VALUE';

let options = {method: 'POST', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "token": "string",
  • "id": "string"
}

ExternalTokenService_UpdateToken

Authorizations:
apiKeyAuth
path Parameters
id
required
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/external-tokens/%7Bid%7D';

let options = {method: 'PUT', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "token": "string"
}

PermissionCheckService

PermissionCheckService_CheckApiKeyPermission

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
object (coralogixintegrationsv1Permission)
object (v1ApiKeyValue)
object (v1PermissionId)

Responses

Request samples

Content type
application/json
{
  • "permission": {
    },
  • "apiKey": {
    },
  • "permissionId": {
    }
}

Response samples

Content type
application/json
{
  • "unauthorized": { },
  • "authorizationResult": {
    }
}

IntegrationService

IntegrationService_GetIntegrations

Authorizations:
apiKeyAuth
query Parameters
includeTestingRevision
boolean

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/integrations?includeTestingRevision=SOME_BOOLEAN_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "integrations": [
    ]
}

IntegrationService_GetIntegrationDefinition

Authorizations:
apiKeyAuth
path Parameters
id
required
string
query Parameters
includeTestingRevision
boolean

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/integrations/definition/%7Bid%7D?includeTestingRevision=SOME_BOOLEAN_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "integrationDefinition": {
    }
}

IntegrationService_GetDeployedIntegration

Authorizations:
apiKeyAuth
path Parameters
integrationId
required
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/integrations/deployed/%7BintegrationId%7D';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "integration": {
    }
}

IntegrationService_DeleteIntegration

Authorizations:
apiKeyAuth
path Parameters
integrationId
required
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/integrations/instance/%7BintegrationId%7D';

let options = {method: 'DELETE', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{ }

IntegrationService_ListManagedIntegrationKeys

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/integrations/managed/list';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "integrationKeys": [
    ]
}

IntegrationService_GetManagedIntegrationStatus

Authorizations:
apiKeyAuth
path Parameters
integrationId
required
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/integrations/managed/status/%7BintegrationId%7D';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "integrationId": "string",
  • "status": {
    }
}

IntegrationService_SaveIntegration

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

This data structure represents a request to save an integration.

required
object (IntegrationMetadata)

This data structure represents the metadata of an integration.

Find out more about integrations

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "integrationId": "string"
}

IntegrationService_UpdateIntegration

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

This data structure represents a list of outgoing webhook types.

id
required
string (This is the integration id generated at creation time)
required
object (IntegrationMetadata)

This data structure represents the metadata of an integration.

Find out more about integrations

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{ }

IntegrationService_TestIntegration

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

This data structure represents a request to test an integration.

required
object (IntegrationMetadata)

This data structure represents the metadata of an integration.

Find out more about integrations
integrationId
string

Responses

Request samples

Content type
application/json
{
  • "integrationData": {
    },
  • "integrationId": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

IntegrationService_GetRumApplicationVersionData

Authorizations:
apiKeyAuth
query Parameters
applicationName
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/integrations/rum/app-versions?applicationName=SOME_STRING_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "versionData": {
    }
}

IntegrationService_SyncRumData

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

This data structure is a request to trigger a sync of RUM data.

force
boolean

The period amount when the sync is not triggered is determined by configuration.

Responses

Request samples

Content type
application/json
{
  • "force": true
}

Response samples

Content type
application/json
{
  • "syncExecuted": true,
  • "syncedAt": "2019-08-24T14:15:22Z"
}

IntegrationService_GetTemplate

Authorizations:
apiKeyAuth
query Parameters
integrationId
string
commonArmParams.logsUrl
string
commonArmParams.apiKey
string
commonArmParams.cgxDomain
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/integrations/template?integrationId=SOME_STRING_VALUE&commonArmParams.logsUrl=SOME_STRING_VALUE&commonArmParams.apiKey=SOME_STRING_VALUE&commonArmParams.cgxDomain=SOME_STRING_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "templateUrl": "string"
}

IntegrationService_GetIntegrationDetails

Authorizations:
apiKeyAuth
path Parameters
id
required
string
query Parameters
includeTestingRevision
boolean

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/integrations/%7Bid%7D?includeTestingRevision=SOME_BOOLEAN_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "integrationDetail": {
    }
}

WebhookIntegrationService

WebhookIntegrationService_CountWebhookIntegrations

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to count the webhooks

object (Count Webhook Integration Request)

Request to count the webhooks

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "count": 15
}

WebhookIntegrationService_CreateWebhookIntegration

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to create a new webhook

name
required
string
apiKeyValue
required
string
application
required
string
subsystem
required
string
isPrivate
required
boolean
object (Json Content Type)

Indicates where to find the timestamp in the json request

object (Json Content Type)

Indicates how to find the timestamp in the text request

Responses

Request samples

Content type
application/json
{
  • "name": "Chocolate is love",
  • "apiKeyValue": "apn_b486d10b58184b25ae02c30dcba87775",
  • "application": "authorization",
  • "subsystem": "token_validator",
  • "isPrivate": true,
  • "json": {
    },
  • "text": {
    }
}

Response samples

Content type
application/json
{}

WebhookIntegrationService_DeleteWebhookIntegration

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to delete a webhook

id
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "b486d10b58184b25ae02c30dcba87775"
}

Response samples

Content type
application/json
{ }

WebhookIntegrationService_ListWebhookIntegrations

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to list integrations

object (List Webhook Integration Request)

Request to list integrations

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "webhooks": [
    ]
}

WebhookIntegrationService_ToggleWebhookIntegrationActivation

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

To enable/disable webhook integrations

id
required
string
isActive
required
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "b486d10b58184b25ae02c30dcba87775",
  • "isActive": true
}

Response samples

Content type
application/json
{ }

PushBasedContextualDataIntegrationService

PushBasedContextualDataIntegrationService_CountPushBasedContextualDataIntegrations

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to return the number of Push Based Contextual Data Integration by a given platform

platform
string (v1PushBasedPlatform)
Default: "UNDEFINED"
Enum: "UNDEFINED" "PLATFORM_BITBUCKET" "PLATFORM_GITHUB" "PLATFORM_GITLAB" "PLATFORM_AWS_SNS" "PLATFORM_OPSGENIE" "PLATFORM_PAGERDUTY" "PLATFORM_PROMETHEUS" "PLATFORM_SLACK" "PLATFORM_INTERCOM"

Responses

Request samples

Content type
application/json
{
  • "platform": "UNDEFINED"
}

Response samples

Content type
application/json
{
  • "counts": [
    ]
}

PushBasedContextualDataIntegrationService_CreatePushBasedContextualDataIntegration

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Creates a new push based integration for different type of sources

object (Create Push Based Integration Request - Bitbucket)

Creates a new push based integration for diffBitbucket data consumption

object (Create Push Based Integration Request - AmazonSns)

Creates a new push based integration for diffAmazonSns data consumption

object (Create Push Based Integration Request - PagerDuty)

Creates a new push based integration for diffPagerDuty data consumption

object (Create Push Based Integration Request - Github)

Creates a new push based integration for dGithub data consumption

object (Create Push Based Integration Request - Gitlab)

Creates a new push based integration for dGitlab data consumption

object (Create Push Based Integration Request - Opsgenie)

Creates a new push based integration for difOpsgenie data consumption

object (Create Push Based Integration Request - Prometheus)

Creates a new push based integration for diffePrometheus data consumption

object (Create Push Based Integration Request - Intercom)

Creates a new push based integration for difIntercom data consumption

object (Create Push Based Integration Request - Slack)

Creates a new push based integration for Slack data consumption

name
required
string
application
required
string
subsystem
required
string

Responses

Request samples

Content type
application/json
{
  • "bitbucket": {
    },
  • "amazonSns": {
    },
  • "pagerDuty": {
    },
  • "github": {
    },
  • "gitlab": {
    },
  • "opsgenie": {
    },
  • "prometheus": {
    },
  • "intercom": {
    },
  • "slack": {
    },
  • "name": "I love chocolate",
  • "application": "authorization",
  • "subsystem": "token_validator"
}

Response samples

Content type
application/json
{
  • "id": "076f4188-05e0-4ed3-afeb-653ad182ccb7"
}

PushBasedContextualDataIntegrationService_DeletePushBasedContextualDataIntegration

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to delete a push based contextual data integration

id
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "076f4188-05e0-4ed3-afeb-653ad182ccb7"
}

Response samples

Content type
application/json
{ }

PushBasedContextualDataIntegrationService_ListPushBasedContextualDataIntegrations

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Requests all the registered integrations for a given platform

platform
required
string (v1PushBasedPlatform)
Default: "UNDEFINED"
Enum: "UNDEFINED" "PLATFORM_BITBUCKET" "PLATFORM_GITHUB" "PLATFORM_GITLAB" "PLATFORM_AWS_SNS" "PLATFORM_OPSGENIE" "PLATFORM_PAGERDUTY" "PLATFORM_PROMETHEUS" "PLATFORM_SLACK" "PLATFORM_INTERCOM"

Responses

Request samples

Content type
application/json
{
  • "platform": "UNDEFINED"
}

Response samples

Content type
application/json
{
  • "integrations": [
    ]
}

PushBasedContextualDataIntegrationService_UpdatePushBasedContextualDataIntegration

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to updated a Push Based ContextualData Integration by id

id
required
string
name
required
string
application
string
subsystem
string

Responses

Request samples

Content type
application/json
{
  • "id": "076f4188-05e0-4ed3-afeb-653ad182ccb7",
  • "name": "I love chocolate",
  • "application": "authorization",
  • "subsystem": "token_validator"
}

Response samples

Content type
application/json
{ }

OutgoingWebhooksService

OutgoingWebhooksService_ListOutgoingWebhooks

Authorizations:
apiKeyAuth
query Parameters
type
required
string
Default: "UNKNOWN"
Enum: "UNKNOWN" "GENERIC" "SLACK" "PAGERDUTY" "SEND_LOG" "EMAIL_GROUP" "MICROSOFT_TEAMS" "JIRA" "OPSGENIE" "DEMISTO" "AWS_EVENT_BRIDGE" "IBM_EVENT_NOTIFICATIONS" "MS_TEAMS_WORKFLOW"

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/outgoing_webhooks?type=SOME_STRING_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "deployed": [
    ]
}

OutgoingWebhooksService_CreateOutgoingWebhook

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

This data structure represents a request to create an outgoing webhook.

required
object (Outgoing Webhook Input Data)

This data structure represents the input data of an outgoing webhook

Find out more about outbound webhooks.

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "id": "example_id"
}

OutgoingWebhooksService_UpdateOutgoingWebhook

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

This data structure represents a request to update an outgoing webhook.

id
required
string
required
object (Outgoing Webhook Input Data)

This data structure represents the input data of an outgoing webhook

Find out more about outbound webhooks.

Responses

Request samples

Content type
application/json
{
  • "id": "example_id",
  • "data": {
    }
}

Response samples

Content type
application/json
{ }

OutgoingWebhooksService_ListAllOutgoingWebhooks

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/outgoing_webhooks/all';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "deployed": [
    ]
}

OutgoingWebhooksService_ListIbmEventNotificationsInstances

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/outgoing_webhooks/ibm_event_notifications/instances';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "instances": [
    ]
}

OutgoingWebhooksService_ListOutboundWebhooksSummary

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/outgoing_webhooks/summaries';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "outboundWebhookSummaries": [
    ]
}

OutgoingWebhooksService_TestOutgoingWebhook

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
object (Outgoing Webhook Input Data)

This data structure represents the input data of an outgoing webhook

Find out more about outbound webhooks.

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "success": { },
  • "failure": {
    }
}

OutgoingWebhooksService_TestExistingOutgoingWebhook

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

This data structure represents a request to test an existing outgoing webhook.

id
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "example_id"
}

Response samples

Content type
application/json
{
  • "success": { },
  • "failure": {
    }
}

OutgoingWebhooksService_ListOutgoingWebhookTypes

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/outgoing_webhooks/types';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "webhooks": [
    ]
}

OutgoingWebhooksService_GetOutgoingWebhookTypeDetails

Authorizations:
apiKeyAuth
path Parameters
type
required
string
Enum: "UNKNOWN" "GENERIC" "SLACK" "PAGERDUTY" "SEND_LOG" "EMAIL_GROUP" "MICROSOFT_TEAMS" "JIRA" "OPSGENIE" "DEMISTO" "AWS_EVENT_BRIDGE" "IBM_EVENT_NOTIFICATIONS" "MS_TEAMS_WORKFLOW"

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/outgoing_webhooks/types/%7Btype%7D';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "details": {
    }
}

OutgoingWebhooksService_GetOutgoingWebhook

Authorizations:
apiKeyAuth
path Parameters
id
required
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/outgoing_webhooks/%7Bid%7D';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "webhook": {
    }
}

OutgoingWebhooksService_DeleteOutgoingWebhook

Authorizations:
apiKeyAuth
path Parameters
id
required
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/outgoing_webhooks/%7Bid%7D';

let options = {method: 'DELETE', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{ }

RuleGroupsService

RuleGroupsService_GetRuleGroupModelMapping

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
name
string
description
string
enabled
boolean
hidden
boolean
creator
string
Array of objects (v1RuleMatcher)
Array of objects (v1GetRuleGroupModelMappingRequestCreateRuleSubgroup)
order
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "enabled": true,
  • "hidden": true,
  • "creator": "string",
  • "ruleMatchers": [
    ],
  • "ruleSubgroups": [
    ],
  • "order": 0
}

Response samples

Content type
application/json
{
  • "ruleDefinition": { }
}

RuleGroupsService_ListRuleGroups

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/api/v1/rulegroups';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "ruleGroups": [
    ]
}

RuleGroupsService_BulkDeleteRuleGroup

Authorizations:
apiKeyAuth
query Parameters
groupIds
Array of strings

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/api/v1/rulegroups?groupIds=SOME_ARRAY_VALUE';

let options = {method: 'DELETE', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{ }

RuleGroupsService_CreateRuleGroup

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
name
string
description
string
enabled
boolean
hidden
boolean
creator
string
Array of objects (v1RuleMatcher)
Array of objects (v1CreateRuleGroupRequestCreateRuleSubgroup)
order
integer <int64>
object (coralogixrulesv1TeamId)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "enabled": true,
  • "hidden": true,
  • "creator": "string",
  • "ruleMatchers": [
    ],
  • "ruleSubgroups": [
    ],
  • "order": 0,
  • "teamId": {
    }
}

Response samples

Content type
application/json
{
  • "ruleGroup": {
    }
}

RuleGroupsService_GetCompanyUsageLimits

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
object (v1GetCompanyUsageLimitsRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "companyId": "string",
  • "limits": {
    },
  • "usage": {
    }
}

RuleGroupsService_GetRuleGroup

Authorizations:
apiKeyAuth
path Parameters
groupId
required
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/api/v1/rulegroups/%7BgroupId%7D';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "ruleGroup": {
    }
}

RuleGroupsService_DeleteRuleGroup

Authorizations:
apiKeyAuth
path Parameters
groupId
required
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/api/v1/rulegroups/%7BgroupId%7D';

let options = {method: 'DELETE', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{ }

RuleGroupsService_UpdateRuleGroup

Authorizations:
apiKeyAuth
path Parameters
groupId
required
string
Request Body schema: application/json
required
name
string
description
string
enabled
boolean
hidden
boolean
creator
string
Array of objects (v1RuleMatcher)
Array of objects (v1CreateRuleGroupRequestCreateRuleSubgroup)
order
integer <int64>
object (coralogixrulesv1TeamId)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "enabled": true,
  • "hidden": true,
  • "creator": "string",
  • "ruleMatchers": [
    ],
  • "ruleSubgroups": [
    ],
  • "order": 0,
  • "teamId": {
    }
}

Response samples

Content type
application/json
{
  • "ruleGroup": {
    }
}

EnrichmentService

EnrichmentService_GetEnrichments

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/enrichments';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "enrichments": [
    ]
}

EnrichmentService_RemoveEnrichments

Authorizations:
apiKeyAuth
query Parameters
enrichmentIds
required
Array of integers <int64> [ items <int64 > ]

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/enrichments?enrichmentIds=SOME_ARRAY_VALUE';

let options = {method: 'DELETE', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "remainingEnrichments": [
    ]
}

EnrichmentService_AddEnrichments

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

This response data structure represents a collection of enrichments

required
Array of objects (Enrichment Prototype)

Responses

Request samples

Content type
application/json
{
  • "requestEnrichments": [
    ]
}

Response samples

Content type
application/json
{
  • "enrichments": [
    ]
}

EnrichmentService_GetEnrichmentLimit

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/enrichments/limit';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "limit": 10,
  • "used": 5
}

EnrichmentService_GetCompanyEnrichmentSettings

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/enrichments/settings';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "enrichmentSettings": {
    }
}

EnrichmentService_AtomicOverwriteEnrichments

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
object (coralogixenrichmentv1EnrichmentType)
Array of objects (v1EnrichmentFieldDefinition)

Responses

Request samples

Content type
application/json
{
  • "enrichmentType": {
    },
  • "enrichmentFields": [
    ]
}

Response samples

Content type
application/json
{
  • "enrichments": [
    ]
}

CustomEnrichmentService

CustomEnrichmentService_GetCustomEnrichments

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/custom_enrichment';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "customEnrichments": [
    ]
}

CustomEnrichmentService_CreateCustomEnrichment

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

This request data structure is used to create a custom enrichment

name
required
string
description
required
string
required
object (File)

This data structure represents a file

Find out more about enrichments

Responses

Request samples

Content type
application/json
{
  • "name": "custom_enrichment_name",
  • "description": "custom_enrichment_description",
  • "file": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Custom enrichment created successfully",
  • "customEnrichment": {
    }
}

CustomEnrichmentService_UpdateCustomEnrichment

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

This request data structure is used to update a custom enrichment

customEnrichmentId
required
integer <int64>
name
required
string
description
required
string
required
object (File)

This data structure represents a file

Find out more about enrichments

Responses

Request samples

Content type
application/json
{
  • "customEnrichmentId": 1,
  • "name": "custom_enrichment_name",
  • "description": "custom_enrichment_description",
  • "file": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Custom enrichment updated successfully",
  • "customEnrichment": {
    }
}

CustomEnrichmentService_SearchCustomEnrichmentData

Authorizations:
apiKeyAuth

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/custom_enrichment/search';

let options = {method: 'POST', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "customEnrichmentsData": [
    ]
}

CustomEnrichmentService_DeleteCustomEnrichment

Authorizations:
apiKeyAuth
path Parameters
customEnrichmentId
required
integer <int64>

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/custom_enrichment/%7BcustomEnrichmentId%7D';

let options = {method: 'DELETE', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "message": "Custom enrichment deleted successfully",
  • "customEnrichmentId": 1
}

CustomEnrichmentService_GetCustomEnrichment

Authorizations:
apiKeyAuth
path Parameters
id
required
integer <int64>

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/custom_enrichment/%7Bid%7D';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "customEnrichment": {
    }
}

PoliciesService

PoliciesService_GetCompanyPolicies

Authorizations:
apiKeyAuth
query Parameters
enabledOnly
required
boolean
sourceType
required
string
Default: "SOURCE_TYPE_UNSPECIFIED"
Enum: "SOURCE_TYPE_UNSPECIFIED" "SOURCE_TYPE_LOGS" "SOURCE_TYPE_SPANS"

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/policies?enabledOnly=SOME_BOOLEAN_VALUE&sourceType=SOME_STRING_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "policies": [
    ]
}

PoliciesService_CreatePolicy

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

This data structue is used to create a new policy.

name
required
string
description
string
priority
required
string (coralogixquotav1Priority)
Default: "PRIORITY_TYPE_UNSPECIFIED"
Enum: "PRIORITY_TYPE_UNSPECIFIED" "PRIORITY_TYPE_BLOCK" "PRIORITY_TYPE_LOW" "PRIORITY_TYPE_MEDIUM" "PRIORITY_TYPE_HIGH"
object (coralogixquotav1Rule)
object (coralogixquotav1Rule)
object (v1ArchiveRetention)
object (Log Rules)

Log rules for a policy.

Find out more about quota management.
object (v1SpanRules)

Responses

Request samples

Content type
application/json
{
  • "name": "My Policy",
  • "description": "My Policy Description",
  • "priority": "PRIORITY_TYPE_UNSPECIFIED",
  • "applicationRule": {
    },
  • "subsystemRule": {
    },
  • "archiveRetention": {
    },
  • "logRules": {
    },
  • "spanRules": {
    }
}

Response samples

Content type
application/json
{
  • "policy": {
    }
}

PoliciesService_UpdatePolicy

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

This data structue is used to update an existing policy.

id
required
string
name
string
description
string
priority
string (coralogixquotav1Priority)
Default: "PRIORITY_TYPE_UNSPECIFIED"
Enum: "PRIORITY_TYPE_UNSPECIFIED" "PRIORITY_TYPE_BLOCK" "PRIORITY_TYPE_LOW" "PRIORITY_TYPE_MEDIUM" "PRIORITY_TYPE_HIGH"
object (coralogixquotav1Rule)
object (coralogixquotav1Rule)
object (v1ArchiveRetention)
object (Log Rules)

Log rules for a policy.

Find out more about quota management.
object (v1SpanRules)
enabled
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "policy_id",
  • "name": "My Policy",
  • "description": "My Policy Description",
  • "priority": "PRIORITY_TYPE_UNSPECIFIED",
  • "applicationRule": {
    },
  • "subsystemRule": {
    },
  • "archiveRetention": {
    },
  • "logRules": {
    },
  • "spanRules": {
    },
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "policy": {
    }
}

PoliciesService_GetPolicy

Authorizations:
apiKeyAuth
path Parameters
id
required
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/policies/%7Bid%7D';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "policy": {
    }
}

PoliciesService_DeletePolicy

Authorizations:
apiKeyAuth
path Parameters
id
required
string

Responses

Request samples 

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/policies/%7Bid%7D';

let options = {method: 'DELETE', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Response samples

Content type
application/json
{
  • "id": "id"
}

PoliciesService_AtomicOverwriteLogPolicies

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

In an atomic operation delete all existing log policies and create the provided list by order.

required
Array of objects (Create Log Policy Request)

Responses

Request samples

Content type
application/json
{
  • "policies": [
    ]
}

Response samples

Content type
application/json
{
  • "createResponses": [
    ]
}

PoliciesService_AtomicOverwriteSpanPolicies

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

In an atomic operation delete all existing span policies and create the provided list by order.

required
Array of objects (Create Span Policy Request)

Responses

Request samples

Content type
application/json
{
  • "policies": [
    ]
}

Response samples

Content type
application/json
{
  • "createResponses": [
    ]
}

PoliciesService_AtomicBatchCreatePolicy

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

This data structure is used to create multiple policies atomically.

required
Array of objects (Create Policy Request)

Responses

Request samples

Content type
application/json
{
  • "policyRequests": [
    ]
}

Response samples

Content type
application/json
{
  • "createResponses": [
    ]
}

PoliciesService_BulkTestLogPolicies

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to test multiple log policies.

required
Array of objects (Log Meta Fields Values)

Responses

Request samples

Content type
application/json
{
  • "metaFieldsValuesList": [
    ]
}

Response samples

Content type
application/json
{
  • "testPoliciesBulkResult": [
    ]
}

PoliciesService_ReorderPolicies

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

This data structue is used to reorder policies.

required
Array of objects (Policy Order)
sourceType
required
string (quotav1SourceType)
Default: "SOURCE_TYPE_UNSPECIFIED"
Enum: "SOURCE_TYPE_UNSPECIFIED" "SOURCE_TYPE_LOGS" "SOURCE_TYPE_SPANS"

Responses

Request samples

Content type
application/json
{
  • "orders": [
    ],
  • "sourceType": "SOURCE_TYPE_UNSPECIFIED"
}

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

PoliciesService_TogglePolicy

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

This data structue is used to toggle a policy by its ID.

id
required
string
enabled
required
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "id",
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "id": "id",
  • "enabled": true
}