redocly logoAPI docs by Redocly

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

Download OpenAPI specification:Download

SLO Service

Manage your SLOs.

Batch Get Service SLOs

No description available

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": [
    ]
}

Create Service SLO

No description available

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

Replace Service SLO

No description available

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

List Service SLOs

No description available

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": [
    ]
}

Get Service SLO

No description available

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

Delete Service SLO

No description available

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

No description available

Authorizations:
apiKeyAuth
query Parameters
deprecatedEntityType
string
entityType
string
Default: "ENTITY_TYPE_UNSPECIFIED"
Enum: "ENTITY_TYPE_UNSPECIFIED" "ALERTS" "TEST_NOTIFICATIONS"

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/routers?deprecatedEntityType=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
{
  • "routers": [
    ]
}

GlobalRoutersService_CreateGlobalRouter

No description available

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
id
string (A unique identifier - automatically generated unless provided by the user)
userDefinedId
string (DEPRECATED - A unique identifier provided by the user)
deprecatedEntityType
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
entityType
required
string (coralogixapisnotification_centerEntityType)
Default: "ENTITY_TYPE_UNSPECIFIED"
Enum: "ENTITY_TYPE_UNSPECIFIED" "ALERTS" "TEST_NOTIFICATIONS"

Responses

Request samples

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

Response samples

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

GlobalRoutersService_ReplaceGlobalRouter

No description available

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
id
string (A unique identifier - automatically generated unless provided by the user)
userDefinedId
string (DEPRECATED - A unique identifier provided by the user)
deprecatedEntityType
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
entityType
required
string (coralogixapisnotification_centerEntityType)
Default: "ENTITY_TYPE_UNSPECIFIED"
Enum: "ENTITY_TYPE_UNSPECIFIED" "ALERTS" "TEST_NOTIFICATIONS"

Responses

Request samples

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

Response samples

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

GlobalRoutersService_GetGlobalRouter

No description available

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

The unique identifier automatically generated by the service

identifier.userDefinedId
string

The unique identifier provided by the user

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/routers/%7Bid%7D?deprecatedIdentifier.id=SOME_STRING_VALUE&deprecatedIdentifier.userFacingId=SOME_STRING_VALUE&identifier.id=SOME_STRING_VALUE&identifier.userDefinedId=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

No description available

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

The unique identifier automatically generated by the service

identifier.userDefinedId
string

The unique identifier provided by the user

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/routers/%7Bid%7D?deprecatedIdentifier.id=SOME_STRING_VALUE&deprecatedIdentifier.userFacingId=SOME_STRING_VALUE&identifier.id=SOME_STRING_VALUE&identifier.userDefinedId=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
{ }

GlobalRoutersService_BatchGetGlobalRouters

No description available

Authorizations:
apiKeyAuth
query Parameters
globalRouterIds
Array of strings

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/routers:batchGetSummaries?globalRouterIds=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
{
  • "routers": {
    },
  • "notFoundIds": [
    ]
}

ConnectorsService

ConnectorsService_ReplaceConnector

No description available

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
id
string (A unique identifier - automatically generated unless provided by the user)
userDefinedId
string (DEPRECATED - 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)
Array of objects (Configuration override templates for specific entity types, values from connector_configs will be used if not overridden)
object (Connector Config)

Configuration for a specific output schema of a connector

Find out more about notification center

Responses

Request samples

Content type
application/json
{
  • "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
  • "userDefinedId": "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",
  • "configOverrides": [
    ],
  • "connectorConfig": {
    }
}

Response samples

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

ConnectorsService_ListConnectors

No description available

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

No description available

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
id
string (A unique identifier - automatically generated unless provided by the user)
userDefinedId
string (DEPRECATED - 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)
Array of objects (Configuration override templates for specific entity types, values from connector_configs will be used if not overridden)
object (Connector Config)

Configuration for a specific output schema of a connector

Find out more about notification center

Responses

Request samples

Content type
application/json
{
  • "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
  • "userDefinedId": "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",
  • "configOverrides": [
    ],
  • "connectorConfig": {
    }
}

Response samples

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

ConnectorsService_GetConnector

No description available

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

The unique identifier automatically generated by the service

identifier.userDefinedId
string

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/connectors/%7Bid%7D?deprecatedId=SOME_STRING_VALUE&identifier.id=SOME_STRING_VALUE&identifier.userDefinedId=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
{
  • "connector": {
    }
}

ConnectorsService_DeleteConnector

No description available

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

The unique identifier automatically generated by the service

