Download OpenAPI specification:Download
filter.timestamp.from required | string <date-time> |
filter.timestamp.to required | string <date-time> |
filter.cxEventTypes required | Array of strings |
filter.cxEventKeys required | Array of strings |
filter.cxEventMetadataFilters.operator required | string Default: "FILTER_OPERATOR_AND_OR_UNSPECIFIED" Enum: "FILTER_OPERATOR_AND_OR_UNSPECIFIED" "FILTER_OPERATOR_OR" |
pagination.pageSize | integer <int64> |
pagination.pageToken | string |
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));
{- "events": [
- {
- "cxEventKey": "test",
- "cxEventType": "test_type",
- "cxEventLabels": {
- "test": "test"
}, - "companyId": 1,
- "cxEventTimestamp": 1714857600,
- "cxEventPayloadType": "test_payload_type",
- "cxEventPayload": {
- "test": "test"
}, - "cxEventDedupKey": "test_dedup_key",
- "cxEventMetadata": {
- "test": "test"
}
}
], - "pagination": {
- "totalSize": 10,
- "nextPageToken": "test"
}
}
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> |
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));
{- "events": {
- "property1": {
- "singleEvent": {
- "cxEventKey": "test",
- "cxEventType": "test_type",
- "cxEventLabels": {
- "test": "test"
}, - "companyId": 1,
- "cxEventTimestamp": 1714857600,
- "cxEventPayloadType": "test_payload_type",
- "cxEventPayload": {
- "test": "test"
}, - "cxEventDedupKey": "test_dedup_key",
- "cxEventMetadata": {
- "test": "test"
}
}, - "multipleEvents": {
- "events": [
- {
- "cxEventKey": "test",
- "cxEventType": "test_type",
- "cxEventLabels": {
- "test": "test"
}, - "companyId": 1,
- "cxEventTimestamp": 1714857600,
- "cxEventPayloadType": "test_payload_type",
- "cxEventPayload": {
- "test": "test"
}, - "cxEventDedupKey": "test_dedup_key",
- "cxEventMetadata": {
- "test": "test"
}
}
]
}
}, - "property2": {
- "singleEvent": {
- "cxEventKey": "test",
- "cxEventType": "test_type",
- "cxEventLabels": {
- "test": "test"
}, - "companyId": 1,
- "cxEventTimestamp": 1714857600,
- "cxEventPayloadType": "test_payload_type",
- "cxEventPayload": {
- "test": "test"
}, - "cxEventDedupKey": "test_dedup_key",
- "cxEventMetadata": {
- "test": "test"
}
}, - "multipleEvents": {
- "events": [
- {
- "cxEventKey": "test",
- "cxEventType": "test_type",
- "cxEventLabels": {
- "test": "test"
}, - "companyId": 1,
- "cxEventTimestamp": 1714857600,
- "cxEventPayloadType": "test_payload_type",
- "cxEventPayload": {
- "test": "test"
}, - "cxEventDedupKey": "test_dedup_key",
- "cxEventMetadata": {
- "test": "test"
}
}
]
}
}
}, - "notFoundIds": [
- "string"
], - "pagination": {
- "totalSize": 10,
- "nextPageToken": "test"
}
}
id required | string |
pagination.pageSize | integer <int64> |
pagination.pageToken | string |
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));
{- "event": {
- "singleEvent": {
- "cxEventKey": "test",
- "cxEventType": "test_type",
- "cxEventLabels": {
- "test": "test"
}, - "companyId": 1,
- "cxEventTimestamp": 1714857600,
- "cxEventPayloadType": "test_payload_type",
- "cxEventPayload": {
- "test": "test"
}, - "cxEventDedupKey": "test_dedup_key",
- "cxEventMetadata": {
- "test": "test"
}
}, - "multipleEvents": {
- "events": [
- {
- "cxEventKey": "test",
- "cxEventType": "test_type",
- "cxEventLabels": {
- "test": "test"
}, - "companyId": 1,
- "cxEventTimestamp": 1714857600,
- "cxEventPayloadType": "test_payload_type",
- "cxEventPayload": {
- "test": "test"
}, - "cxEventDedupKey": "test_dedup_key",
- "cxEventMetadata": {
- "test": "test"
}
}
]
}
}, - "pagination": {
- "totalSize": 10,
- "nextPageToken": "test"
}
}
filter.timestamp.from required | string <date-time> |
filter.timestamp.to required | string <date-time> |
filter.cxEventTypes required | Array of strings |
filter.cxEventKeys required | Array of strings |
filter.cxEventMetadataFilters.operator required | string Default: "FILTER_OPERATOR_AND_OR_UNSPECIFIED" Enum: "FILTER_OPERATOR_AND_OR_UNSPECIFIED" "FILTER_OPERATOR_OR" |
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));
{- "count": 10,
- "reachedLimit": false
}
filter.timestamp.from required | string <date-time> |
filter.timestamp.to required | string <date-time> |
filter.cxEventTypes required | Array of strings |
filter.cxEventKeys required | Array of strings |
filter.cxEventMetadataFilters.operator required | string Default: "FILTER_OPERATOR_AND_OR_UNSPECIFIED" Enum: "FILTER_OPERATOR_AND_OR_UNSPECIFIED" "FILTER_OPERATOR_OR" |
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));
{- "cxEventMetadataFieldStatistics": {
- "property1": {
- "fieldStatistics": {
- "property1": "string",
- "property2": "string"
}
}, - "property2": {
- "fieldStatistics": {
- "property1": "string",
- "property2": "string"
}
}
}
}
ids required | Array of strings |
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));
{- "slos": {
- "property1": {
- "id": "slo_id",
- "name": "slo_name",
- "serviceName": "service_name",
- "status": "SLO_STATUS_UNSPECIFIED",
- "description": "slo_description",
- "targetPercentage": 99,
- "createdAt": "2021-01-01T00:00:00.000Z",
- "remainingErrorBudgetPercentage": 1,
- "latencySli": {
- "thresholdMicroseconds": "1000000",
- "thresholdSymbol": "THRESHOLD_SYMBOL_UNSPECIFIED"
}, - "errorSli": { },
- "filters": [
- {
- "field": "field_name",
- "compareType": "COMPARE_TYPE_UNSPECIFIED",
- "fieldValues": [
- "value1",
- "value2"
]
}
], - "period": "SLO_PERIOD_UNSPECIFIED"
}, - "property2": {
- "id": "slo_id",
- "name": "slo_name",
- "serviceName": "service_name",
- "status": "SLO_STATUS_UNSPECIFIED",
- "description": "slo_description",
- "targetPercentage": 99,
- "createdAt": "2021-01-01T00:00:00.000Z",
- "remainingErrorBudgetPercentage": 1,
- "latencySli": {
- "thresholdMicroseconds": "1000000",
- "thresholdSymbol": "THRESHOLD_SYMBOL_UNSPECIFIED"
}, - "errorSli": { },
- "filters": [
- {
- "field": "field_name",
- "compareType": "COMPARE_TYPE_UNSPECIFIED",
- "fieldValues": [
- "value1",
- "value2"
]
}
], - "period": "SLO_PERIOD_UNSPECIFIED"
}
}, - "notFoundIds": [
- "slo_id1",
- "slo_id2"
]
}
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. |
{- "slo": {
- "id": "slo_id",
- "name": "slo_name",
- "serviceName": "service_name",
- "status": "SLO_STATUS_UNSPECIFIED",
- "description": "slo_description",
- "targetPercentage": 99,
- "createdAt": "2021-01-01T00:00:00.000Z",
- "remainingErrorBudgetPercentage": 1,
- "latencySli": {
- "thresholdMicroseconds": "1000000",
- "thresholdSymbol": "THRESHOLD_SYMBOL_UNSPECIFIED"
}, - "errorSli": { },
- "filters": [
- {
- "field": "field_name",
- "compareType": "COMPARE_TYPE_UNSPECIFIED",
- "fieldValues": [
- "value1",
- "value2"
]
}
], - "period": "SLO_PERIOD_UNSPECIFIED"
}
}
{- "slo": {
- "id": "slo_id",
- "name": "slo_name",
- "serviceName": "service_name",
- "status": "SLO_STATUS_UNSPECIFIED",
- "description": "slo_description",
- "targetPercentage": 99,
- "createdAt": "2021-01-01T00:00:00.000Z",
- "remainingErrorBudgetPercentage": 1,
- "latencySli": {
- "thresholdMicroseconds": "1000000",
- "thresholdSymbol": "THRESHOLD_SYMBOL_UNSPECIFIED"
}, - "errorSli": { },
- "filters": [
- {
- "field": "field_name",
- "compareType": "COMPARE_TYPE_UNSPECIFIED",
- "fieldValues": [
- "value1",
- "value2"
]
}
], - "period": "SLO_PERIOD_UNSPECIFIED"
}
}
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. |
{- "slo": {
- "id": "slo_id",
- "name": "slo_name",
- "serviceName": "service_name",
- "status": "SLO_STATUS_UNSPECIFIED",
- "description": "slo_description",
- "targetPercentage": 99,
- "createdAt": "2021-01-01T00:00:00.000Z",
- "remainingErrorBudgetPercentage": 1,
- "latencySli": {
- "thresholdMicroseconds": "1000000",
- "thresholdSymbol": "THRESHOLD_SYMBOL_UNSPECIFIED"
}, - "errorSli": { },
- "filters": [
- {
- "field": "field_name",
- "compareType": "COMPARE_TYPE_UNSPECIFIED",
- "fieldValues": [
- "value1",
- "value2"
]
}
], - "period": "SLO_PERIOD_UNSPECIFIED"
}
}
{- "slo": {
- "id": "slo_id",
- "name": "slo_name",
- "serviceName": "service_name",
- "status": "SLO_STATUS_UNSPECIFIED",
- "description": "slo_description",
- "targetPercentage": 99,
- "createdAt": "2021-01-01T00:00:00.000Z",
- "remainingErrorBudgetPercentage": 1,
- "latencySli": {
- "thresholdMicroseconds": "1000000",
- "thresholdSymbol": "THRESHOLD_SYMBOL_UNSPECIFIED"
}, - "errorSli": { },
- "filters": [
- {
- "field": "field_name",
- "compareType": "COMPARE_TYPE_UNSPECIFIED",
- "fieldValues": [
- "value1",
- "value2"
]
}
], - "period": "SLO_PERIOD_UNSPECIFIED"
}
}
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 |
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));
{- "slos": [
- {
- "id": "slo_id",
- "name": "slo_name",
- "serviceName": "service_name",
- "status": "SLO_STATUS_UNSPECIFIED",
- "description": "slo_description",
- "targetPercentage": 99,
- "createdAt": "2021-01-01T00:00:00.000Z",
- "remainingErrorBudgetPercentage": 1,
- "latencySli": {
- "thresholdMicroseconds": "1000000",
- "thresholdSymbol": "THRESHOLD_SYMBOL_UNSPECIFIED"
}, - "errorSli": { },
- "filters": [
- {
- "field": "field_name",
- "compareType": "COMPARE_TYPE_UNSPECIFIED",
- "fieldValues": [
- "value1",
- "value2"
]
}
], - "period": "SLO_PERIOD_UNSPECIFIED"
}
]
}
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));
{- "slo": {
- "id": "slo_id",
- "name": "slo_name",
- "serviceName": "service_name",
- "status": "SLO_STATUS_UNSPECIFIED",
- "description": "slo_description",
- "targetPercentage": 99,
- "createdAt": "2021-01-01T00:00:00.000Z",
- "remainingErrorBudgetPercentage": 1,
- "latencySli": {
- "thresholdMicroseconds": "1000000",
- "thresholdSymbol": "THRESHOLD_SYMBOL_UNSPECIFIED"
}, - "errorSli": { },
- "filters": [
- {
- "field": "field_name",
- "compareType": "COMPARE_TYPE_UNSPECIFIED",
- "fieldValues": [
- "value1",
- "value2"
]
}
], - "period": "SLO_PERIOD_UNSPECIFIED"
}
}
id required | string |
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));
{ }
entityType | string |
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/routers?entityType=SOME_STRING_VALUE'; let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{- "routers": [
- {
- "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
- "userFacingId": "user-provided-id",
- "entityType": "alerts",
- "name": "My Router",
- "description": "string",
- "rules": [
- {
- "condition": "alertDef.priority == 'P3'",
- "targets": [
- {
- "connectorId": "string",
- "presetId": "string",
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- {
- "fieldName": null,
- "template": null
}
], - "connectorConfigFields": [
- {
- "fieldName": null,
- "template": null
}
]
}, - "customDetails": {
- "property1": "string",
- "property2": "string"
}
}
], - "customDetails": {
- "property1": "string",
- "property2": "string"
}, - "name": "string"
}
], - "fallback": [
- {
- "connectorId": "string",
- "presetId": "string",
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- {
- "fieldName": "title",
- "template": "{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}"
}
], - "connectorConfigFields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}, - "customDetails": {
- "property1": "string",
- "property2": "string"
}
}
], - "createTime": "2019-08-24T14:15:22Z",
- "updateTime": "2019-08-24T14:15:22Z",
- "entityLabels": {
- "property1": "string",
- "property2": "string"
}
}
]
}
id | string (A unique identifier automatically generated by the service (do not provide this from the client side)) |
userFacingId | string (A unique identifier provided by the user) |
entityType required | string (The source of the notification (e.g., "alerts")) |
name required | string |
description | string |
Array of objects (The routing rules to be applied in order to determine the destinations of the notification, teh first rule that matches will be used) | |
Array of objects (The fallback destinations to be used if no rule matches) | |
createTime | string <date-time> (System-generated timestamp for when the router was last updated) |
updateTime | string <date-time> (System-generated timestamp for when the router was last updated) |
object |
{- "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
- "userFacingId": "user-provided-id",
- "entityType": "alerts",
- "name": "My Router",
- "description": "string",
- "rules": [
- {
- "condition": "alertDef.priority == 'P3'",
- "targets": [
- {
- "connectorId": "string",
- "presetId": "string",
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- {
- "fieldName": "title",
- "template": "{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}"
}
], - "connectorConfigFields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}, - "customDetails": {
- "property1": "string",
- "property2": "string"
}
}
], - "customDetails": {
- "property1": "string",
- "property2": "string"
}, - "name": "string"
}
], - "fallback": [
- {
- "connectorId": "string",
- "presetId": "string",
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- {
- "fieldName": "title",
- "template": "{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}"
}
], - "connectorConfigFields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}, - "customDetails": {
- "property1": "string",
- "property2": "string"
}
}
], - "createTime": "2019-08-24T14:15:22Z",
- "updateTime": "2019-08-24T14:15:22Z",
- "entityLabels": {
- "property1": "string",
- "property2": "string"
}
}
{- "router": {
- "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
- "userFacingId": "user-provided-id",
- "entityType": "alerts",
- "name": "My Router",
- "description": "string",
- "rules": [
- {
- "condition": "alertDef.priority == 'P3'",
- "targets": [
- {
- "connectorId": "string",
- "presetId": "string",
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- {
- "fieldName": "title",
- "template": "{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}"
}
], - "connectorConfigFields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}, - "customDetails": {
- "property1": "string",
- "property2": "string"
}
}
], - "customDetails": {
- "property1": "string",
- "property2": "string"
}, - "name": "string"
}
], - "fallback": [
- {
- "connectorId": "string",
- "presetId": "string",
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- {
- "fieldName": "title",
- "template": "{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}"
}
], - "connectorConfigFields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}, - "customDetails": {
- "property1": "string",
- "property2": "string"
}
}
], - "createTime": "2019-08-24T14:15:22Z",
- "updateTime": "2019-08-24T14:15:22Z",
- "entityLabels": {
- "property1": "string",
- "property2": "string"
}
}
}
id | string (A unique identifier automatically generated by the service (do not provide this from the client side)) |
userFacingId | string (A unique identifier provided by the user) |
entityType required | string (The source of the notification (e.g., "alerts")) |
name required | string |
description | string |
Array of objects (The routing rules to be applied in order to determine the destinations of the notification, teh first rule that matches will be used) | |
Array of objects (The fallback destinations to be used if no rule matches) | |
createTime | string <date-time> (System-generated timestamp for when the router was last updated) |
updateTime | string <date-time> (System-generated timestamp for when the router was last updated) |
object |
{- "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
- "userFacingId": "user-provided-id",
- "entityType": "alerts",
- "name": "My Router",
- "description": "string",
- "rules": [
- {
- "condition": "alertDef.priority == 'P3'",
- "targets": [
- {
- "connectorId": "string",
- "presetId": "string",
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- {
- "fieldName": "title",
- "template": "{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}"
}
], - "connectorConfigFields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}, - "customDetails": {
- "property1": "string",
- "property2": "string"
}
}
], - "customDetails": {
- "property1": "string",
- "property2": "string"
}, - "name": "string"
}
], - "fallback": [
- {
- "connectorId": "string",
- "presetId": "string",
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- {
- "fieldName": "title",
- "template": "{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}"
}
], - "connectorConfigFields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}, - "customDetails": {
- "property1": "string",
- "property2": "string"
}
}
], - "createTime": "2019-08-24T14:15:22Z",
- "updateTime": "2019-08-24T14:15:22Z",
- "entityLabels": {
- "property1": "string",
- "property2": "string"
}
}
{- "router": {
- "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
- "userFacingId": "user-provided-id",
- "entityType": "alerts",
- "name": "My Router",
- "description": "string",
- "rules": [
- {
- "condition": "alertDef.priority == 'P3'",
- "targets": [
- {
- "connectorId": "string",
- "presetId": "string",
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- {
- "fieldName": "title",
- "template": "{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}"
}
], - "connectorConfigFields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}, - "customDetails": {
- "property1": "string",
- "property2": "string"
}
}
], - "customDetails": {
- "property1": "string",
- "property2": "string"
}, - "name": "string"
}
], - "fallback": [
- {
- "connectorId": "string",
- "presetId": "string",
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- {
- "fieldName": "title",
- "template": "{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}"
}
], - "connectorConfigFields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}, - "customDetails": {
- "property1": "string",
- "property2": "string"
}
}
], - "createTime": "2019-08-24T14:15:22Z",
- "updateTime": "2019-08-24T14:15:22Z",
- "entityLabels": {
- "property1": "string",
- "property2": "string"
}
}
}
identifier.userFacingId required | string |
identifier.id | string |
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/routers/%7Bidentifier.userFacingId%7D?identifier.id=SOME_STRING_VALUE'; let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{- "router": {
- "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
- "userFacingId": "user-provided-id",
- "entityType": "alerts",
- "name": "My Router",
- "description": "string",
- "rules": [
- {
- "condition": "alertDef.priority == 'P3'",
- "targets": [
- {
- "connectorId": "string",
- "presetId": "string",
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- {
- "fieldName": "title",
- "template": "{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}"
}
], - "connectorConfigFields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}, - "customDetails": {
- "property1": "string",
- "property2": "string"
}
}
], - "customDetails": {
- "property1": "string",
- "property2": "string"
}, - "name": "string"
}
], - "fallback": [
- {
- "connectorId": "string",
- "presetId": "string",
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- {
- "fieldName": "title",
- "template": "{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}"
}
], - "connectorConfigFields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}, - "customDetails": {
- "property1": "string",
- "property2": "string"
}
}
], - "createTime": "2019-08-24T14:15:22Z",
- "updateTime": "2019-08-24T14:15:22Z",
- "entityLabels": {
- "property1": "string",
- "property2": "string"
}
}
}
identifier.userFacingId required | string |
identifier.id | string |
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/routers/%7Bidentifier.userFacingId%7D?identifier.id=SOME_STRING_VALUE'; let options = {method: 'DELETE', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{ }
id | string (A unique identifier automatically generated by the service (do not provide this from the client side)) |
userFacingId | string (A unique identifier provided by the user) |
type required | string (notification_centerConnectorType) Default: "CONNECTOR_TYPE_UNSPECIFIED" Enum: "CONNECTOR_TYPE_UNSPECIFIED" "SLACK" "GENERIC_HTTPS" "PAGERDUTY" "AWS" "IBM_EVENT_NOTIFICATIONS" |
teamId | integer <int64> |
name required | string <= 200 characters |
description | string <= 5000 characters |
createTime | string <date-time> (System-generated timestamp for when the connector was last updated) |
updateTime | string <date-time> (System-generated timestamp for when the connector was last updated) |
required | Array of objects (Connector Config) |
Array of objects (Configuration override templates for specific entity types, values from connector_configs will be used if not overridden) |
{- "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
- "userFacingId": "user-connector-id",
- "type": "CONNECTOR_TYPE_UNSPECIFIED",
- "teamId": "12345",
- "name": "My Slack Connector",
- "description": "Connector for team notifications",
- "createTime": "2019-08-24T14:15:22Z",
- "updateTime": "2019-08-24T14:15:22Z",
- "connectorConfigs": [
- {
- "outputSchemaId": "schema-id",
- "fields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}
], - "configOverrides": [
- {
- "entityType": "alerts",
- "connectorConfigs": [
- {
- "outputSchemaId": "schema-id",
- "fields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}
]
}
]
}
{- "connector": {
- "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
- "userFacingId": "user-connector-id",
- "type": "CONNECTOR_TYPE_UNSPECIFIED",
- "teamId": "12345",
- "name": "My Slack Connector",
- "description": "Connector for team notifications",
- "createTime": "2019-08-24T14:15:22Z",
- "updateTime": "2019-08-24T14:15:22Z",
- "connectorConfigs": [
- {
- "outputSchemaId": "schema-id",
- "fields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}
], - "configOverrides": [
- {
- "entityType": "alerts",
- "connectorConfigs": [
- {
- "outputSchemaId": "schema-id",
- "fields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}
]
}
]
}
}
connectorType | string Default: "CONNECTOR_TYPE_UNSPECIFIED" Enum: "CONNECTOR_TYPE_UNSPECIFIED" "SLACK" "GENERIC_HTTPS" "PAGERDUTY" "AWS" "IBM_EVENT_NOTIFICATIONS" |
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));
{- "connectors": [
- {
- "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
- "userFacingId": "user-connector-id",
- "type": "CONNECTOR_TYPE_UNSPECIFIED",
- "teamId": "12345",
- "name": "My Slack Connector",
- "description": "Connector for team notifications",
- "createTime": "2019-08-24T14:15:22Z",
- "updateTime": "2019-08-24T14:15:22Z",
- "connectorConfigs": [
- {
- "outputSchemaId": "schema-id",
- "fields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}
], - "configOverrides": [
- {
- "entityType": "alerts",
- "connectorConfigs": [
- {
- "outputSchemaId": "schema-id",
- "fields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}
]
}
]
}
]
}
id | string (A unique identifier automatically generated by the service (do not provide this from the client side)) |
userFacingId | string (A unique identifier provided by the user) |
type required | string (notification_centerConnectorType) Default: "CONNECTOR_TYPE_UNSPECIFIED" Enum: "CONNECTOR_TYPE_UNSPECIFIED" "SLACK" "GENERIC_HTTPS" "PAGERDUTY" "AWS" "IBM_EVENT_NOTIFICATIONS" |
teamId | integer <int64> |
name required | string <= 200 characters |
description | string <= 5000 characters |
createTime | string <date-time> (System-generated timestamp for when the connector was last updated) |
updateTime | string <date-time> (System-generated timestamp for when the connector was last updated) |
required | Array of objects (Connector Config) |
Array of objects (Configuration override templates for specific entity types, values from connector_configs will be used if not overridden) |
{- "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
- "userFacingId": "user-connector-id",
- "type": "CONNECTOR_TYPE_UNSPECIFIED",
- "teamId": "12345",
- "name": "My Slack Connector",
- "description": "Connector for team notifications",
- "createTime": "2019-08-24T14:15:22Z",
- "updateTime": "2019-08-24T14:15:22Z",
- "connectorConfigs": [
- {
- "outputSchemaId": "schema-id",
- "fields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}
], - "configOverrides": [
- {
- "entityType": "alerts",
- "connectorConfigs": [
- {
- "outputSchemaId": "schema-id",
- "fields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}
]
}
]
}
{- "connector": {
- "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
- "userFacingId": "user-connector-id",
- "type": "CONNECTOR_TYPE_UNSPECIFIED",
- "teamId": "12345",
- "name": "My Slack Connector",
- "description": "Connector for team notifications",
- "createTime": "2019-08-24T14:15:22Z",
- "updateTime": "2019-08-24T14:15:22Z",
- "connectorConfigs": [
- {
- "outputSchemaId": "schema-id",
- "fields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}
], - "configOverrides": [
- {
- "entityType": "alerts",
- "connectorConfigs": [
- {
- "outputSchemaId": "schema-id",
- "fields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}
]
}
]
}
}
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/connectors/%7Bid%7D'; let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{- "connector": {
- "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
- "userFacingId": "user-connector-id",
- "type": "CONNECTOR_TYPE_UNSPECIFIED",
- "teamId": "12345",
- "name": "My Slack Connector",
- "description": "Connector for team notifications",
- "createTime": "2019-08-24T14:15:22Z",
- "updateTime": "2019-08-24T14:15:22Z",
- "connectorConfigs": [
- {
- "outputSchemaId": "schema-id",
- "fields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}
], - "configOverrides": [
- {
- "entityType": "alerts",
- "connectorConfigs": [
- {
- "outputSchemaId": "schema-id",
- "fields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}
]
}
]
}
}
id required | string |
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/connectors/%7Bid%7D'; let options = {method: 'DELETE', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{ }
ids | Array of strings |
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/connectors:batchGet?ids=SOME_ARRAY_VALUE'; let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{- "connectors": {
- "property1": {
- "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
- "userFacingId": "user-connector-id",
- "type": "CONNECTOR_TYPE_UNSPECIFIED",
- "teamId": "12345",
- "name": "My Slack Connector",
- "description": "Connector for team notifications",
- "createTime": "2019-08-24T14:15:22Z",
- "updateTime": "2019-08-24T14:15:22Z",
- "connectorConfigs": [
- {
- "outputSchemaId": "schema-id",
- "fields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}
], - "configOverrides": [
- {
- "entityType": "alerts",
- "connectorConfigs": [
- {
- "outputSchemaId": "schema-id",
- "fields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}
]
}
]
}, - "property2": {
- "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
- "userFacingId": "user-connector-id",
- "type": "CONNECTOR_TYPE_UNSPECIFIED",
- "teamId": "12345",
- "name": "My Slack Connector",
- "description": "Connector for team notifications",
- "createTime": "2019-08-24T14:15:22Z",
- "updateTime": "2019-08-24T14:15:22Z",
- "connectorConfigs": [
- {
- "outputSchemaId": "schema-id",
- "fields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}
], - "configOverrides": [
- {
- "entityType": "alerts",
- "connectorConfigs": [
- {
- "outputSchemaId": "schema-id",
- "fields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}
]
}
]
}
}, - "notFoundIds": [
- "connector-id-3"
]
}
ids | Array of strings |
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/connectors:batchGetSummaries?ids=SOME_ARRAY_VALUE'; let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{- "connectorSummaries": {
- "property1": {
- "id": "string",
- "userFacingId": "string",
- "type": "CONNECTOR_TYPE_UNSPECIFIED",
- "teamId": 0,
- "name": "string",
- "description": "string",
- "createTime": "2019-08-24T14:15:22Z",
- "updateTime": "2019-08-24T14:15:22Z"
}, - "property2": {
- "id": "string",
- "userFacingId": "string",
- "type": "CONNECTOR_TYPE_UNSPECIFIED",
- "teamId": 0,
- "name": "string",
- "description": "string",
- "createTime": "2019-08-24T14:15:22Z",
- "updateTime": "2019-08-24T14:15:22Z"
}
}, - "notFoundIds": [
- "connector-id-3"
]
}
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));
{- "connectorTypeSummaries": [
- {
- "type": "CONNECTOR_TYPE_UNSPECIFIED",
- "count": "5"
}
]
}
connectorType | string Default: "CONNECTOR_TYPE_UNSPECIFIED" Enum: "CONNECTOR_TYPE_UNSPECIFIED" "SLACK" "GENERIC_HTTPS" "PAGERDUTY" "AWS" "IBM_EVENT_NOTIFICATIONS" |
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));
{- "connectorSummaries": [
- {
- "id": "string",
- "userFacingId": "string",
- "type": "CONNECTOR_TYPE_UNSPECIFIED",
- "teamId": 0,
- "name": "string",
- "description": "string",
- "createTime": "2019-08-24T14:15:22Z",
- "updateTime": "2019-08-24T14:15:22Z"
}
]
}
id | string (A unique identifier automatically generated by the service (do not provide this from the client side)) |
userFacingId | string (A unique identifier provided by the user) |
entityType required | string |
connectorType | string (notification_centerConnectorType) Default: "CONNECTOR_TYPE_UNSPECIFIED" Enum: "CONNECTOR_TYPE_UNSPECIFIED" "SLACK" "GENERIC_HTTPS" "PAGERDUTY" "AWS" "IBM_EVENT_NOTIFICATIONS" |
required | Array of objects (A list of of configuration override templates, each associated with a specific output schema and condition) |
parent | object (Preset) Recursive Set of preconfigured templates for notification content rendering |
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" |
{- "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
- "userFacingId": "user-preset-id",
- "entityType": "alerts",
- "connectorType": "CONNECTOR_TYPE_UNSPECIFIED",
- "configOverrides": [
- {
- "conditionType": {
- "matchEntityType": {
- "entityType": "string"
}, - "matchEntityTypeAndSubType": {
- "entityType": "string",
- "entitySubType": "string"
}
}, - "outputSchemaId": "string",
- "messageConfig": {
- "fields": [
- {
- "fieldName": "title",
- "template": "{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}"
}
]
}
}
], - "parent": { },
- "name": "My Preset",
- "description": "Custom preset for alerts",
- "createTime": "2019-08-24T14:15:22Z",
- "updateTime": "2019-08-24T14:15:22Z",
- "presetType": "PRESET_TYPE_UNSPECIFIED"
}
{- "preset": {
- "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
- "userFacingId": "user-preset-id",
- "entityType": "alerts",
- "connectorType": "CONNECTOR_TYPE_UNSPECIFIED",
- "configOverrides": [
- {
- "conditionType": {
- "matchEntityType": {
- "entityType": "string"
}, - "matchEntityTypeAndSubType": {
- "entityType": "string",
- "entitySubType": "string"
}
}, - "outputSchemaId": "string",
- "messageConfig": {
- "fields": [
- {
- "fieldName": "title",
- "template": "{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}"
}
]
}
}
], - "parent": { },
- "name": "My Preset",
- "description": "Custom preset for alerts",
- "createTime": "2019-08-24T14:15:22Z",
- "updateTime": "2019-08-24T14:15:22Z",
- "presetType": "PRESET_TYPE_UNSPECIFIED"
}
}
id | string (A unique identifier automatically generated by the service (do not provide this from the client side)) |
userFacingId | string (A unique identifier provided by the user) |
entityType required | string |
connectorType | string (notification_centerConnectorType) Default: "CONNECTOR_TYPE_UNSPECIFIED" Enum: "CONNECTOR_TYPE_UNSPECIFIED" "SLACK" "GENERIC_HTTPS" "PAGERDUTY" "AWS" "IBM_EVENT_NOTIFICATIONS" |
required | Array of objects (A list of of configuration override templates, each associated with a specific output schema and condition) |
parent | object (Preset) Recursive Set of preconfigured templates for notification content rendering |
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" |
{- "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
- "userFacingId": "user-preset-id",
- "entityType": "alerts",
- "connectorType": "CONNECTOR_TYPE_UNSPECIFIED",
- "configOverrides": [
- {
- "conditionType": {
- "matchEntityType": {
- "entityType": "string"
}, - "matchEntityTypeAndSubType": {
- "entityType": "string",
- "entitySubType": "string"
}
}, - "outputSchemaId": "string",
- "messageConfig": {
- "fields": [
- {
- "fieldName": "title",
- "template": "{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}"
}
]
}
}
], - "parent": { },
- "name": "My Preset",
- "description": "Custom preset for alerts",
- "createTime": "2019-08-24T14:15:22Z",
- "updateTime": "2019-08-24T14:15:22Z",
- "presetType": "PRESET_TYPE_UNSPECIFIED"
}
{- "preset": {
- "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
- "userFacingId": "user-preset-id",
- "entityType": "alerts",
- "connectorType": "CONNECTOR_TYPE_UNSPECIFIED",
- "configOverrides": [
- {
- "conditionType": {
- "matchEntityType": {
- "entityType": "string"
}, - "matchEntityTypeAndSubType": {
- "entityType": "string",
- "entitySubType": "string"
}
}, - "outputSchemaId": "string",
- "messageConfig": {
- "fields": [
- {
- "fieldName": "title",
- "template": "{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}"
}
]
}
}
], - "parent": { },
- "name": "My Preset",
- "description": "Custom preset for alerts",
- "createTime": "2019-08-24T14:15:22Z",
- "updateTime": "2019-08-24T14:15:22Z",
- "presetType": "PRESET_TYPE_UNSPECIFIED"
}
}
identifier.userFacingId required | string The unique identifier provided by the user |
id | string |
userFacingId | string |
identifier.id | string The unique identifier automatically generated by the service |
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/presets/custom/%7Bidentifier.userFacingId%7D?id=SOME_STRING_VALUE&userFacingId=SOME_STRING_VALUE&identifier.id=SOME_STRING_VALUE'; let options = {method: 'DELETE', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{ }
identifier.userFacingId required | string The unique identifier provided by the user |
id | string |
userFacingId | string |
identifier.id | string The unique identifier automatically generated by the service |
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/presets/custom/%7Bidentifier.userFacingId%7D:defaultSet?id=SOME_STRING_VALUE&userFacingId=SOME_STRING_VALUE&identifier.id=SOME_STRING_VALUE'; let options = {method: 'POST', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{ }
identifier.userFacingId required | string The unique identifier provided by the user |
id | string |
userFacingId | string |
identifier.id | string The unique identifier automatically generated by the service |
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/presets/%7Bidentifier.userFacingId%7D?id=SOME_STRING_VALUE&userFacingId=SOME_STRING_VALUE&identifier.id=SOME_STRING_VALUE'; let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{- "preset": {
- "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
- "userFacingId": "user-preset-id",
- "entityType": "alerts",
- "connectorType": "CONNECTOR_TYPE_UNSPECIFIED",
- "configOverrides": [
- {
- "conditionType": {
- "matchEntityType": {
- "entityType": "string"
}, - "matchEntityTypeAndSubType": {
- "entityType": "string",
- "entitySubType": "string"
}
}, - "outputSchemaId": "string",
- "messageConfig": {
- "fields": [
- {
- "fieldName": "title",
- "template": "{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}"
}
]
}
}
], - "parent": { },
- "name": "My Preset",
- "description": "Custom preset for alerts",
- "createTime": "2019-08-24T14:15:22Z",
- "updateTime": "2019-08-24T14:15:22Z",
- "presetType": "PRESET_TYPE_UNSPECIFIED"
}
}
identifier.userFacingId required | string The unique identifier provided by the user |
identifier.id | string The unique identifier automatically generated by the service |
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/presets/%7Bidentifier.userFacingId%7D:defaultSet?identifier.id=SOME_STRING_VALUE'; let options = {method: 'POST', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{ }
ids | Array of strings |
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/presets:batchGet?ids=SOME_ARRAY_VALUE'; let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{- "presets": {
- "property1": {
- "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
- "userFacingId": "user-preset-id",
- "entityType": "alerts",
- "connectorType": "CONNECTOR_TYPE_UNSPECIFIED",
- "configOverrides": [
- {
- "conditionType": {
- "matchEntityType": {
- "entityType": "string"
}, - "matchEntityTypeAndSubType": {
- "entityType": "string",
- "entitySubType": "string"
}
}, - "outputSchemaId": "string",
- "messageConfig": {
- "fields": [
- {
- "fieldName": "title",
- "template": "{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}"
}
]
}
}
], - "parent": { },
- "name": "My Preset",
- "description": "Custom preset for alerts",
- "createTime": "2019-08-24T14:15:22Z",
- "updateTime": "2019-08-24T14:15:22Z",
- "presetType": "PRESET_TYPE_UNSPECIFIED"
}, - "property2": {
- "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
- "userFacingId": "user-preset-id",
- "entityType": "alerts",
- "connectorType": "CONNECTOR_TYPE_UNSPECIFIED",
- "configOverrides": [
- {
- "conditionType": {
- "matchEntityType": {
- "entityType": "string"
}, - "matchEntityTypeAndSubType": {
- "entityType": "string",
- "entitySubType": "string"
}
}, - "outputSchemaId": "string",
- "messageConfig": {
- "fields": [
- {
- "fieldName": "title",
- "template": "{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}"
}
]
}
}
], - "parent": { },
- "name": "My Preset",
- "description": "Custom preset for alerts",
- "createTime": "2019-08-24T14:15:22Z",
- "updateTime": "2019-08-24T14:15:22Z",
- "presetType": "PRESET_TYPE_UNSPECIFIED"
}
}, - "notFoundIds": [
- "string"
]
}
connectorType | string Default: "CONNECTOR_TYPE_UNSPECIFIED" Enum: "CONNECTOR_TYPE_UNSPECIFIED" "SLACK" "GENERIC_HTTPS" "PAGERDUTY" "AWS" "IBM_EVENT_NOTIFICATIONS" |
entityType | string |
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/presets:defaultSummaryGet?connectorType=SOME_STRING_VALUE&entityType=SOME_STRING_VALUE'; let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{- "presetSummary": {
- "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
- "userFacingId": "user-preset-id",
- "entityType": "alerts",
- "connectorType": "CONNECTOR_TYPE_UNSPECIFIED",
- "parentId": "c246e826-10c2-405e-8d3f-afcc24ad4d15",
- "name": "My Preset",
- "description": "Custom preset for alerts",
- "createTime": "2019-08-24T14:15:22Z",
- "updateTime": "2019-08-24T14:15:22Z",
- "presetType": "PRESET_TYPE_UNSPECIFIED"
}
}
connectorType | string Default: "CONNECTOR_TYPE_UNSPECIFIED" Enum: "CONNECTOR_TYPE_UNSPECIFIED" "SLACK" "GENERIC_HTTPS" "PAGERDUTY" "AWS" "IBM_EVENT_NOTIFICATIONS" |
entityType | string |
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/presets:summariesList?connectorType=SOME_STRING_VALUE&entityType=SOME_STRING_VALUE'; let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{- "presetSummaries": [
- {
- "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
- "userFacingId": "user-preset-id",
- "entityType": "alerts",
- "connectorType": "CONNECTOR_TYPE_UNSPECIFIED",
- "parentId": "c246e826-10c2-405e-8d3f-afcc24ad4d15",
- "name": "My Preset",
- "description": "Custom preset for alerts",
- "createTime": "2019-08-24T14:15:22Z",
- "updateTime": "2019-08-24T14:15:22Z",
- "presetType": "PRESET_TYPE_UNSPECIFIED"
}
]
}
connectorType | string Default: "CONNECTOR_TYPE_UNSPECIFIED" Enum: "CONNECTOR_TYPE_UNSPECIFIED" "SLACK" "GENERIC_HTTPS" "PAGERDUTY" "AWS" "IBM_EVENT_NOTIFICATIONS" |
entityType | string |
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/presets:systemDefaultSummaryGet?connectorType=SOME_STRING_VALUE&entityType=SOME_STRING_VALUE'; let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{- "presetSummary": {
- "id": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
- "userFacingId": "user-preset-id",
- "entityType": "alerts",
- "connectorType": "CONNECTOR_TYPE_UNSPECIFIED",
- "parentId": "c246e826-10c2-405e-8d3f-afcc24ad4d15",
- "name": "My Preset",
- "description": "Custom preset for alerts",
- "createTime": "2019-08-24T14:15:22Z",
- "updateTime": "2019-08-24T14:15:22Z",
- "presetType": "PRESET_TYPE_UNSPECIFIED"
}
}
Request to test a connector configuration
type | string (notification_centerConnectorType) Default: "CONNECTOR_TYPE_UNSPECIFIED" Enum: "CONNECTOR_TYPE_UNSPECIFIED" "SLACK" "GENERIC_HTTPS" "PAGERDUTY" "AWS" "IBM_EVENT_NOTIFICATIONS" |
outputSchemaId | string |
Array of objects (coralogixapisnotification_centerConnectorConfigField) | |
entityType | string |
{- "type": "CONNECTOR_TYPE_UNSPECIFIED",
- "outputSchemaId": "default",
- "fields": [
- {
- "fieldName": "string",
- "template": "string"
}
], - "entityType": "alerts"
}
{- "result": {
- "success": { },
- "failure": {
- "message": "string",
- "statusCode": 0
}
}
}
entityType | string |
entitySubType | string |
connectorId | string |
presetId | string |
outputSchemaId | string |
Array of objects (coralogixapisnotification_centerConnectorConfigField) | |
Array of objects (Message Config Field) |
{- "entityType": "alerts",
- "entitySubType": "logsImmediateResolved",
- "connectorId": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
- "presetId": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
- "outputSchemaId": "default",
- "connectorConfigFields": [
- {
- "fieldName": "string",
- "template": "string"
}
], - "messageConfigFields": [
- {
- "fieldName": "title",
- "template": "{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}"
}
]
}
{- "result": {
- "success": { },
- "failure": {
- "message": "string",
- "statusCode": 0
}
}
}
connectorId | string |
outputSchemaId | string |
{- "connectorId": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
- "outputSchemaId": "default"
}
{- "result": {
- "success": { },
- "failure": {
- "message": "string",
- "statusCode": 0
}
}
}
entityType | string |
entitySubType | string |
presetId | string |
connectorId | string |
{- "entityType": "alerts",
- "entitySubType": "logsImmediateResolved",
- "presetId": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
- "connectorId": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9"
}
{- "result": {
- "success": { },
- "failure": {
- "message": "string",
- "statusCode": 0
}
}
}
entityType | string |
entitySubType | string |
connectorId | string |
presetId | string |
Array of objects (notification_centerConfigOverrides) |
{- "entityType": "alerts",
- "entitySubType": "metric",
- "connectorId": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
- "presetId": "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9",
- "configOverrides": [
- {
- "conditionType": {
- "matchEntityType": {
- "entityType": "string"
}, - "matchEntityTypeAndSubType": {
- "entityType": "string",
- "entitySubType": "string"
}
}, - "outputSchemaId": "string",
- "messageConfig": {
- "fields": [
- {
- "fieldName": "title",
- "template": "{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}"
}
]
}
}
]
}
{- "result": {
- "success": { },
- "failure": {
- "message": "string",
- "statusCode": 0
}
}
}
Request to check that provided routing condition is valid
entityType | string |
template | string |
{- "entityType": "alerts",
- "template": "alertDef.priority == 'P1'"
}
{- "success": {
- "result": true
}, - "failure": {
- "message": "Invalid condition: condition should be rendered to a boolean value (true or false)"
}
}
entityType | string |
entitySubType | string |
template | string |
{- "entityType": "alerts",
- "entitySubType": "logsImmediateResolved",
- "template": "{{ alertDef.name }}"
}
{- "result": {
- "success": {
- "renderedValue": "Rendered template result"
}, - "failure": {
- "message": "Template rendering failed",
- "reason": "FAILURE_REASON_UNSPECIFIED"
}
}
}
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/v1/notification-center/entities:listEntityTypes'; let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{- "entityTypes": [
- "string"
]
}
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. |
hashed required | boolean |
{- "name": "my_api_key",
- "owner": {
- "userId": "string",
- "teamId": 0,
- "organisationId": "string"
}, - "keyPermissions": {
- "presets": [
- "my_preset"
], - "permissions": [
- "read_logs"
]
}, - "hashed": true
}
{- "keyId": "my_key_id",
- "name": "my_api_key",
- "value": "my_api_key_value"
}
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));
{- "keys": [
- {
- "name": "my_api_key",
- "owner": {
- "userId": "string",
- "teamId": 0,
- "organisationId": "string"
}, - "active": true,
- "hashed": true,
- "keyPermissions": {
- "presets": [
- {
- "name": "my_preset",
- "permissions": [
- "read_logs"
]
}
], - "permissions": [
- "string"
]
}, - "value": "string",
- "id": "string"
}
]
}
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));
{- "keyInfo": {
- "name": "my_api_key",
- "owner": {
- "userId": "string",
- "teamId": 0,
- "organisationId": "string"
}, - "active": true,
- "hashed": true,
- "keyPermissions": {
- "presets": [
- {
- "name": "my_preset",
- "permissions": [
- "read_logs"
]
}
], - "permissions": [
- "string"
]
}, - "value": "string",
- "id": "string"
}
}
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));
{ }
keyId required | string |
newName | string |
isActive | boolean |
object (Presets) This data structure represents a set of permissions presets on an API key. | |
object (Permissions) This data structure represents a set of permissions on an API key. |
{- "newName": "my_new_name",
- "isActive": true,
- "presets": {
- "presets": [
- "string"
]
}, - "permissions": {
- "permissions": [
- "string"
]
}
}
{ }
This data structure is used to activate or deactivate a SAML identity provider
teamId required | integer <int64> |
isActive required | boolean |
{- "teamId": 0,
- "isActive": true
}
{ }
teamId required | integer <int64> |
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));
{- "teamId": 0,
- "spParameters": {
- "signingCertPem": "certificate",
- "nameIdFormat": "name_id",
- "assertionConsumerServiceUrl": "assertion",
- "binding": "binding"
}, - "idpParameters": {
- "active": true,
- "metadataContent": "<?xml version= ...",
- "teamEntityId": 1234567,
- "groupNames": [
- "group1"
]
}, - "idpDetails": {
- "name": "string",
- "icon": "string"
}
}
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 |
{- "teamId": 0,
- "params": {
- "active": true,
- "metadataContent": "<?xml version= ...",
- "teamEntityId": 1234567,
- "groupNames": [
- "group1"
]
}
}
{ }
teamId required | integer <int64> |
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));
{- "params": {
- "signingCertPem": "certificate",
- "nameIdFormat": "name_id",
- "assertionConsumerServiceUrl": "assertion",
- "binding": "binding"
}
}
alertVersionId required | string The Alert's version ID |
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/v3/alert-defs-internal/alertVersionId/%7BalertVersionId%7D'; let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{- "alertDef": {
- "alertDefProperties": {
- "name": "My Alert",
- "description": "Alert description",
- "enabled": true,
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED",
- "activeOn": {
- "dayOfWeek": [
- "DAY_OF_WEEK_MONDAY_OR_UNSPECIFIED"
], - "startTime": {
- "hours": 14,
- "minutes": 30
}, - "endTime": {
- "hours": 14,
- "minutes": 30
}
}, - "type": "ALERT_DEF_TYPE_LOGS_IMMEDIATE_OR_UNSPECIFIED",
- "logsImmediate": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "notificationPayloadFilter": "text"
}, - "tracingImmediate": {
- "tracingFilter": {
- "simpleFilter": {
- "tracingLabelFilters": {
- "applicationName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "serviceName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "operationName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "spanFields": [
- {
- "key": "string",
- "filterType": {
- "values": [ ],
- "operation": null
}
}
]
}, - "latencyThresholdMs": "string"
}
}, - "notificationPayloadFilter": [
- "string"
]
}, - "logsThreshold": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "rules": [
- {
- "condition": {
- "threshold": 100,
- "timeWindow": {
- "logsTimeWindowSpecificValue": "LOGS_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "LOGS_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": "text",
- "evaluationDelayMs": 60000
}, - "logsRatioThreshold": {
- "numerator": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "numeratorAlias": "numerator_alias",
- "denominator": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "denominatorAlias": "string",
- "rules": [
- {
- "condition": {
- "threshold": 10,
- "timeWindow": {
- "logsRatioTimeWindowSpecificValue": "LOGS_RATIO_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "LOGS_RATIO_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": "text",
- "groupByFor": "LOGS_RATIO_GROUP_BY_FOR_BOTH_OR_UNSPECIFIED",
- "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "ignoreInfinity": true,
- "evaluationDelayMs": 60000
}, - "logsTimeRelativeThreshold": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "threshold": 10,
- "comparedTo": "LOGS_TIME_RELATIVE_COMPARED_TO_PREVIOUS_HOUR_OR_UNSPECIFIED",
- "conditionType": "LOGS_TIME_RELATIVE_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "ignoreInfinity": true,
- "notificationPayloadFilter": "text",
- "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "evaluationDelayMs": 60000
}, - "metricThreshold": {
- "metricFilter": {
- "promql": "string"
}, - "rules": [
- {
- "condition": {
- "threshold": 0.1,
- "forOverPct": 0,
- "ofTheLast": {
- "metricTimeWindowSpecificValue": "METRIC_TIME_WINDOW_VALUE_MINUTES_1_OR_UNSPECIFIED",
- "metricTimeWindowDynamicDuration": "string"
}, - "conditionType": "METRIC_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "missingValues": {
- "replaceWithZero": true,
- "minNonNullValuesPct": 0
}, - "evaluationDelayMs": 0
}, - "tracingThreshold": {
- "tracingFilter": {
- "simpleFilter": {
- "tracingLabelFilters": {
- "applicationName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "serviceName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "operationName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "spanFields": [
- {
- "key": "string",
- "filterType": {
- "values": [ ],
- "operation": null
}
}
]
}, - "latencyThresholdMs": "string"
}
}, - "rules": [
- {
- "condition": {
- "spanAmount": 0.1,
- "timeWindow": {
- "tracingTimeWindowValue": "TRACING_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "TRACING_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": [
- "string"
]
}, - "flow": {
- "stages": [
- {
- "flowStagesGroups": {
- "groups": [
- {
- "alertDefs": [
- null
], - "nextOp": "NEXT_OP_AND_OR_UNSPECIFIED",
- "alertsOp": "ALERTS_OP_AND_OR_UNSPECIFIED"
}
]
}, - "timeframeMs": 60000,
- "timeframeType": "TIMEFRAME_TYPE_UNSPECIFIED"
}
], - "enforceSuppression": true
}, - "logsAnomaly": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "minimumThreshold": 10,
- "timeWindow": {
- "logsTimeWindowSpecificValue": "LOGS_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "LOGS_ANOMALY_CONDITION_TYPE_MORE_THAN_USUAL_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": "text",
- "evaluationDelayMs": 60000,
- "anomalyAlertSettings": {
- "percentageOfDeviation": 10
}
}, - "metricAnomaly": {
- "metricFilter": {
- "promql": "string"
}, - "rules": [
- {
- "condition": {
- "threshold": 10,
- "forOverPct": 10,
- "ofTheLast": {
- "metricTimeWindowSpecificValue": "METRIC_TIME_WINDOW_VALUE_MINUTES_1_OR_UNSPECIFIED",
- "metricTimeWindowDynamicDuration": "string"
}, - "minNonNullValuesPct": 10,
- "conditionType": "METRIC_ANOMALY_CONDITION_TYPE_MORE_THAN_USUAL_OR_UNSPECIFIED"
}
}
], - "evaluationDelayMs": 60000,
- "anomalyAlertSettings": {
- "percentageOfDeviation": 10
}
}, - "logsNewValue": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "keypathToTrack": "metadata.field",
- "timeWindow": {
- "logsNewValueTimeWindowSpecificValue": "LOGS_NEW_VALUE_TIME_WINDOW_VALUE_HOURS_12_OR_UNSPECIFIED"
}
}
}
], - "notificationPayloadFilter": "text"
}, - "logsUniqueCount": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "maxUniqueCount": "string",
- "timeWindow": {
- "logsUniqueValueTimeWindowSpecificValue": "LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_MINUTE_1_OR_UNSPECIFIED"
}
}
}
], - "notificationPayloadFilter": "text",
- "maxUniqueCountPerGroupByKey": 100,
- "uniqueCountKeypath": "unique_count"
}, - "groupByKeys": [
- "string"
], - "incidentsSettings": {
- "minutes": 10,
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
}, - "notificationGroup": {
- "groupByKeys": [
- "string"
], - "webhooks": [
- {
- "minutes": 10,
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "integration": {
- "integrationId": 123,
- "recipients": {
- "emails": [
- "string"
]
}
}
}
], - "destinations": [
- {
- "connectorId": "string",
- "presetId": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "triggeredRoutingOverrides": {
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- {
- "fieldName": null,
- "template": null
}
], - "connectorConfigFields": [
- {
- "fieldName": null,
- "template": null
}
]
}
}, - "resolvedRouteOverrides": {
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- {
- "fieldName": null,
- "template": null
}
], - "connectorConfigFields": [
- {
- "fieldName": null,
- "template": null
}
]
}
}
}
], - "router": {
- "id": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
}
}, - "notificationGroupExcess": [
- {
- "groupByKeys": [
- "string"
], - "webhooks": [
- {
- "minutes": 10,
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "integration": {
- "integrationId": 123,
- "recipients": {
- "emails": [
- null
]
}
}
}
], - "destinations": [
- {
- "connectorId": "string",
- "presetId": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "triggeredRoutingOverrides": {
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- null
], - "connectorConfigFields": [
- null
]
}
}, - "resolvedRouteOverrides": {
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- null
], - "connectorConfigFields": [
- null
]
}
}
}
], - "router": {
- "id": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
}
}
], - "entityLabels": {
- "property1": "string",
- "property2": "string"
}, - "phantomMode": true,
- "deleted": true
}, - "id": 1,
- "alertVersionId": "string",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z"
}
}
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));
{- "alertDefs": [
- {
- "alertDefProperties": {
- "name": "My Alert",
- "description": "Alert description",
- "enabled": true,
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED",
- "activeOn": {
- "dayOfWeek": [
- "DAY_OF_WEEK_MONDAY_OR_UNSPECIFIED"
], - "startTime": {
- "hours": 14,
- "minutes": 30
}, - "endTime": {
- "hours": 14,
- "minutes": 30
}
}, - "type": "ALERT_DEF_TYPE_LOGS_IMMEDIATE_OR_UNSPECIFIED",
- "logsImmediate": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": null,
- "operation": null
}
], - "subsystemName": [
- {
- "value": null,
- "operation": null
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "notificationPayloadFilter": "text"
}, - "tracingImmediate": {
- "tracingFilter": {
- "simpleFilter": {
- "tracingLabelFilters": {
- "applicationName": [
- {
- "values": [ ],
- "operation": null
}
], - "subsystemName": [
- {
- "values": [ ],
- "operation": null
}
], - "serviceName": [
- {
- "values": [ ],
- "operation": null
}
], - "operationName": [
- {
- "values": [ ],
- "operation": null
}
], - "spanFields": [
- {
- "key": null,
- "filterType": null
}
]
}, - "latencyThresholdMs": "string"
}
}, - "notificationPayloadFilter": [
- "string"
]
}, - "logsThreshold": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": null,
- "operation": null
}
], - "subsystemName": [
- {
- "value": null,
- "operation": null
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "rules": [
- {
- "condition": {
- "threshold": 100,
- "timeWindow": {
- "logsTimeWindowSpecificValue": "LOGS_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "LOGS_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": "text",
- "evaluationDelayMs": 60000
}, - "logsRatioThreshold": {
- "numerator": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": null,
- "operation": null
}
], - "subsystemName": [
- {
- "value": null,
- "operation": null
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "numeratorAlias": "numerator_alias",
- "denominator": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": null,
- "operation": null
}
], - "subsystemName": [
- {
- "value": null,
- "operation": null
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "denominatorAlias": "string",
- "rules": [
- {
- "condition": {
- "threshold": 10,
- "timeWindow": {
- "logsRatioTimeWindowSpecificValue": "LOGS_RATIO_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "LOGS_RATIO_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": "text",
- "groupByFor": "LOGS_RATIO_GROUP_BY_FOR_BOTH_OR_UNSPECIFIED",
- "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "ignoreInfinity": true,
- "evaluationDelayMs": 60000
}, - "logsTimeRelativeThreshold": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": null,
- "operation": null
}
], - "subsystemName": [
- {
- "value": null,
- "operation": null
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "threshold": 10,
- "comparedTo": "LOGS_TIME_RELATIVE_COMPARED_TO_PREVIOUS_HOUR_OR_UNSPECIFIED",
- "conditionType": "LOGS_TIME_RELATIVE_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "ignoreInfinity": true,
- "notificationPayloadFilter": "text",
- "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "evaluationDelayMs": 60000
}, - "metricThreshold": {
- "metricFilter": {
- "promql": "string"
}, - "rules": [
- {
- "condition": {
- "threshold": 0.1,
- "forOverPct": 0,
- "ofTheLast": {
- "metricTimeWindowSpecificValue": "METRIC_TIME_WINDOW_VALUE_MINUTES_1_OR_UNSPECIFIED",
- "metricTimeWindowDynamicDuration": "string"
}, - "conditionType": "METRIC_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "missingValues": {
- "replaceWithZero": true,
- "minNonNullValuesPct": 0
}, - "evaluationDelayMs": 0
}, - "tracingThreshold": {
- "tracingFilter": {
- "simpleFilter": {
- "tracingLabelFilters": {
- "applicationName": [
- {
- "values": [ ],
- "operation": null
}
], - "subsystemName": [
- {
- "values": [ ],
- "operation": null
}
], - "serviceName": [
- {
- "values": [ ],
- "operation": null
}
], - "operationName": [
- {
- "values": [ ],
- "operation": null
}
], - "spanFields": [
- {
- "key": null,
- "filterType": null
}
]
}, - "latencyThresholdMs": "string"
}
}, - "rules": [
- {
- "condition": {
- "spanAmount": 0.1,
- "timeWindow": {
- "tracingTimeWindowValue": "TRACING_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "TRACING_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": [
- "string"
]
}, - "flow": {
- "stages": [
- {
- "flowStagesGroups": {
- "groups": [
- {
- "alertDefs": [ ],
- "nextOp": null,
- "alertsOp": null
}
]
}, - "timeframeMs": 60000,
- "timeframeType": "TIMEFRAME_TYPE_UNSPECIFIED"
}
], - "enforceSuppression": true
}, - "logsAnomaly": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": null,
- "operation": null
}
], - "subsystemName": [
- {
- "value": null,
- "operation": null
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "minimumThreshold": 10,
- "timeWindow": {
- "logsTimeWindowSpecificValue": "LOGS_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "LOGS_ANOMALY_CONDITION_TYPE_MORE_THAN_USUAL_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": "text",
- "evaluationDelayMs": 60000,
- "anomalyAlertSettings": {
- "percentageOfDeviation": 10
}
}, - "metricAnomaly": {
- "metricFilter": {
- "promql": "string"
}, - "rules": [
- {
- "condition": {
- "threshold": 10,
- "forOverPct": 10,
- "ofTheLast": {
- "metricTimeWindowSpecificValue": "METRIC_TIME_WINDOW_VALUE_MINUTES_1_OR_UNSPECIFIED",
- "metricTimeWindowDynamicDuration": "string"
}, - "minNonNullValuesPct": 10,
- "conditionType": "METRIC_ANOMALY_CONDITION_TYPE_MORE_THAN_USUAL_OR_UNSPECIFIED"
}
}
], - "evaluationDelayMs": 60000,
- "anomalyAlertSettings": {
- "percentageOfDeviation": 10
}
}, - "logsNewValue": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": null,
- "operation": null
}
], - "subsystemName": [
- {
- "value": null,
- "operation": null
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "keypathToTrack": "metadata.field",
- "timeWindow": {
- "logsNewValueTimeWindowSpecificValue": "LOGS_NEW_VALUE_TIME_WINDOW_VALUE_HOURS_12_OR_UNSPECIFIED"
}
}
}
], - "notificationPayloadFilter": "text"
}, - "logsUniqueCount": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": null,
- "operation": null
}
], - "subsystemName": [
- {
- "value": null,
- "operation": null
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "maxUniqueCount": "string",
- "timeWindow": {
- "logsUniqueValueTimeWindowSpecificValue": "LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_MINUTE_1_OR_UNSPECIFIED"
}
}
}
], - "notificationPayloadFilter": "text",
- "maxUniqueCountPerGroupByKey": 100,
- "uniqueCountKeypath": "unique_count"
}, - "groupByKeys": [
- "string"
], - "incidentsSettings": {
- "minutes": 10,
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
}, - "notificationGroup": {
- "groupByKeys": [
- "string"
], - "webhooks": [
- {
- "minutes": 10,
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "integration": {
- "integrationId": 123,
- "recipients": {
- "emails": [
- null
]
}
}
}
], - "destinations": [
- {
- "connectorId": "string",
- "presetId": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "triggeredRoutingOverrides": {
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- null
], - "connectorConfigFields": [
- null
]
}
}, - "resolvedRouteOverrides": {
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- null
], - "connectorConfigFields": [
- null
]
}
}
}
], - "router": {
- "id": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
}
}, - "notificationGroupExcess": [
- {
- "groupByKeys": [
- "string"
], - "webhooks": [
- {
- "minutes": 10,
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "integration": {
- "integrationId": 123,
- "recipients": {
- "emails": [ ]
}
}
}
], - "destinations": [
- {
- "connectorId": "string",
- "presetId": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "triggeredRoutingOverrides": {
- "configOverrides": {
- "outputSchemaId": null,
- "messageConfigFields": [ ],
- "connectorConfigFields": [ ]
}
}, - "resolvedRouteOverrides": {
- "configOverrides": {
- "outputSchemaId": null,
- "messageConfigFields": [ ],
- "connectorConfigFields": [ ]
}
}
}
], - "router": {
- "id": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
}
}
], - "entityLabels": {
- "property1": "string",
- "property2": "string"
}, - "phantomMode": true,
- "deleted": true
}, - "id": 1,
- "alertVersionId": "string",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z"
}
]
}
name required | string |
description | string |
enabled required | boolean |
priority | string (v3AlertDefPriority) Default: "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED" Enum: "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED" "ALERT_DEF_PRIORITY_P4" "ALERT_DEF_PRIORITY_P3" "ALERT_DEF_PRIORITY_P2" "ALERT_DEF_PRIORITY_P1" |
object (Activity Schedule) Defines when an alert should be active based on days of the week and time windows | |
type required | string (v3AlertDefType) Default: "ALERT_DEF_TYPE_LOGS_IMMEDIATE_OR_UNSPECIFIED" Enum: "ALERT_DEF_TYPE_LOGS_IMMEDIATE_OR_UNSPECIFIED" "ALERT_DEF_TYPE_LOGS_THRESHOLD" "ALERT_DEF_TYPE_LOGS_ANOMALY" "ALERT_DEF_TYPE_LOGS_RATIO_THRESHOLD" "ALERT_DEF_TYPE_LOGS_NEW_VALUE" "ALERT_DEF_TYPE_LOGS_UNIQUE_COUNT" "ALERT_DEF_TYPE_LOGS_TIME_RELATIVE_THRESHOLD" "ALERT_DEF_TYPE_METRIC_THRESHOLD" "ALERT_DEF_TYPE_METRIC_ANOMALY" "ALERT_DEF_TYPE_TRACING_IMMEDIATE" "ALERT_DEF_TYPE_TRACING_THRESHOLD" "ALERT_DEF_TYPE_FLOW" |
object (Logs Immediate Alert Type) Configuration for immediate alerts triggered on log entries matching specific filters | |
object (Tracing Immediate Alert Type) Configuration for immediate alerts triggered on trace entries | |
object (Logs Threshold Alert Type) Configuration for alerts triggered when log counts exceed or fall below specified thresholds | |
object (Logs Ratio Threshold Alert Type) Configuration for alerts based on the ratio between two log queries | |
object (Logs Time Relative Threshold Alert Type) Configuration for alerts comparing log counts between different time periods | |
object (Metric Threshold Alert Type) Configuration for alerts based on metric threshold violations | |
object (Tracing Threshold Alert Type) Configuration for alerts based on trace count thresholds | |
object (Flow Alert Type) Configuration for flow-based alerts with multiple stages | |
object (Logs Anomaly Alert Type) Configuration for alerts triggered by anomalous log patterns | |
object (Metric Anomaly Alert Type) Configuration for alerts triggered by anomalous metric patterns | |
object (Logs New Value Alert Type) Configuration for alerts triggered by new values appearing in logs | |
object (Logs Unique Count Alert Type) Configuration for alerts based on unique value counts in logs | |
groupByKeys | Array of strings |
object (v3AlertDefIncidentSettings) | |
object (v3AlertDefNotificationGroup) | |
Array of objects (v3AlertDefNotificationGroup) | |
object | |
phantomMode | boolean |
deleted | boolean |
{- "name": "My Alert",
- "description": "Alert description",
- "enabled": true,
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED",
- "activeOn": {
- "dayOfWeek": [
- "DAY_OF_WEEK_MONDAY_OR_UNSPECIFIED"
], - "startTime": {
- "hours": 14,
- "minutes": 30
}, - "endTime": {
- "hours": 14,
- "minutes": 30
}
}, - "type": "ALERT_DEF_TYPE_LOGS_IMMEDIATE_OR_UNSPECIFIED",
- "logsImmediate": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "notificationPayloadFilter": "text"
}, - "tracingImmediate": {
- "tracingFilter": {
- "simpleFilter": {
- "tracingLabelFilters": {
- "applicationName": [
- {
- "values": [
- "string"
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "values": [
- "string"
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "serviceName": [
- {
- "values": [
- "string"
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "operationName": [
- {
- "values": [
- "string"
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "spanFields": [
- {
- "key": "string",
- "filterType": {
- "values": [
- "string"
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
}
]
}, - "latencyThresholdMs": "string"
}
}, - "notificationPayloadFilter": [
- "string"
]
}, - "logsThreshold": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "rules": [
- {
- "condition": {
- "threshold": 100,
- "timeWindow": {
- "logsTimeWindowSpecificValue": "LOGS_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "LOGS_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": "text",
- "evaluationDelayMs": 60000
}, - "logsRatioThreshold": {
- "numerator": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "numeratorAlias": "numerator_alias",
- "denominator": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "denominatorAlias": "string",
- "rules": [
- {
- "condition": {
- "threshold": 10,
- "timeWindow": {
- "logsRatioTimeWindowSpecificValue": "LOGS_RATIO_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "LOGS_RATIO_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": "text",
- "groupByFor": "LOGS_RATIO_GROUP_BY_FOR_BOTH_OR_UNSPECIFIED",
- "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "ignoreInfinity": true,
- "evaluationDelayMs": 60000
}, - "logsTimeRelativeThreshold": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "threshold": 10,
- "comparedTo": "LOGS_TIME_RELATIVE_COMPARED_TO_PREVIOUS_HOUR_OR_UNSPECIFIED",
- "conditionType": "LOGS_TIME_RELATIVE_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "ignoreInfinity": true,
- "notificationPayloadFilter": "text",
- "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "evaluationDelayMs": 60000
}, - "metricThreshold": {
- "metricFilter": {
- "promql": "string"
}, - "rules": [
- {
- "condition": {
- "threshold": 0.1,
- "forOverPct": 0,
- "ofTheLast": {
- "metricTimeWindowSpecificValue": "METRIC_TIME_WINDOW_VALUE_MINUTES_1_OR_UNSPECIFIED",
- "metricTimeWindowDynamicDuration": "string"
}, - "conditionType": "METRIC_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "missingValues": {
- "replaceWithZero": true,
- "minNonNullValuesPct": 0
}, - "evaluationDelayMs": 0
}, - "tracingThreshold": {
- "tracingFilter": {
- "simpleFilter": {
- "tracingLabelFilters": {
- "applicationName": [
- {
- "values": [
- "string"
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "values": [
- "string"
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "serviceName": [
- {
- "values": [
- "string"
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "operationName": [
- {
- "values": [
- "string"
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "spanFields": [
- {
- "key": "string",
- "filterType": {
- "values": [
- "string"
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
}
]
}, - "latencyThresholdMs": "string"
}
}, - "rules": [
- {
- "condition": {
- "spanAmount": 0.1,
- "timeWindow": {
- "tracingTimeWindowValue": "TRACING_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "TRACING_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": [
- "string"
]
}, - "flow": {
- "stages": [
- {
- "flowStagesGroups": {
- "groups": [
- {
- "alertDefs": [
- {
- "id": 1,
- "not": true
}
], - "nextOp": "NEXT_OP_AND_OR_UNSPECIFIED",
- "alertsOp": "ALERTS_OP_AND_OR_UNSPECIFIED"
}
]
}, - "timeframeMs": 60000,
- "timeframeType": "TIMEFRAME_TYPE_UNSPECIFIED"
}
], - "enforceSuppression": true
}, - "logsAnomaly": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "minimumThreshold": 10,
- "timeWindow": {
- "logsTimeWindowSpecificValue": "LOGS_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "LOGS_ANOMALY_CONDITION_TYPE_MORE_THAN_USUAL_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": "text",
- "evaluationDelayMs": 60000,
- "anomalyAlertSettings": {
- "percentageOfDeviation": 10
}
}, - "metricAnomaly": {
- "metricFilter": {
- "promql": "string"
}, - "rules": [
- {
- "condition": {
- "threshold": 10,
- "forOverPct": 10,
- "ofTheLast": {
- "metricTimeWindowSpecificValue": "METRIC_TIME_WINDOW_VALUE_MINUTES_1_OR_UNSPECIFIED",
- "metricTimeWindowDynamicDuration": "string"
}, - "minNonNullValuesPct": 10,
- "conditionType": "METRIC_ANOMALY_CONDITION_TYPE_MORE_THAN_USUAL_OR_UNSPECIFIED"
}
}
], - "evaluationDelayMs": 60000,
- "anomalyAlertSettings": {
- "percentageOfDeviation": 10
}
}, - "logsNewValue": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "keypathToTrack": "metadata.field",
- "timeWindow": {
- "logsNewValueTimeWindowSpecificValue": "LOGS_NEW_VALUE_TIME_WINDOW_VALUE_HOURS_12_OR_UNSPECIFIED"
}
}
}
], - "notificationPayloadFilter": "text"
}, - "logsUniqueCount": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "maxUniqueCount": "string",
- "timeWindow": {
- "logsUniqueValueTimeWindowSpecificValue": "LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_MINUTE_1_OR_UNSPECIFIED"
}
}
}
], - "notificationPayloadFilter": "text",
- "maxUniqueCountPerGroupByKey": 100,
- "uniqueCountKeypath": "unique_count"
}, - "groupByKeys": [
- "string"
], - "incidentsSettings": {
- "minutes": 10,
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
}, - "notificationGroup": {
- "groupByKeys": [
- "string"
], - "webhooks": [
- {
- "minutes": 10,
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "integration": {
- "integrationId": 123,
- "recipients": {
- "emails": [
- "string"
]
}
}
}
], - "destinations": [
- {
- "connectorId": "string",
- "presetId": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "triggeredRoutingOverrides": {
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- {
- "fieldName": "string",
- "template": "string"
}
], - "connectorConfigFields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}
}, - "resolvedRouteOverrides": {
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- {
- "fieldName": "string",
- "template": "string"
}
], - "connectorConfigFields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}
}
}
], - "router": {
- "id": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
}
}, - "notificationGroupExcess": [
- {
- "groupByKeys": [
- "string"
], - "webhooks": [
- {
- "minutes": 10,
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "integration": {
- "integrationId": 123,
- "recipients": {
- "emails": [
- "string"
]
}
}
}
], - "destinations": [
- {
- "connectorId": "string",
- "presetId": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "triggeredRoutingOverrides": {
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- {
- "fieldName": "string",
- "template": "string"
}
], - "connectorConfigFields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}
}, - "resolvedRouteOverrides": {
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- {
- "fieldName": "string",
- "template": "string"
}
], - "connectorConfigFields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}
}
}
], - "router": {
- "id": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
}
}
], - "entityLabels": {
- "property1": "string",
- "property2": "string"
}, - "phantomMode": true,
- "deleted": true
}
{- "alertDef": {
- "alertDefProperties": {
- "name": "My Alert",
- "description": "Alert description",
- "enabled": true,
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED",
- "activeOn": {
- "dayOfWeek": [
- "DAY_OF_WEEK_MONDAY_OR_UNSPECIFIED"
], - "startTime": {
- "hours": 14,
- "minutes": 30
}, - "endTime": {
- "hours": 14,
- "minutes": 30
}
}, - "type": "ALERT_DEF_TYPE_LOGS_IMMEDIATE_OR_UNSPECIFIED",
- "logsImmediate": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "notificationPayloadFilter": "text"
}, - "tracingImmediate": {
- "tracingFilter": {
- "simpleFilter": {
- "tracingLabelFilters": {
- "applicationName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "serviceName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "operationName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "spanFields": [
- {
- "key": "string",
- "filterType": {
- "values": [ ],
- "operation": null
}
}
]
}, - "latencyThresholdMs": "string"
}
}, - "notificationPayloadFilter": [
- "string"
]
}, - "logsThreshold": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "rules": [
- {
- "condition": {
- "threshold": 100,
- "timeWindow": {
- "logsTimeWindowSpecificValue": "LOGS_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "LOGS_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": "text",
- "evaluationDelayMs": 60000
}, - "logsRatioThreshold": {
- "numerator": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "numeratorAlias": "numerator_alias",
- "denominator": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "denominatorAlias": "string",
- "rules": [
- {
- "condition": {
- "threshold": 10,
- "timeWindow": {
- "logsRatioTimeWindowSpecificValue": "LOGS_RATIO_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "LOGS_RATIO_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": "text",
- "groupByFor": "LOGS_RATIO_GROUP_BY_FOR_BOTH_OR_UNSPECIFIED",
- "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "ignoreInfinity": true,
- "evaluationDelayMs": 60000
}, - "logsTimeRelativeThreshold": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "threshold": 10,
- "comparedTo": "LOGS_TIME_RELATIVE_COMPARED_TO_PREVIOUS_HOUR_OR_UNSPECIFIED",
- "conditionType": "LOGS_TIME_RELATIVE_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "ignoreInfinity": true,
- "notificationPayloadFilter": "text",
- "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "evaluationDelayMs": 60000
}, - "metricThreshold": {
- "metricFilter": {
- "promql": "string"
}, - "rules": [
- {
- "condition": {
- "threshold": 0.1,
- "forOverPct": 0,
- "ofTheLast": {
- "metricTimeWindowSpecificValue": "METRIC_TIME_WINDOW_VALUE_MINUTES_1_OR_UNSPECIFIED",
- "metricTimeWindowDynamicDuration": "string"
}, - "conditionType": "METRIC_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "missingValues": {
- "replaceWithZero": true,
- "minNonNullValuesPct": 0
}, - "evaluationDelayMs": 0
}, - "tracingThreshold": {
- "tracingFilter": {
- "simpleFilter": {
- "tracingLabelFilters": {
- "applicationName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "serviceName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "operationName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "spanFields": [
- {
- "key": "string",
- "filterType": {
- "values": [ ],
- "operation": null
}
}
]
}, - "latencyThresholdMs": "string"
}
}, - "rules": [
- {
- "condition": {
- "spanAmount": 0.1,
- "timeWindow": {
- "tracingTimeWindowValue": "TRACING_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "TRACING_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": [
- "string"
]
}, - "flow": {
- "stages": [
- {
- "flowStagesGroups": {
- "groups": [
- {
- "alertDefs": [
- null
], - "nextOp": "NEXT_OP_AND_OR_UNSPECIFIED",
- "alertsOp": "ALERTS_OP_AND_OR_UNSPECIFIED"
}
]
}, - "timeframeMs": 60000,
- "timeframeType": "TIMEFRAME_TYPE_UNSPECIFIED"
}
], - "enforceSuppression": true
}, - "logsAnomaly": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "minimumThreshold": 10,
- "timeWindow": {
- "logsTimeWindowSpecificValue": "LOGS_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "LOGS_ANOMALY_CONDITION_TYPE_MORE_THAN_USUAL_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": "text",
- "evaluationDelayMs": 60000,
- "anomalyAlertSettings": {
- "percentageOfDeviation": 10
}
}, - "metricAnomaly": {
- "metricFilter": {
- "promql": "string"
}, - "rules": [
- {
- "condition": {
- "threshold": 10,
- "forOverPct": 10,
- "ofTheLast": {
- "metricTimeWindowSpecificValue": "METRIC_TIME_WINDOW_VALUE_MINUTES_1_OR_UNSPECIFIED",
- "metricTimeWindowDynamicDuration": "string"
}, - "minNonNullValuesPct": 10,
- "conditionType": "METRIC_ANOMALY_CONDITION_TYPE_MORE_THAN_USUAL_OR_UNSPECIFIED"
}
}
], - "evaluationDelayMs": 60000,
- "anomalyAlertSettings": {
- "percentageOfDeviation": 10
}
}, - "logsNewValue": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "keypathToTrack": "metadata.field",
- "timeWindow": {
- "logsNewValueTimeWindowSpecificValue": "LOGS_NEW_VALUE_TIME_WINDOW_VALUE_HOURS_12_OR_UNSPECIFIED"
}
}
}
], - "notificationPayloadFilter": "text"
}, - "logsUniqueCount": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "maxUniqueCount": "string",
- "timeWindow": {
- "logsUniqueValueTimeWindowSpecificValue": "LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_MINUTE_1_OR_UNSPECIFIED"
}
}
}
], - "notificationPayloadFilter": "text",
- "maxUniqueCountPerGroupByKey": 100,
- "uniqueCountKeypath": "unique_count"
}, - "groupByKeys": [
- "string"
], - "incidentsSettings": {
- "minutes": 10,
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
}, - "notificationGroup": {
- "groupByKeys": [
- "string"
], - "webhooks": [
- {
- "minutes": 10,
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "integration": {
- "integrationId": 123,
- "recipients": {
- "emails": [
- "string"
]
}
}
}
], - "destinations": [
- {
- "connectorId": "string",
- "presetId": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "triggeredRoutingOverrides": {
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- {
- "fieldName": null,
- "template": null
}
], - "connectorConfigFields": [
- {
- "fieldName": null,
- "template": null
}
]
}
}, - "resolvedRouteOverrides": {
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- {
- "fieldName": null,
- "template": null
}
], - "connectorConfigFields": [
- {
- "fieldName": null,
- "template": null
}
]
}
}
}
], - "router": {
- "id": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
}
}, - "notificationGroupExcess": [
- {
- "groupByKeys": [
- "string"
], - "webhooks": [
- {
- "minutes": 10,
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "integration": {
- "integrationId": 123,
- "recipients": {
- "emails": [
- null
]
}
}
}
], - "destinations": [
- {
- "connectorId": "string",
- "presetId": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "triggeredRoutingOverrides": {
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- null
], - "connectorConfigFields": [
- null
]
}
}, - "resolvedRouteOverrides": {
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- null
], - "connectorConfigFields": [
- null
]
}
}
}
], - "router": {
- "id": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
}
}
], - "entityLabels": {
- "property1": "string",
- "property2": "string"
}, - "phantomMode": true,
- "deleted": true
}, - "id": 1,
- "alertVersionId": "string",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z"
}
}
Request to replace an existing alert definition
required | object (Alert Definition Properties) User-configurable properties of an alert definition |
id required | string |
{- "alertDefProperties": {
- "name": "My Alert",
- "description": "Alert description",
- "enabled": true,
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED",
- "activeOn": {
- "dayOfWeek": [
- "DAY_OF_WEEK_MONDAY_OR_UNSPECIFIED"
], - "startTime": {
- "hours": 14,
- "minutes": 30
}, - "endTime": {
- "hours": 14,
- "minutes": 30
}
}, - "type": "ALERT_DEF_TYPE_LOGS_IMMEDIATE_OR_UNSPECIFIED",
- "logsImmediate": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "notificationPayloadFilter": "text"
}, - "tracingImmediate": {
- "tracingFilter": {
- "simpleFilter": {
- "tracingLabelFilters": {
- "applicationName": [
- {
- "values": [
- "string"
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "values": [
- "string"
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "serviceName": [
- {
- "values": [
- "string"
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "operationName": [
- {
- "values": [
- "string"
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "spanFields": [
- {
- "key": "string",
- "filterType": {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
}
]
}, - "latencyThresholdMs": "string"
}
}, - "notificationPayloadFilter": [
- "string"
]
}, - "logsThreshold": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "rules": [
- {
- "condition": {
- "threshold": 100,
- "timeWindow": {
- "logsTimeWindowSpecificValue": "LOGS_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "LOGS_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": "text",
- "evaluationDelayMs": 60000
}, - "logsRatioThreshold": {
- "numerator": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "numeratorAlias": "numerator_alias",
- "denominator": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "denominatorAlias": "string",
- "rules": [
- {
- "condition": {
- "threshold": 10,
- "timeWindow": {
- "logsRatioTimeWindowSpecificValue": "LOGS_RATIO_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "LOGS_RATIO_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": "text",
- "groupByFor": "LOGS_RATIO_GROUP_BY_FOR_BOTH_OR_UNSPECIFIED",
- "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "ignoreInfinity": true,
- "evaluationDelayMs": 60000
}, - "logsTimeRelativeThreshold": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "threshold": 10,
- "comparedTo": "LOGS_TIME_RELATIVE_COMPARED_TO_PREVIOUS_HOUR_OR_UNSPECIFIED",
- "conditionType": "LOGS_TIME_RELATIVE_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "ignoreInfinity": true,
- "notificationPayloadFilter": "text",
- "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "evaluationDelayMs": 60000
}, - "metricThreshold": {
- "metricFilter": {
- "promql": "string"
}, - "rules": [
- {
- "condition": {
- "threshold": 0.1,
- "forOverPct": 0,
- "ofTheLast": {
- "metricTimeWindowSpecificValue": "METRIC_TIME_WINDOW_VALUE_MINUTES_1_OR_UNSPECIFIED",
- "metricTimeWindowDynamicDuration": "string"
}, - "conditionType": "METRIC_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "missingValues": {
- "replaceWithZero": true,
- "minNonNullValuesPct": 0
}, - "evaluationDelayMs": 0
}, - "tracingThreshold": {
- "tracingFilter": {
- "simpleFilter": {
- "tracingLabelFilters": {
- "applicationName": [
- {
- "values": [
- "string"
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "values": [
- "string"
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "serviceName": [
- {
- "values": [
- "string"
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "operationName": [
- {
- "values": [
- "string"
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "spanFields": [
- {
- "key": "string",
- "filterType": {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
}
]
}, - "latencyThresholdMs": "string"
}
}, - "rules": [
- {
- "condition": {
- "spanAmount": 0.1,
- "timeWindow": {
- "tracingTimeWindowValue": "TRACING_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "TRACING_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": [
- "string"
]
}, - "flow": {
- "stages": [
- {
- "flowStagesGroups": {
- "groups": [
- {
- "alertDefs": [
- {
- "id": null,
- "not": null
}
], - "nextOp": "NEXT_OP_AND_OR_UNSPECIFIED",
- "alertsOp": "ALERTS_OP_AND_OR_UNSPECIFIED"
}
]
}, - "timeframeMs": 60000,
- "timeframeType": "TIMEFRAME_TYPE_UNSPECIFIED"
}
], - "enforceSuppression": true
}, - "logsAnomaly": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "minimumThreshold": 10,
- "timeWindow": {
- "logsTimeWindowSpecificValue": "LOGS_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "LOGS_ANOMALY_CONDITION_TYPE_MORE_THAN_USUAL_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": "text",
- "evaluationDelayMs": 60000,
- "anomalyAlertSettings": {
- "percentageOfDeviation": 10
}
}, - "metricAnomaly": {
- "metricFilter": {
- "promql": "string"
}, - "rules": [
- {
- "condition": {
- "threshold": 10,
- "forOverPct": 10,
- "ofTheLast": {
- "metricTimeWindowSpecificValue": "METRIC_TIME_WINDOW_VALUE_MINUTES_1_OR_UNSPECIFIED",
- "metricTimeWindowDynamicDuration": "string"
}, - "minNonNullValuesPct": 10,
- "conditionType": "METRIC_ANOMALY_CONDITION_TYPE_MORE_THAN_USUAL_OR_UNSPECIFIED"
}
}
], - "evaluationDelayMs": 60000,
- "anomalyAlertSettings": {
- "percentageOfDeviation": 10
}
}, - "logsNewValue": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "keypathToTrack": "metadata.field",
- "timeWindow": {
- "logsNewValueTimeWindowSpecificValue": "LOGS_NEW_VALUE_TIME_WINDOW_VALUE_HOURS_12_OR_UNSPECIFIED"
}
}
}
], - "notificationPayloadFilter": "text"
}, - "logsUniqueCount": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "maxUniqueCount": "string",
- "timeWindow": {
- "logsUniqueValueTimeWindowSpecificValue": "LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_MINUTE_1_OR_UNSPECIFIED"
}
}
}
], - "notificationPayloadFilter": "text",
- "maxUniqueCountPerGroupByKey": 100,
- "uniqueCountKeypath": "unique_count"
}, - "groupByKeys": [
- "string"
], - "incidentsSettings": {
- "minutes": 10,
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
}, - "notificationGroup": {
- "groupByKeys": [
- "string"
], - "webhooks": [
- {
- "minutes": 10,
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "integration": {
- "integrationId": 123,
- "recipients": {
- "emails": [
- "string"
]
}
}
}
], - "destinations": [
- {
- "connectorId": "string",
- "presetId": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "triggeredRoutingOverrides": {
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- {
- "fieldName": "string",
- "template": "string"
}
], - "connectorConfigFields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}
}, - "resolvedRouteOverrides": {
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- {
- "fieldName": "string",
- "template": "string"
}
], - "connectorConfigFields": [
- {
- "fieldName": "string",
- "template": "string"
}
]
}
}
}
], - "router": {
- "id": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
}
}, - "notificationGroupExcess": [
- {
- "groupByKeys": [
- "string"
], - "webhooks": [
- {
- "minutes": 10,
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "integration": {
- "integrationId": 123,
- "recipients": {
- "emails": [
- "string"
]
}
}
}
], - "destinations": [
- {
- "connectorId": "string",
- "presetId": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "triggeredRoutingOverrides": {
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- {
- "fieldName": null,
- "template": null
}
], - "connectorConfigFields": [
- {
- "fieldName": null,
- "template": null
}
]
}
}, - "resolvedRouteOverrides": {
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- {
- "fieldName": null,
- "template": null
}
], - "connectorConfigFields": [
- {
- "fieldName": null,
- "template": null
}
]
}
}
}
], - "router": {
- "id": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
}
}
], - "entityLabels": {
- "property1": "string",
- "property2": "string"
}, - "phantomMode": true,
- "deleted": true
}, - "id": "alert-123"
}
{- "alertDef": {
- "alertDefProperties": {
- "name": "My Alert",
- "description": "Alert description",
- "enabled": true,
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED",
- "activeOn": {
- "dayOfWeek": [
- "DAY_OF_WEEK_MONDAY_OR_UNSPECIFIED"
], - "startTime": {
- "hours": 14,
- "minutes": 30
}, - "endTime": {
- "hours": 14,
- "minutes": 30
}
}, - "type": "ALERT_DEF_TYPE_LOGS_IMMEDIATE_OR_UNSPECIFIED",
- "logsImmediate": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "notificationPayloadFilter": "text"
}, - "tracingImmediate": {
- "tracingFilter": {
- "simpleFilter": {
- "tracingLabelFilters": {
- "applicationName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "serviceName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "operationName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "spanFields": [
- {
- "key": "string",
- "filterType": {
- "values": [ ],
- "operation": null
}
}
]
}, - "latencyThresholdMs": "string"
}
}, - "notificationPayloadFilter": [
- "string"
]
}, - "logsThreshold": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "rules": [
- {
- "condition": {
- "threshold": 100,
- "timeWindow": {
- "logsTimeWindowSpecificValue": "LOGS_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "LOGS_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": "text",
- "evaluationDelayMs": 60000
}, - "logsRatioThreshold": {
- "numerator": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "numeratorAlias": "numerator_alias",
- "denominator": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "denominatorAlias": "string",
- "rules": [
- {
- "condition": {
- "threshold": 10,
- "timeWindow": {
- "logsRatioTimeWindowSpecificValue": "LOGS_RATIO_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "LOGS_RATIO_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": "text",
- "groupByFor": "LOGS_RATIO_GROUP_BY_FOR_BOTH_OR_UNSPECIFIED",
- "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "ignoreInfinity": true,
- "evaluationDelayMs": 60000
}, - "logsTimeRelativeThreshold": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "threshold": 10,
- "comparedTo": "LOGS_TIME_RELATIVE_COMPARED_TO_PREVIOUS_HOUR_OR_UNSPECIFIED",
- "conditionType": "LOGS_TIME_RELATIVE_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "ignoreInfinity": true,
- "notificationPayloadFilter": "text",
- "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "evaluationDelayMs": 60000
}, - "metricThreshold": {
- "metricFilter": {
- "promql": "string"
}, - "rules": [
- {
- "condition": {
- "threshold": 0.1,
- "forOverPct": 0,
- "ofTheLast": {
- "metricTimeWindowSpecificValue": "METRIC_TIME_WINDOW_VALUE_MINUTES_1_OR_UNSPECIFIED",
- "metricTimeWindowDynamicDuration": "string"
}, - "conditionType": "METRIC_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "missingValues": {
- "replaceWithZero": true,
- "minNonNullValuesPct": 0
}, - "evaluationDelayMs": 0
}, - "tracingThreshold": {
- "tracingFilter": {
- "simpleFilter": {
- "tracingLabelFilters": {
- "applicationName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "serviceName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "operationName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "spanFields": [
- {
- "key": "string",
- "filterType": {
- "values": [ ],
- "operation": null
}
}
]
}, - "latencyThresholdMs": "string"
}
}, - "rules": [
- {
- "condition": {
- "spanAmount": 0.1,
- "timeWindow": {
- "tracingTimeWindowValue": "TRACING_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "TRACING_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": [
- "string"
]
}, - "flow": {
- "stages": [
- {
- "flowStagesGroups": {
- "groups": [
- {
- "alertDefs": [
- null
], - "nextOp": "NEXT_OP_AND_OR_UNSPECIFIED",
- "alertsOp": "ALERTS_OP_AND_OR_UNSPECIFIED"
}
]
}, - "timeframeMs": 60000,
- "timeframeType": "TIMEFRAME_TYPE_UNSPECIFIED"
}
], - "enforceSuppression": true
}, - "logsAnomaly": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "minimumThreshold": 10,
- "timeWindow": {
- "logsTimeWindowSpecificValue": "LOGS_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "LOGS_ANOMALY_CONDITION_TYPE_MORE_THAN_USUAL_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": "text",
- "evaluationDelayMs": 60000,
- "anomalyAlertSettings": {
- "percentageOfDeviation": 10
}
}, - "metricAnomaly": {
- "metricFilter": {
- "promql": "string"
}, - "rules": [
- {
- "condition": {
- "threshold": 10,
- "forOverPct": 10,
- "ofTheLast": {
- "metricTimeWindowSpecificValue": "METRIC_TIME_WINDOW_VALUE_MINUTES_1_OR_UNSPECIFIED",
- "metricTimeWindowDynamicDuration": "string"
}, - "minNonNullValuesPct": 10,
- "conditionType": "METRIC_ANOMALY_CONDITION_TYPE_MORE_THAN_USUAL_OR_UNSPECIFIED"
}
}
], - "evaluationDelayMs": 60000,
- "anomalyAlertSettings": {
- "percentageOfDeviation": 10
}
}, - "logsNewValue": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "keypathToTrack": "metadata.field",
- "timeWindow": {
- "logsNewValueTimeWindowSpecificValue": "LOGS_NEW_VALUE_TIME_WINDOW_VALUE_HOURS_12_OR_UNSPECIFIED"
}
}
}
], - "notificationPayloadFilter": "text"
}, - "logsUniqueCount": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "maxUniqueCount": "string",
- "timeWindow": {
- "logsUniqueValueTimeWindowSpecificValue": "LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_MINUTE_1_OR_UNSPECIFIED"
}
}
}
], - "notificationPayloadFilter": "text",
- "maxUniqueCountPerGroupByKey": 100,
- "uniqueCountKeypath": "unique_count"
}, - "groupByKeys": [
- "string"
], - "incidentsSettings": {
- "minutes": 10,
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
}, - "notificationGroup": {
- "groupByKeys": [
- "string"
], - "webhooks": [
- {
- "minutes": 10,
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "integration": {
- "integrationId": 123,
- "recipients": {
- "emails": [
- "string"
]
}
}
}
], - "destinations": [
- {
- "connectorId": "string",
- "presetId": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "triggeredRoutingOverrides": {
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- {
- "fieldName": null,
- "template": null
}
], - "connectorConfigFields": [
- {
- "fieldName": null,
- "template": null
}
]
}
}, - "resolvedRouteOverrides": {
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- {
- "fieldName": null,
- "template": null
}
], - "connectorConfigFields": [
- {
- "fieldName": null,
- "template": null
}
]
}
}
}
], - "router": {
- "id": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
}
}, - "notificationGroupExcess": [
- {
- "groupByKeys": [
- "string"
], - "webhooks": [
- {
- "minutes": 10,
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "integration": {
- "integrationId": 123,
- "recipients": {
- "emails": [
- null
]
}
}
}
], - "destinations": [
- {
- "connectorId": "string",
- "presetId": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "triggeredRoutingOverrides": {
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- null
], - "connectorConfigFields": [
- null
]
}
}, - "resolvedRouteOverrides": {
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- null
], - "connectorConfigFields": [
- null
]
}
}
}
], - "router": {
- "id": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
}
}
], - "entityLabels": {
- "property1": "string",
- "property2": "string"
}, - "phantomMode": true,
- "deleted": true
}, - "id": 1,
- "alertVersionId": "string",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z"
}
}
alertVersionId required | string |
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/v3/alert-defs/alertVersionId/%7BalertVersionId%7D'; let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{- "alertDef": {
- "alertDefProperties": {
- "name": "My Alert",
- "description": "Alert description",
- "enabled": true,
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED",
- "activeOn": {
- "dayOfWeek": [
- "DAY_OF_WEEK_MONDAY_OR_UNSPECIFIED"
], - "startTime": {
- "hours": 14,
- "minutes": 30
}, - "endTime": {
- "hours": 14,
- "minutes": 30
}
}, - "type": "ALERT_DEF_TYPE_LOGS_IMMEDIATE_OR_UNSPECIFIED",
- "logsImmediate": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "notificationPayloadFilter": "text"
}, - "tracingImmediate": {
- "tracingFilter": {
- "simpleFilter": {
- "tracingLabelFilters": {
- "applicationName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "serviceName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "operationName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "spanFields": [
- {
- "key": "string",
- "filterType": {
- "values": [ ],
- "operation": null
}
}
]
}, - "latencyThresholdMs": "string"
}
}, - "notificationPayloadFilter": [
- "string"
]
}, - "logsThreshold": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "rules": [
- {
- "condition": {
- "threshold": 100,
- "timeWindow": {
- "logsTimeWindowSpecificValue": "LOGS_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "LOGS_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": "text",
- "evaluationDelayMs": 60000
}, - "logsRatioThreshold": {
- "numerator": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "numeratorAlias": "numerator_alias",
- "denominator": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "denominatorAlias": "string",
- "rules": [
- {
- "condition": {
- "threshold": 10,
- "timeWindow": {
- "logsRatioTimeWindowSpecificValue": "LOGS_RATIO_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "LOGS_RATIO_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": "text",
- "groupByFor": "LOGS_RATIO_GROUP_BY_FOR_BOTH_OR_UNSPECIFIED",
- "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "ignoreInfinity": true,
- "evaluationDelayMs": 60000
}, - "logsTimeRelativeThreshold": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "threshold": 10,
- "comparedTo": "LOGS_TIME_RELATIVE_COMPARED_TO_PREVIOUS_HOUR_OR_UNSPECIFIED",
- "conditionType": "LOGS_TIME_RELATIVE_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "ignoreInfinity": true,
- "notificationPayloadFilter": "text",
- "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "evaluationDelayMs": 60000
}, - "metricThreshold": {
- "metricFilter": {
- "promql": "string"
}, - "rules": [
- {
- "condition": {
- "threshold": 0.1,
- "forOverPct": 0,
- "ofTheLast": {
- "metricTimeWindowSpecificValue": "METRIC_TIME_WINDOW_VALUE_MINUTES_1_OR_UNSPECIFIED",
- "metricTimeWindowDynamicDuration": "string"
}, - "conditionType": "METRIC_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "missingValues": {
- "replaceWithZero": true,
- "minNonNullValuesPct": 0
}, - "evaluationDelayMs": 0
}, - "tracingThreshold": {
- "tracingFilter": {
- "simpleFilter": {
- "tracingLabelFilters": {
- "applicationName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "serviceName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "operationName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "spanFields": [
- {
- "key": "string",
- "filterType": {
- "values": [ ],
- "operation": null
}
}
]
}, - "latencyThresholdMs": "string"
}
}, - "rules": [
- {
- "condition": {
- "spanAmount": 0.1,
- "timeWindow": {
- "tracingTimeWindowValue": "TRACING_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "TRACING_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": [
- "string"
]
}, - "flow": {
- "stages": [
- {
- "flowStagesGroups": {
- "groups": [
- {
- "alertDefs": [
- null
], - "nextOp": "NEXT_OP_AND_OR_UNSPECIFIED",
- "alertsOp": "ALERTS_OP_AND_OR_UNSPECIFIED"
}
]
}, - "timeframeMs": 60000,
- "timeframeType": "TIMEFRAME_TYPE_UNSPECIFIED"
}
], - "enforceSuppression": true
}, - "logsAnomaly": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "minimumThreshold": 10,
- "timeWindow": {
- "logsTimeWindowSpecificValue": "LOGS_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "LOGS_ANOMALY_CONDITION_TYPE_MORE_THAN_USUAL_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": "text",
- "evaluationDelayMs": 60000,
- "anomalyAlertSettings": {
- "percentageOfDeviation": 10
}
}, - "metricAnomaly": {
- "metricFilter": {
- "promql": "string"
}, - "rules": [
- {
- "condition": {
- "threshold": 10,
- "forOverPct": 10,
- "ofTheLast": {
- "metricTimeWindowSpecificValue": "METRIC_TIME_WINDOW_VALUE_MINUTES_1_OR_UNSPECIFIED",
- "metricTimeWindowDynamicDuration": "string"
}, - "minNonNullValuesPct": 10,
- "conditionType": "METRIC_ANOMALY_CONDITION_TYPE_MORE_THAN_USUAL_OR_UNSPECIFIED"
}
}
], - "evaluationDelayMs": 60000,
- "anomalyAlertSettings": {
- "percentageOfDeviation": 10
}
}, - "logsNewValue": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "keypathToTrack": "metadata.field",
- "timeWindow": {
- "logsNewValueTimeWindowSpecificValue": "LOGS_NEW_VALUE_TIME_WINDOW_VALUE_HOURS_12_OR_UNSPECIFIED"
}
}
}
], - "notificationPayloadFilter": "text"
}, - "logsUniqueCount": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "maxUniqueCount": "string",
- "timeWindow": {
- "logsUniqueValueTimeWindowSpecificValue": "LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_MINUTE_1_OR_UNSPECIFIED"
}
}
}
], - "notificationPayloadFilter": "text",
- "maxUniqueCountPerGroupByKey": 100,
- "uniqueCountKeypath": "unique_count"
}, - "groupByKeys": [
- "string"
], - "incidentsSettings": {
- "minutes": 10,
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
}, - "notificationGroup": {
- "groupByKeys": [
- "string"
], - "webhooks": [
- {
- "minutes": 10,
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "integration": {
- "integrationId": 123,
- "recipients": {
- "emails": [
- "string"
]
}
}
}
], - "destinations": [
- {
- "connectorId": "string",
- "presetId": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "triggeredRoutingOverrides": {
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- {
- "fieldName": null,
- "template": null
}
], - "connectorConfigFields": [
- {
- "fieldName": null,
- "template": null
}
]
}
}, - "resolvedRouteOverrides": {
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- {
- "fieldName": null,
- "template": null
}
], - "connectorConfigFields": [
- {
- "fieldName": null,
- "template": null
}
]
}
}
}
], - "router": {
- "id": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
}
}, - "notificationGroupExcess": [
- {
- "groupByKeys": [
- "string"
], - "webhooks": [
- {
- "minutes": 10,
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "integration": {
- "integrationId": 123,
- "recipients": {
- "emails": [
- null
]
}
}
}
], - "destinations": [
- {
- "connectorId": "string",
- "presetId": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "triggeredRoutingOverrides": {
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- null
], - "connectorConfigFields": [
- null
]
}
}, - "resolvedRouteOverrides": {
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- null
], - "connectorConfigFields": [
- null
]
}
}
}
], - "router": {
- "id": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
}
}
], - "entityLabels": {
- "property1": "string",
- "property2": "string"
}, - "phantomMode": true,
- "deleted": true
}, - "id": 1,
- "alertVersionId": "string",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z"
}
}
id required | string |
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));
{- "alertDef": {
- "alertDefProperties": {
- "name": "My Alert",
- "description": "Alert description",
- "enabled": true,
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED",
- "activeOn": {
- "dayOfWeek": [
- "DAY_OF_WEEK_MONDAY_OR_UNSPECIFIED"
], - "startTime": {
- "hours": 14,
- "minutes": 30
}, - "endTime": {
- "hours": 14,
- "minutes": 30
}
}, - "type": "ALERT_DEF_TYPE_LOGS_IMMEDIATE_OR_UNSPECIFIED",
- "logsImmediate": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "notificationPayloadFilter": "text"
}, - "tracingImmediate": {
- "tracingFilter": {
- "simpleFilter": {
- "tracingLabelFilters": {
- "applicationName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "serviceName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "operationName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "spanFields": [
- {
- "key": "string",
- "filterType": {
- "values": [ ],
- "operation": null
}
}
]
}, - "latencyThresholdMs": "string"
}
}, - "notificationPayloadFilter": [
- "string"
]
}, - "logsThreshold": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "rules": [
- {
- "condition": {
- "threshold": 100,
- "timeWindow": {
- "logsTimeWindowSpecificValue": "LOGS_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "LOGS_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": "text",
- "evaluationDelayMs": 60000
}, - "logsRatioThreshold": {
- "numerator": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "numeratorAlias": "numerator_alias",
- "denominator": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "denominatorAlias": "string",
- "rules": [
- {
- "condition": {
- "threshold": 10,
- "timeWindow": {
- "logsRatioTimeWindowSpecificValue": "LOGS_RATIO_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "LOGS_RATIO_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": "text",
- "groupByFor": "LOGS_RATIO_GROUP_BY_FOR_BOTH_OR_UNSPECIFIED",
- "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "ignoreInfinity": true,
- "evaluationDelayMs": 60000
}, - "logsTimeRelativeThreshold": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "threshold": 10,
- "comparedTo": "LOGS_TIME_RELATIVE_COMPARED_TO_PREVIOUS_HOUR_OR_UNSPECIFIED",
- "conditionType": "LOGS_TIME_RELATIVE_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "ignoreInfinity": true,
- "notificationPayloadFilter": "text",
- "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "evaluationDelayMs": 60000
}, - "metricThreshold": {
- "metricFilter": {
- "promql": "string"
}, - "rules": [
- {
- "condition": {
- "threshold": 0.1,
- "forOverPct": 0,
- "ofTheLast": {
- "metricTimeWindowSpecificValue": "METRIC_TIME_WINDOW_VALUE_MINUTES_1_OR_UNSPECIFIED",
- "metricTimeWindowDynamicDuration": "string"
}, - "conditionType": "METRIC_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}, - "override": {
- "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
}
}
], - "undetectedValuesManagement": {
- "triggerUndetectedValues": true,
- "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
}, - "missingValues": {
- "replaceWithZero": true,
- "minNonNullValuesPct": 0
}, - "evaluationDelayMs": 0
}, - "tracingThreshold": {
- "tracingFilter": {
- "simpleFilter": {
- "tracingLabelFilters": {
- "applicationName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "serviceName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "operationName": [
- {
- "values": [
- null
], - "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "spanFields": [
- {
- "key": "string",
- "filterType": {
- "values": [ ],
- "operation": null
}
}
]
}, - "latencyThresholdMs": "string"
}
}, - "rules": [
- {
- "condition": {
- "spanAmount": 0.1,
- "timeWindow": {
- "tracingTimeWindowValue": "TRACING_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "TRACING_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": [
- "string"
]
}, - "flow": {
- "stages": [
- {
- "flowStagesGroups": {
- "groups": [
- {
- "alertDefs": [
- null
], - "nextOp": "NEXT_OP_AND_OR_UNSPECIFIED",
- "alertsOp": "ALERTS_OP_AND_OR_UNSPECIFIED"
}
]
}, - "timeframeMs": 60000,
- "timeframeType": "TIMEFRAME_TYPE_UNSPECIFIED"
}
], - "enforceSuppression": true
}, - "logsAnomaly": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "minimumThreshold": 10,
- "timeWindow": {
- "logsTimeWindowSpecificValue": "LOGS_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
}, - "conditionType": "LOGS_ANOMALY_CONDITION_TYPE_MORE_THAN_USUAL_OR_UNSPECIFIED"
}
}
], - "notificationPayloadFilter": "text",
- "evaluationDelayMs": 60000,
- "anomalyAlertSettings": {
- "percentageOfDeviation": 10
}
}, - "metricAnomaly": {
- "metricFilter": {
- "promql": "string"
}, - "rules": [
- {
- "condition": {
- "threshold": 10,
- "forOverPct": 10,
- "ofTheLast": {
- "metricTimeWindowSpecificValue": "METRIC_TIME_WINDOW_VALUE_MINUTES_1_OR_UNSPECIFIED",
- "metricTimeWindowDynamicDuration": "string"
}, - "minNonNullValuesPct": 10,
- "conditionType": "METRIC_ANOMALY_CONDITION_TYPE_MORE_THAN_USUAL_OR_UNSPECIFIED"
}
}
], - "evaluationDelayMs": 60000,
- "anomalyAlertSettings": {
- "percentageOfDeviation": 10
}
}, - "logsNewValue": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "keypathToTrack": "metadata.field",
- "timeWindow": {
- "logsNewValueTimeWindowSpecificValue": "LOGS_NEW_VALUE_TIME_WINDOW_VALUE_HOURS_12_OR_UNSPECIFIED"
}
}
}
], - "notificationPayloadFilter": "text"
}, - "logsUniqueCount": {
- "logsFilter": {
- "simpleFilter": {
- "luceneQuery": "string",
- "labelFilters": {
- "applicationName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "subsystemName": [
- {
- "value": "string",
- "operation": "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"
}
], - "severities": [
- "LOG_SEVERITY_VERBOSE_UNSPECIFIED"
]
}
}
}, - "rules": [
- {
- "condition": {
- "maxUniqueCount": "string",
- "timeWindow": {
- "logsUniqueValueTimeWindowSpecificValue": "LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_MINUTE_1_OR_UNSPECIFIED"
}
}
}
], - "notificationPayloadFilter": "text",
- "maxUniqueCountPerGroupByKey": 100,
- "uniqueCountKeypath": "unique_count"
}, - "groupByKeys": [
- "string"
], - "incidentsSettings": {
- "minutes": 10,
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
}, - "notificationGroup": {
- "groupByKeys": [
- "string"
], - "webhooks": [
- {
- "minutes": 10,
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "integration": {
- "integrationId": 123,
- "recipients": {
- "emails": [
- "string"
]
}
}
}
], - "destinations": [
- {
- "connectorId": "string",
- "presetId": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "triggeredRoutingOverrides": {
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- {
- "fieldName": null,
- "template": null
}
], - "connectorConfigFields": [
- {
- "fieldName": null,
- "template": null
}
]
}
}, - "resolvedRouteOverrides": {
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- {
- "fieldName": null,
- "template": null
}
], - "connectorConfigFields": [
- {
- "fieldName": null,
- "template": null
}
]
}
}
}
], - "router": {
- "id": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
}
}, - "notificationGroupExcess": [
- {
- "groupByKeys": [
- "string"
], - "webhooks": [
- {
- "minutes": 10,
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "integration": {
- "integrationId": 123,
- "recipients": {
- "emails": [
- null
]
}
}
}
], - "destinations": [
- {
- "connectorId": "string",
- "presetId": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
- "triggeredRoutingOverrides": {
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- null
], - "connectorConfigFields": [
- null
]
}
}, - "resolvedRouteOverrides": {
- "configOverrides": {
- "outputSchemaId": "string",
- "messageConfigFields": [
- null
], - "connectorConfigFields": [
- null
]
}
}
}
], - "router": {
- "id": "string",
- "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
}
}
], - "entityLabels": {
- "property1": "string",
- "property2": "string"
}, - "phantomMode": true,
- "deleted": true
}, - "id": 1,
- "alertVersionId": "string",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z"
}
}
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));
{ }
id required | string |
active required | boolean |
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));
{ }
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));
{- "result": {
- "content": "string"
}, - "error": {
- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}
}
id required | string |
pagination.pageSize | integer <int64> |
pagination.pageToken | string |
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));
{- "id": "string",
- "singlePermutation": {
- "permutationLabels": {
- "property1": "string",
- "property2": "string"
}, - "groupLabels": {
- "property1": "string",
- "property2": "string"
}, - "timestamp": "2019-08-24T14:15:22Z",
- "alertId": "string",
- "status": "ALERT_STATUS_RESOLVED_OR_UNSPECIFIED",
- "preGroupingEventId": "string",
- "payload": { },
- "payloadType": "string",
- "permutationId": "string",
- "incidentCorrelationKey": "string",
- "activityAnalysis": {
- "rules": [
- "rule1",
- "rule2"
], - "status": "ACTIVITY_ANALYSIS_STATUS_ACTIVATE_OR_UNSPECIFIED"
}
}, - "multiplePermutation": {
- "alertEventMultiplePermutation": [
- {
- "permutationLabels": {
- "property1": "string",
- "property2": "string"
}, - "groupLabels": {
- "property1": "string",
- "property2": "string"
}, - "timestamp": "2019-08-24T14:15:22Z",
- "alertId": "string",
- "status": "ALERT_STATUS_RESOLVED_OR_UNSPECIFIED",
- "preGroupingEventId": "string",
- "payload": { },
- "payloadType": "string",
- "permutationId": "string",
- "incidentCorrelationKey": "string",
- "activityAnalysis": {
- "rules": [
- "rule1",
- "rule2"
], - "status": "ACTIVITY_ANALYSIS_STATUS_ACTIVATE_OR_UNSPECIFIED"
}
}
]
}, - "pagination": {
- "totalSize": 0,
- "nextPageToken": "string"
}
}
ids | Array of strings |
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));
{- "eventsStats": {
- "property1": {
- "count": 0,
- "resolvedCount": 0,
- "triggeredCount": 0,
- "triggeredPermutationsSamples": [
- {
- "permutationLabels": {
- "property1": "string",
- "property2": "string"
}
}
], - "resolvedPermutationsSamples": [
- {
- "permutationLabels": {
- "property1": "string",
- "property2": "string"
}
}
], - "activityAnalysisStats": {
- "isMutedCount": 0,
- "rules": [
- "string"
]
}
}, - "property2": {
- "count": 0,
- "resolvedCount": 0,
- "triggeredCount": 0,
- "triggeredPermutationsSamples": [
- {
- "permutationLabels": {
- "property1": "string",
- "property2": "string"
}
}
], - "resolvedPermutationsSamples": [
- {
- "permutationLabels": {
- "property1": "string",
- "property2": "string"
}
}
], - "activityAnalysisStats": {
- "isMutedCount": 0,
- "rules": [
- "string"
]
}
}
}
}
requestId | string |
object (astDashboard) Dashboard represents the structure and configuration of a Coralogix Custom Dashboard. | |
isLocked | boolean |
{- "requestId": "string",
- "dashboard": {
- "id": "string",
- "name": "string",
- "description": "string",
- "layout": {
- "sections": [
- {
- "id": {
- "value": "string"
}, - "rows": [
- {
- "id": {
- "value": "string"
}, - "appearance": {
- "height": 0
}, - "widgets": [
- {
- "id": {
- "value": null
}, - "title": "string",
- "description": "string",
- "definition": {
- "lineChart": null,
- "dataTable": null,
- "gauge": null,
- "pieChart": null,
- "barChart": null,
- "horizontalBarChart": null,
- "markdown": null,
- "hexagon": null
}, - "appearance": {
- "width": null
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}
], - "options": {
- "internal": { },
- "custom": {
- "name": "string",
- "description": "string",
- "collapsed": true,
- "color": {
- "predefined": "SECTION_PREDEFINED_COLOR_UNSPECIFIED"
}
}
}
}
]
}, - "variables": [
- {
- "name": "string",
- "definition": {
- "constant": {
- "value": "string"
}, - "multiSelect": {
- "selected": [
- "string"
], - "source": {
- "logsPath": {
- "value": "string",
- "observationField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}
}, - "metricLabel": {
- "metricName": "string",
- "label": "string"
}, - "constantList": {
- "values": [
- "string"
]
}, - "spanField": {
- "value": {
- "metadataField": "METADATA_FIELD_UNSPECIFIED",
- "tagField": "string",
- "processTagField": "string"
}
}, - "query": {
- "query": {
- "logsQuery": {
- "type": null
}, - "metricsQuery": {
- "type": null
}, - "spansQuery": {
- "type": null
}
}, - "refreshStrategy": "REFRESH_STRATEGY_UNSPECIFIED",
- "valueDisplayOptions": {
- "valueRegex": "string",
- "labelRegex": "string"
}
}
}, - "selection": {
- "all": { },
- "list": {
- "values": [
- "string"
], - "labels": [
- "string"
]
}
}, - "valuesOrderDirection": "ORDER_DIRECTION_UNSPECIFIED",
- "selectionOptions": {
- "selectionType": "SELECTION_TYPE_UNSPECIFIED"
}
}
}, - "displayName": "string",
- "description": "string",
- "displayType": "VARIABLE_DISPLAY_TYPE_UNSPECIFIED"
}
], - "filters": [
- {
- "source": {
- "logs": {
- "field": "string",
- "operator": {
- "equals": {
- "selection": {
- "all": { },
- "list": {
- "values": [ ]
}
}
}, - "notEquals": {
- "selection": {
- "list": {
- "values": [ ]
}
}
}
}, - "observationField": {
- "keypath": [
- "string"
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}
}, - "spans": {
- "field": {
- "metadataField": "METADATA_FIELD_UNSPECIFIED",
- "tagField": "string",
- "processTagField": "string"
}, - "operator": {
- "equals": {
- "selection": {
- "all": { },
- "list": {
- "values": [ ]
}
}
}, - "notEquals": {
- "selection": {
- "list": {
- "values": [ ]
}
}
}
}
}, - "metrics": {
- "metric": "string",
- "label": "string",
- "operator": {
- "equals": {
- "selection": {
- "all": { },
- "list": {
- "values": [ ]
}
}
}, - "notEquals": {
- "selection": {
- "list": {
- "values": [ ]
}
}
}
}
}
}, - "enabled": true,
- "collapsed": true
}
], - "absoluteTimeFrame": {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z"
}, - "relativeTimeFrame": "string",
- "folderId": {
- "value": "string"
}, - "folderPath": {
- "segments": [
- "string"
]
}, - "annotations": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "source": {
- "metrics": {
- "promqlQuery": {
- "value": "string"
}, - "strategy": {
- "startTimeMetric": { }
}, - "messageTemplate": "string",
- "labels": [
- "string"
]
}, - "logs": {
- "luceneQuery": {
- "value": "string"
}, - "strategy": {
- "instant": {
- "timestampField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}
}, - "range": {
- "startTimestampField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}, - "endTimestampField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}
}, - "duration": {
- "startTimestampField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}, - "durationField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}
}
}, - "messageTemplate": "string",
- "labelFields": [
- {
- "keypath": [
- "string"
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}
]
}, - "spans": {
- "luceneQuery": {
- "value": "string"
}, - "strategy": {
- "instant": {
- "timestampField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}
}, - "range": {
- "startTimestampField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}, - "endTimestampField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}
}, - "duration": {
- "startTimestampField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}, - "durationField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}
}
}, - "messageTemplate": "string",
- "labelFields": [
- {
- "keypath": [
- "string"
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}
]
}
}
}
], - "off": { },
- "twoMinutes": { },
- "fiveMinutes": { }
}, - "isLocked": true
}
{- "dashboardId": "string"
}
requestId | string |
object (astDashboard) Dashboard represents the structure and configuration of a Coralogix Custom Dashboard. | |
isLocked | boolean |
{- "requestId": "string",
- "dashboard": {
- "id": "string",
- "name": "string",
- "description": "string",
- "layout": {
- "sections": [
- {
- "id": {
- "value": "string"
}, - "rows": [
- {
- "id": {
- "value": "string"
}, - "appearance": {
- "height": 0
}, - "widgets": [
- {
- "id": {
- "value": null
}, - "title": "string",
- "description": "string",
- "definition": {
- "lineChart": null,
- "dataTable": null,
- "gauge": null,
- "pieChart": null,
- "barChart": null,
- "horizontalBarChart": null,
- "markdown": null,
- "hexagon": null
}, - "appearance": {
- "width": null
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}
], - "options": {
- "internal": { },
- "custom": {
- "name": "string",
- "description": "string",
- "collapsed": true,
- "color": {
- "predefined": "SECTION_PREDEFINED_COLOR_UNSPECIFIED"
}
}
}
}
]
}, - "variables": [
- {
- "name": "string",
- "definition": {
- "constant": {
- "value": "string"
}, - "multiSelect": {
- "selected": [
- "string"
], - "source": {
- "logsPath": {
- "value": "string",
- "observationField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}
}, - "metricLabel": {
- "metricName": "string",
- "label": "string"
}, - "constantList": {
- "values": [
- "string"
]
}, - "spanField": {
- "value": {
- "metadataField": "METADATA_FIELD_UNSPECIFIED",
- "tagField": "string",
- "processTagField": "string"
}
}, - "query": {
- "query": {
- "logsQuery": {
- "type": null
}, - "metricsQuery": {
- "type": null
}, - "spansQuery": {
- "type": null
}
}, - "refreshStrategy": "REFRESH_STRATEGY_UNSPECIFIED",
- "valueDisplayOptions": {
- "valueRegex": "string",
- "labelRegex": "string"
}
}
}, - "selection": {
- "all": { },
- "list": {
- "values": [
- "string"
], - "labels": [
- "string"
]
}
}, - "valuesOrderDirection": "ORDER_DIRECTION_UNSPECIFIED",
- "selectionOptions": {
- "selectionType": "SELECTION_TYPE_UNSPECIFIED"
}
}
}, - "displayName": "string",
- "description": "string",
- "displayType": "VARIABLE_DISPLAY_TYPE_UNSPECIFIED"
}
], - "filters": [
- {
- "source": {
- "logs": {
- "field": "string",
- "operator": {
- "equals": {
- "selection": {
- "all": { },
- "list": {
- "values": [ ]
}
}
}, - "notEquals": {
- "selection": {
- "list": {
- "values": [ ]
}
}
}
}, - "observationField": {
- "keypath": [
- "string"
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}
}, - "spans": {
- "field": {
- "metadataField": "METADATA_FIELD_UNSPECIFIED",
- "tagField": "string",
- "processTagField": "string"
}, - "operator": {
- "equals": {
- "selection": {
- "all": { },
- "list": {
- "values": [ ]
}
}
}, - "notEquals": {
- "selection": {
- "list": {
- "values": [ ]
}
}
}
}
}, - "metrics": {
- "metric": "string",
- "label": "string",
- "operator": {
- "equals": {
- "selection": {
- "all": { },
- "list": {
- "values": [ ]
}
}
}, - "notEquals": {
- "selection": {
- "list": {
- "values": [ ]
}
}
}
}
}
}, - "enabled": true,
- "collapsed": true
}
], - "absoluteTimeFrame": {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z"
}, - "relativeTimeFrame": "string",
- "folderId": {
- "value": "string"
}, - "folderPath": {
- "segments": [
- "string"
]
}, - "annotations": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "source": {
- "metrics": {
- "promqlQuery": {
- "value": "string"
}, - "strategy": {
- "startTimeMetric": { }
}, - "messageTemplate": "string",
- "labels": [
- "string"
]
}, - "logs": {
- "luceneQuery": {
- "value": "string"
}, - "strategy": {
- "instant": {
- "timestampField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}
}, - "range": {
- "startTimestampField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}, - "endTimestampField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}
}, - "duration": {
- "startTimestampField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}, - "durationField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}
}
}, - "messageTemplate": "string",
- "labelFields": [
- {
- "keypath": [
- "string"
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}
]
}, - "spans": {
- "luceneQuery": {
- "value": "string"
}, - "strategy": {
- "instant": {
- "timestampField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}
}, - "range": {
- "startTimestampField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}, - "endTimestampField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}
}, - "duration": {
- "startTimestampField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}, - "durationField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}
}
}, - "messageTemplate": "string",
- "labelFields": [
- {
- "keypath": [
- "string"
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}
]
}
}
}
], - "off": { },
- "twoMinutes": { },
- "fiveMinutes": { }
}, - "isLocked": true
}
{ }
dashboardId required | string |
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/dashboards/%7BdashboardId%7D'; let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{- "dashboard": {
- "id": "string",
- "name": "string",
- "description": "string",
- "layout": {
- "sections": [
- {
- "id": {
- "value": "string"
}, - "rows": [
- {
- "id": {
- "value": "string"
}, - "appearance": {
- "height": 0
}, - "widgets": [
- {
- "id": {
- "value": null
}, - "title": "string",
- "description": "string",
- "definition": {
- "lineChart": null,
- "dataTable": null,
- "gauge": null,
- "pieChart": null,
- "barChart": null,
- "horizontalBarChart": null,
- "markdown": null,
- "hexagon": null
}, - "appearance": {
- "width": null
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}
], - "options": {
- "internal": { },
- "custom": {
- "name": "string",
- "description": "string",
- "collapsed": true,
- "color": {
- "predefined": "SECTION_PREDEFINED_COLOR_UNSPECIFIED"
}
}
}
}
]
}, - "variables": [
- {
- "name": "string",
- "definition": {
- "constant": {
- "value": "string"
}, - "multiSelect": {
- "selected": [
- "string"
], - "source": {
- "logsPath": {
- "value": "string",
- "observationField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}
}, - "metricLabel": {
- "metricName": "string",
- "label": "string"
}, - "constantList": {
- "values": [
- "string"
]
}, - "spanField": {
- "value": {
- "metadataField": "METADATA_FIELD_UNSPECIFIED",
- "tagField": "string",
- "processTagField": "string"
}
}, - "query": {
- "query": {
- "logsQuery": {
- "type": null
}, - "metricsQuery": {
- "type": null
}, - "spansQuery": {
- "type": null
}
}, - "refreshStrategy": "REFRESH_STRATEGY_UNSPECIFIED",
- "valueDisplayOptions": {
- "valueRegex": "string",
- "labelRegex": "string"
}
}
}, - "selection": {
- "all": { },
- "list": {
- "values": [
- "string"
], - "labels": [
- "string"
]
}
}, - "valuesOrderDirection": "ORDER_DIRECTION_UNSPECIFIED",
- "selectionOptions": {
- "selectionType": "SELECTION_TYPE_UNSPECIFIED"
}
}
}, - "displayName": "string",
- "description": "string",
- "displayType": "VARIABLE_DISPLAY_TYPE_UNSPECIFIED"
}
], - "filters": [
- {
- "source": {
- "logs": {
- "field": "string",
- "operator": {
- "equals": {
- "selection": {
- "all": { },
- "list": {
- "values": [ ]
}
}
}, - "notEquals": {
- "selection": {
- "list": {
- "values": [ ]
}
}
}
}, - "observationField": {
- "keypath": [
- "string"
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}
}, - "spans": {
- "field": {
- "metadataField": "METADATA_FIELD_UNSPECIFIED",
- "tagField": "string",
- "processTagField": "string"
}, - "operator": {
- "equals": {
- "selection": {
- "all": { },
- "list": {
- "values": [ ]
}
}
}, - "notEquals": {
- "selection": {
- "list": {
- "values": [ ]
}
}
}
}
}, - "metrics": {
- "metric": "string",
- "label": "string",
- "operator": {
- "equals": {
- "selection": {
- "all": { },
- "list": {
- "values": [ ]
}
}
}, - "notEquals": {
- "selection": {
- "list": {
- "values": [ ]
}
}
}
}
}
}, - "enabled": true,
- "collapsed": true
}
], - "absoluteTimeFrame": {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z"
}, - "relativeTimeFrame": "string",
- "folderId": {
- "value": "string"
}, - "folderPath": {
- "segments": [
- "string"
]
}, - "annotations": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "source": {
- "metrics": {
- "promqlQuery": {
- "value": "string"
}, - "strategy": {
- "startTimeMetric": { }
}, - "messageTemplate": "string",
- "labels": [
- "string"
]
}, - "logs": {
- "luceneQuery": {
- "value": "string"
}, - "strategy": {
- "instant": {
- "timestampField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}
}, - "range": {
- "startTimestampField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}, - "endTimestampField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}
}, - "duration": {
- "startTimestampField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}, - "durationField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}
}
}, - "messageTemplate": "string",
- "labelFields": [
- {
- "keypath": [
- "string"
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}
]
}, - "spans": {
- "luceneQuery": {
- "value": "string"
}, - "strategy": {
- "instant": {
- "timestampField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}
}, - "range": {
- "startTimestampField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}, - "endTimestampField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}
}, - "duration": {
- "startTimestampField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}, - "durationField": {
- "keypath": [
- null
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}
}
}, - "messageTemplate": "string",
- "labelFields": [
- {
- "keypath": [
- "string"
], - "scope": "DATASET_SCOPE_UNSPECIFIED"
}
]
}
}
}
], - "off": { },
- "twoMinutes": { },
- "fiveMinutes": { }
}, - "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
}
dashboardId required | string |
requestId | string |
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/dashboards/%7BdashboardId%7D?requestId=SOME_STRING_VALUE'; let options = {method: 'DELETE', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{ }
dashboardId required | string |
requestId | string |
{- "requestId": "string"
}
{ }
dashboardId required | string |
requestId | string |
folderId | string (could be null to assign the dashboard to root) |
{- "requestId": "string",
- "folderId": "string"
}
{ }
dashboardId required | string |
requestId | string |
{- "requestId": "string"
}
{ }
dashboardId required | string |
requestId | string |
{- "requestId": "string"
}
{ }
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/dashboards/catalog'; let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{- "items": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "isDefault": true,
- "isPinned": true,
- "createTime": "2019-08-24T14:15:22Z",
- "updateTime": "2019-08-24T14:15:22Z",
- "folder": {
- "id": "string",
- "name": "string",
- "parentId": "string"
}, - "authorId": "string",
- "isLocked": true
}
]
}
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/dashboards/folders'; let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{- "folder": [
- {
- "id": "string",
- "name": "string",
- "parentId": "string"
}
]
}
requestId | string |
object (commonDashboardFolder) |
{- "requestId": "string",
- "folder": {
- "id": "string",
- "name": "string",
- "parentId": "string"
}
}
{ }
requestId | string |
object (commonDashboardFolder) |
{- "requestId": "string",
- "folder": {
- "id": "string",
- "name": "string",
- "parentId": "string"
}
}
{ }
folderId required | string |
requestId | string |
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/dashboards/folders/%7BfolderId%7D?requestId=SOME_STRING_VALUE'; let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{- "folder": {
- "id": "string",
- "name": "string",
- "parentId": "string"
}
}
folderId required | string |
requestId | string |
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/dashboards/folders/%7BfolderId%7D?requestId=SOME_STRING_VALUE'; let options = {method: 'DELETE', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{ }
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));
{- "actions": [
- {
- "id": "string",
- "name": "string",
- "url": "string",
- "isHidden": true,
- "isPrivate": true,
- "sourceType": "SOURCE_TYPE_UNSPECIFIED",
- "applicationNames": [
- "string"
], - "subsystemNames": [
- "string"
], - "createdBy": "string"
}
]
}
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 |
{- "name": "string",
- "url": "string",
- "isPrivate": true,
- "sourceType": "SOURCE_TYPE_UNSPECIFIED",
- "applicationNames": [
- "string"
], - "subsystemNames": [
- "string"
]
}
{- "action": {
- "id": "string",
- "name": "string",
- "url": "string",
- "isHidden": true,
- "isPrivate": true,
- "sourceType": "SOURCE_TYPE_UNSPECIFIED",
- "applicationNames": [
- "string"
], - "subsystemNames": [
- "string"
], - "createdBy": "string"
}
}
object (actionsv2Action) |
{- "action": {
- "id": "string",
- "name": "string",
- "url": "string",
- "isHidden": true,
- "isPrivate": true,
- "sourceType": "SOURCE_TYPE_UNSPECIFIED",
- "applicationNames": [
- "string"
], - "subsystemNames": [
- "string"
], - "createdBy": "string"
}
}
{- "action": {
- "id": "string",
- "name": "string",
- "url": "string",
- "isHidden": true,
- "isPrivate": true,
- "sourceType": "SOURCE_TYPE_UNSPECIFIED",
- "applicationNames": [
- "string"
], - "subsystemNames": [
- "string"
], - "createdBy": "string"
}
}
Array of objects (v2ActionExecutionRequest) |
{- "requests": [
- {
- "create": {
- "name": "string",
- "url": "string",
- "isPrivate": true,
- "sourceType": "SOURCE_TYPE_UNSPECIFIED",
- "applicationNames": [
- "string"
], - "subsystemNames": [
- "string"
]
}, - "replace": {
- "action": {
- "id": "string",
- "name": "string",
- "url": "string",
- "isHidden": true,
- "isPrivate": true,
- "sourceType": "SOURCE_TYPE_UNSPECIFIED",
- "applicationNames": [
- "string"
], - "subsystemNames": [
- "string"
], - "createdBy": "string"
}
}, - "delete": {
- "id": "string"
}
}
]
}
{- "matchingResponses": [
- {
- "create": {
- "action": {
- "id": "string",
- "name": "string",
- "url": "string",
- "isHidden": true,
- "isPrivate": true,
- "sourceType": "SOURCE_TYPE_UNSPECIFIED",
- "applicationNames": [
- "string"
], - "subsystemNames": [
- "string"
], - "createdBy": "string"
}
}, - "replace": {
- "action": {
- "id": "string",
- "name": "string",
- "url": "string",
- "isHidden": true,
- "isPrivate": true,
- "sourceType": "SOURCE_TYPE_UNSPECIFIED",
- "applicationNames": [
- "string"
], - "subsystemNames": [
- "string"
], - "createdBy": "string"
}
}, - "delete": { }
}
]
}
object | |
object |
{- "privateActionsOrder": {
- "property1": 0,
- "property2": 0
}, - "sharedActionsOrder": {
- "property1": 0,
- "property2": 0
}
}
{ }
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));
{- "action": {
- "id": "string",
- "name": "string",
- "url": "string",
- "isHidden": true,
- "isPrivate": true,
- "sourceType": "SOURCE_TYPE_UNSPECIFIED",
- "applicationNames": [
- "string"
], - "subsystemNames": [
- "string"
], - "createdBy": "string"
}
}
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));
{ }
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));
{- "e2m": [
- {
- "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": {
- "limit": 30000,
- "hasExceededLimit": true
}, - "metricLabels": [
- {
- "targetLabel": "alias_label_name",
- "sourceField": "log_obj.string_value"
}
], - "metricFields": [
- {
- "targetBaseMetricName": "alias_field_name",
- "sourceField": "log_obj.numeric_field",
- "aggregations": [
- {
- "enabled": true,
- "aggType": "AGG_TYPE_UNSPECIFIED",
- "targetMetricName": "alias_field_name_agg_func",
- "samples": {
- "sampleType": "SAMPLE_TYPE_UNSPECIFIED"
}, - "histogram": {
- "buckets": 2
}
}
]
}
], - "type": "E2M_TYPE_UNSPECIFIED",
- "spansQuery": {
- "lucene": "applicationName:myApp",
- "applicationnameFilters": "myApp",
- "subsystemnameFilters": "mySubsystem",
- "actionFilters": "myAction",
- "serviceFilters": "myService"
}, - "logsQuery": {
- "lucene": "log_obj.numeric_field: [50 TO 100]",
- "alias": "new_query",
- "applicationnameFilters": "app_name",
- "subsystemnameFilters": "sub_name",
- "severityFilters": [
- "SEVERITY_UNSPECIFIED"
]
}, - "isInternal": true
}
]
}
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. | |
object (SpansQuery) This data structure represents a query for logs. |
{- "name": "Service catalog latency",
- "description": "avg and max the latency of catalog service",
- "permutationsLimit": 30000,
- "metricLabels": [
- {
- "targetLabel": "alias_label_name",
- "sourceField": "log_obj.string_value"
}
], - "metricFields": [
- {
- "targetBaseMetricName": "alias_field_name",
- "sourceField": "log_obj.numeric_field",
- "aggregations": [
- {
- "enabled": true,
- "aggType": "AGG_TYPE_UNSPECIFIED",
- "targetMetricName": "alias_field_name_agg_func",
- "samples": {
- "sampleType": "SAMPLE_TYPE_UNSPECIFIED"
}, - "histogram": {
- "buckets": 2
}
}
]
}
], - "type": "E2M_TYPE_UNSPECIFIED",
- "spansQuery": {
- "lucene": "applicationName:myApp",
- "applicationnameFilters": "myApp",
- "subsystemnameFilters": "mySubsystem",
- "actionFilters": "myAction",
- "serviceFilters": "myService"
}, - "logsQuery": {
- "lucene": "log_obj.numeric_field: [50 TO 100]",
- "alias": "new_query",
- "applicationnameFilters": "app_name",
- "subsystemnameFilters": "sub_name",
- "severityFilters": [
- "SEVERITY_UNSPECIFIED"
]
}
}
{- "e2m": {
- "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": {
- "limit": 30000,
- "hasExceededLimit": true
}, - "metricLabels": [
- {
- "targetLabel": "alias_label_name",
- "sourceField": "log_obj.string_value"
}
], - "metricFields": [
- {
- "targetBaseMetricName": "alias_field_name",
- "sourceField": "log_obj.numeric_field",
- "aggregations": [
- {
- "enabled": true,
- "aggType": "AGG_TYPE_UNSPECIFIED",
- "targetMetricName": "alias_field_name_agg_func",
- "samples": {
- "sampleType": "SAMPLE_TYPE_UNSPECIFIED"
}, - "histogram": {
- "buckets": 2
}
}
]
}
], - "type": "E2M_TYPE_UNSPECIFIED",
- "spansQuery": {
- "lucene": "applicationName:myApp",
- "applicationnameFilters": "myApp",
- "subsystemnameFilters": "mySubsystem",
- "actionFilters": "myAction",
- "serviceFilters": "myService"
}, - "logsQuery": {
- "lucene": "log_obj.numeric_field: [50 TO 100]",
- "alias": "new_query",
- "applicationnameFilters": "app_name",
- "subsystemnameFilters": "sub_name",
- "severityFilters": [
- "SEVERITY_UNSPECIFIED"
]
}, - "isInternal": true
}
}
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 | |
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. | |
object (SpansQuery) This data structure represents a query for logs. | |
isInternal | boolean (A flag that represents if the e2m is for internal usage) |
{- "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": {
- "limit": 30000,
- "hasExceededLimit": true
}, - "metricLabels": [
- {
- "targetLabel": "alias_label_name",
- "sourceField": "log_obj.string_value"
}
], - "metricFields": [
- {
- "targetBaseMetricName": "alias_field_name",
- "sourceField": "log_obj.numeric_field",
- "aggregations": [
- {
- "enabled": true,
- "aggType": "AGG_TYPE_UNSPECIFIED",
- "targetMetricName": "alias_field_name_agg_func",
- "samples": {
- "sampleType": "SAMPLE_TYPE_UNSPECIFIED"
}, - "histogram": {
- "buckets": 2
}
}
]
}
], - "type": "E2M_TYPE_UNSPECIFIED",
- "spansQuery": {
- "lucene": "applicationName:myApp",
- "applicationnameFilters": "myApp",
- "subsystemnameFilters": "mySubsystem",
- "actionFilters": "myAction",
- "serviceFilters": "myService"
}, - "logsQuery": {
- "lucene": "log_obj.numeric_field: [50 TO 100]",
- "alias": "new_query",
- "applicationnameFilters": "app_name",
- "subsystemnameFilters": "sub_name",
- "severityFilters": [
- "SEVERITY_UNSPECIFIED"
]
}, - "isInternal": true
}
{- "e2m": {
- "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": {
- "limit": 30000,
- "hasExceededLimit": true
}, - "metricLabels": [
- {
- "targetLabel": "alias_label_name",
- "sourceField": "log_obj.string_value"
}
], - "metricFields": [
- {
- "targetBaseMetricName": "alias_field_name",
- "sourceField": "log_obj.numeric_field",
- "aggregations": [
- {
- "enabled": true,
- "aggType": "AGG_TYPE_UNSPECIFIED",
- "targetMetricName": "alias_field_name_agg_func",
- "samples": {
- "sampleType": "SAMPLE_TYPE_UNSPECIFIED"
}, - "histogram": {
- "buckets": 2
}
}
]
}
], - "type": "E2M_TYPE_UNSPECIFIED",
- "spansQuery": {
- "lucene": "applicationName:myApp",
- "applicationnameFilters": "myApp",
- "subsystemnameFilters": "mySubsystem",
- "actionFilters": "myAction",
- "serviceFilters": "myService"
}, - "logsQuery": {
- "lucene": "log_obj.numeric_field: [50 TO 100]",
- "alias": "new_query",
- "applicationnameFilters": "app_name",
- "subsystemnameFilters": "sub_name",
- "severityFilters": [
- "SEVERITY_UNSPECIFIED"
]
}, - "isInternal": true
}
}
Array of objects (represents one of e2m actions create/replace/delete) |
{- "requests": [
- {
- "create": {
- "e2m": {
- "name": "Service catalog latency",
- "description": "avg and max the latency of catalog service",
- "permutationsLimit": 30000,
- "metricLabels": [
- {
- "targetLabel": "alias_label_name",
- "sourceField": "log_obj.string_value"
}
], - "metricFields": [
- {
- "targetBaseMetricName": "alias_field_name",
- "sourceField": "log_obj.numeric_field",
- "aggregations": [
- {
- "enabled": true,
- "aggType": "AGG_TYPE_UNSPECIFIED",
- "targetMetricName": "alias_field_name_agg_func",
- "samples": {
- "sampleType": null
}, - "histogram": {
- "buckets": [ ]
}
}
]
}
], - "type": "E2M_TYPE_UNSPECIFIED",
- "spansQuery": {
- "lucene": "applicationName:myApp",
- "applicationnameFilters": "myApp",
- "subsystemnameFilters": "mySubsystem",
- "actionFilters": "myAction",
- "serviceFilters": "myService"
}, - "logsQuery": {
- "lucene": "log_obj.numeric_field: [50 TO 100]",
- "alias": "new_query",
- "applicationnameFilters": "app_name",
- "subsystemnameFilters": "sub_name",
- "severityFilters": [
- "SEVERITY_UNSPECIFIED"
]
}
}
}, - "replace": {
- "e2m": {
- "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": {
- "limit": 30000,
- "hasExceededLimit": true
}, - "metricLabels": [
- {
- "targetLabel": "alias_label_name",
- "sourceField": "log_obj.string_value"
}
], - "metricFields": [
- {
- "targetBaseMetricName": "alias_field_name",
- "sourceField": "log_obj.numeric_field",
- "aggregations": [
- {
- "enabled": true,
- "aggType": "AGG_TYPE_UNSPECIFIED",
- "targetMetricName": "alias_field_name_agg_func",
- "samples": {
- "sampleType": null
}, - "histogram": {
- "buckets": [ ]
}
}
]
}
], - "type": "E2M_TYPE_UNSPECIFIED",
- "spansQuery": {
- "lucene": "applicationName:myApp",
- "applicationnameFilters": "myApp",
- "subsystemnameFilters": "mySubsystem",
- "actionFilters": "myAction",
- "serviceFilters": "myService"
}, - "logsQuery": {
- "lucene": "log_obj.numeric_field: [50 TO 100]",
- "alias": "new_query",
- "applicationnameFilters": "app_name",
- "subsystemnameFilters": "sub_name",
- "severityFilters": [
- "SEVERITY_UNSPECIFIED"
]
}, - "isInternal": true
}
}, - "delete": {
- "id": "d6a3658e-78d2-47d0-9b81-b2c551f01b09"
}
}
]
}
{- "matchingResponses": [
- {
- "created": {
- "e2m": {
- "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": {
- "limit": 30000,
- "hasExceededLimit": true
}, - "metricLabels": [
- {
- "targetLabel": "alias_label_name",
- "sourceField": "log_obj.string_value"
}
], - "metricFields": [
- {
- "targetBaseMetricName": "alias_field_name",
- "sourceField": "log_obj.numeric_field",
- "aggregations": [
- {
- "enabled": true,
- "aggType": "AGG_TYPE_UNSPECIFIED",
- "targetMetricName": "alias_field_name_agg_func",
- "samples": {
- "sampleType": null
}, - "histogram": {
- "buckets": [ ]
}
}
]
}
], - "type": "E2M_TYPE_UNSPECIFIED",
- "spansQuery": {
- "lucene": "applicationName:myApp",
- "applicationnameFilters": "myApp",
- "subsystemnameFilters": "mySubsystem",
- "actionFilters": "myAction",
- "serviceFilters": "myService"
}, - "logsQuery": {
- "lucene": "log_obj.numeric_field: [50 TO 100]",
- "alias": "new_query",
- "applicationnameFilters": "app_name",
- "subsystemnameFilters": "sub_name",
- "severityFilters": [
- "SEVERITY_UNSPECIFIED"
]
}, - "isInternal": true
}
}, - "replaced": {
- "e2m": {
- "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": {
- "limit": 30000,
- "hasExceededLimit": true
}, - "metricLabels": [
- {
- "targetLabel": "alias_label_name",
- "sourceField": "log_obj.string_value"
}
], - "metricFields": [
- {
- "targetBaseMetricName": "alias_field_name",
- "sourceField": "log_obj.numeric_field",
- "aggregations": [
- {
- "enabled": true,
- "aggType": "AGG_TYPE_UNSPECIFIED",
- "targetMetricName": "alias_field_name_agg_func",
- "samples": {
- "sampleType": null
}, - "histogram": {
- "buckets": [ ]
}
}
]
}
], - "type": "E2M_TYPE_UNSPECIFIED",
- "spansQuery": {
- "lucene": "applicationName:myApp",
- "applicationnameFilters": "myApp",
- "subsystemnameFilters": "mySubsystem",
- "actionFilters": "myAction",
- "serviceFilters": "myService"
}, - "logsQuery": {
- "lucene": "log_obj.numeric_field: [50 TO 100]",
- "alias": "new_query",
- "applicationnameFilters": "app_name",
- "subsystemnameFilters": "sub_name",
- "severityFilters": [
- "SEVERITY_UNSPECIFIED"
]
}, - "isInternal": true
}
}, - "deleted": {
- "id": "string"
}
}
]
}
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 |
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));
{- "permutations": [
- {
- "day": "string",
- "permutations": 0
}
]
}
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));
{- "companyId": "string",
- "labelsLimit": 0,
- "permutationsLimit": {
- "limit": 0,
- "used": 0
}, - "metricsLimit": {
- "limit": 0,
- "used": 0
}
}
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));
{- "e2m": {
- "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": {
- "limit": 30000,
- "hasExceededLimit": true
}, - "metricLabels": [
- {
- "targetLabel": "alias_label_name",
- "sourceField": "log_obj.string_value"
}
], - "metricFields": [
- {
- "targetBaseMetricName": "alias_field_name",
- "sourceField": "log_obj.numeric_field",
- "aggregations": [
- {
- "enabled": true,
- "aggType": "AGG_TYPE_UNSPECIFIED",
- "targetMetricName": "alias_field_name_agg_func",
- "samples": {
- "sampleType": "SAMPLE_TYPE_UNSPECIFIED"
}, - "histogram": {
- "buckets": 2
}
}
]
}
], - "type": "E2M_TYPE_UNSPECIFIED",
- "spansQuery": {
- "lucene": "applicationName:myApp",
- "applicationnameFilters": "myApp",
- "subsystemnameFilters": "mySubsystem",
- "actionFilters": "myAction",
- "serviceFilters": "myService"
}, - "logsQuery": {
- "lucene": "log_obj.numeric_field: [50 TO 100]",
- "alias": "new_query",
- "applicationnameFilters": "app_name",
- "subsystemnameFilters": "sub_name",
- "severityFilters": [
- "SEVERITY_UNSPECIFIED"
]
}, - "isInternal": true
}
}
id required | string id of e2m to be deleted |
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));
{- "id": "string"
}
ids required | Array of strings |
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));
{- "scopes": [
- {
- "id": "scope_id",
- "displayName": "scope_name",
- "description": "scope_description",
- "teamId": 1234,
- "filters": [
- {
- "entityType": "ENTITY_TYPE_UNSPECIFIED",
- "expression": "expression"
}
], - "defaultExpression": "expression"
}
]
}
This data structure represents a request to create a scope
displayName required | string |
description | string |
required | Array of objects (Filter) |
defaultExpression | string |
{- "displayName": "scope_name",
- "description": "scope_description",
- "filters": [
- {
- "entityType": "ENTITY_TYPE_UNSPECIFIED",
- "expression": "expression"
}
], - "defaultExpression": "expression"
}
{- "scope": {
- "id": "scope_id",
- "displayName": "scope_name",
- "description": "scope_description",
- "teamId": 1234,
- "filters": [
- {
- "entityType": "ENTITY_TYPE_UNSPECIFIED",
- "expression": "expression"
}
], - "defaultExpression": "expression"
}
}
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 |
{- "id": "scope_id",
- "displayName": "scope_name",
- "description": "scope_description",
- "filters": [
- {
- "entityType": "ENTITY_TYPE_UNSPECIFIED",
- "expression": "expression"
}
], - "defaultExpression": "expression"
}
{- "scope": {
- "id": "scope_id",
- "displayName": "scope_name",
- "description": "scope_description",
- "teamId": 1234,
- "filters": [
- {
- "entityType": "ENTITY_TYPE_UNSPECIFIED",
- "expression": "expression"
}
], - "defaultExpression": "expression"
}
}
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));
{- "scopes": [
- {
- "id": "scope_id",
- "displayName": "scope_name",
- "description": "scope_description",
- "teamId": 1234,
- "filters": [
- {
- "entityType": "ENTITY_TYPE_UNSPECIFIED",
- "expression": "expression"
}
], - "defaultExpression": "expression"
}
]
}
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));
{ }
Request to list incidents with filtering, pagination and ordering options
object (v1IncidentQueryFilter) | |
object (Pagination Request) Pagination parameters for list requests | |
Array of objects (OrderBy) |
{- "filter": {
- "assignee": [
- "string"
], - "status": [
- "INCIDENT_STATUS_UNSPECIFIED"
], - "state": [
- "INCIDENT_STATE_UNSPECIFIED"
], - "severity": [
- "INCIDENT_SEVERITY_UNSPECIFIED"
], - "contextualLabels": {
- "property1": {
- "contextualLabelValues": [
- "string"
]
}, - "property2": {
- "contextualLabelValues": [
- "string"
]
}
}, - "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "searchQuery": {
- "query": "string",
- "incidentField": "INCIDENTS_FIELDS_UNSPECIFIED",
- "contextualLabel": "string"
}, - "applicationName": [
- "string"
], - "subsystemName": [
- "string"
], - "isMuted": true,
- "createdAtRange": {
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z"
}, - "incidentDurationRange": {
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z"
}, - "metaLabels": [
- {
- "key": "key",
- "value": "value"
}
], - "metaLabelsOp": "FILTER_OPERATOR_OR_OR_UNSPECIFIED"
}, - "pagination": {
- "pageSize": 0,
- "pageToken": "string"
}, - "orderBys": [
- {
- "incidentField": "INCIDENTS_FIELDS_UNSPECIFIED",
- "contextualLabel": "string",
- "direction": "ORDER_BY_DIRECTION_UNSPECIFIED"
}
]
}
{- "incidents": [
- {
- "id": "incident_id",
- "name": "incident_name",
- "state": "INCIDENT_STATE_UNSPECIFIED",
- "status": "INCIDENT_STATUS_UNSPECIFIED",
- "assignments": [
- {
- "assignedTo": {
- "userId": "string"
}, - "assignedBy": {
- "userId": "string"
}
}
], - "description": "incident_description",
- "severity": "INCIDENT_SEVERITY_UNSPECIFIED",
- "contextualLabels": {
- "property1": "string",
- "property2": "string"
}, - "displayLabels": {
- "property1": "string",
- "property2": "string"
}, - "events": [
- {
- "id": "string",
- "incidentEventType": "INCIDENT_EVENT_TYPE_UNSPECIFIED",
- "snoozeIndicator": {
- "startTime": "2019-08-24T14:15:22Z",
- "durationMinutes": 0,
- "userId": "string"
}, - "assignment": {
- "assignment": {
- "assignedTo": {
- "userId": "string"
}, - "assignedBy": {
- "userId": "string"
}
}
}, - "unassign": { },
- "upsertState": {
- "stateType": "UPSERT_INCIDENT_STATE_TYPE_UNSPECIFIED",
- "payload": {
- "cxEventKey": "string"
}, - "isMuted": true
}, - "acknowledge": {
- "acknowledgedBy": {
- "userId": "string"
}
}, - "close": {
- "closedBy": {
- "userId": "string"
}
}, - "originatorType": "ORIGINATOR_TYPE_UNSPECIFIED",
- "administrativeEvent": {
- "userId": "string"
}, - "operationalEvent": {
- "systemName": "string"
}
}
], - "createdAt": "2024-01-01T00:00:00.000Z",
- "closedAt": "2024-01-01T00:00:00.000Z",
- "lastStateUpdateTime": "2024-01-01T00:00:00.000Z",
- "lastStateUpdateKey": "last_state_update_key",
- "isMuted": false,
- "metaLabels": [
- {
- "key": "key",
- "value": "value"
}
], - "duration": "string"
}
], - "pagination": {
- "totalSize": 0,
- "nextPageToken": "string"
}
}
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));
{- "incident": {
- "id": "incident_id",
- "name": "incident_name",
- "state": "INCIDENT_STATE_UNSPECIFIED",
- "status": "INCIDENT_STATUS_UNSPECIFIED",
- "assignments": [
- {
- "assignedTo": {
- "userId": "string"
}, - "assignedBy": {
- "userId": "string"
}
}
], - "description": "incident_description",
- "severity": "INCIDENT_SEVERITY_UNSPECIFIED",
- "contextualLabels": {
- "property1": "string",
- "property2": "string"
}, - "displayLabels": {
- "property1": "string",
- "property2": "string"
}, - "events": [
- {
- "id": "string",
- "incidentEventType": "INCIDENT_EVENT_TYPE_UNSPECIFIED",
- "snoozeIndicator": {
- "startTime": "2019-08-24T14:15:22Z",
- "durationMinutes": 0,
- "userId": "string"
}, - "assignment": {
- "assignment": {
- "assignedTo": {
- "userId": "string"
}, - "assignedBy": {
- "userId": "string"
}
}
}, - "unassign": { },
- "upsertState": {
- "stateType": "UPSERT_INCIDENT_STATE_TYPE_UNSPECIFIED",
- "payload": {
- "cxEventKey": "string"
}, - "isMuted": true
}, - "acknowledge": {
- "acknowledgedBy": {
- "userId": "string"
}
}, - "close": {
- "closedBy": {
- "userId": "string"
}
}, - "originatorType": "ORIGINATOR_TYPE_UNSPECIFIED",
- "administrativeEvent": {
- "userId": "string"
}, - "operationalEvent": {
- "systemName": "string"
}
}
], - "createdAt": "2024-01-01T00:00:00.000Z",
- "closedAt": "2024-01-01T00:00:00.000Z",
- "lastStateUpdateTime": "2024-01-01T00:00:00.000Z",
- "lastStateUpdateKey": "last_state_update_key",
- "isMuted": false,
- "metaLabels": [
- {
- "key": "key",
- "value": "value"
}
], - "duration": "string"
}
}
incidentId required | string |
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));
{- "incidentEvents": [
- {
- "id": "string",
- "incidentEventType": "INCIDENT_EVENT_TYPE_UNSPECIFIED",
- "snoozeIndicator": {
- "startTime": "2019-08-24T14:15:22Z",
- "durationMinutes": 0,
- "userId": "string"
}, - "assignment": {
- "assignment": {
- "assignedTo": {
- "userId": "string"
}, - "assignedBy": {
- "userId": "string"
}
}
}, - "unassign": { },
- "upsertState": {
- "stateType": "UPSERT_INCIDENT_STATE_TYPE_UNSPECIFIED",
- "payload": {
- "cxEventKey": "string"
}, - "isMuted": true
}, - "acknowledge": {
- "acknowledgedBy": {
- "userId": "string"
}
}, - "close": {
- "closedBy": {
- "userId": "string"
}
}, - "originatorType": "ORIGINATOR_TYPE_UNSPECIFIED",
- "administrativeEvent": {
- "userId": "string"
}, - "operationalEvent": {
- "systemName": "string"
}
}
]
}
Request to acknowledge one or more incidents
incidentIds required | Array of strings List of incident IDs to acknowledge |
{- "incidentIds": [
- "incident_id_1",
- "incident_id_2"
]
}
{- "incidents": [
- {
- "id": "incident_id",
- "name": "incident_name",
- "state": "INCIDENT_STATE_UNSPECIFIED",
- "status": "INCIDENT_STATUS_UNSPECIFIED",
- "assignments": [
- {
- "assignedTo": {
- "userId": "string"
}, - "assignedBy": {
- "userId": "string"
}
}
], - "description": "incident_description",
- "severity": "INCIDENT_SEVERITY_UNSPECIFIED",
- "contextualLabels": {
- "property1": "string",
- "property2": "string"
}, - "displayLabels": {
- "property1": "string",
- "property2": "string"
}, - "events": [
- {
- "id": "string",
- "incidentEventType": "INCIDENT_EVENT_TYPE_UNSPECIFIED",
- "snoozeIndicator": {
- "startTime": "2019-08-24T14:15:22Z",
- "durationMinutes": 0,
- "userId": "string"
}, - "assignment": {
- "assignment": {
- "assignedTo": {
- "userId": "string"
}, - "assignedBy": {
- "userId": "string"
}
}
}, - "unassign": { },
- "upsertState": {
- "stateType": "UPSERT_INCIDENT_STATE_TYPE_UNSPECIFIED",
- "payload": {
- "cxEventKey": "string"
}, - "isMuted": true
}, - "acknowledge": {
- "acknowledgedBy": {
- "userId": "string"
}
}, - "close": {
- "closedBy": {
- "userId": "string"
}
}, - "originatorType": "ORIGINATOR_TYPE_UNSPECIFIED",
- "administrativeEvent": {
- "userId": "string"
}, - "operationalEvent": {
- "systemName": "string"
}
}
], - "createdAt": "2024-01-01T00:00:00.000Z",
- "closedAt": "2024-01-01T00:00:00.000Z",
- "lastStateUpdateTime": "2024-01-01T00:00:00.000Z",
- "lastStateUpdateKey": "last_state_update_key",
- "isMuted": false,
- "metaLabels": [
- {
- "key": "key",
- "value": "value"
}
], - "duration": "string"
}
]
}
Request to assign one or more incidents to a user
incidentIds required | Array of strings |
required | object (v1UserDetails) |
{- "incidentIds": [
- "string"
], - "assignedTo": {
- "userId": "string"
}
}
{- "incidents": [
- {
- "id": "incident_id",
- "name": "incident_name",
- "state": "INCIDENT_STATE_UNSPECIFIED",
- "status": "INCIDENT_STATUS_UNSPECIFIED",
- "assignments": [
- {
- "assignedTo": {
- "userId": "string"
}, - "assignedBy": {
- "userId": "string"
}
}
], - "description": "incident_description",
- "severity": "INCIDENT_SEVERITY_UNSPECIFIED",
- "contextualLabels": {
- "property1": "string",
- "property2": "string"
}, - "displayLabels": {
- "property1": "string",
- "property2": "string"
}, - "events": [
- {
- "id": "string",
- "incidentEventType": "INCIDENT_EVENT_TYPE_UNSPECIFIED",
- "snoozeIndicator": {
- "startTime": "2019-08-24T14:15:22Z",
- "durationMinutes": 0,
- "userId": "string"
}, - "assignment": {
- "assignment": {
- "assignedTo": {
- "userId": "string"
}, - "assignedBy": {
- "userId": "string"
}
}
}, - "unassign": { },
- "upsertState": {
- "stateType": "UPSERT_INCIDENT_STATE_TYPE_UNSPECIFIED",
- "payload": {
- "cxEventKey": "string"
}, - "isMuted": true
}, - "acknowledge": {
- "acknowledgedBy": {
- "userId": "string"
}
}, - "close": {
- "closedBy": {
- "userId": "string"
}
}, - "originatorType": "ORIGINATOR_TYPE_UNSPECIFIED",
- "administrativeEvent": {
- "userId": "string"
}, - "operationalEvent": {
- "systemName": "string"
}
}
], - "createdAt": "2024-01-01T00:00:00.000Z",
- "closedAt": "2024-01-01T00:00:00.000Z",
- "lastStateUpdateTime": "2024-01-01T00:00:00.000Z",
- "lastStateUpdateKey": "last_state_update_key",
- "isMuted": false,
- "metaLabels": [
- {
- "key": "key",
- "value": "value"
}
], - "duration": "string"
}
]
}
ids required | Array of strings |
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));
{- "incidents": {
- "property1": {
- "id": "incident_id",
- "name": "incident_name",
- "state": "INCIDENT_STATE_UNSPECIFIED",
- "status": "INCIDENT_STATUS_UNSPECIFIED",
- "assignments": [
- {
- "assignedTo": {
- "userId": "string"
}, - "assignedBy": {
- "userId": "string"
}
}
], - "description": "incident_description",
- "severity": "INCIDENT_SEVERITY_UNSPECIFIED",
- "contextualLabels": {
- "property1": "string",
- "property2": "string"
}, - "displayLabels": {
- "property1": "string",
- "property2": "string"
}, - "events": [
- {
- "id": "string",
- "incidentEventType": "INCIDENT_EVENT_TYPE_UNSPECIFIED",
- "snoozeIndicator": {
- "startTime": "2019-08-24T14:15:22Z",
- "durationMinutes": 0,
- "userId": "string"
}, - "assignment": {
- "assignment": {
- "assignedTo": {
- "userId": "string"
}, - "assignedBy": {
- "userId": "string"
}
}
}, - "unassign": { },
- "upsertState": {
- "stateType": "UPSERT_INCIDENT_STATE_TYPE_UNSPECIFIED",
- "payload": {
- "cxEventKey": "string"
}, - "isMuted": true
}, - "acknowledge": {
- "acknowledgedBy": {
- "userId": "string"
}
}, - "close": {
- "closedBy": {
- "userId": "string"
}
}, - "originatorType": "ORIGINATOR_TYPE_UNSPECIFIED",
- "administrativeEvent": {
- "userId": "string"
}, - "operationalEvent": {
- "systemName": "string"
}
}
], - "createdAt": "2024-01-01T00:00:00.000Z",
- "closedAt": "2024-01-01T00:00:00.000Z",
- "lastStateUpdateTime": "2024-01-01T00:00:00.000Z",
- "lastStateUpdateKey": "last_state_update_key",
- "isMuted": false,
- "metaLabels": [
- {
- "key": "key",
- "value": "value"
}
], - "duration": "string"
}, - "property2": {
- "id": "incident_id",
- "name": "incident_name",
- "state": "INCIDENT_STATE_UNSPECIFIED",
- "status": "INCIDENT_STATUS_UNSPECIFIED",
- "assignments": [
- {
- "assignedTo": {
- "userId": "string"
}, - "assignedBy": {
- "userId": "string"
}
}
], - "description": "incident_description",
- "severity": "INCIDENT_SEVERITY_UNSPECIFIED",
- "contextualLabels": {
- "property1": "string",
- "property2": "string"
}, - "displayLabels": {
- "property1": "string",
- "property2": "string"
}, - "events": [
- {
- "id": "string",
- "incidentEventType": "INCIDENT_EVENT_TYPE_UNSPECIFIED",
- "snoozeIndicator": {
- "startTime": "2019-08-24T14:15:22Z",
- "durationMinutes": 0,
- "userId": "string"
}, - "assignment": {
- "assignment": {
- "assignedTo": {
- "userId": "string"
}, - "assignedBy": {
- "userId": "string"
}
}
}, - "unassign": { },
- "upsertState": {
- "stateType": "UPSERT_INCIDENT_STATE_TYPE_UNSPECIFIED",
- "payload": {
- "cxEventKey": "string"
}, - "isMuted": true
}, - "acknowledge": {
- "acknowledgedBy": {
- "userId": "string"
}
}, - "close": {
- "closedBy": {
- "userId": "string"
}
}, - "originatorType": "ORIGINATOR_TYPE_UNSPECIFIED",
- "administrativeEvent": {
- "userId": "string"
}, - "operationalEvent": {
- "systemName": "string"
}
}
], - "createdAt": "2024-01-01T00:00:00.000Z",
- "closedAt": "2024-01-01T00:00:00.000Z",
- "lastStateUpdateTime": "2024-01-01T00:00:00.000Z",
- "lastStateUpdateKey": "last_state_update_key",
- "isMuted": false,
- "metaLabels": [
- {
- "key": "key",
- "value": "value"
}
], - "duration": "string"
}
}, - "notFoundIds": [
- "string"
]
}
Request to close one or more incidents
incidentIds required | Array of strings List of incident IDs to close |
{- "incidentIds": [
- "incident_id_1",
- "incident_id_2"
]
}
{- "incidents": [
- {
- "id": "incident_id",
- "name": "incident_name",
- "state": "INCIDENT_STATE_UNSPECIFIED",
- "status": "INCIDENT_STATUS_UNSPECIFIED",
- "assignments": [
- {
- "assignedTo": {
- "userId": "string"
}, - "assignedBy": {
- "userId": "string"
}
}
], - "description": "incident_description",
- "severity": "INCIDENT_SEVERITY_UNSPECIFIED",
- "contextualLabels": {
- "property1": "string",
- "property2": "string"
}, - "displayLabels": {
- "property1": "string",
- "property2": "string"
}, - "events": [
- {
- "id": "string",
- "incidentEventType": "INCIDENT_EVENT_TYPE_UNSPECIFIED",
- "snoozeIndicator": {
- "startTime": "2019-08-24T14:15:22Z",
- "durationMinutes": 0,
- "userId": "string"
}, - "assignment": {
- "assignment": {
- "assignedTo": {
- "userId": "string"
}, - "assignedBy": {
- "userId": "string"
}
}
}, - "unassign": { },
- "upsertState": {
- "stateType": "UPSERT_INCIDENT_STATE_TYPE_UNSPECIFIED",
- "payload": {
- "cxEventKey": "string"
}, - "isMuted": true
}, - "acknowledge": {
- "acknowledgedBy": {
- "userId": "string"
}
}, - "close": {
- "closedBy": {
- "userId": "string"
}
}, - "originatorType": "ORIGINATOR_TYPE_UNSPECIFIED",
- "administrativeEvent": {
- "userId": "string"
}, - "operationalEvent": {
- "systemName": "string"
}
}
], - "createdAt": "2024-01-01T00:00:00.000Z",
- "closedAt": "2024-01-01T00:00:00.000Z",
- "lastStateUpdateTime": "2024-01-01T00:00:00.000Z",
- "lastStateUpdateKey": "last_state_update_key",
- "isMuted": false,
- "metaLabels": [
- {
- "key": "key",
- "value": "value"
}
], - "duration": "string"
}
]
}
Request to get available filter values for incidents
object (v1IncidentQueryFilter) |
{- "filter": {
- "assignee": [
- "string"
], - "status": [
- "INCIDENT_STATUS_UNSPECIFIED"
], - "state": [
- "INCIDENT_STATE_UNSPECIFIED"
], - "severity": [
- "INCIDENT_SEVERITY_UNSPECIFIED"
], - "contextualLabels": {
- "property1": {
- "contextualLabelValues": [
- "string"
]
}, - "property2": {
- "contextualLabelValues": [
- "string"
]
}
}, - "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "searchQuery": {
- "query": "string",
- "incidentField": "INCIDENTS_FIELDS_UNSPECIFIED",
- "contextualLabel": "string"
}, - "applicationName": [
- "string"
], - "subsystemName": [
- "string"
], - "isMuted": true,
- "createdAtRange": {
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z"
}, - "incidentDurationRange": {
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z"
}, - "metaLabels": [
- {
- "key": "key",
- "value": "value"
}
], - "metaLabelsOp": "FILTER_OPERATOR_OR_OR_UNSPECIFIED"
}
}
{- "filtersValues": {
- "assigneeWithCount": [
- {
- "assignee": "assignee",
- "count": 10
}
], - "statusWithCount": [
- {
- "status": "INCIDENT_STATUS_UNSPECIFIED",
- "count": 10
}
], - "stateWithCount": [
- {
- "state": "INCIDENT_STATE_UNSPECIFIED",
- "count": 10
}
], - "severityWithCount": [
- {
- "severity": "INCIDENT_SEVERITY_UNSPECIFIED",
- "count": 10
}
], - "contextualLabels": {
- "property1": {
- "valuesWithCount": [
- {
- "contextualLabelValue": "contextual_label_value",
- "count": 10
}
]
}, - "property2": {
- "valuesWithCount": [
- {
- "contextualLabelValue": "contextual_label_value",
- "count": 10
}
]
}
}, - "metaLabelsWithCount": [
- {
- "metaLabel": {
- "key": "key",
- "value": "value"
}, - "count": 10
}
], - "metaLabelsOp": "FILTER_OPERATOR_OR_OR_UNSPECIFIED"
}
}
Request to get an incident using a correlation key and timestamp
correlationKey required | string Correlation key to identify the incident |
incidentPointInTime required | string <date-time> Timestamp to identify the specific point in time for the incident |
{- "correlationKey": "correlation_key_123",
- "incidentPointInTime": "2024-01-01T00:00:00.000Z"
}
{- "incident": {
- "id": "incident_id",
- "name": "incident_name",
- "state": "INCIDENT_STATE_UNSPECIFIED",
- "status": "INCIDENT_STATUS_UNSPECIFIED",
- "assignments": [
- {
- "assignedTo": {
- "userId": "string"
}, - "assignedBy": {
- "userId": "string"
}
}
], - "description": "incident_description",
- "severity": "INCIDENT_SEVERITY_UNSPECIFIED",
- "contextualLabels": {
- "property1": "string",
- "property2": "string"
}, - "displayLabels": {
- "property1": "string",
- "property2": "string"
}, - "events": [
- {
- "id": "string",
- "incidentEventType": "INCIDENT_EVENT_TYPE_UNSPECIFIED",
- "snoozeIndicator": {
- "startTime": "2019-08-24T14:15:22Z",
- "durationMinutes": 0,
- "userId": "string"
}, - "assignment": {
- "assignment": {
- "assignedTo": {
- "userId": "string"
}, - "assignedBy": {
- "userId": "string"
}
}
}, - "unassign": { },
- "upsertState": {
- "stateType": "UPSERT_INCIDENT_STATE_TYPE_UNSPECIFIED",
- "payload": {
- "cxEventKey": "string"
}, - "isMuted": true
}, - "acknowledge": {
- "acknowledgedBy": {
- "userId": "string"
}
}, - "close": {
- "closedBy": {
- "userId": "string"
}
}, - "originatorType": "ORIGINATOR_TYPE_UNSPECIFIED",
- "administrativeEvent": {
- "userId": "string"
}, - "operationalEvent": {
- "systemName": "string"
}
}
], - "createdAt": "2024-01-01T00:00:00.000Z",
- "closedAt": "2024-01-01T00:00:00.000Z",
- "lastStateUpdateTime": "2024-01-01T00:00:00.000Z",
- "lastStateUpdateKey": "last_state_update_key",
- "isMuted": false,
- "metaLabels": [
- {
- "key": "key",
- "value": "value"
}
], - "duration": "string"
}
}
Request to get aggregated incident data with filtering and grouping options
object (v1IncidentQueryFilter) | |
Array of objects (GroupBy) | |
object (Pagination Request) Pagination parameters for list requests |
{- "filter": {
- "assignee": [
- "string"
], - "status": [
- "INCIDENT_STATUS_UNSPECIFIED"
], - "state": [
- "INCIDENT_STATE_UNSPECIFIED"
], - "severity": [
- "INCIDENT_SEVERITY_UNSPECIFIED"
], - "contextualLabels": {
- "property1": {
- "contextualLabelValues": [
- "string"
]
}, - "property2": {
- "contextualLabelValues": [
- "string"
]
}
}, - "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "searchQuery": {
- "query": "string",
- "incidentField": "INCIDENTS_FIELDS_UNSPECIFIED",
- "contextualLabel": "string"
}, - "applicationName": [
- "string"
], - "subsystemName": [
- "string"
], - "isMuted": true,
- "createdAtRange": {
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z"
}, - "incidentDurationRange": {
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z"
}, - "metaLabels": [
- {
- "key": "key",
- "value": "value"
}
], - "metaLabelsOp": "FILTER_OPERATOR_OR_OR_UNSPECIFIED"
}, - "groupBys": [
- {
- "incidentField": "INCIDENTS_FIELDS_UNSPECIFIED",
- "contextualLabel": "string",
- "orderByDirection": "ORDER_BY_DIRECTION_UNSPECIFIED"
}
], - "pagination": {
- "pageSize": 0,
- "pageToken": "string"
}
}
{- "incidentAggs": [
- {
- "groupBysValue": [
- {
- "incidentField": {
- "id": "string",
- "severity": "INCIDENT_SEVERITY_UNSPECIFIED",
- "name": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "closedAt": "2019-08-24T14:15:22Z",
- "state": "INCIDENT_STATE_UNSPECIFIED",
- "status": "INCIDENT_STATUS_UNSPECIFIED",
- "lastStateUpdateTime": "2019-08-24T14:15:22Z",
- "applicationName": "string",
- "subsystemName": "string",
- "duration": "string"
}, - "contextualLabels": {
- "fieldName": "field_name",
- "fieldValue": "field_value"
}
}
], - "aggStateCount": [
- {
- "state": "INCIDENT_STATE_UNSPECIFIED",
- "count": 10
}
], - "aggStatusCount": [
- {
- "status": "INCIDENT_STATUS_UNSPECIFIED",
- "count": 10
}
], - "aggSeverityCount": [
- {
- "severity": "INCIDENT_SEVERITY_UNSPECIFIED",
- "count": 10
}
], - "aggAssignmentsCount": [
- {
- "assignedTo": {
- "userId": "string"
}, - "count": 10
}
], - "firstCreatedAt": "2019-08-24T14:15:22Z",
- "lastClosedAt": "2019-08-24T14:15:22Z",
- "allValuesCount": 0,
- "listIncidentsId": [
- "string"
], - "lastStateUpdateTime": "2019-08-24T14:15:22Z",
- "aggMetaLabelsCount": [
- {
- "metaLabel": {
- "key": "key",
- "value": "value"
}, - "count": 10
}
]
}
], - "pagination": {
- "totalSize": 0,
- "nextPageToken": "string"
}
}
Request to list incident events with filtering, pagination and ordering options
object (v1IncidentEventQueryFilter) | |
object (Pagination Request) Pagination parameters for list requests | |
object (List Incident Event Request Order By) Ordering configuration for incident events list |
{- "filter": {
- "status": [
- "INCIDENT_STATUS_UNSPECIFIED"
], - "severity": [
- "INCIDENT_SEVERITY_UNSPECIFIED"
], - "contextualLabels": {
- "property1": {
- "contextualLabelValues": [
- "string"
]
}, - "property2": {
- "contextualLabelValues": [
- "string"
]
}
}, - "name": "string",
- "isMuted": true,
- "timestamp": {
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z"
}, - "labels": {
- "metaLabels": [
- {
- "key": "key",
- "value": "value"
}
], - "operator": "FILTER_OPERATOR_OR_OR_UNSPECIFIED"
}
}, - "pagination": {
- "pageSize": 0,
- "pageToken": "string"
}, - "orderBy": {
- "field": "INCIDENT_EVENT_ORDER_BY_FIELD_TYPE_TIMESTAMP_OR_UNSPECIFIED",
- "direction": "ORDER_BY_DIRECTION_UNSPECIFIED"
}
}
{- "items": [
- {
- "cxEventKey": "string",
- "incidentEvent": {
- "id": "string",
- "incidentEventType": "INCIDENT_EVENT_TYPE_UNSPECIFIED",
- "snoozeIndicator": {
- "startTime": "2019-08-24T14:15:22Z",
- "durationMinutes": 0,
- "userId": "string"
}, - "assignment": {
- "assignment": {
- "assignedTo": {
- "userId": "string"
}, - "assignedBy": {
- "userId": "string"
}
}
}, - "unassign": { },
- "upsertState": {
- "stateType": "UPSERT_INCIDENT_STATE_TYPE_UNSPECIFIED",
- "payload": {
- "cxEventKey": "string"
}, - "isMuted": true
}, - "acknowledge": {
- "acknowledgedBy": {
- "userId": "string"
}
}, - "close": {
- "closedBy": {
- "userId": "string"
}
}, - "originatorType": "ORIGINATOR_TYPE_UNSPECIFIED",
- "administrativeEvent": {
- "userId": "string"
}, - "operationalEvent": {
- "systemName": "string"
}
}, - "cxEventTimestamp": "2019-08-24T14:15:22Z",
- "incidentEventExtendedMetadata": {
- "incidentSeverity": "INCIDENT_SEVERITY_UNSPECIFIED",
- "alertId": "string",
- "incidentState": "INCIDENT_STATE_UNSPECIFIED",
- "alertName": "string",
- "alertType": "INCIDENT_EVENT_ALERT_TYPE_STANDARD_OR_UNSPECIFIED",
- "isMuted": true,
- "incidentStatus": "INCIDENT_STATUS_UNSPECIFIED",
- "alertGroupByFields": [
- "string"
], - "alertLabels": [
- {
- "key": "key",
- "value": "value"
}
], - "incidentPermutation": {
- "property1": "string",
- "property2": "string"
}
}
}
], - "pagination": {
- "totalSize": 0,
- "nextPageToken": "string"
}
}
Request to get available filter values for incident events
object (v1IncidentEventQueryFilter) |
{- "filter": {
- "status": [
- "INCIDENT_STATUS_UNSPECIFIED"
], - "severity": [
- "INCIDENT_SEVERITY_UNSPECIFIED"
], - "contextualLabels": {
- "property1": {
- "contextualLabelValues": [
- "string"
]
}, - "property2": {
- "contextualLabelValues": [
- "string"
]
}
}, - "name": "string",
- "isMuted": true,
- "timestamp": {
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z"
}, - "labels": {
- "metaLabels": [
- {
- "key": "key",
- "value": "value"
}
], - "operator": "FILTER_OPERATOR_OR_OR_UNSPECIFIED"
}
}
}
{- "filtersValues": {
- "assigneeWithCount": [
- {
- "assignee": "assignee",
- "count": 10
}
], - "statusWithCount": [
- {
- "status": "INCIDENT_STATUS_UNSPECIFIED",
- "count": 10
}
], - "stateWithCount": [
- {
- "state": "INCIDENT_STATE_UNSPECIFIED",
- "count": 10
}
], - "severityWithCount": [
- {
- "severity": "INCIDENT_SEVERITY_UNSPECIFIED",
- "count": 10
}
], - "contextualLabels": {
- "property1": {
- "valuesWithCount": [
- {
- "contextualLabelValue": "contextual_label_value",
- "count": 10
}
]
}, - "property2": {
- "valuesWithCount": [
- {
- "contextualLabelValue": "contextual_label_value",
- "count": 10
}
]
}
}, - "metaLabelsWithCount": [
- {
- "metaLabel": {
- "key": "key",
- "value": "value"
}, - "count": 10
}
], - "metaLabelsOp": "FILTER_OPERATOR_OR_OR_UNSPECIFIED"
}
}
Request to get the total count of incident events matching a filter
object (v1IncidentEventQueryFilter) |
{- "filter": {
- "status": [
- "INCIDENT_STATUS_UNSPECIFIED"
], - "severity": [
- "INCIDENT_SEVERITY_UNSPECIFIED"
], - "contextualLabels": {
- "property1": {
- "contextualLabelValues": [
- "string"
]
}, - "property2": {
- "contextualLabelValues": [
- "string"
]
}
}, - "name": "string",
- "isMuted": true,
- "timestamp": {
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z"
}, - "labels": {
- "metaLabels": [
- {
- "key": "key",
- "value": "value"
}
], - "operator": "FILTER_OPERATOR_OR_OR_UNSPECIFIED"
}
}
}
{- "count": 100,
- "reachedLimit": false
}
Request to resolve one or more incidents
incidentIds required | Array of strings List of incident IDs to resolve |
{- "incidentIds": [
- "incident_id_1",
- "incident_id_2"
]
}
{- "incidents": [
- {
- "id": "incident_id",
- "name": "incident_name",
- "state": "INCIDENT_STATE_UNSPECIFIED",
- "status": "INCIDENT_STATUS_UNSPECIFIED",
- "assignments": [
- {
- "assignedTo": {
- "userId": "string"
}, - "assignedBy": {
- "userId": "string"
}
}
], - "description": "incident_description",
- "severity": "INCIDENT_SEVERITY_UNSPECIFIED",
- "contextualLabels": {
- "property1": "string",
- "property2": "string"
}, - "displayLabels": {
- "property1": "string",
- "property2": "string"
}, - "events": [
- {
- "id": "string",
- "incidentEventType": "INCIDENT_EVENT_TYPE_UNSPECIFIED",
- "snoozeIndicator": {
- "startTime": "2019-08-24T14:15:22Z",
- "durationMinutes": 0,
- "userId": "string"
}, - "assignment": {
- "assignment": {
- "assignedTo": {
- "userId": "string"
}, - "assignedBy": {
- "userId": "string"
}
}
}, - "unassign": { },
- "upsertState": {
- "stateType": "UPSERT_INCIDENT_STATE_TYPE_UNSPECIFIED",
- "payload": {
- "cxEventKey": "string"
}, - "isMuted": true
}, - "acknowledge": {
- "acknowledgedBy": {
- "userId": "string"
}
}, - "close": {
- "closedBy": {
- "userId": "string"
}
}, - "originatorType": "ORIGINATOR_TYPE_UNSPECIFIED",
- "administrativeEvent": {
- "userId": "string"
}, - "operationalEvent": {
- "systemName": "string"
}
}
], - "createdAt": "2024-01-01T00:00:00.000Z",
- "closedAt": "2024-01-01T00:00:00.000Z",
- "lastStateUpdateTime": "2024-01-01T00:00:00.000Z",
- "lastStateUpdateKey": "last_state_update_key",
- "isMuted": false,
- "metaLabels": [
- {
- "key": "key",
- "value": "value"
}
], - "duration": "string"
}
]
}
Request to remove assignments from one or more incidents
incidentIds required | Array of strings |
{- "incidentIds": [
- "string"
]
}
{- "incidents": [
- {
- "id": "incident_id",
- "name": "incident_name",
- "state": "INCIDENT_STATE_UNSPECIFIED",
- "status": "INCIDENT_STATUS_UNSPECIFIED",
- "assignments": [
- {
- "assignedTo": {
- "userId": "string"
}, - "assignedBy": {
- "userId": "string"
}
}
], - "description": "incident_description",
- "severity": "INCIDENT_SEVERITY_UNSPECIFIED",
- "contextualLabels": {
- "property1": "string",
- "property2": "string"
}, - "displayLabels": {
- "property1": "string",
- "property2": "string"
}, - "events": [
- {
- "id": "string",
- "incidentEventType": "INCIDENT_EVENT_TYPE_UNSPECIFIED",
- "snoozeIndicator": {
- "startTime": "2019-08-24T14:15:22Z",
- "durationMinutes": 0,
- "userId": "string"
}, - "assignment": {
- "assignment": {
- "assignedTo": {
- "userId": "string"
}, - "assignedBy": {
- "userId": "string"
}
}
}, - "unassign": { },
- "upsertState": {
- "stateType": "UPSERT_INCIDENT_STATE_TYPE_UNSPECIFIED",
- "payload": {
- "cxEventKey": "string"
}, - "isMuted": true
}, - "acknowledge": {
- "acknowledgedBy": {
- "userId": "string"
}
}, - "close": {
- "closedBy": {
- "userId": "string"
}
}, - "originatorType": "ORIGINATOR_TYPE_UNSPECIFIED",
- "administrativeEvent": {
- "userId": "string"
}, - "operationalEvent": {
- "systemName": "string"
}
}
], - "createdAt": "2024-01-01T00:00:00.000Z",
- "closedAt": "2024-01-01T00:00:00.000Z",
- "lastStateUpdateTime": "2024-01-01T00:00:00.000Z",
- "lastStateUpdateKey": "last_state_update_key",
- "isMuted": false,
- "metaLabels": [
- {
- "key": "key",
- "value": "value"
}
], - "duration": "string"
}
]
}
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));
{- "rules": 1
}
This data structure is used to add a metrics tco rule.
label required | string |
regex required | string |
{- "label": "rule1",
- "regex": ".*"
}
{ }
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));
{- "tenantConfig": {
- "tenantId": 0,
- "retentionPolicy": {
- "rawResolution": 1,
- "fiveMinutesResolution": 2,
- "oneHourResolution": 3
}, - "ibm": {
- "endpoint": "s3.us-south.cloud-object-storage.appdomain.cloud",
- "crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/1234567890abcdef1234567890abcdef:12345678-1234-1234-1234-1234567890ab::",
- "serviceCrn": "crn:v1:bluemix:public:cloud-object-storage:global:a/1234567890abcdef1234567890abcdef:12345678-1234-1234-1234-1234567890ab::"
}, - "s3": {
- "bucket": "string",
- "region": "string"
}, - "prefix": "string",
- "disabled": true
}
}
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. |
object (IBM Bucket Configuration) This data structure is used to configure an IBM bucket. | |
object (S3 Configuration) This data structure represents the S3 configuration for a tenant. |
{- "retentionPolicy": {
- "rawResolution": 1,
- "fiveMinutesResolution": 2,
- "oneHourResolution": 3
}, - "ibm": {
- "endpoint": "s3.us-south.cloud-object-storage.appdomain.cloud",
- "crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/1234567890abcdef1234567890abcdef:12345678-1234-1234-1234-1234567890ab::",
- "serviceCrn": "crn:v1:bluemix:public:cloud-object-storage:global:a/1234567890abcdef1234567890abcdef:12345678-1234-1234-1234-1234567890ab::"
}, - "s3": {
- "bucket": "string",
- "region": "string"
}
}
{ }
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. | |
object (S3 Configuration) This data structure represents the S3 configuration for a tenant. |
{- "retentionDays": 0,
- "ibm": {
- "endpoint": "s3.us-south.cloud-object-storage.appdomain.cloud",
- "crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/1234567890abcdef1234567890abcdef:12345678-1234-1234-1234-1234567890ab::",
- "serviceCrn": "crn:v1:bluemix:public:cloud-object-storage:global:a/1234567890abcdef1234567890abcdef:12345678-1234-1234-1234-1234567890ab::"
}, - "s3": {
- "bucket": "string",
- "region": "string"
}
}
{ }
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));
{ }
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));
{ }
This data structure is used to validate a bucket.
object (IBM Bucket Configuration) This data structure is used to configure an IBM bucket. | |
object (S3 Configuration) This data structure represents the S3 configuration for a tenant. |
{- "ibm": {
- "endpoint": "s3.us-south.cloud-object-storage.appdomain.cloud",
- "crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/1234567890abcdef1234567890abcdef:12345678-1234-1234-1234-1234567890ab::",
- "serviceCrn": "crn:v1:bluemix:public:cloud-object-storage:global:a/1234567890abcdef1234567890abcdef:12345678-1234-1234-1234-1234567890ab::"
}, - "s3": {
- "bucket": "string",
- "region": "string"
}
}
{ }
Array of objects (datausagev1Team) | |
object (datausagev1DateRange) | |
resolution | string |
Array of objects (datausagev1Dimension) |
{- "teamIds": [
- {
- "id": "string"
}
], - "dateRange": {
- "fromDate": "2019-08-24T14:15:22Z",
- "toDate": "2019-08-24T14:15:22Z"
}, - "resolution": "string",
- "dimensions": [
- {
- "pillar": "PILLAR_UNSPECIFIED",
- "genericDimension": {
- "key": "string",
- "value": "string"
}, - "tier": "TCO_TIER_UNSPECIFIED",
- "severity": "SEVERITY_UNSPECIFIED",
- "priority": "PRIORITY_UNSPECIFIED"
}
]
}
{- "dataUsage": {
- "property1": {
- "usage": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "size": 0.1
}
]
}, - "property2": {
- "usage": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "size": 0.1
}
]
}
}
}
object (/ Requests data for a group of teams within a set of days) |
{- "param": {
- "teams": [
- {
- "id": "string"
}
], - "range": "RANGE_UNSPECIFIED"
}
}
{- "events": [
- {
- "team": {
- "id": "string"
}, - "blockEvent": [
- {
- "dataUnitsIngested": {
- "value": 0.1
}, - "quota": {
- "value": 0.1
}, - "blockedFrom": "2019-08-24T14:15:22Z"
}
]
}
]
}
object (/ Requests data for a group of teams within a set of days) |
{- "param": {
- "teams": [
- {
- "id": "string"
}
], - "range": "RANGE_UNSPECIFIED"
}
}
{- "teamsUsage": [
- {
- "team": {
- "id": "string"
}, - "metrics": [
- {
- "dailyAvg": {
- "value": 0.1
}, - "dailyUsage": {
- "value": 0.1
}, - "date": "2019-08-24T14:15:22Z",
- "payAsYouGoUsage": {
- "value": 0.1
}, - "dailyAvgDataSent": {
- "value": 0.1
}, - "dailyDataSent": {
- "value": 0.1
}, - "logsSent": {
- "low": {
- "value": 0.1
}, - "medium": {
- "value": 0.1
}, - "high": {
- "value": 0.1
}, - "blocked": {
- "value": 0.1
}
}, - "metricsSent": {
- "low": {
- "value": 0.1
}, - "medium": {
- "value": 0.1
}, - "high": {
- "value": 0.1
}, - "blocked": {
- "value": 0.1
}
}, - "tracesSent": {
- "low": {
- "value": 0.1
}, - "medium": {
- "value": 0.1
}, - "high": {
- "value": 0.1
}, - "blocked": {
- "value": 0.1
}
}, - "logsQuota": {
- "low": {
- "value": 0.1
}, - "medium": {
- "value": 0.1
}, - "high": {
- "value": 0.1
}, - "blocked": {
- "value": 0.1
}
}, - "metricsQuota": {
- "low": {
- "value": 0.1
}, - "medium": {
- "value": 0.1
}, - "high": {
- "value": 0.1
}, - "blocked": {
- "value": 0.1
}
}, - "tracesQuota": {
- "low": {
- "value": 0.1
}, - "medium": {
- "value": 0.1
}, - "high": {
- "value": 0.1
}, - "blocked": {
- "value": 0.1
}
}, - "sessionRecordingSent": {
- "low": {
- "value": 0.1
}, - "medium": {
- "value": 0.1
}, - "high": {
- "value": 0.1
}, - "blocked": {
- "value": 0.1
}
}, - "sessionRecordingQuota": {
- "low": {
- "value": 0.1
}, - "medium": {
- "value": 0.1
}, - "high": {
- "value": 0.1
}, - "blocked": {
- "value": 0.1
}
}
}
]
}
]
}
object (/ Requests data for a group of teams in a particular moment) |
{- "param": {
- "teams": [
- {
- "id": "string"
}
], - "time": "2019-08-24T14:15:22Z"
}
}
{- "teamsQuota": [
- {
- "team": {
- "id": "string"
}, - "quota": {
- "value": 0.1
}, - "retention": {
- "value": "string"
}
}
]
}
object (/ Requests data for a group of teams within a set of days) |
{- "param": {
- "teams": [
- {
- "id": "string"
}
], - "range": "RANGE_UNSPECIFIED"
}
}
{- "historyEntries": [
- {
- "team": {
- "id": "string"
}, - "quotaEntry": [
- {
- "quota": {
- "value": 0.1
}, - "timestamp": "2019-08-24T14:15:22Z",
- "retention": {
- "value": "string"
}
}
]
}
]
}
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. |
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));
{- "result": {
- "entries": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "sizeGb": 0.1,
- "units": 0.1,
- "dimensions": [
- {
- "pillar": "PILLAR_UNSPECIFIED",
- "genericDimension": {
- "key": "key",
- "value": "value"
}, - "tier": "TCO_TIER_UNSPECIFIED",
- "severity": "SEVERITY_UNSPECIFIED",
- "priority": "PRIORITY_UNSPECIFIED"
}
]
}
]
}, - "error": {
- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}
}
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));
{- "enabled": true
}
This data structure is used to update data usage metrics export status.
enabled | boolean |
{- "enabled": true
}
{- "enabled": true
}
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 |
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));
{- "result": {
- "logsCount": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "logsCount": 100,
- "severity": "SEVERITY_UNSPECIFIED",
- "priority": "PRIORITY_UNSPECIFIED"
}
]
}, - "error": {
- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}
}
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 |
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));
{- "result": {
- "spansCount": [
- {
- "timestamp": "2021-01-01T00:00:00.000Z",
- "successSpanCount": 100,
- "errorSpanCount": 10,
- "lowSuccessSpanCount": 50,
- "lowErrorSpanCount": 5
}
]
}, - "error": {
- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}
}
range | string (datausagev1Range) Default: "RANGE_UNSPECIFIED" Enum: "RANGE_UNSPECIFIED" "RANGE_CURRENT_MONTH" "RANGE_LAST_30_DAYS" "RANGE_LAST_90_DAYS" "RANGE_LAST_WEEK" |
object (datausagev1DateRange) |
{- "range": "RANGE_UNSPECIFIED",
- "dateRange": {
- "fromDate": "2019-08-24T14:15:22Z",
- "toDate": "2019-08-24T14:15:22Z"
}
}
{- "response": [
- {
- "statsDate": "2019-08-24T14:15:22Z",
- "block": 0.1,
- "blockCountQuota": 0.1,
- "low": 0.1,
- "lowCountQuota": 0.1,
- "medium": 0.1,
- "mediumCountQuota": 0.1,
- "high": 0.1,
- "highCountQuota": 0.1,
- "total": 0.1,
- "totalCountQuota": 0.1,
- "highMetricsCountQuota": 0.1,
- "highMetricsQuota": 0.1,
- "highTracingCountQuota": 0.1,
- "highTracingQuota": 0.1,
- "mediumTracingCountQuota": 0.1,
- "mediumTracingQuota": 0.1,
- "lowTracingCountQuota": 0.1,
- "lowTracingQuota": 0.1,
- "lowSessionRecordingCountQuota": 0.1,
- "lowSessionRecordingQuota": 0.1
}
]
}
range | string (datausagev1Range) Default: "RANGE_UNSPECIFIED" Enum: "RANGE_UNSPECIFIED" "RANGE_CURRENT_MONTH" "RANGE_LAST_30_DAYS" "RANGE_LAST_90_DAYS" "RANGE_LAST_WEEK" |
object (datausagev1DateRange) |
{- "range": "RANGE_UNSPECIFIED",
- "dateRange": {
- "fromDate": "2019-08-24T14:15:22Z",
- "toDate": "2019-08-24T14:15:22Z"
}
}
{- "overageDetail": [
- {
- "date": "2019-08-24T14:15:22Z",
- "overageUnit": "string"
}
]
}
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));
{- "retentions": [
- {
- "id": "string",
- "order": 0,
- "name": "string",
- "editable": true
}
]
}
This data structure is used to update retentions
required | Array of objects (v1RetentionUpdateElement) |
{- "retentionUpdateElements": [
- {
- "id": "string",
- "name": "string"
}
]
}
{- "retentions": [
- {
- "id": "string",
- "order": 0,
- "name": "string",
- "editable": true
}
]
}
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));
{- "enableTags": true
}
{ }
{- "activateRetentions": true
}
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));
{- "target": {
- "s3": {
- "bucket": "bucket",
- "region": "us-west-2"
}, - "ibmCos": {
- "bucketCrn": "bucket_crn",
- "serviceCrn": "service_crn",
- "bucketType": "IBM_BUCKET_TYPE_UNSPECIFIED"
}, - "archiveSpec": {
- "archivingFormatId": "json_id",
- "isActive": true,
- "enableTags": true
}
}
}
This data structure is used to set a storage target for logs.
isActive required | boolean |
object (IBM COS Target Spec) This data structure represents an IBM COS target. |
{- "isActive": true,
- "s3": {
- "bucket": "bucket",
- "region": "us-west-2"
}, - "ibmCos": {
- "bucketCrn": "bucket_crn",
- "serviceCrn": "service_crn",
- "bucketType": "IBM_BUCKET_TYPE_UNSPECIFIED"
}
}
{- "target": {
- "s3": {
- "bucket": "bucket",
- "region": "us-west-2"
}, - "ibmCos": {
- "bucketCrn": "bucket_crn",
- "serviceCrn": "service_crn",
- "bucketType": "IBM_BUCKET_TYPE_UNSPECIFIED"
}, - "archiveSpec": {
- "archivingFormatId": "json_id",
- "isActive": true,
- "enableTags": true
}
}
}
This data structure is used to validate a storage target for logs.
isActive required | boolean |
object (IBM COS Target Spec) This data structure represents an IBM COS target. |
{- "isActive": true,
- "s3": {
- "bucket": "bucket",
- "region": "us-west-2"
}, - "ibmCos": {
- "bucketCrn": "bucket_crn",
- "serviceCrn": "service_crn",
- "bucketType": "IBM_BUCKET_TYPE_UNSPECIFIED"
}
}
{- "isValid": true
}
name | string |
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));
{- "group": {
- "groupId": {
- "id": 0
}, - "name": "string",
- "description": "string",
- "externalId": "string",
- "groupOrigin": "GROUP_ORIGIN_UNSPECIFIED",
- "teamId": {
- "id": 0
}, - "roles": [
- {
- "roleId": {
- "id": 0
}, - "name": "string",
- "description": "string"
}
], - "scope": {
- "id": {
- "id": 0
}, - "filters": {
- "subsystems": [
- {
- "term": "string",
- "filterType": "FILTER_TYPE_UNSPECIFIED"
}
], - "applications": [
- {
- "term": "string",
- "filterType": "FILTER_TYPE_UNSPECIFIED"
}
]
}
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "nextGenScopeId": "string"
}
}
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 |
{- "name": "string",
- "teamId": {
- "id": 0
}, - "description": "string",
- "externalId": "string",
- "roleIds": [
- {
- "id": 0
}
], - "userIds": [
- {
- "id": "string"
}
], - "scopeFilters": {
- "subsystems": [
- {
- "term": "string",
- "filterType": "FILTER_TYPE_UNSPECIFIED"
}
], - "applications": [
- {
- "term": "string",
- "filterType": "FILTER_TYPE_UNSPECIFIED"
}
]
}, - "nextGenScopeId": "string"
}
{- "groupId": {
- "id": 0
}
}
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. | |
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. | |
object (UserUpdates) This data structure represents the information associated with an API key. | |
object (/ Scope filters are currently possible to be defined for subsystems and applications) | |
nextGenScopeId | string (/ If set, updates new team group next gen scope) |
{- "groupId": {
- "id": 0
}, - "name": "string",
- "description": "string",
- "externalId": "string",
- "roleUpdates": {
- "roleIds": [
- {
- "id": 0
}
]
}, - "userUpdates": {
- "userIds": [
- {
- "id": "string"
}
]
}, - "scopeFilters": {
- "subsystems": [
- {
- "term": "string",
- "filterType": "FILTER_TYPE_UNSPECIFIED"
}
], - "applications": [
- {
- "term": "string",
- "filterType": "FILTER_TYPE_UNSPECIFIED"
}
]
}, - "nextGenScopeId": "string"
}
{ }
teamId.id | integer <int64> |
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));
{- "groups": [
- {
- "groupId": {
- "id": 0
}, - "name": "string",
- "description": "string",
- "externalId": "string",
- "groupOrigin": "GROUP_ORIGIN_UNSPECIFIED",
- "teamId": {
- "id": 0
}, - "roles": [
- {
- "roleId": {
- "id": 0
}, - "name": "string",
- "description": "string"
}
], - "scope": {
- "id": {
- "id": 0
}, - "filters": {
- "subsystems": [
- {
- "term": "string",
- "filterType": "FILTER_TYPE_UNSPECIFIED"
}
], - "applications": [
- {
- "term": "string",
- "filterType": "FILTER_TYPE_UNSPECIFIED"
}
]
}
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "nextGenScopeId": "string"
}
]
}
teamId.id | integer <int64> |
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));
{ }
Bulk request to assign users to multiple team groups simultaneously, efficiently managing group memberships at scale.
object (coralogixpermissionsv1TeamId) | |
Array of objects (AddUsersToTeamGroup) |
{- "teamId": {
- "id": 0
}, - "addUsersToGroup": [
- {
- "groupId": {
- "id": 0
}, - "userIds": [
- {
- "id": "string"
}
]
}
]
}
{ }
groupId.id required | integer <int64> |
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));
{- "group": {
- "groupId": {
- "id": 0
}, - "name": "string",
- "description": "string",
- "externalId": "string",
- "groupOrigin": "GROUP_ORIGIN_UNSPECIFIED",
- "teamId": {
- "id": 0
}, - "roles": [
- {
- "roleId": {
- "id": 0
}, - "name": "string",
- "description": "string"
}
], - "scope": {
- "id": {
- "id": 0
}, - "filters": {
- "subsystems": [
- {
- "term": "string",
- "filterType": "FILTER_TYPE_UNSPECIFIED"
}
], - "applications": [
- {
- "term": "string",
- "filterType": "FILTER_TYPE_UNSPECIFIED"
}
]
}
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "nextGenScopeId": "string"
}
}
groupId.id required | integer <int64> |
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));
{ }
groupId.id required | integer <int64> |
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));
{- "scope": {
- "id": {
- "id": 0
}, - "filters": {
- "subsystems": [
- {
- "term": "string",
- "filterType": "FILTER_TYPE_UNSPECIFIED"
}
], - "applications": [
- {
- "term": "string",
- "filterType": "FILTER_TYPE_UNSPECIFIED"
}
]
}
}
}
groupId.id required | integer <int64> |
groupId | |
object (/ Scope filters are currently possible to be defined for subsystems and applications) |
{- "groupId": { },
- "scopeFilters": {
- "subsystems": [
- {
- "term": "string",
- "filterType": "FILTER_TYPE_UNSPECIFIED"
}
], - "applications": [
- {
- "term": "string",
- "filterType": "FILTER_TYPE_UNSPECIFIED"
}
]
}
}
{- "scopeId": {
- "id": 0
}
}
groupId.id required | integer <int64> |
pageSize | integer <int64> / Pagination size. Defaults to 100 if empty |
pageToken | string / Optional pagination continuation token / Contains an encoded cursor |
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));
{- "users": [
- {
- "userId": {
- "id": "string"
}, - "userAccountId": {
- "id": 0
}, - "username": "string",
- "firstName": "string",
- "lastName": "string",
- "status": "USER_STATUS_UNSPECIFIED"
}
], - "noMorePages": { },
- "token": {
- "nextPageToken": "string"
}
}
groupId.id required | integer <int64> |
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));
{ }
groupId.id required | integer <int64> |
groupId | |
Array of objects (/ Users to add to group) |
{- "groupId": { },
- "userIds": [
- {
- "id": "string"
}
]
}
{- "teamId": {
- "id": 0
}
}
Request to list all extensions
includeHiddenExtensions | boolean |
object (GetAllExtensionsRequest - Filter) Filter by integration ids |
{- "includeHiddenExtensions": true,
- "filter": {
- "integrations": [
- "string"
]
}
}
{- "extensions": [
- {
- "id": "string",
- "name": "string",
- "image": "string",
- "darkModeImage": "string",
- "revisions": [
- {
- "version": "string",
- "description": "string",
- "excerpt": "string",
- "labels": [
- "string"
], - "integrationDetails": [
- {
- "name": "string",
- "link": "string"
}
], - "summary": {
- "itemCounts": {
- "actions": 0,
- "alerts": 0,
- "customDashboards": 0,
- "enrichments": 0,
- "eventsToMetrics": 0,
- "grafanaDashboards": 0,
- "kibanaDashboards": 0,
- "metricsRuleGroup": 0,
- "parsingRules": 0,
- "savedViews": 0
}, - "isNew": true
}
}
], - "isHidden": true,
- "integrations": [
- "string"
], - "keywords": [
- "string"
], - "deprecation": {
- "reason": "string",
- "replacementExtensions": [
- "string"
]
}
}
]
}
id required | string |
includeDashboardBinaries | boolean On the frontend, we don't need the dashboard binaries. But we need them for deployment in the extensions-service - so it's kind of temporary argument, so as soon all the deployment logic is moved to the extensions-api, it can be removed. |
includeTestingRevision | boolean |
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/extensions/v1/%7Bid%7D?includeDashboardBinaries=SOME_BOOLEAN_VALUE&includeTestingRevision=SOME_BOOLEAN_VALUE'; let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{- "id": "string",
- "name": "string",
- "image": "string",
- "darkModeImage": "string",
- "revisions": [
- {
- "version": "string",
- "description": "string",
- "excerpt": "string",
- "labels": [
- "string"
], - "integrationDetails": [
- {
- "name": "string",
- "link": "string"
}
], - "items": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "targetDomain": "ACTION",
- "data": { },
- "binaries": [
- {
- "type": "PREVIEW_IMAGE",
- "data": "string",
- "fileName": "string"
}
], - "isMandatory": true,
- "permissionResource": "UNKNOWN",
- "extendedInternalId": "string",
- "uniqueId": "string"
}
], - "binaries": [
- {
- "type": "KIBANA_INDEX_PATTERN",
- "data": "string"
}
], - "permissionDeniedItems": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "targetDomain": "ACTION",
- "data": { },
- "binaries": [
- {
- "type": "PREVIEW_IMAGE",
- "data": "string",
- "fileName": "string"
}
], - "isMandatory": true,
- "permissionResource": "UNKNOWN",
- "extendedInternalId": "string",
- "uniqueId": "string"
}
], - "isTesting": true
}
], - "isHidden": true,
- "integrations": [
- "string"
], - "keywords": [
- "string"
], - "permissionDeniedRevisions": [
- {
- "version": "string",
- "description": "string",
- "excerpt": "string",
- "labels": [
- "string"
], - "integrationDetails": [
- {
- "name": "string",
- "link": "string"
}
], - "items": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "targetDomain": "ACTION",
- "data": { },
- "binaries": [
- {
- "type": "PREVIEW_IMAGE",
- "data": "string",
- "fileName": "string"
}
], - "isMandatory": true,
- "permissionResource": "UNKNOWN",
- "extendedInternalId": "string",
- "uniqueId": "string"
}
], - "binaries": [
- {
- "type": "KIBANA_INDEX_PATTERN",
- "data": "string"
}
], - "permissionDeniedItems": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "targetDomain": "ACTION",
- "data": { },
- "binaries": [
- {
- "type": "PREVIEW_IMAGE",
- "data": "string",
- "fileName": "string"
}
], - "isMandatory": true,
- "permissionResource": "UNKNOWN",
- "extendedInternalId": "string",
- "uniqueId": "string"
}
], - "isTesting": true
}
], - "changelog": [
- {
- "version": "string",
- "descriptionMd": "string"
}
], - "deprecation": {
- "reason": "string",
- "replacementExtensions": [
- "string"
]
}
}
companyId | string |
id | string |
{- "companyId": "string",
- "id": "string"
}
{ }
id | string |
version | string |
itemIds | Array of strings |
applications | Array of strings |
subsystems | Array of strings |
object (v1ExtensionDeployment) |
{- "id": "string",
- "version": "string",
- "itemIds": [
- "string"
], - "applications": [
- "string"
], - "subsystems": [
- "string"
], - "extensionDeployment": {
- "id": "string",
- "version": "string",
- "itemIds": [
- "string"
], - "applications": [
- "string"
], - "subsystems": [
- "string"
]
}
}
{- "extensionDeployment": {
- "id": "string",
- "version": "string",
- "itemIds": [
- "string"
], - "applications": [
- "string"
], - "subsystems": [
- "string"
]
}
}
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/extensions-deployment/v1/deployed'; let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{- "deployedExtensions": [
- {
- "id": "string",
- "version": "string",
- "applications": [
- "string"
], - "subsystems": [
- "string"
], - "itemIds": [
- "string"
], - "summary": {
- "deployedItemCounts": {
- "actions": 0,
- "alerts": 0,
- "customDashboards": 0,
- "enrichments": 0,
- "eventsToMetrics": 0,
- "grafanaDashboards": 0,
- "kibanaDashboards": 0,
- "metricsRuleGroup": 0,
- "parsingRules": 0,
- "savedViews": 0
}
}
}
]
}
id | string |
keptExtensionItems | Array of strings |
{- "id": "string",
- "keptExtensionItems": [
- "string"
]
}
{- "failedItems": [
- {
- "itemId": "string",
- "remoteId": "string",
- "reason": "string"
}
], - "extensionDeployment": {
- "id": "string",
- "version": "string",
- "itemIds": [
- "string"
], - "applications": [
- "string"
], - "subsystems": [
- "string"
]
}
}
id | string |
version | string |
itemIds | Array of strings |
applications | Array of strings |
subsystems | Array of strings |
object (v1ExtensionDeployment) |
{- "id": "string",
- "version": "string",
- "itemIds": [
- "string"
], - "applications": [
- "string"
], - "subsystems": [
- "string"
], - "extensionDeployment": {
- "id": "string",
- "version": "string",
- "itemIds": [
- "string"
], - "applications": [
- "string"
], - "subsystems": [
- "string"
]
}
}
{- "extensionDeployment": {
- "id": "string",
- "version": "string",
- "itemIds": [
- "string"
], - "applications": [
- "string"
], - "subsystems": [
- "string"
]
}
}
object (ExtensionData) Response to list all extensions |
{- "extensionData": {
- "id": "076f4188-05e0-4ed3-afeb-653ad182ccb7",
- "name": "I love chocolate",
- "description": "Chocolate is full of love",
- "excerpt": "Chocolate is full of love",
- "image": "string",
- "darkModeImage": "string",
- "labels": [
- "cocoa",
- "sugar"
], - "version": "v1.0.13",
- "items": [
- {
- "name": "Low cocoa content",
- "description": "Less than 60% cocoa",
- "targetDomain": "ACTION",
- "data": { },
- "binaries": [
- {
- "type": "PREVIEW_IMAGE",
- "data": "string",
- "fileName": "string"
}
], - "isMandatory": true,
- "internalId": 0,
- "uniqueId": "string",
- "permissionResource": "UNKNOWN"
}
], - "integrationDetails": [
- {
- "name": "string",
- "link": "string"
}
], - "isHidden": false,
- "binaries": [
- {
- "type": "KIBANA_INDEX_PATTERN",
- "data": "string"
}
], - "integrations": [
- "string"
], - "keywords": [
- "string"
], - "changelog": [
- {
- "version": "string",
- "descriptionMd": "string"
}
], - "deprecation": {
- "reason": "string",
- "replacementExtensions": [
- "string"
]
}
}
}
{ }
object (ExtensionData) Response to list all extensions | |
cleanupAfterTest | boolean |
{- "extensionData": {
- "id": "076f4188-05e0-4ed3-afeb-653ad182ccb7",
- "name": "I love chocolate",
- "description": "Chocolate is full of love",
- "excerpt": "Chocolate is full of love",
- "image": "string",
- "darkModeImage": "string",
- "labels": [
- "cocoa",
- "sugar"
], - "version": "v1.0.13",
- "items": [
- {
- "name": "Low cocoa content",
- "description": "Less than 60% cocoa",
- "targetDomain": "ACTION",
- "data": { },
- "binaries": [
- {
- "type": "PREVIEW_IMAGE",
- "data": "string",
- "fileName": "string"
}
], - "isMandatory": true,
- "internalId": 0,
- "uniqueId": "string",
- "permissionResource": "UNKNOWN"
}
], - "integrationDetails": [
- {
- "name": "string",
- "link": "string"
}
], - "isHidden": false,
- "binaries": [
- {
- "type": "KIBANA_INDEX_PATTERN",
- "data": "string"
}
], - "integrations": [
- "string"
], - "keywords": [
- "string"
], - "changelog": [
- {
- "version": "string",
- "descriptionMd": "string"
}
], - "deprecation": {
- "reason": "string",
- "replacementExtensions": [
- "string"
]
}
}, - "cleanupAfterTest": true
}
{ }
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/quota/v1/quotas'; let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{- "companyId": "string",
- "alert": {
- "used": 0,
- "limit": 0
}, - "enrichment": {
- "used": 0,
- "limit": 0
}, - "parsingRule": {
- "used": 0,
- "limit": 0
}, - "parsingRuleGroup": {
- "used": 0,
- "limit": 0
}, - "parsingTheme": {
- "used": 0,
- "limit": 0
}, - "dynamicAlert": {
- "used": 0,
- "limit": 0
}, - "events2Metrics": {
- "labelsLimit": 0,
- "permutations": {
- "used": 0,
- "limit": 0
}, - "metrics": {
- "used": 0,
- "limit": 0
}
}
}
Response to list all extensions (streaming inputs)
id | string |
name | string |
description | string |
excerpt | string |
image | string |
darkModeImage | string |
labels | Array of strings |
version | string |
Array of objects (v1ExtensionItemData) | |
Array of objects (v1IntegrationDetail) | |
isHidden | boolean |
Array of objects (v1ExtensionBinary) | |
integrations | Array of strings |
keywords | Array of strings |
Array of objects (v1ChangelogEntry) | |
object (v1Deprecation) |
{- "id": "076f4188-05e0-4ed3-afeb-653ad182ccb7",
- "name": "I love chocolate",
- "description": "Chocolate is full of love",
- "excerpt": "Chocolate is full of love",
- "image": "string",
- "darkModeImage": "string",
- "labels": [
- "cocoa",
- "sugar"
], - "version": "v1.0.13",
- "items": [
- {
- "name": "Low cocoa content",
- "description": "Less than 60% cocoa",
- "targetDomain": "ACTION",
- "data": { },
- "binaries": [
- {
- "type": "PREVIEW_IMAGE",
- "data": "string",
- "fileName": "string"
}
], - "isMandatory": true,
- "internalId": 0,
- "uniqueId": "string",
- "permissionResource": "UNKNOWN"
}
], - "integrationDetails": [
- {
- "name": "string",
- "link": "string"
}
], - "isHidden": false,
- "binaries": [
- {
- "type": "KIBANA_INDEX_PATTERN",
- "data": "string"
}
], - "integrations": [
- "string"
], - "keywords": [
- "string"
], - "changelog": [
- {
- "version": "string",
- "descriptionMd": "string"
}
], - "deprecation": {
- "reason": "string",
- "replacementExtensions": [
- "string"
]
}
}
{ }
Response to list all extensions (streaming inputs)
id | string |
name | string |
description | string |
excerpt | string |
image | string |
darkModeImage | string |
labels | Array of strings |
version | string |
Array of objects (v1ExtensionItemData) | |
Array of objects (v1IntegrationDetail) | |
isHidden | boolean |
Array of objects (v1ExtensionBinary) | |
integrations | Array of strings |
keywords | Array of strings |
Array of objects (v1ChangelogEntry) | |
object (v1Deprecation) |
{- "id": "076f4188-05e0-4ed3-afeb-653ad182ccb7",
- "name": "I love chocolate",
- "description": "Chocolate is full of love",
- "excerpt": "Chocolate is full of love",
- "image": "string",
- "darkModeImage": "string",
- "labels": [
- "cocoa",
- "sugar"
], - "version": "v1.0.13",
- "items": [
- {
- "name": "Low cocoa content",
- "description": "Less than 60% cocoa",
- "targetDomain": "ACTION",
- "data": { },
- "binaries": [
- {
- "type": "PREVIEW_IMAGE",
- "data": "string",
- "fileName": "string"
}
], - "isMandatory": true,
- "internalId": 0,
- "uniqueId": "string",
- "permissionResource": "UNKNOWN"
}
], - "integrationDetails": [
- {
- "name": "string",
- "link": "string"
}
], - "isHidden": false,
- "binaries": [
- {
- "type": "KIBANA_INDEX_PATTERN",
- "data": "string"
}
], - "integrations": [
- "string"
], - "keywords": [
- "string"
], - "changelog": [
- {
- "version": "string",
- "descriptionMd": "string"
}
], - "deprecation": {
- "reason": "string",
- "replacementExtensions": [
- "string"
]
}
}
{- "invalidExtensions": [
- {
- "extensionId": "string",
- "errorMessage": "string"
}
]
}
key | string |
name | string |
companyId | integer <int64> |
iconUrl | string |
timestamp | string <date-time> |
application | Array of strings |
subsystem | Array of strings |
{- "key": "string",
- "name": "string",
- "companyId": 0,
- "iconUrl": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "application": [
- "string"
], - "subsystem": [
- "string"
]
}
{- "id": "string",
- "key": "string",
- "name": "string",
- "companyId": 0,
- "status": "STATUS_UNSPECIFIED",
- "iconUrl": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "application": [
- "string"
], - "subsystem": [
- "string"
], - "updatedAt": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "type": {
- "id": "string",
- "type": "TYPE_UNSPECIFIED"
}
}
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/api/v1/deletetag/%7Bid%7D'; let options = {method: 'DELETE', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
"string"
id | string <uint64> |
key | string |
name | string |
companyId | integer <int64> |
status | string (tagsv1Status) Default: "STATUS_UNSPECIFIED" Enum: "STATUS_UNSPECIFIED" "STATUS_SUCCESSFUL" |
iconUrl | string |
timestamp | string <date-time> |
application | Array of strings |
subsystem | Array of strings |
updatedAt | string <date-time> |
createdAt | string <date-time> |
object (v1TagType) |
{- "id": "string",
- "key": "string",
- "name": "string",
- "companyId": 0,
- "status": "STATUS_UNSPECIFIED",
- "iconUrl": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "application": [
- "string"
], - "subsystem": [
- "string"
], - "updatedAt": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "type": {
- "id": "string",
- "type": "TYPE_UNSPECIFIED"
}
}
{- "id": "string",
- "key": "string",
- "name": "string",
- "companyId": 0,
- "status": "STATUS_UNSPECIFIED",
- "iconUrl": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "application": [
- "string"
], - "subsystem": [
- "string"
], - "updatedAt": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "type": {
- "id": "string",
- "type": "TYPE_UNSPECIFIED"
}
}
object (GetTagsRequestQueryDef) |
{- "queryDef": {
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "pageIndex": 0,
- "pageSize": 0,
- "queryParams": {
- "metadata": {
- "applicationName": [
- "string"
], - "subsystemName": [
- "string"
]
}, - "sortModel": [
- {
- "field": "string",
- "ordering": "string",
- "missing": "string"
}
]
}
}
}
{- "data": [
- {
- "id": "string",
- "key": "string",
- "name": "string",
- "companyId": 0,
- "status": "STATUS_UNSPECIFIED",
- "iconUrl": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "application": [
- "string"
], - "subsystem": [
- "string"
], - "updatedAt": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "type": {
- "id": "string",
- "type": "TYPE_UNSPECIFIED"
}
}
]
}
object (tagsv1Query) | |
object (tagsv1Query) |
{- "compareTag": {
- "applicationName": [
- "string"
], - "endTime": "2019-08-24T14:15:22Z",
- "startTime": "2019-08-24T14:15:22Z",
- "subsystemName": [
- "string"
], - "step": "string"
}, - "tag": {
- "applicationName": [
- "string"
], - "endTime": "2019-08-24T14:15:22Z",
- "startTime": "2019-08-24T14:15:22Z",
- "subsystemName": [
- "string"
], - "step": "string"
}
}
{- "alertsListInfo": [
- {
- "name": "string",
- "severity": 0,
- "size": 0
}
], - "severityInfo": [
- {
- "severity": 0,
- "size": 0
}
], - "volumeCompareGraph": {
- "compareTag": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "value": 0
}
], - "tag": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "value": 0
}
]
}
}
object (tagsv1Query) | |
object (tagsv1Query) |
{- "compareTag": {
- "applicationName": [
- "string"
], - "endTime": "2019-08-24T14:15:22Z",
- "startTime": "2019-08-24T14:15:22Z",
- "subsystemName": [
- "string"
], - "step": "string"
}, - "tag": {
- "applicationName": [
- "string"
], - "endTime": "2019-08-24T14:15:22Z",
- "startTime": "2019-08-24T14:15:22Z",
- "subsystemName": [
- "string"
], - "step": "string"
}
}
{- "compareTag": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "value": 0
}
], - "tag": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "value": 0
}
]
}
object (tagsv1Query) | |
object (tagsv1Query) |
{- "compareTag": {
- "applicationName": [
- "string"
], - "endTime": "2019-08-24T14:15:22Z",
- "startTime": "2019-08-24T14:15:22Z",
- "subsystemName": [
- "string"
], - "step": "string"
}, - "tag": {
- "applicationName": [
- "string"
], - "endTime": "2019-08-24T14:15:22Z",
- "startTime": "2019-08-24T14:15:22Z",
- "subsystemName": [
- "string"
], - "step": "string"
}
}
{- "data": [
- {
- "tagResult": 0.1,
- "compareResult": 0.1,
- "linkCacheId": "string",
- "type": "string"
}
]
}
name | string |
key | string |
application | Array of strings |
subsystem | Array of strings |
iconUrl | string |
timestamp | string |
type | string Default: "TYPE_UNSPECIFIED" Enum: "TYPE_UNSPECIFIED" "TYPE_CUSTOM_EVENT" "TYPE_BITBUCKET" "TYPE_GITLAB" "TYPE_TFS" "TYPE_HEROKU" |
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/api/v1/addTag?name=SOME_STRING_VALUE&key=SOME_STRING_VALUE&application=SOME_ARRAY_VALUE&subsystem=SOME_ARRAY_VALUE&iconUrl=SOME_STRING_VALUE×tamp=SOME_STRING_VALUE&type=SOME_STRING_VALUE'; let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{- "id": "string",
- "key": "string",
- "name": "string",
- "companyId": 0,
- "status": "STATUS_UNSPECIFIED",
- "iconUrl": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "application": [
- "string"
], - "subsystem": [
- "string"
], - "updatedAt": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "type": {
- "id": "string",
- "type": "TYPE_UNSPECIFIED"
}
}
name | string |
key | string |
application | Array of strings |
subsystem | Array of strings |
iconUrl | string |
timestamp | string |
type | string (tagsv1Type) Default: "TYPE_UNSPECIFIED" Enum: "TYPE_UNSPECIFIED" "TYPE_CUSTOM_EVENT" "TYPE_BITBUCKET" "TYPE_GITLAB" "TYPE_TFS" "TYPE_HEROKU" |
{- "name": "string",
- "key": "string",
- "application": [
- "string"
], - "subsystem": [
- "string"
], - "iconUrl": "string",
- "timestamp": "string",
- "type": "TYPE_UNSPECIFIED"
}
{- "id": "string",
- "key": "string",
- "name": "string",
- "companyId": 0,
- "status": "STATUS_UNSPECIFIED",
- "iconUrl": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "application": [
- "string"
], - "subsystem": [
- "string"
], - "updatedAt": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "type": {
- "id": "string",
- "type": "TYPE_UNSPECIFIED"
}
}
name | string |
application | Array of strings |
subsystem | Array of strings |
{ }
"string"
name | string |
application | Array of strings |
subsystem | Array of strings |
{ }
"string"
name | string |
application | Array of strings |
subsystem | Array of strings |
{ }
"string"
name | string |
key | string |
application | Array of strings |
subsystem | Array of strings |
iconUrl | string |
timestamp | string <date-time> |
type | string (tagsv1Type) Default: "TYPE_UNSPECIFIED" Enum: "TYPE_UNSPECIFIED" "TYPE_CUSTOM_EVENT" "TYPE_BITBUCKET" "TYPE_GITLAB" "TYPE_TFS" "TYPE_HEROKU" |
{- "name": "string",
- "key": "string",
- "application": [
- "string"
], - "subsystem": [
- "string"
], - "iconUrl": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "type": "TYPE_UNSPECIFIED"
}
{- "tag": {
- "id": "string",
- "key": "string",
- "name": "string",
- "companyId": 0,
- "status": "STATUS_UNSPECIFIED",
- "iconUrl": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "application": [
- "string"
], - "subsystem": [
- "string"
], - "updatedAt": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "type": {
- "id": "string",
- "type": "TYPE_UNSPECIFIED"
}
}
}
name | string |
key | string |
application | Array of strings |
subsystem | Array of strings |
iconUrl | string |
timestamp | string |
type | string Default: "TYPE_UNSPECIFIED" Enum: "TYPE_UNSPECIFIED" "TYPE_CUSTOM_EVENT" "TYPE_BITBUCKET" "TYPE_GITLAB" "TYPE_TFS" "TYPE_HEROKU" |
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/api/v1/external/tags/add?name=SOME_STRING_VALUE&key=SOME_STRING_VALUE&application=SOME_ARRAY_VALUE&subsystem=SOME_ARRAY_VALUE&iconUrl=SOME_STRING_VALUE×tamp=SOME_STRING_VALUE&type=SOME_STRING_VALUE'; let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{- "tag": {
- "id": "string",
- "key": "string",
- "name": "string",
- "companyId": 0,
- "status": "STATUS_UNSPECIFIED",
- "iconUrl": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "application": [
- "string"
], - "subsystem": [
- "string"
], - "updatedAt": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "type": {
- "id": "string",
- "type": "TYPE_UNSPECIFIED"
}
}
}
name | string |
application | Array of strings |
subsystem | Array of strings |
{ }
"string"
platform | string Default: "UNDEFINED" Enum: "UNDEFINED" "PLATFORM_BITBUCKET" "PLATFORM_GITHUB" "PLATFORM_GITLAB" "PLATFORM_AWS_SNS" "PLATFORM_OPSGENIE" "PLATFORM_PAGERDUTY" "PLATFORM_PROMETHEUS" "PLATFORM_SLACK" "PLATFORM_INTERCOM" |
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/v1/external-tokens?platform=SOME_STRING_VALUE'; let options = {method: 'POST', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{- "token": "string",
- "id": "string"
}
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/v1/external-tokens/%7Bid%7D'; let options = {method: 'PUT', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{- "token": "string"
}
object (coralogixintegrationsv1Permission) | |
object (v1ApiKeyValue) | |
object (v1PermissionId) |
{- "permission": {
- "resource": {
- "id": 0
}, - "action": {
- "id": 0
}
}, - "apiKey": {
- "key": "string"
}, - "permissionId": {
- "id": 0
}
}
{- "unauthorized": { },
- "authorizationResult": {
- "apiKeyId": {
- "id": "string"
}
}
}
includeTestingRevision | boolean |
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));
{- "integrations": [
- {
- "integration": {
- "id": "string",
- "name": "string",
- "description": "string",
- "icon": "string",
- "darkIcon": "string",
- "tags": [
- "string"
], - "versions": [
- "string"
], - "integrationType": {
- "managed": {
- "variant": "DEFAULT"
}, - "untracked": { },
- "cloudformation": { },
- "arm": { },
- "pushBasedContextualData": { },
- "contextualData": { },
- "genericWebhook": { }
}, - "featureFlag": "string"
}, - "amountIntegrations": 0,
- "errors": [
- "string"
], - "upgradeAvailable": true,
- "isNew": true
}
]
}
id required | string |
includeTestingRevision | boolean |
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));
{- "integrationDefinition": {
- "key": "string",
- "integrationType": {
- "managed": {
- "variant": "DEFAULT"
}, - "untracked": { },
- "cloudformation": { },
- "arm": { },
- "pushBasedContextualData": { },
- "contextualData": { },
- "genericWebhook": { }
}, - "revisions": [
- {
- "id": "string",
- "fields": [
- {
- "single": {
- "defaultValue": "string"
}, - "multiText": {
- "options": [
- "string"
], - "defaultValues": [
- "string"
]
}, - "multipleSelection": {
- "options": [
- "string"
]
}, - "singleBoolean": {
- "defaultValue": true
}, - "selection": {
- "options": [
- "string"
], - "defaultValue": "string"
}, - "singleNumber": {
- "defaultValue": 0.1
}, - "type": "API_KEY",
- "name": "string",
- "tooltip": "string",
- "templateParamName": "string",
- "placeholder": "string",
- "required": true,
- "predefined": true,
- "visible": true,
- "readonly": true,
- "applicableIf": {
- "type": "UNKNOWN",
- "values": [
- {
- "fieldName": "string",
- "valuePattern": "string"
}
]
}, - "groupId": "string",
- "upgradeNotice": "string",
- "allowedPattern": "string",
- "documentationReference": "string"
}
], - "groups": [
- {
- "id": "string",
- "name": "string"
}
], - "cloudFormation": {
- "templateUrl": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}, - "postInstallationSteps": {
- "property1": "string",
- "property2": "string"
}
}, - "managedService": { },
- "helmChart": {
- "template": "string",
- "commands": [
- {
- "name": "string",
- "command": "string",
- "description": "string",
- "tooltipText": "string",
- "language": "UNKNOWN",
- "links": [
- {
- "key": "string",
- "text": "string",
- "url": "string"
}
]
}
], - "guide": {
- "introduction": "string",
- "installationRequirements": "string"
}
}, - "azureArmTemplate": {
- "templateUrl": "string"
}, - "rum": {
- "browserSdkCommands": [
- {
- "name": "string",
- "command": "string",
- "description": "string",
- "tooltipText": "string",
- "language": "UNKNOWN",
- "links": [
- {
- "key": "string",
- "text": "string",
- "url": "string"
}
]
}
], - "sourceMapCommands": [
- {
- "name": "string",
- "command": "string",
- "description": "string",
- "tooltipText": "string",
- "language": "UNKNOWN",
- "links": [
- {
- "key": "string",
- "text": "string",
- "url": "string"
}
]
}
]
}, - "terraform": {
- "configurationBlocks": [
- {
- "name": "string",
- "value": "string",
- "description": "string"
}
]
}, - "upgradeInstructionsMd": "string",
- "revisionDeploymentSupported": true,
- "featureFlag": "string"
}
], - "featureFlag": "string"
}
}
integrationId required | string |
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));
{- "integration": {
- "id": "string",
- "definitionKey": "string",
- "definitionVersion": "string",
- "parameters": [
- {
- "key": "string",
- "stringValue": "string",
- "booleanValue": true,
- "stringList": {
- "values": [
- "string"
]
}, - "apiKey": {
- "id": "string",
- "value": "string"
}, - "numericValue": 0.1,
- "sensitiveData": { }
}
], - "integrationStatus": {
- "connectionStatus": "PENDING",
- "details": {
- "property1": "string",
- "property2": "string"
}, - "messages": [
- "string"
]
}
}
}
integrationId required | string |
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));
{ }
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));
{- "integrationKeys": [
- "string"
]
}
integrationId required | string |
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));
{- "integrationId": "string",
- "status": {
- "connectionStatus": "PENDING",
- "details": {
- "property1": "string",
- "property2": "string"
}, - "messages": [
- "string"
]
}
}
This data structure represents a request to save an integration.
required | object (IntegrationMetadata) This data structure represents the metadata of an integration. |
{- "metadata": {
- "integrationKey": "string",
- "version": "string",
- "integrationParameters": {
- "parameters": [
- {
- "key": "string",
- "stringValue": "string",
- "booleanValue": true,
- "stringList": {
- "values": [
- "string"
]
}, - "apiKey": {
- "id": "string",
- "value": "string"
}, - "numericValue": 0.1,
- "sensitiveData": { }
}
]
}
}
}
{- "integrationId": "string"
}
This data structure represents a list of outgoing webhook types.
id required | string (This is the integration id generated at creation time) |
required | object (IntegrationMetadata) This data structure represents the metadata of an integration. |
{- "id": "string",
- "metadata": {
- "integrationKey": "string",
- "version": "string",
- "integrationParameters": {
- "parameters": [
- {
- "key": "string",
- "stringValue": "string",
- "booleanValue": true,
- "stringList": {
- "values": [
- "string"
]
}, - "apiKey": {
- "id": "string",
- "value": "string"
}, - "numericValue": 0.1,
- "sensitiveData": { }
}
]
}
}
}
{ }
This data structure represents a request to test an integration.
required | object (IntegrationMetadata) This data structure represents the metadata of an integration. |
integrationId | string |
{- "integrationData": {
- "integrationKey": "string",
- "version": "string",
- "integrationParameters": {
- "parameters": [
- {
- "key": "string",
- "stringValue": "string",
- "booleanValue": true,
- "stringList": {
- "values": [
- "string"
]
}, - "apiKey": {
- "id": "string",
- "value": "string"
}, - "numericValue": 0.1,
- "sensitiveData": { }
}
]
}
}, - "integrationId": "string"
}
{- "result": {
- "success": { },
- "failure": {
- "errorMessage": "string"
}
}
}
applicationName | string |
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));
{- "versionData": {
- "versions": [
- {
- "version": "string",
- "logMetadata": {
- "firstOccurrence": "2019-08-24T14:15:22Z",
- "lastOccurrence": "2019-08-24T14:15:22Z"
}, - "sourceMapMetadata": {
- "createdAt": "2019-08-24T14:15:22Z",
- "isUploadedSuccessful": true
}
}
], - "syncedAt": "2019-08-24T14:15:22Z"
}
}
This data structure is a request to trigger a sync of RUM data.
force | boolean The period amount when the sync is not triggered is determined by configuration. |
{- "force": true
}
{- "syncExecuted": true,
- "syncedAt": "2019-08-24T14:15:22Z"
}
integrationId | string |
commonArmParams.logsUrl | string |
commonArmParams.apiKey | string |
commonArmParams.cgxDomain | string |
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));
{- "templateUrl": "string"
}
id required | string |
includeTestingRevision | boolean |
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));
{- "integrationDetail": {
- "integration": {
- "id": "string",
- "name": "string",
- "description": "string",
- "icon": "string",
- "darkIcon": "string",
- "tags": [
- "string"
], - "versions": [
- "string"
], - "integrationType": {
- "managed": {
- "variant": "DEFAULT"
}, - "untracked": { },
- "cloudformation": { },
- "arm": { },
- "pushBasedContextualData": { },
- "contextualData": { },
- "genericWebhook": { }
}, - "featureFlag": "string"
}, - "extensions": [
- {
- "id": "string",
- "name": "string",
- "image": "string",
- "darkModeImage": "string",
- "revisions": [
- {
- "version": "string",
- "description": "string",
- "excerpt": "string",
- "labels": [
- "string"
], - "integrationDetails": [
- {
- "name": "string",
- "link": "string"
}
], - "items": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "targetDomain": "ACTION",
- "data": { },
- "binaries": [
- {
- "type": null,
- "data": null,
- "fileName": null
}
], - "isMandatory": true,
- "permissionResource": "UNKNOWN",
- "extendedInternalId": "string",
- "uniqueId": "string"
}
], - "binaries": [
- {
- "type": "KIBANA_INDEX_PATTERN",
- "data": "string"
}
], - "permissionDeniedItems": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "targetDomain": "ACTION",
- "data": { },
- "binaries": [
- {
- "type": null,
- "data": null,
- "fileName": null
}
], - "isMandatory": true,
- "permissionResource": "UNKNOWN",
- "extendedInternalId": "string",
- "uniqueId": "string"
}
], - "isTesting": true
}
], - "isHidden": true,
- "integrations": [
- "string"
], - "keywords": [
- "string"
], - "permissionDeniedRevisions": [
- {
- "version": "string",
- "description": "string",
- "excerpt": "string",
- "labels": [
- "string"
], - "integrationDetails": [
- {
- "name": "string",
- "link": "string"
}
], - "items": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "targetDomain": "ACTION",
- "data": { },
- "binaries": [
- {
- "type": null,
- "data": null,
- "fileName": null
}
], - "isMandatory": true,
- "permissionResource": "UNKNOWN",
- "extendedInternalId": "string",
- "uniqueId": "string"
}
], - "binaries": [
- {
- "type": "KIBANA_INDEX_PATTERN",
- "data": "string"
}
], - "permissionDeniedItems": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "targetDomain": "ACTION",
- "data": { },
- "binaries": [
- {
- "type": null,
- "data": null,
- "fileName": null
}
], - "isMandatory": true,
- "permissionResource": "UNKNOWN",
- "extendedInternalId": "string",
- "uniqueId": "string"
}
], - "isTesting": true
}
], - "changelog": [
- {
- "version": "string",
- "descriptionMd": "string"
}
], - "deprecation": {
- "reason": "string",
- "replacementExtensions": [
- "string"
]
}
}
], - "docs": [
- {
- "name": "string",
- "link": "string"
}
], - "default": {
- "registered": [
- {
- "id": "string",
- "definitionVersion": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "parameters": [
- {
- "key": "string",
- "stringValue": "string",
- "booleanValue": true,
- "stringList": {
- "values": [
- "string"
]
}, - "apiKey": {
- "id": "string",
- "value": "string"
}, - "numericValue": 0.1,
- "sensitiveData": { }
}
], - "integrationStatus": {
- "connectionStatus": "PENDING",
- "details": {
- "property1": "string",
- "property2": "string"
}, - "messages": [
- "string"
]
}, - "empty": { },
- "cloudformation": {
- "arn": "string",
- "region": "string"
}, - "arm": {
- "subscriptionId": "string",
- "resourceGroupName": "string"
}, - "isTesting": true
}
]
}, - "local": {
- "changes": [
- {
- "version": "string",
- "descriptionMd": "string"
}
]
}, - "external": {
- "url": "string"
}
}
}
Request to count the webhooks
Request to count the webhooks
{ }
{- "count": 15
}
Request to create a new webhook
name required | string |
apiKeyValue required | string |
application required | string |
subsystem required | string |
isPrivate required | boolean |
object (Json Content Type) Indicates where to find the timestamp in the json request | |
object (Json Content Type) Indicates how to find the timestamp in the text request |
{- "name": "Chocolate is love",
- "apiKeyValue": "apn_b486d10b58184b25ae02c30dcba87775",
- "application": "authorization",
- "subsystem": "token_validator",
- "isPrivate": true,
- "json": {
- "generate": { },
- "jsonPath": {
- "jsonPath": "$.field.date",
- "automatic": { },
- "custom": {
- "format": "dd/MM/yyyy hh:mm:ss"
}
}
}, - "text": {
- "generate": { },
- "regex": {
- "regex": "^[0-9]{4}",
- "automatic": { },
- "custom": {
- "format": "dd/MM/yyyy hh:mm:ss"
}
}
}
}
{- "id": "b486d10b58184b25ae02c30dcba87775",
}
Request to delete a webhook
id required | string |
{- "id": "b486d10b58184b25ae02c30dcba87775"
}
{ }
Request to list integrations
Request to list integrations
{ }
{- "webhooks": [
- {
- "webhookId": "b486d10b58184b25ae02c30dcba87775",
- "companyId": "123456789",
- "name": "Chocolate is love",
- "application": "authorization",
- "subsystem": "token_validator",
- "isPrivate": true,
- "isActive": true,
- "createdAt": "2024-10-20T00:00:00.000Z",
- "updatedAt": "2024-10-20T00:00:00.000Z"
}
]
}
To enable/disable webhook integrations
id required | string |
isActive required | boolean |
{- "id": "b486d10b58184b25ae02c30dcba87775",
- "isActive": true
}
{ }
Request to return the number of Push Based Contextual Data Integration by a given platform
platform | string (v1PushBasedPlatform) Default: "UNDEFINED" Enum: "UNDEFINED" "PLATFORM_BITBUCKET" "PLATFORM_GITHUB" "PLATFORM_GITLAB" "PLATFORM_AWS_SNS" "PLATFORM_OPSGENIE" "PLATFORM_PAGERDUTY" "PLATFORM_PROMETHEUS" "PLATFORM_SLACK" "PLATFORM_INTERCOM" |
{- "platform": "UNDEFINED"
}
{- "counts": [
- {
- "platform": "UNDEFINED",
- "count": 1
}
]
}
Creates a new push based integration for different type of sources
object (Create Push Based Integration Request - Bitbucket) Creates a new push based integration for diffBitbucket data consumption | |
object (Create Push Based Integration Request - AmazonSns) Creates a new push based integration for diffAmazonSns data consumption | |
object (Create Push Based Integration Request - PagerDuty) Creates a new push based integration for diffPagerDuty data consumption | |
object (Create Push Based Integration Request - Github) Creates a new push based integration for dGithub data consumption | |
object (Create Push Based Integration Request - Gitlab) Creates a new push based integration for dGitlab data consumption | |
object (Create Push Based Integration Request - Opsgenie) Creates a new push based integration for difOpsgenie data consumption | |
object (Create Push Based Integration Request - Prometheus) Creates a new push based integration for diffePrometheus data consumption | |
object (Create Push Based Integration Request - Intercom) Creates a new push based integration for difIntercom data consumption | |
object (Create Push Based Integration Request - Slack) Creates a new push based integration for Slack data consumption | |
name required | string |
application required | string |
subsystem required | string |
{- "bitbucket": {
- "internalTokenId": "076f4188-05e0-4ed3-afeb-653ad182ccb7"
}, - "amazonSns": {
- "internalTokenId": "076f4188-05e0-4ed3-afeb-653ad182ccb7"
}, - "pagerDuty": {
- "internalTokenId": "076f4188-05e0-4ed3-afeb-653ad182ccb7"
}, - "github": {
- "internalTokenId": "076f4188-05e0-4ed3-afeb-653ad182ccb7"
}, - "gitlab": {
- "internalTokenId": "076f4188-05e0-4ed3-afeb-653ad182ccb7"
}, - "opsgenie": {
- "internalTokenId": "076f4188-05e0-4ed3-afeb-653ad182ccb7"
}, - "prometheus": {
- "internalTokenId": "076f4188-05e0-4ed3-afeb-653ad182ccb7"
}, - "intercom": {
- "token": "076f4188-05e0-4ed3-afeb-653ad182ccb7"
}, - "slack": {
- "internalTokenId": "076f4188-05e0-4ed3-afeb-653ad182ccb7"
}, - "name": "I love chocolate",
- "application": "authorization",
- "subsystem": "token_validator"
}
{- "id": "076f4188-05e0-4ed3-afeb-653ad182ccb7"
}
Request to delete a push based contextual data integration
id required | string |
{- "id": "076f4188-05e0-4ed3-afeb-653ad182ccb7"
}
{ }
Requests all the registered integrations for a given platform
platform required | string (v1PushBasedPlatform) Default: "UNDEFINED" Enum: "UNDEFINED" "PLATFORM_BITBUCKET" "PLATFORM_GITHUB" "PLATFORM_GITLAB" "PLATFORM_AWS_SNS" "PLATFORM_OPSGENIE" "PLATFORM_PAGERDUTY" "PLATFORM_PROMETHEUS" "PLATFORM_SLACK" "PLATFORM_INTERCOM" |
{- "platform": "UNDEFINED"
}
{- "integrations": [
- {
- "id": "076f4188-05e0-4ed3-afeb-653ad182ccb7",
- "name": "I love chocolate",
- "application": "authorization",
- "subsystem": "token_validator",
- "platform": "UNDEFINED",
- "token": "076f4188-05e0-4ed3-afeb-653ad182ccb7",
- "createdAt": "2024-10-24T00:00:00.000Z",
- "updatedAt": "2024-10-24T00:00:00.000Z"
}
]
}
Request to updated a Push Based ContextualData Integration by id
id required | string |
name required | string |
application | string |
subsystem | string |
{- "id": "076f4188-05e0-4ed3-afeb-653ad182ccb7",
- "name": "I love chocolate",
- "application": "authorization",
- "subsystem": "token_validator"
}
{ }
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" |
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));
{- "deployed": [
- {
- "id": "webhook_id",
- "name": "my_webhook",
- "url": "slack.webhook.com",
- "createdAt": "2024-10-20T00:00:00.000Z",
- "updatedAt": "2024-10-20T00:00:00.000Z",
- "externalId": "external_id_example"
}
]
}
This data structure represents a request to create an outgoing webhook.
required | object (Outgoing Webhook Input Data) This data structure represents the input data of an outgoing webhook |
{- "data": {
- "type": "UNKNOWN",
- "name": "my_webhook",
- "url": "slack.webhook.com",
- "genericWebhook": {
- "uuid": "d838cd7b-087b-40c6-bc33-80997020f5d0",
- "method": "UNKNOWN",
- "headers": {
- "Content-Type": "application/json"
}, - "payload": {
- "key": "value"
}
}, - "slack": {
- "digests": [
- {
- "type": "UNKNOWN",
- "isActive": true
}
], - "attachments": [
- {
- "type": "EMPTY",
- "isActive": true
}
]
}, - "pagerDuty": {
- "serviceKey": "pager_duty_service_key"
}, - "sendLog": {
- "uuid": "d838cd7b-087b-40c6-bc33-80997020f5d0",
- "payload": {
- "key": "value"
}
}, - "emailGroup": {
- "emailAddresses": [
- "example@coralogix.com"
]
}, - "microsoftTeams": { },
- "jira": {
- "apiToken": "jira_api_token",
- "email": "jira_email",
- "projectKey": "jira_project_key"
}, - "opsgenie": { },
- "demisto": {
- "uuid": "d838cd7b-087b-40c6-bc33-80997020f5d0",
- "payload": {
- "key": "value"
}
}, - "awsEventBridge": {
- "eventBusArn": "arn:aws:events:us-east-1:123456789012:event-bus/default",
- "detail": {
- "key": "value"
}, - "detailType": "detail_type",
- "source": "source",
- "roleName": "role_name"
}, - "ibmEventNotifications": {
- "eventNotificationsInstanceId": "string",
- "regionId": "string",
- "sourceId": "string",
- "sourceName": "string",
- "endpointType": "ENDPOINT_TYPE_DEFAULT_OR_PUBLIC"
}, - "msTeamsWorkflow": { }
}
}
{- "id": "example_id"
}
This data structure represents a request to update an outgoing webhook.
id required | string |
required | object (Outgoing Webhook Input Data) This data structure represents the input data of an outgoing webhook |
{- "id": "example_id",
- "data": {
- "type": "UNKNOWN",
- "name": "my_webhook",
- "url": "slack.webhook.com",
- "genericWebhook": {
- "uuid": "d838cd7b-087b-40c6-bc33-80997020f5d0",
- "method": "UNKNOWN",
- "headers": {
- "Content-Type": "application/json"
}, - "payload": {
- "key": "value"
}
}, - "slack": {
- "digests": [
- {
- "type": "UNKNOWN",
- "isActive": true
}
], - "attachments": [
- {
- "type": "EMPTY",
- "isActive": true
}
]
}, - "pagerDuty": {
- "serviceKey": "pager_duty_service_key"
}, - "sendLog": {
- "uuid": "d838cd7b-087b-40c6-bc33-80997020f5d0",
- "payload": {
- "key": "value"
}
}, - "emailGroup": {
- "emailAddresses": [
- "example@coralogix.com"
]
}, - "microsoftTeams": { },
- "jira": {
- "apiToken": "jira_api_token",
- "email": "jira_email",
- "projectKey": "jira_project_key"
}, - "opsgenie": { },
- "demisto": {
- "uuid": "d838cd7b-087b-40c6-bc33-80997020f5d0",
- "payload": {
- "key": "value"
}
}, - "awsEventBridge": {
- "eventBusArn": "arn:aws:events:us-east-1:123456789012:event-bus/default",
- "detail": {
- "key": "value"
}, - "detailType": "detail_type",
- "source": "source",
- "roleName": "role_name"
}, - "ibmEventNotifications": {
- "eventNotificationsInstanceId": "string",
- "regionId": "string",
- "sourceId": "string",
- "sourceName": "string",
- "endpointType": "ENDPOINT_TYPE_DEFAULT_OR_PUBLIC"
}, - "msTeamsWorkflow": { }
}
}
{ }
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));
{- "deployed": [
- {
- "id": "webhook_id",
- "type": "UNKNOWN",
- "name": "my_webhook",
- "url": "slack.webhook.com",
- "createdAt": "2024-10-20T00:00:00.000Z",
- "updatedAt": "2024-10-20T00:00:00.000Z",
- "externalId": "external_id_example"
}
]
}
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));
{- "instances": [
- {
- "instanceId": "5a8b249b-3915-49e7-ad43-030f585d84c5",
- "regionId": "eu-gb",
- "name": "chocolate-is-love",
- "crn": "crn:v1:staging:public:logs:eu-gb:a/436fa6f7760f46eba99e22f099c33cb8:5a8b249b-3915-49e7-ad43-030f585d84c5::",
- "isUsed": true
}
]
}
const fetch = require('node-fetch'); let url = 'https://api.coralogix.com/mgmt/openapi/v1/outgoing_webhooks/summaries'; let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
{- "outboundWebhookSummaries": [
- {
- "id": "string",
- "type": "UNKNOWN",
- "name": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "externalId": 0
}
]
}
object (Outgoing Webhook Input Data) This data structure represents the input data of an outgoing webhook |
{- "data": {
- "type": "UNKNOWN",
- "name": "my_webhook",
- "url": "slack.webhook.com",
- "genericWebhook": {
- "uuid": "d838cd7b-087b-40c6-bc33-80997020f5d0",
- "method": "UNKNOWN",
- "headers": {
- "Content-Type": "application/json"
}, - "payload": {
- "key": "value"
}
}, - "slack": {
- "digests": [
- {
- "type": "UNKNOWN",
- "isActive": true
}
], - "attachments": [
- {
- "type": "EMPTY",
- "isActive": true
}
]
}, - "pagerDuty": {
- "serviceKey": "pager_duty_service_key"
}, - "sendLog": {
- "uuid": "d838cd7b-087b-40c6-bc33-80997020f5d0",
- "payload": {
- "key": "value"
}
}, - "emailGroup": {
- "emailAddresses": [
- "example@coralogix.com"
]
}, - "microsoftTeams": { },
- "jira": {
- "apiToken": "jira_api_token",
- "email": "jira_email",
- "projectKey": "jira_project_key"
}, - "opsgenie": { },
- "demisto": {
- "uuid": "d838cd7b-087b-40c6-bc33-80997020f5d0",
- "payload": {
- "key": "value"
}
}, - "awsEventBridge": {
- "eventBusArn": "arn:aws:events:us-east-1:123456789012:event-bus/default",
- "detail": {
- "key": "value"
}, - "detailType": "detail_type",
- "source": "source",
- "roleName": "role_name"
}, - "ibmEventNotifications": {
- "eventNotificationsInstanceId": "string",
- "regionId": "string",
- "sourceId": "string",
- "sourceName": "string",
- "endpointType": "ENDPOINT_TYPE_DEFAULT_OR_PUBLIC"
}, - "msTeamsWorkflow": { }
}
}
{- "success": { },
- "failure": {
- "errorMessage": "example_error_message",
- "displayMessage": "example_display_message",
- "statusCode": 400
}
}
This data structure represents a request to test an existing outgoing webhook.
id required | string |
{- "id": "example_id"
}
{- "success": { },
- "failure": {
- "errorMessage": "example_error_message",
- "displayMessage": "example_display_message",
- "statusCode": 400
}
}
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));
{- "webhooks": [
- {
- "type": "UNKNOWN",
- "label": "example_label",
- "count": 3
}
]
}
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" |
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));
{- "details": {
- "type": "UNKNOWN",
- "label": "example_label"
}
}
id required | string |
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));
{- "webhook": {
- "id": "webhook_id",
- "type": "UNKNOWN",
- "name": "my_webhook",
- "url": "slack.webhook.com",
- "createdAt": "2024-10-20T00:00:00.000Z",
- "updatedAt": "2024-10-20T00:00:00.000Z",
- "externalId": "external_id_example",
- "genericWebhook": {
- "uuid": "d838cd7b-087b-40c6-bc33-80997020f5d0",
- "method": "UNKNOWN",
- "headers": {
- "Content-Type": "application/json"
}, - "payload": {
- "key": "value"
}
}, - "slack": {
- "digests": [
- {
- "type": "UNKNOWN",
- "isActive": true
}
], - "attachments": [
- {
- "type": "EMPTY",
- "isActive": true
}
]
}, - "pagerDuty": {
- "serviceKey": "pager_duty_service_key"
}, - "sendLog": {
- "uuid": "d838cd7b-087b-40c6-bc33-80997020f5d0",
- "payload": {
- "key": "value"
}
}, - "emailGroup": {
- "emailAddresses": [
- "example@coralogix.com"
]
}, - "microsoftTeams": { },
- "jira": {
- "apiToken": "jira_api_token",
- "email": "jira_email",
- "projectKey": "jira_project_key"
}, - "opsgenie": { },
- "demisto": {
- "uuid": "d838cd7b-087b-40c6-bc33-80997020f5d0",
- "payload": {
- "key": "value"
}
}, - "awsEventBridge": {
- "eventBusArn": "arn:aws:events:us-east-1:123456789012:event-bus/default",
- "detail": {
- "key": "value"
}, - "detailType": "detail_type",
- "source": "source",
- "roleName": "role_name"
}, - "ibmEventNotifications": {
- "eventNotificationsInstanceId": "string",
- "regionId": "string",
- "sourceId": "string",
- "sourceName": "string",
- "endpointType": "ENDPOINT_TYPE_DEFAULT_OR_PUBLIC"
}, - "msTeamsWorkflow": { }
}
}
id required | string |
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));
{ }
name | string |
description | string |
enabled | boolean |
hidden | boolean |
creator | string |
Array of objects (v1RuleMatcher) | |
Array of objects (v1GetRuleGroupModelMappingRequestCreateRuleSubgroup) | |
order | integer <int64> |
{- "name": "string",
- "description": "string",
- "enabled": true,
- "hidden": true,
- "creator": "string",
- "ruleMatchers": [
- {
- "applicationName": {
- "value": "string"
}, - "subsystemName": {
- "value": "string"
}, - "severity": {
- "value": "VALUE_DEBUG_OR_UNSPECIFIED"
}
}
], - "ruleSubgroups": [
- {
- "rules": [
- {
- "name": "string",
- "description": "string",
- "sourceField": "string",
- "parameters": {
- "extractParameters": {
- "rule": "string"
}, - "jsonExtractParameters": {
- "destinationFieldType": "DESTINATION_FIELD_CATEGORY_OR_UNSPECIFIED",
- "rule": "string",
- "destinationFieldText": "string"
}, - "replaceParameters": {
- "destinationField": "string",
- "replaceNewVal": "string",
- "rule": "string"
}, - "parseParameters": {
- "destinationField": "string",
- "rule": "string"
}, - "allowParameters": {
- "keepBlockedLogs": true,
- "rule": "string"
}, - "blockParameters": {
- "keepBlockedLogs": true,
- "rule": "string"
}, - "extractTimestampParameters": {
- "standard": "FORMAT_STANDARD_STRFTIME_OR_UNSPECIFIED",
- "format": "string"
}, - "removeFieldsParameters": {
- "fields": [
- "string"
]
}, - "jsonStringifyParameters": {
- "destinationField": "string",
- "deleteSource": true
}, - "jsonParseParameters": {
- "destinationField": "string",
- "deleteSource": true,
- "escapedValue": true,
- "overrideDest": true
}
}, - "enabled": true,
- "order": 0
}
], - "enabled": true,
- "order": 0
}
], - "order": 0
}
{- "ruleDefinition": { }
}
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));
{- "ruleGroups": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "creator": "string",
- "enabled": true,
- "hidden": true,
- "ruleMatchers": [
- {
- "applicationName": {
- "value": "string"
}, - "subsystemName": {
- "value": "string"
}, - "severity": {
- "value": "VALUE_DEBUG_OR_UNSPECIFIED"
}
}
], - "ruleSubgroups": [
- {
- "id": "string",
- "rules": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "sourceField": "string",
- "parameters": {
- "extractParameters": {
- "rule": "string"
}, - "jsonExtractParameters": {
- "destinationFieldType": "DESTINATION_FIELD_CATEGORY_OR_UNSPECIFIED",
- "rule": "string",
- "destinationFieldText": "string"
}, - "replaceParameters": {
- "destinationField": "string",
- "replaceNewVal": "string",
- "rule": "string"
}, - "parseParameters": {
- "destinationField": "string",
- "rule": "string"
}, - "allowParameters": {
- "keepBlockedLogs": true,
- "rule": "string"
}, - "blockParameters": {
- "keepBlockedLogs": true,
- "rule": "string"
}, - "extractTimestampParameters": {
- "standard": "FORMAT_STANDARD_STRFTIME_OR_UNSPECIFIED",
- "format": "string"
}, - "removeFieldsParameters": {
- "fields": [
- null
]
}, - "jsonStringifyParameters": {
- "destinationField": "string",
- "deleteSource": true
}, - "jsonParseParameters": {
- "destinationField": "string",
- "deleteSource": true,
- "escapedValue": true,
- "overrideDest": true
}
}, - "enabled": true,
- "order": 0
}
], - "enabled": true,
- "order": 0
}
], - "order": 0
}
]
}
groupIds | Array of strings |
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));
{ }
name | string |
description | string |
enabled | boolean |
hidden | boolean |
creator | string |
Array of objects (v1RuleMatcher) | |
Array of objects (v1CreateRuleGroupRequestCreateRuleSubgroup) | |
order | integer <int64> |
object (coralogixrulesv1TeamId) |
{- "name": "string",
- "description": "string",
- "enabled": true,
- "hidden": true,
- "creator": "string",
- "ruleMatchers": [
- {
- "applicationName": {
- "value": "string"
}, - "subsystemName": {
- "value": "string"
}, - "severity": {
- "value": "VALUE_DEBUG_OR_UNSPECIFIED"
}
}
], - "ruleSubgroups": [
- {
- "rules": [
- {
- "name": "string",
- "description": "string",
- "sourceField": "string",
- "parameters": {
- "extractParameters": {
- "rule": "string"
}, - "jsonExtractParameters": {
- "destinationFieldType": "DESTINATION_FIELD_CATEGORY_OR_UNSPECIFIED",
- "rule": "string",
- "destinationFieldText": "string"
}, - "replaceParameters": {
- "destinationField": "string",
- "replaceNewVal": "string",
- "rule": "string"
}, - "parseParameters": {
- "destinationField": "string",
- "rule": "string"
}, - "allowParameters": {
- "keepBlockedLogs": true,
- "rule": "string"
}, - "blockParameters": {
- "keepBlockedLogs": true,
- "rule": "string"
}, - "extractTimestampParameters": {
- "standard": "FORMAT_STANDARD_STRFTIME_OR_UNSPECIFIED",
- "format": "string"
}, - "removeFieldsParameters": {
- "fields": [
- "string"
]
}, - "jsonStringifyParameters": {
- "destinationField": "string",
- "deleteSource": true
}, - "jsonParseParameters": {
- "destinationField": "string",
- "deleteSource": true,
- "escapedValue": true,
- "overrideDest": true
}
}, - "enabled": true,
- "order": 0
}
], - "enabled": true,
- "order": 0
}
], - "order": 0,
- "teamId": {
- "id": 0
}
}
{- "ruleGroup": {
- "id": "string",
- "name": "string",
- "description": "string",
- "creator": "string",
- "enabled": true,
- "hidden": true,
- "ruleMatchers": [
- {
- "applicationName": {
- "value": "string"
}, - "subsystemName": {
- "value": "string"
}, - "severity": {
- "value": "VALUE_DEBUG_OR_UNSPECIFIED"
}
}
], - "ruleSubgroups": [
- {
- "id": "string",
- "rules": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "sourceField": "string",
- "parameters": {
- "extractParameters": {
- "rule": "string"
}, - "jsonExtractParameters": {
- "destinationFieldType": "DESTINATION_FIELD_CATEGORY_OR_UNSPECIFIED",
- "rule": "string",
- "destinationFieldText": "string"
}, - "replaceParameters": {
- "destinationField": "string",
- "replaceNewVal": "string",
- "rule": "string"
}, - "parseParameters": {
- "destinationField": "string",
- "rule": "string"
}, - "allowParameters": {
- "keepBlockedLogs": true,
- "rule": "string"
}, - "blockParameters": {
- "keepBlockedLogs": true,
- "rule": "string"
}, - "extractTimestampParameters": {
- "standard": "FORMAT_STANDARD_STRFTIME_OR_UNSPECIFIED",
- "format": "string"
}, - "removeFieldsParameters": {
- "fields": [
- "string"
]
}, - "jsonStringifyParameters": {
- "destinationField": "string",
- "deleteSource": true
}, - "jsonParseParameters": {
- "destinationField": "string",
- "deleteSource": true,
- "escapedValue": true,
- "overrideDest": true
}
}, - "enabled": true,
- "order": 0
}
], - "enabled": true,
- "order": 0
}
], - "order": 0
}
}
{ }
{- "companyId": "string",
- "limits": {
- "parsingThemes": 0,
- "groups": 0,
- "rules": 0
}, - "usage": {
- "parsingThemes": 0,
- "groups": 0,
- "rules": 0
}
}
groupId required | string |
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));
{- "ruleGroup": {
- "id": "string",
- "name": "string",
- "description": "string",
- "creator": "string",
- "enabled": true,
- "hidden": true,
- "ruleMatchers": [
- {
- "applicationName": {
- "value": "string"
}, - "subsystemName": {
- "value": "string"
}, - "severity": {
- "value": "VALUE_DEBUG_OR_UNSPECIFIED"
}
}
], - "ruleSubgroups": [
- {
- "id": "string",
- "rules": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "sourceField": "string",
- "parameters": {
- "extractParameters": {
- "rule": "string"
}, - "jsonExtractParameters": {
- "destinationFieldType": "DESTINATION_FIELD_CATEGORY_OR_UNSPECIFIED",
- "rule": "string",
- "destinationFieldText": "string"
}, - "replaceParameters": {
- "destinationField": "string",
- "replaceNewVal": "string",
- "rule": "string"
}, - "parseParameters": {
- "destinationField": "string",
- "rule": "string"
}, - "allowParameters": {
- "keepBlockedLogs": true,
- "rule": "string"
}, - "blockParameters": {
- "keepBlockedLogs": true,
- "rule": "string"
}, - "extractTimestampParameters": {
- "standard": "FORMAT_STANDARD_STRFTIME_OR_UNSPECIFIED",
- "format": "string"
}, - "removeFieldsParameters": {
- "fields": [
- "string"
]
}, - "jsonStringifyParameters": {
- "destinationField": "string",
- "deleteSource": true
}, - "jsonParseParameters": {
- "destinationField": "string",
- "deleteSource": true,
- "escapedValue": true,
- "overrideDest": true
}
}, - "enabled": true,
- "order": 0
}
], - "enabled": true,
- "order": 0
}
], - "order": 0
}
}
groupId required | string |
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));
{ }
groupId required | string |
name | string |
description | string |
enabled | boolean |
hidden | boolean |
creator | string |
Array of objects (v1RuleMatcher) | |
Array of objects (v1CreateRuleGroupRequestCreateRuleSubgroup) | |
order | integer <int64> |
object (coralogixrulesv1TeamId) |
{- "name": "string",
- "description": "string",
- "enabled": true,
- "hidden": true,
- "creator": "string",
- "ruleMatchers": [
- {
- "applicationName": {
- "value": "string"
}, - "subsystemName": {
- "value": "string"
}, - "severity": {
- "value": "VALUE_DEBUG_OR_UNSPECIFIED"
}
}
], - "ruleSubgroups": [
- {
- "rules": [
- {
- "name": "string",
- "description": "string",
- "sourceField": "string",
- "parameters": {
- "extractParameters": {
- "rule": "string"
}, - "jsonExtractParameters": {
- "destinationFieldType": "DESTINATION_FIELD_CATEGORY_OR_UNSPECIFIED",
- "rule": "string",
- "destinationFieldText": "string"
}, - "replaceParameters": {
- "destinationField": "string",
- "replaceNewVal": "string",
- "rule": "string"
}, - "parseParameters": {
- "destinationField": "string",
- "rule": "string"
}, - "allowParameters": {
- "keepBlockedLogs": true,
- "rule": "string"
}, - "blockParameters": {
- "keepBlockedLogs": true,
- "rule": "string"
}, - "extractTimestampParameters": {
- "standard": "FORMAT_STANDARD_STRFTIME_OR_UNSPECIFIED",
- "format": "string"
}, - "removeFieldsParameters": {
- "fields": [
- "string"
]
}, - "jsonStringifyParameters": {
- "destinationField": "string",
- "deleteSource": true
}, - "jsonParseParameters": {
- "destinationField": "string",
- "deleteSource": true,
- "escapedValue": true,
- "overrideDest": true
}
}, - "enabled": true,
- "order": 0
}
], - "enabled": true,
- "order": 0
}
], - "order": 0,
- "teamId": {
- "id": 0
}
}
{- "ruleGroup": {
- "id": "string",
- "name": "string",
- "description": "string",
- "creator": "string",
- "enabled": true,
- "hidden": true,
- "ruleMatchers": [
- {
- "applicationName": {
- "value": "string"
}, - "subsystemName": {
- "value": "string"
}, - "severity": {
- "value": "VALUE_DEBUG_OR_UNSPECIFIED"
}
}
], - "ruleSubgroups": [
- {
- "id": "string",
- "rules": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "sourceField": "string",
- "parameters": {
- "extractParameters": {
- "rule": "string"
}, - "jsonExtractParameters": {
- "destinationFieldType": "DESTINATION_FIELD_CATEGORY_OR_UNSPECIFIED",
- "rule": "string",
- "destinationFieldText": "string"
}, - "replaceParameters": {
- "destinationField": "string",
- "replaceNewVal": "string",
- "rule": "string"
}, - "parseParameters": {
- "destinationField": "string",
- "rule": "string"
}, - "allowParameters": {
- "keepBlockedLogs": true,
- "rule": "string"
}, - "blockParameters": {
- "keepBlockedLogs": true,
- "rule": "string"
}, - "extractTimestampParameters": {
- "standard": "FORMAT_STANDARD_STRFTIME_OR_UNSPECIFIED",
- "format": "string"
}, - "removeFieldsParameters": {
- "fields": [
- "string"
]
}, - "jsonStringifyParameters": {
- "destinationField": "string",
- "deleteSource": true
}, - "jsonParseParameters": {
- "destinationField": "string",
- "deleteSource": true,
- "escapedValue": true,
- "overrideDest": true
}
}, - "enabled": true,
- "order": 0
}
], - "enabled": true,
- "order": 0
}
], - "order": 0
}
}
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));
{- "enrichments": [
- {
- "id": 1,
- "fieldName": 1,
- "enrichmentType": {
- "geoIp": {
- "withAsn": true
}, - "suspiciousIp": { },
- "aws": {
- "resourceType": "ec2"
}, - "customEnrichment": {
- "id": 1
}
}, - "enrichedFieldName": 1
}
]
}
enrichmentIds required | Array of integers <int64> [ items <int64 > ] |
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));
{- "remainingEnrichments": [
- {
- "id": 1,
- "fieldName": 1,
- "enrichmentType": {
- "geoIp": {
- "withAsn": true
}, - "suspiciousIp": { },
- "aws": {
- "resourceType": "ec2"
}, - "customEnrichment": {
- "id": 1
}
}, - "enrichedFieldName": 1
}
]
}
This response data structure represents a collection of enrichments
required | Array of objects (Enrichment Prototype) |
{- "requestEnrichments": [
- {
- "fieldName": "sourceIPs",
- "enrichmentType": {
- "geoIp": {
- "withAsn": true
}, - "suspiciousIp": { },
- "aws": {
- "resourceType": "ec2"
}, - "customEnrichment": {
- "id": 1
}
}, - "enrichedFieldName": "string"
}
]
}
{- "enrichments": [
- {
- "id": 1,
- "fieldName": 1,
- "enrichmentType": {
- "geoIp": {
- "withAsn": true
}, - "suspiciousIp": { },
- "aws": {
- "resourceType": "ec2"
}, - "customEnrichment": {
- "id": 1
}
}, - "enrichedFieldName": 1
}
]
}
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));
{- "limit": 10,
- "used": 5
}
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));
{- "enrichmentSettings": {
- "enrichmentAmountLimit": 0,
- "enrichmentsInUse": 0,
- "sizeLimitBytes": "string",
- "rowLimit": 0,
- "queryOnlySizeLimitBytes": "string",
- "queryOnlyRowLimit": 0
}
}
object (coralogixenrichmentv1EnrichmentType) | |
Array of objects (v1EnrichmentFieldDefinition) |
{- "enrichmentType": {
- "geoIp": {
- "withAsn": true
}, - "suspiciousIp": { },
- "aws": {
- "resourceType": "ec2"
}, - "customEnrichment": {
- "id": 1
}
}, - "enrichmentFields": [
- {
- "fieldName": "string",
- "enrichedFieldName": "string"
}
]
}
{- "enrichments": [
- {
- "id": 1,
- "fieldName": 1,
- "enrichmentType": {
- "geoIp": {
- "withAsn": true
}, - "suspiciousIp": { },
- "aws": {
- "resourceType": "ec2"
}, - "customEnrichment": {
- "id": 1
}
}, - "enrichedFieldName": 1
}
]
}
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));
{- "customEnrichments": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "version": 0,
- "isQueryOnly": true
}
]
}
This request data structure is used to create a custom enrichment
name required | string |
description required | string |
required |
{- "name": "custom_enrichment_name",
- "description": "custom_enrichment_description",
- "file": {
- "name": "file_name",
- "extension": "csv",
- "textual": "row1,row2 value1,value2",
- "binary": "0xFABB32"
}
}
{- "message": "Custom enrichment created successfully",
- "customEnrichment": {
- "id": 0,
- "name": "string",
- "description": "string",
- "version": 0,
- "isQueryOnly": true
}
}
This request data structure is used to update a custom enrichment
customEnrichmentId required | integer <int64> |
name required | string |
description required | string |
required |
{- "customEnrichmentId": 1,
- "name": "custom_enrichment_name",
- "description": "custom_enrichment_description",
- "file": {
- "name": "file_name",
- "extension": "csv",
- "textual": "row1,row2 value1,value2",
- "binary": "0xFABB32"
}
}
{- "message": "Custom enrichment updated successfully",
- "customEnrichment": {
- "id": 0,
- "name": "string",
- "description": "string",
- "version": 0,
- "isQueryOnly": true
}
}
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));
{- "customEnrichmentsData": [
- {
- "definition": {
- "id": 0,
- "name": "string",
- "description": "string",
- "version": 0,
- "isQueryOnly": true
}, - "textual": "string",
- "binary": "string"
}
]
}
customEnrichmentId required | integer <int64> |
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));
{- "message": "Custom enrichment deleted successfully",
- "customEnrichmentId": 1
}
id required | integer <int64> |
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));
{- "customEnrichment": {
- "id": 0,
- "name": "string",
- "description": "string",
- "version": 0,
- "isQueryOnly": true
}
}
enabledOnly required | boolean |
sourceType required | string Default: "SOURCE_TYPE_UNSPECIFIED" Enum: "SOURCE_TYPE_UNSPECIFIED" "SOURCE_TYPE_LOGS" "SOURCE_TYPE_SPANS" |
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));
{- "policies": [
- {
- "id": "policy_id",
- "companyId": 1234,
- "name": "My Policy",
- "description": "My Policy Description",
- "priority": "PRIORITY_TYPE_UNSPECIFIED",
- "deleted": false,
- "enabled": true,
- "order": 1,
- "applicationRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "subsystemRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "logRules": {
- "severities": [
- "SEVERITY_UNSPECIFIED"
]
}, - "spanRules": {
- "serviceRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "actionRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "tagRules": [
- {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "tagName": "tag_name",
- "tagValue": "tag_value"
}
]
}, - "createdAt": "2021-01-01T00:00:00.000Z",
- "updatedAt": "2021-01-01T00:00:00.000Z",
- "archiveRetention": {
- "id": "string"
}
}
]
}
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 (v1SpanRules) |
{- "name": "My Policy",
- "description": "My Policy Description",
- "priority": "PRIORITY_TYPE_UNSPECIFIED",
- "applicationRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "subsystemRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "archiveRetention": {
- "id": "string"
}, - "logRules": {
- "severities": [
- "SEVERITY_UNSPECIFIED"
]
}, - "spanRules": {
- "serviceRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "actionRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "tagRules": [
- {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "tagName": "tag_name",
- "tagValue": "tag_value"
}
]
}
}
{- "policy": {
- "id": "policy_id",
- "companyId": 1234,
- "name": "My Policy",
- "description": "My Policy Description",
- "priority": "PRIORITY_TYPE_UNSPECIFIED",
- "deleted": false,
- "enabled": true,
- "order": 1,
- "applicationRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "subsystemRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "logRules": {
- "severities": [
- "SEVERITY_UNSPECIFIED"
]
}, - "spanRules": {
- "serviceRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "actionRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "tagRules": [
- {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "tagName": "tag_name",
- "tagValue": "tag_value"
}
]
}, - "createdAt": "2021-01-01T00:00:00.000Z",
- "updatedAt": "2021-01-01T00:00:00.000Z",
- "archiveRetention": {
- "id": "string"
}
}
}
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 (v1SpanRules) | |
enabled | boolean |
{- "id": "policy_id",
- "name": "My Policy",
- "description": "My Policy Description",
- "priority": "PRIORITY_TYPE_UNSPECIFIED",
- "applicationRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "subsystemRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "archiveRetention": {
- "id": "string"
}, - "logRules": {
- "severities": [
- "SEVERITY_UNSPECIFIED"
]
}, - "spanRules": {
- "serviceRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "actionRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "tagRules": [
- {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "tagName": "tag_name",
- "tagValue": "tag_value"
}
]
}, - "enabled": true
}
{- "policy": {
- "id": "policy_id",
- "companyId": 1234,
- "name": "My Policy",
- "description": "My Policy Description",
- "priority": "PRIORITY_TYPE_UNSPECIFIED",
- "deleted": false,
- "enabled": true,
- "order": 1,
- "applicationRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "subsystemRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "logRules": {
- "severities": [
- "SEVERITY_UNSPECIFIED"
]
}, - "spanRules": {
- "serviceRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "actionRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "tagRules": [
- {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "tagName": "tag_name",
- "tagValue": "tag_value"
}
]
}, - "createdAt": "2021-01-01T00:00:00.000Z",
- "updatedAt": "2021-01-01T00:00:00.000Z",
- "archiveRetention": {
- "id": "string"
}
}
}
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));
{- "policy": {
- "id": "policy_id",
- "companyId": 1234,
- "name": "My Policy",
- "description": "My Policy Description",
- "priority": "PRIORITY_TYPE_UNSPECIFIED",
- "deleted": false,
- "enabled": true,
- "order": 1,
- "applicationRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "subsystemRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "logRules": {
- "severities": [
- "SEVERITY_UNSPECIFIED"
]
}, - "spanRules": {
- "serviceRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "actionRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "tagRules": [
- {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "tagName": "tag_name",
- "tagValue": "tag_value"
}
]
}, - "createdAt": "2021-01-01T00:00:00.000Z",
- "updatedAt": "2021-01-01T00:00:00.000Z",
- "archiveRetention": {
- "id": "string"
}
}
}
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));
{- "id": "id"
}
In an atomic operation delete all existing log policies and create the provided list by order.
required | Array of objects (Create Log Policy Request) |
{- "policies": [
- {
- "policy": {
- "name": "My Policy",
- "description": "My Policy Description",
- "priority": "PRIORITY_TYPE_UNSPECIFIED",
- "applicationRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "subsystemRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "archiveRetention": {
- "id": "string"
}
}, - "logRules": {
- "severities": [
- "SEVERITY_UNSPECIFIED"
]
}
}
]
}
{- "createResponses": [
- {
- "policy": {
- "id": "policy_id",
- "companyId": 1234,
- "name": "My Policy",
- "description": "My Policy Description",
- "priority": "PRIORITY_TYPE_UNSPECIFIED",
- "deleted": false,
- "enabled": true,
- "order": 1,
- "applicationRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "subsystemRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "logRules": {
- "severities": [
- "SEVERITY_UNSPECIFIED"
]
}, - "spanRules": {
- "serviceRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "actionRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "tagRules": [
- {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "tagName": "tag_name",
- "tagValue": "tag_value"
}
]
}, - "createdAt": "2021-01-01T00:00:00.000Z",
- "updatedAt": "2021-01-01T00:00:00.000Z",
- "archiveRetention": {
- "id": "string"
}
}
}
]
}
In an atomic operation delete all existing span policies and create the provided list by order.
required | Array of objects (Create Span Policy Request) |
{- "policies": [
- {
- "policy": {
- "name": "My Policy",
- "description": "My Policy Description",
- "priority": "PRIORITY_TYPE_UNSPECIFIED",
- "applicationRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "subsystemRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "archiveRetention": {
- "id": "string"
}
}, - "spanRules": {
- "serviceRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "actionRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "tagRules": [
- {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "tagName": "tag_name",
- "tagValue": "tag_value"
}
]
}
}
]
}
{- "createResponses": [
- {
- "policy": {
- "id": "policy_id",
- "companyId": 1234,
- "name": "My Policy",
- "description": "My Policy Description",
- "priority": "PRIORITY_TYPE_UNSPECIFIED",
- "deleted": false,
- "enabled": true,
- "order": 1,
- "applicationRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "subsystemRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "logRules": {
- "severities": [
- "SEVERITY_UNSPECIFIED"
]
}, - "spanRules": {
- "serviceRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "actionRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "tagRules": [
- {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "tagName": "tag_name",
- "tagValue": "tag_value"
}
]
}, - "createdAt": "2021-01-01T00:00:00.000Z",
- "updatedAt": "2021-01-01T00:00:00.000Z",
- "archiveRetention": {
- "id": "string"
}
}
}
]
}
This data structure is used to create multiple policies atomically.
required | Array of objects (Create Policy Request) |
{- "policyRequests": [
- {
- "name": "My Policy",
- "description": "My Policy Description",
- "priority": "PRIORITY_TYPE_UNSPECIFIED",
- "applicationRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "subsystemRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "archiveRetention": {
- "id": "string"
}, - "logRules": {
- "severities": [
- "SEVERITY_UNSPECIFIED"
]
}, - "spanRules": {
- "serviceRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "actionRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "tagRules": [
- {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "tagName": "tag_name",
- "tagValue": "tag_value"
}
]
}
}
]
}
{- "createResponses": [
- {
- "policy": {
- "id": "policy_id",
- "companyId": 1234,
- "name": "My Policy",
- "description": "My Policy Description",
- "priority": "PRIORITY_TYPE_UNSPECIFIED",
- "deleted": false,
- "enabled": true,
- "order": 1,
- "applicationRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "subsystemRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "logRules": {
- "severities": [
- "SEVERITY_UNSPECIFIED"
]
}, - "spanRules": {
- "serviceRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "actionRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "tagRules": [
- {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "tagName": "tag_name",
- "tagValue": "tag_value"
}
]
}, - "createdAt": "2021-01-01T00:00:00.000Z",
- "updatedAt": "2021-01-01T00:00:00.000Z",
- "archiveRetention": {
- "id": "string"
}
}
}
]
}
Request to test multiple log policies.
required | Array of objects (Log Meta Fields Values) |
{- "metaFieldsValuesList": [
- {
- "applicationNameValues": "application_name",
- "severityValues": "severity",
- "subsystemNameValues": "subsystem_name"
}
]
}
{- "testPoliciesBulkResult": [
- {
- "metaFieldsValues": {
- "applicationNameValues": "application_name",
- "severityValues": "severity",
- "subsystemNameValues": "subsystem_name"
}, - "matched": true,
- "policy": {
- "id": "policy_id",
- "companyId": 1234,
- "name": "My Policy",
- "description": "My Policy Description",
- "priority": "PRIORITY_TYPE_UNSPECIFIED",
- "deleted": false,
- "enabled": true,
- "order": 1,
- "applicationRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "subsystemRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "logRules": {
- "severities": [
- "SEVERITY_UNSPECIFIED"
]
}, - "spanRules": {
- "serviceRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "actionRule": {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "name": "string"
}, - "tagRules": [
- {
- "ruleTypeId": "RULE_TYPE_ID_UNSPECIFIED",
- "tagName": "tag_name",
- "tagValue": "tag_value"
}
]
}, - "createdAt": "2021-01-01T00:00:00.000Z",
- "updatedAt": "2021-01-01T00:00:00.000Z",
- "archiveRetention": {
- "id": "string"
}
}
}
]
}
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" |
{- "orders": [
- {
- "order": 1,
- "id": "id"
}
], - "sourceType": "SOURCE_TYPE_UNSPECIFIED"
}
{- "orders": [
- {
- "order": 1,
- "id": "id"
}
]
}
This data structue is used to toggle a policy by its ID.
id required | string |
enabled required | boolean |
{- "id": "id",
- "enabled": true
}
{- "id": "id",
- "enabled": true
}