identifier.userDefinedId
string

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/connectors/%7Bid%7D?deprecatedId=SOME_STRING_VALUE&identifier.id=SOME_STRING_VALUE&identifier.userDefinedId=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_BatchGetConnectors

No description available

Authorizations:
apiKeyAuth
query Parameters
deprecatedIds
Array of strings
connectorIds
Array of strings

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/connectors:batchGet?deprecatedIds=SOME_ARRAY_VALUE&connectorIds=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

No description available

Authorizations:
apiKeyAuth
query Parameters
deprecatedIds
Array of strings
connectorIds
Array of strings

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/connectors:batchGetSummaries?deprecatedIds=SOME_ARRAY_VALUE&connectorIds=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

No description available

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

No description available

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
{
  • "connectors": [
    ]
}

PresetsService

PresetsService_CreateCustomPreset

No description available

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
id
string (A unique identifier - automatically generated unless provided by the user)
userDefinedId
string (DEPRECATED - A unique identifier provided by the user)
deprecatedEntityType
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)
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"
entityType
required
string (coralogixapisnotification_centerEntityType)
Default: "ENTITY_TYPE_UNSPECIFIED"
Enum: "ENTITY_TYPE_UNSPECIFIED" "ALERTS" "TEST_NOTIFICATIONS"
parentId
string

Responses

Request samples

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

Response samples

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

PresetsService_ReplaceCustomPreset

No description available

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
id
string (A unique identifier - automatically generated unless provided by the user)
userDefinedId
string (DEPRECATED - A unique identifier provided by the user)
deprecatedEntityType
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)
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"
entityType
required
string (coralogixapisnotification_centerEntityType)
Default: "ENTITY_TYPE_UNSPECIFIED"
Enum: "ENTITY_TYPE_UNSPECIFIED" "ALERTS" "TEST_NOTIFICATIONS"
parentId
string

Responses

Request samples

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

Response samples

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

PresetsService_DeleteCustomPreset

No description available

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

The unique identifier automatically generated by the service

identifier.userDefinedId
string

The unique identifier provided by the user

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/presets/custom/%7Bid%7D?deprecatedIdentifier2.id=SOME_STRING_VALUE&deprecatedIdentifier2.userFacingId=SOME_STRING_VALUE&identifier.id=SOME_STRING_VALUE&identifier.userDefinedId=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

No description available

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

The unique identifier automatically generated by the service

identifier.userDefinedId
string

The unique identifier provided by the user

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/presets/custom/%7Bid%7D:defaultSet?deprecatedIdentifier2.id=SOME_STRING_VALUE&deprecatedIdentifier2.userFacingId=SOME_STRING_VALUE&identifier.id=SOME_STRING_VALUE&identifier.userDefinedId=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

No description available

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

The unique identifier automatically generated by the service

identifier.userDefinedId
string

The unique identifier provided by the user

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/presets/%7Bid%7D?deprecatedIdentifier2.id=SOME_STRING_VALUE&deprecatedIdentifier2.userFacingId=SOME_STRING_VALUE&identifier.id=SOME_STRING_VALUE&identifier.userDefinedId=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

No description available

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

The unique identifier automatically generated by the service

identifier.userDefinedId
string

The unique identifier provided by the user

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/presets/%7Bid%7D:defaultSet?deprecatedIdentifier.id=SOME_STRING_VALUE&deprecatedIdentifier.userFacingId=SOME_STRING_VALUE&identifier.id=SOME_STRING_VALUE&identifier.userDefinedId=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

No description available

Authorizations:
apiKeyAuth
query Parameters
deprecatedIds
Array of strings
presetIds
Array of strings

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/presets:batchGet?deprecatedIds=SOME_ARRAY_VALUE&presetIds=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

No description available

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

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&deprecatedEntityType=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

No description available

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

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&deprecatedEntityType=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

No description available

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

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&deprecatedEntityType=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

No description available

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)
deprecatedEntityType
string
entityType
string (coralogixapisnotification_centerEntityType)
Default: "ENTITY_TYPE_UNSPECIFIED"
Enum: "ENTITY_TYPE_UNSPECIFIED" "ALERTS" "TEST_NOTIFICATIONS"

Responses

Request samples

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

Response samples

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

TestingService_TestDestination

No description available

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
deprecatedEntityType
string
entitySubType
string
deprecatedConnectorId
string
deprecatedPresetId
string
outputSchemaId
string
Array of objects (Message Config Field)
object (Deprecated - use single id field instead)
object (Deprecated - use single id field instead)
entityType
string (coralogixapisnotification_centerEntityType)
Default: "ENTITY_TYPE_UNSPECIFIED"
Enum: "ENTITY_TYPE_UNSPECIFIED" "ALERTS" "TEST_NOTIFICATIONS"
Array of objects (notification_centerTemplatedConnectorConfigField)
connectorId
string
presetId
string

Responses

Request samples

Content type
application/json
{
  • "deprecatedEntityType": "string",
  • "entitySubType": "logsImmediateResolved",
  • "deprecatedConnectorId": "string",
  • "deprecatedPresetId": "string",
  • "outputSchemaId": "default",
  • "messageConfigFields": [
    ],
  • "connectorIdentifier": {
    },
  • "presetIdentifier": {
    },
  • "entityType": "ENTITY_TYPE_UNSPECIFIED",
  • "connectorConfigFields": [
    ],
  • "connectorId": "string",
  • "presetId": "string"
}

Response samples

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

TestingService_TestExistingConnector

No description available

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
deprecatedConnectorId
string
outputSchemaId
string
object (Deprecated - use single id field instead)
connectorId
string

Responses

Request samples

Content type
application/json
{
  • "deprecatedConnectorId": "string",
  • "outputSchemaId": "default",
  • "connectorIdentifier": {
    },
  • "connectorId": "string"
}

Response samples

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

TestingService_TestExistingPreset

No description available

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
deprecatedEntityType
string
entitySubType
string
deprecatedPresetId
string
deprecatedConnectorId
string
object (Deprecated - use single id field instead)
object (Deprecated - use single id field instead)
entityType
string (coralogixapisnotification_centerEntityType)
Default: "ENTITY_TYPE_UNSPECIFIED"
Enum: "ENTITY_TYPE_UNSPECIFIED" "ALERTS" "TEST_NOTIFICATIONS"
connectorId
string
presetId
string

Responses

Request samples

Content type
application/json
{
  • "deprecatedEntityType": "string",
  • "entitySubType": "logsImmediateResolved",
  • "deprecatedPresetId": "string",
  • "deprecatedConnectorId": "string",
  • "connectorIdentifier": {
    },
  • "presetIdentifier": {
    },
  • "entityType": "ENTITY_TYPE_UNSPECIFIED",
  • "connectorId": "string",
  • "presetId": "string"
}

Response samples

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

TestingService_TestPresetConfig

No description available

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
deprecatedEntityType
string
entitySubType
string
deprecatedConnectorId
string
deprecatedPresetId
string
Array of objects (notification_centerConfigOverrides)
object (Deprecated - use single id field instead)
object (Deprecated - use single id field instead)
entityType
string (coralogixapisnotification_centerEntityType)
Default: "ENTITY_TYPE_UNSPECIFIED"
Enum: "ENTITY_TYPE_UNSPECIFIED" "ALERTS" "TEST_NOTIFICATIONS"
connectorId
string
parentPresetId
string

Responses

Request samples

Content type
application/json
{
  • "deprecatedEntityType": "string",
  • "entitySubType": "metric",
  • "deprecatedConnectorId": "string",
  • "deprecatedPresetId": "string",
  • "configOverrides": [
    ],
  • "connectorIdentifier": {
    },
  • "presetIdentifier": {
    },
  • "entityType": "ENTITY_TYPE_UNSPECIFIED",
  • "connectorId": "string",
  • "parentPresetId": "string"
}

Response samples

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

TestingService_TestRoutingConditionValid

No description available

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to check that provided routing condition is valid

deprecatedEntityType
string
template
string
entityType
string (coralogixapisnotification_centerEntityType)
Default: "ENTITY_TYPE_UNSPECIFIED"
Enum: "ENTITY_TYPE_UNSPECIFIED" "ALERTS" "TEST_NOTIFICATIONS"

Responses

Request samples

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

Response samples

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

TestingService_TestTemplateRender

No description available

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
deprecatedEntityType
string
entitySubType
string
template
string
entityType
string (coralogixapisnotification_centerEntityType)
Default: "ENTITY_TYPE_UNSPECIFIED"
Enum: "ENTITY_TYPE_UNSPECIFIED" "ALERTS" "TEST_NOTIFICATIONS"

Responses

Request samples

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

Response samples

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

EntitiesService

EntitiesService_ListEntityTypes

No description available

Authorizations:
apiKeyAuth

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/entity-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
{
  • "deprecatedEntityTypes": [
    ],
  • "entityTypes": [
    ]
}

EntitiesService_ListEntitySubTypes

No description available

Authorizations:
apiKeyAuth
path Parameters
entityType
required
string
Enum: "ENTITY_TYPE_UNSPECIFIED" "ALERTS" "TEST_NOTIFICATIONS"

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/entity-types/%7BentityType%7D/entity-subtypes';

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
{
  • "entitySubTypes": [
    ]
}

API Keys Service

Manage your API Keys.

Create API Key

No description available

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

Get "Send Data" API Keys

No description available

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": [
    ]
}

Get API Key

No description available

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

Delete API Key

No description available

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

Update API Key

No description available

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

SAML Configuration Service

Manage your SAML configuration

Activate/Deactivate SAML

No description available

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

Get SAML Configuration

No description available

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

Set IDP Parameters

No description available

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

Get SP Parameters

No description available

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

Alert definitions service

View and manage your alerts using alert definitions - data structures that contain the configuration required to create an alert.

Learn more about alerts in our documentation

Get a list of all accessible alert definitions

No description available

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": [
    ]
}

Create an alert

No description available

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

The name of the alert definition

description
string

A detailed description of what the alert monitors and when it triggers

enabled
boolean
Default: "true"

Whether the alert is currently active and monitoring

priority
required
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 (Alert 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.

Learn more about logs immediate alerts in our documentation
object (Trace-based immediate alert type)

Configuration for immediate alerts triggered on trace entries

Learn more about trace-based alerts in our documentation.
object (Log-based threshold alert type)

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

Learn more about log-based threshold alerts in our documentation
object (Log-based ratio threshold alert type)

Configuration for alerts based on the ratio between two log queries

Learn more about logs ratio alerts in our documentation
object (Log-based time-relative threshold alert type)

Configuration for alerts that are triggered when a fixed ratio reaches a set threshold compared to a past time frame.

Learn more about log-based, time-relative alerts in our documentation
object (Metric-based threshold alert type)

Configuration for alerts based on metric threshold violations

Learn more about metric-based threshold alerts in our documentation
object (Trace-based threshold alert type)

Configuration for alerts based on trace count thresholds

Learn more about trace-based alerts in our documentation
object (Flow alert type)

Configuration for flow-based alerts with multiple stages

Learn more about flow alerts in our documentation
object (Log-based anomaly alert type)

Configuration for alerts triggered by anomalous log patterns

Learn more about logs anomaly alerts in our documentation
object (Metric-based anomaly alert type)

Configuration for alerts triggered by anomalous metric patterns

Learn more about metric-based anomaly alerts in our documentation
object (Log-based new value alert type)

Configuration for alerts triggered by new values appearing in logs

object (Log-based unique count alert type)

Configuration for alerts based on unique value counts in logs

Learn more about log-based, unique count alerts in our documentation
groupByKeys
Array of strings <= 2 items

Keys used to group and aggregate alert data

object (Alert definition incident settings)
object (Alert definition notification group)
Array of objects (Alert definition notification group)

Additional notification groups for alerts (deprecated)

object

Labels used to identify and categorize the alert entity

phantomMode
boolean
Default: "false"

Whether the alert is in phantom mode (creating incidents or not)

deleted
boolean
Default: "false"

Whether the alert has been marked as deleted

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": false,
  • "deleted": false
}

Response samples

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

Replace an alert definition

No description available

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

A request to replace an existing alert definition

required
object (Alert definition properties)

User-configurable properties of an alert definition

id
required
string (Alert definition ID)

Alert definition ID

Responses

Request samples

Content type
application/json
{
  • "alertDefProperties": {
    },
  • "id": "123e4567-e89b-12d3-a456-426614174000"
}

Response samples

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

Get alert definition by alert version ID

No description available

Authorizations:
apiKeyAuth
path Parameters
alertVersionId
required
string <UUIDv4>

Alert version ID

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v3/alert-defs/alert-version-id/%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 definition by ID

No description available

Authorizations:
apiKeyAuth
path Parameters
id
required
string <UUIDv4>

Alert definition ID

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

No description available

Authorizations:
apiKeyAuth
path Parameters
id
required
string <UUIDv4>

Alert definition ID

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

Disable or enable an alert

No description available

Authorizations:
apiKeyAuth
path Parameters
id
required
string <UUIDv4>

The alert definition ID

query Parameters
active
required
boolean

Whether to enable or disable the alert definition

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

Download alerts

Download a list of all accessible alert definitions in base64-encoded byte format.

Requires the following permissions:

  • alerts:ReadConfig
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": {
    }
}

Alert events service

Get information regarding your alert events - instances of alerts being triggered.

Learn more about alert events and incidents in our documentation.

Get alert events statistics

No description available

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

Get alert event by ID

No description available

Authorizations:
apiKeyAuth
path Parameters
id
required
string

Alert event ID

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

Recording Rules Service

A service to manage recording rules.

List Recording Rules

No description available

Authorizations:
apiKeyAuth

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v1/rule-group-sets';

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
{
  • "sets": [
    ]
}

Create Recording Rules

No description available

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

A set of rule groups to create.

Array of objects (In Rule Group)
name
string

Responses

Request samples

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

Response samples

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

Get Recording Rules

No description available

Authorizations:
apiKeyAuth
path Parameters
id
required
string

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v1/rule-group-sets/%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
{
  • "id": "string",
  • "groups": [
    ],
  • "name": "string"
}

Delete Recording Rules

No description available

Authorizations:
apiKeyAuth
path Parameters
id
required
string

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v1/rule-group-sets/%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
{ }

Update Recording Rules

No description available

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
required
Array of objects (In Rule Group)
name
string

Responses

Request samples

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

Response samples

Content type
application/json
{ }

Dashboard service

Manage your dashboards.

Get dashboard catalog

Get a list of all dashboards accessible.

Requires the following permissions:

  • team-dashboards:Read
Authorizations:
apiKeyAuth

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v1/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": [
    ]
}

Create a new dashboard

No description available

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

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

Learn more about Custom Dashboards in our documentation.
isLocked
boolean

Responses

Request samples

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

Response samples

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

Replace a dashboard

No description available

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

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

Learn more about Custom Dashboards in our documentation.
isLocked
boolean

Responses

Request samples

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

Response samples

Content type
application/json
{ }

Get a dashboard

No description available

Authorizations:
apiKeyAuth
path Parameters
dashboardId
required
string

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v1/dashboards/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,
  • "lockerAuthorId": "string",
  • "lockerName": "string"
}

Delete a dashboard

No description available

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/v1/dashboards/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
{ }

Replace the default dashboard

No description available

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

Assign a dashboard to a folder

No description available

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

Add dashboard to favorites

No description available

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

Remove dashboard from favorites

No description available

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

Dashboard folders service

Manage your dashboard folders.

List dashboard folders

List all dashboard folders accessible.

Requires the following permissions:

  • team-dashboards:Read
Authorizations:
apiKeyAuth

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v1/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": [
    ]
}

Create a dashboard folder

No description available

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

Replace a dashboard folder

No description available

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

Get a dashboard folder

Returns a dashboard folder data.

Requires the following permissions:

  • team-dashboards:Read
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/v1/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": {
    }
}

Delete a dashboard folder

No description available

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/v1/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
{ }

Actions Service

A service for managing actions.

List Actions

No description available

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": [
    ]
}

Create Action

No description available

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

Replace Action

No description available

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

Atomic Batch Execute Actions

No description available

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": [
    ]
}

Order Actions

No description available

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

Get Action

No description available

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

Delete Action

No description available

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

Events2Metrics Service

Manage your events2metrics.

List E2Ms

No description available

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": [
    ]
}

Create a new E2M

No description available

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

Replace an E2M

No description available

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

Atomic Batch Execute E2M

No description available

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": [
    ]
}

List E2M Labels Cardinality

No description available

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": [
    ]
}

Get E2M Limits

No description available

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

Get an E2M

No description available

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

Delete an E2M

No description available

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

Events Service

A service for querying events.

Learn more about alerts in our documentation

List Events

No description available

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

Batch Get Event

No description available

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

Get Event

No description available

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

List Events Count

No description available

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

Get Events Statistics

No description available

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

Folders for views

Create and manage view folders.

List view folders

List view's folders

Authorizations:
apiKeyAuth

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v1/view_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
{
  • "view_folders": [
    ]
}

Create View Folder

Create view folder

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Create view folder.

name
string (View folder name) non-empty

Folder name

Responses

Request samples

Content type
application/json
{
  • "name": "My Folder"
}

Response samples

Content type
application/json
{
  • "id": "0cd4ed54-9b59-4eef-b329-151a167e2304",
  • "name": "My Folder"
}

Replace View Folder

Replaces an existing view folder

Authorizations:
apiKeyAuth
path Parameters
folder.id
required
string <uuid>

Unique identifier for folders

Request Body schema: application/json
required

View folder

name
required
string non-empty

Folder name

Responses

Request samples

Content type
application/json
{
  • "name": "My Folder"
}

Response samples

Content type
application/json
{
  • "id": "0cd4ed54-9b59-4eef-b329-151a167e2304",
  • "name": "My Folder"
}

Get View Folder

Create view folder

Authorizations:
apiKeyAuth
path Parameters
id
required
string <uuid>

Unique identifier for folders

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v1/view_folders/%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
{
  • "id": "0cd4ed54-9b59-4eef-b329-151a167e2304",
  • "name": "My Folder"
}

Delete View Folder

Deletes a view folder by ID

Authorizations:
apiKeyAuth
path Parameters
id
required
string <uuid>

Unique identifier for folders

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v1/view_folders/%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
{ }

Views

Create and manage views.

List views

Lists all company public views

Authorizations:
apiKeyAuth

Responses

Request samples 

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

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

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
{
  • "views": [
    ]
}

Create a view

Creates a new view

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

View folder.

name
required
string non-empty

View name

object (SearchQuery)
required
object (Time selection)
object (Selected filters)
folderId
string <uuid> = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Unique identifier for folders

Responses

Request samples

Content type
application/json
{
  • "name": "Logs view",
  • "searchQuery": {
    },
  • "timeSelection": {
    },
  • "filters": {
    },
  • "folderId": "3dc02998-0b50-4ea8-b68a-4779d716fa1f"
}

Response samples

Content type
application/json
{
  • "name": "Logs view",
  • "search_query": {
    },
  • "time_selection": {
    },
  • "filters": {
    }
}

Get view

Gets a view by ID

Authorizations:
apiKeyAuth
path Parameters
id
required
integer <int32>

id

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v1/views/%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
{
  • "id": 52,
  • "name": "Logs view",
  • "search_query": {
    },
  • "time_selection": {
    },
  • "filters": {
    }
}

Delete view

Deletes a view by ID

Authorizations:
apiKeyAuth
path Parameters
id
required
integer <int32>

id

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v1/views/%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
{ }

Replace a view

Replaces an existing view

Authorizations:
apiKeyAuth
path Parameters
view.id
required
integer <int32>

id

Request Body schema: application/json
required

View

name
required
string (View name) non-empty

View name

object (SearchQuery)
required
object (Time selection)
object (Selected filters)
folderId
string <uuid> = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Unique identifier for folders

isCompactMode
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "Logs view",
  • "searchQuery": {
    },
  • "timeSelection": {
    },
  • "filters": {
    },
  • "folderId": "3dc02998-0b50-4ea8-b68a-4779d716fa1f",
  • "isCompactMode": true
}

Response samples

Content type
application/json
{
  • "name": "Logs view",
  • "search_query": {
    },
  • "time_selection": {
    },
  • "filters": {
    }
}

Scopes Service

A service to manage scopes

Get Team Scopes By Ids

No description available

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": [
    ]
}

Create Scope

No description available

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

Update Scope

No description available

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

Get Team Scopes

No description available

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": [
    ]
}

Delete Scope

No description available

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

Incidents service

Handle all operations related to incident management within Coralogix. Identify, manage, and resolve incidents efficiently through automated workflows and team collaboration.

Find out more about incident management in our documentation

List incidents with filters

Lists all available incidents based on specified filters and order. The list is ordered in an unspecified direction and sorted by creation time.

Requires the following permissions:

  • incidents:read
Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to list incidents with filtering, pagination and ordering options

object (Incident query filter)

Filter configuration for incidents

object (Pagination request)

Pagination parameters for list requests

Array of objects (Incident order by)

Order by fields

Responses

Request samples

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

Response samples

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

Get incident by ID

Retrieve detailed information about a single incident by its unique identifier.

Requires the following permissions:

  • incidents:read
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": {
    }
}

Get incident events

Retrieve a chronological list of all events associated with a specific incident. Includes state changes, assignments, acknowledgments, and resolutions.

Requires the following permissions:

  • incidents:read
Authorizations:
apiKeyAuth
path Parameters
incidentId
required
string

ID of the incident to retrieve events for

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": [
    ]
}

Acknowledge incidents

Mark one or more incidents as acknowledged.

Requires the following permissions:

  • incidents:acknowledge
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": [
    ]
}

Assign incidents to a user

Assign one or more incidents to a specific user.

Requires the following permissions:

  • incidents:assign
Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to assign one or more incidents to a user

incidentIds
required
Array of strings

List of incident IDs to assign

required
object (User details)

Responses

Request samples

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

Response samples

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

Get multiple incidents by IDs

Retrieve multiple incidents by their IDs in a single request.

Requires the following permissions:

  • incidents:read
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": [
    ]
}

Close incidents

No description available

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": [
    ]
}

Get available filter values

No description available

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to get available filter values for incidents

object (Incident query filter)

Filter configuration for incidents

Responses

Request samples

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

Response samples

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

List incident events with filters

List incident events with support for filtering, pagination, and ordering.

Requires the following permissions:

  • incidents:read
Authorizations:
apiKeyAuth
Request Body schema: application/json
required

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

object (Incident event query filter)

Filter configuration for incident events

object (Pagination request)

Pagination parameters for list requests

object (List incident events order by request)

Responses

Request samples

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

Response samples

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

Get available incident event filter values

No description available

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

A request to get available filter values for incident events

object (Incident event query filter)

Filter configuration for incident events

Responses

Request samples

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

Response samples

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

Get total count of incident events

Retrieve the total count of incident events matching a filter.

Requires the following permissions:

  • incidents:read
Authorizations:
apiKeyAuth
Request Body schema: application/json
required

A request to get the total count of incident events matching a filter

object (Incident event query filter)

Filter configuration for incident events

Responses

Request samples

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

Response samples

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

Get incident aggregations

Retrieve aggregated incident data with support for grouping and filtering.

Requires the following permissions:

  • incidents:read
Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to get aggregated incident data with filtering and grouping options

object (Incident query filter)

Filter configuration for incidents

Array of objects (Incident group by)

Group by fields for aggregation

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

Resolve incidents

Mark one or more incidents as resolved.

Requires the following permissions:

  • incidents:close
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": [
    ]
}

Remove incident user assignments

Remove user assignments from one or more incidents.

Requires the following permissions:

  • incidents:assign
Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Request to remove assignments from one or more incidents

incidentIds
required
Array of strings

List of incident IDs to unassign

Responses

Request samples

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

Response samples

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

MetricsTcoService

MetricsTcoService_Get

No description available

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

No description available

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

No description available

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

No description available

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

No description available

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

No description available

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

No description available

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

No description available

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

No description available

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

Data Usage Service

A service to manage data usage metrics.

Get Data Usage

No description available

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

Get Daily Usage Evaluation Tokens

No description available

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

This data structure represents a date range.

Find out more about data usage.

Responses

Request samples

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

Response samples

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

Get Daily Usage Processed GBs

No description available

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

This data structure represents a date range.

Find out more about data usage.

Responses

Request samples

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

Response samples

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

Get Daily Usage Units

No description available

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

This data structure represents a date range.

Find out more about data usage.

Responses

Request samples

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

Response samples

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

Get Data Usage Metrics Export Status

No description available

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
}

Update Data Usage Metrics Export Status

No description available

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
}

Get Logs Count

No description available

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

Get Spans Count

No description available

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

Target Service

View and manage your storage targets for logs.

Find out more about archives

Get target

No description available

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

Set target

No description available

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

Validate target

No description available

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
}

Team Permissions Management Service

Manage Team Groups.

Get Team Group By Name

No description available

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

Create Team Group

No description available

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

Update Team Group

No description available

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

Get Team Groups

No description available

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": [
    ]
}

Remove Users From Team Groups

No description available

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

Add Users To Team Groups

No description available

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

Get Team Group

No description available

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

Delete Team Group

No description available

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

Get Team Group Scope

No description available

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

Set Team Group Scope

No description available

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

Get Group Users

No description available

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 Users From Team Group

No description available

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 Group

No description available

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

Integration service

A service that enables querying for integration information.

Find out more about integrations in our documentation.

Get all integrations

No description available

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": [
    ]
}

Get integration definition

No description available

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

Get deployed integration

No description available

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

Delete integration

No description available

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

List managed integration keys

No description available

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": [
    ]
}

Get managed integration status

No description available

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

Save integration registration metadata

No description available

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

This data structure represents the metadata of an integration.

Responses

Request samples

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

Response samples

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

Update integration

No description available

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 (Integration metadata)

This data structure represents the metadata of an integration.

Responses

Request samples

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

Response samples

Content type
application/json
{ }

Test integration

No description available

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

This data structure represents the metadata of an integration.

integrationId
string

Responses

Request samples

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

Response samples

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

Get RUM integration versions data

No description available

Authorizations:
apiKeyAuth
query Parameters
applicationName
required
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": {
    }
}

Trigger sync of RUM integration data

No description available

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
force
boolean

The time between syncs is controlled 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"
}

Get integration template

No description available

Authorizations:
apiKeyAuth
query Parameters
integrationId
required
string
commonArmParams.logsUrl
required
string
commonArmParams.apiKey
required
string
commonArmParams.cgxDomain
required
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"
}

Get integration details

No description available

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

Contextual data integration service

Query for contextual data integration information.

Save contextual data integration

No description available

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

This data structure represents the metadata of an integration.

Responses

Request samples

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

Response samples

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

Update contextual data integration

No description available

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
integrationId
required
string
required
object (Integration metadata)

This data structure represents the metadata of an integration.

Responses

Request samples

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

Response samples

Content type
application/json
{ }

Test contextual data integration

No description available

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

This data structure represents the metadata of an integration.

integrationId
string

Responses

Request samples

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

Response samples

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

Delete contextual data integration

No description available

Authorizations:
apiKeyAuth
path Parameters
integrationId
required
string

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v1/contextual-data/integration/%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
{ }

Get all contextual data integrations accessible

No description available

Authorizations:
apiKeyAuth
query Parameters
includeTestingIntegrations
boolean

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v1/contextual-data/integrations?includeTestingIntegrations=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": [
    ]
}

Get contextual data integration definition

No description available

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

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v1/contextual-data/integrations/definition/%7Bid%7D?includeTestingIntegrations=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": {
    }
}

Get contextual data integration details

No description available

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

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v1/contextual-data/integrations/%7Bid%7D?includeTestingRevisions=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": {
    }
}

List outgoing webhooks

No description available

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": [
    ]
}

Create an outgoing webhook

No description available

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
required
object (Outgoing webhook input data)

Responses

Request samples

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

Response samples

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

Update an outgoing webhook

No description available

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
id
required
string
required
object (Outgoing webhook input data)

Responses

Request samples

Content type
application/json
{
  • "id": "example_id",
  • "data": {
    }
}

Response samples

Content type
application/json
{ }

List all outgoing webhooks

No description available

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": [
    ]
}

List IBM event notification instances

No description available

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": [
    ]
}

List outbound webhooks summary

No description available

Authorizations:
apiKeyAuth

Responses

Request samples 

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

let url = 'https://api.coralogix.com/mgmt/openapi/v1/outgoing-webhooks/summary';

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": [
    ]
}

Test an outgoing webhook

No description available

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
required
object (Outgoing webhook input data)

Responses

Request samples

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

Response samples

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

Test an existing outgoing webhook

No description available

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

Responses

Request samples

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

Response samples

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

Get outgoing webhook types

No description available

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": [
    ]
}

Get outgoing webhook type details

No description available

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

Get outgoing webhook

No description available

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

Delete an outgoing webhook

No description available

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

Rule Groups Service

A service to manage rule groups.

Get Rule Group Model Mapping

No description available

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

List Rule Groups

No description available

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": [
    ]
}

Bulk Delete Rule Group

No description available

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

Create Rule Group

No description available

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

Get Company Usage Limits

No description available

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

Get Rule Group

No description available

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

Delete Rule Group

No description available

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

Update Rule Group

No description available

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

Enrichments Service

Manage your enrichments.

Get Enrichments

No description available

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": [
    ]
}

Delete Enrichments

No description available

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": [
    ]
}

Add Enrichments

No description available

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": [
    ]
}

Get Enrichment Limit

No description available

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
}

Get Company Enrichment Settings

No description available

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

Atomic Overwrite Enrichments

No description available

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": [
    ]
}

Custom Enrichments Service

Manage your enrichments.

Get Custom Enrichments

No description available

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": [
    ]
}

Create Custom Enrichments

No description available

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

Update Custom Enrichment

No description available

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

Search Custom Enrichment Data

No description available

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": [
    ]
}

Delete Custom Enrichments

No description available

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
}

Get Custom Enrichment

No description available

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

Policies Service

View and manage your TCO policies

Get Company Policies

No description available

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": [
    ]
}

Get Policy by ID

No description available

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

Update Policy

No description available

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

Get Policy by ID

No description available

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

Delete Policy

No description available

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

Atomic Overwrite Log Policies

No description available

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": [
    ]
}

Atomic Overwrite Span Policies

No description available

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": [
    ]
}

Atomic Batch Create Policy

No description available

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": [
    ]
}

Bulk Test Log Policies

No description available

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": [
    ]
}

Reorder Policies

No description available

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": [
    ]
}

Toggle Policies

No description available

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
}

Retentions Service

Get Retentions

No description available

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": [
    ]
}

Update Retentions

No description available

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": [
    ]
}

Get Retentions Enabled

No description available

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
}

Activate Retentions

No description available

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
}