Rule Groups Service
Events2Metrics Service
Enrichments Service
Contextual data integration service
Custom Enrichments Service
Dashboard service
Dashboard folders service
Incidents service
- POSTList incidents with filters
- GETGet incident by ID
- GETGet incident events
- POSTAcknowledge incidents
- POSTAssign incidents to a user
- POSTGet multiple incidents by IDs
- POSTClose incidents
- POSTGet available filter values
- POSTList incident events with filters
- POSTGet available incident event filter values
- POSTGet total count of incident events
- POSTGet incident aggregations
- POSTResolve incidents
- POSTRemove incident user assignments
Integration service
- GETGet all integrations
- GETGet integration definition
- GETGet deployed integration
- DELDelete integration
- GETList managed integration keys
- GETGet managed integration status
- PUTUpdate integration
- POSTSave integration registration metadata
- POSTTest integration
- GETGet RUM integration versions data
- POSTTrigger sync of RUM integration data
- GETGet integration template
- GETGet integration details
Outgoing webhooks service
- GETList outgoing webhooks
- PUTUpdate an outgoing webhook
- POSTCreate an outgoing webhook
- GETList all outgoing webhooks
- GETList IBM event notification instances
- GETList outbound webhooks summary
- POSTTest an outgoing webhook
- POSTTest an existing outgoing webhook
- GETGet outgoing webhook types
- GETGet outgoing webhook type details
- GETGet outgoing webhook
- DELDelete an outgoing webhook
Policies Service
Retentions Service
Scopes Service
SLO Service
SAML Configuration Service
Team Permissions Management Service
- GETGet Team Group By Name
- PUTUpdate Team Group
- POSTCreate Team Group
- GETGet Team Groups
- POSTAdd Users To Team Groups
- DELRemove Users From Team Groups
- GETGet Team Group
- DELDelete Team Group
- GETGet Team Group Scope
- POSTSet Team Group Scope
- GETGet Group Users
- POSTAdd Users To Team Group
- DELRemove Users From Team Group
Folders for views
Actions Service
Target Service
Alert definitions service
Alert events service
API Keys Service
Policies Service
Atomic Overwrite Span Policies
POST
/
v1
/
policies:atomicOverwriteSpanPolicies
Copy
const fetch = require('node-fetch');
let url = 'https://api.coralogix.com/mgmt/openapi/v1/policies:atomicOverwriteSpanPolicies';
let options = {
method: 'POST',
headers: {Authorization: 'Bearer <API_KEY>', 'content-type': 'application/json'},
body: '{"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"}]}}]}'
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error('error:' + err));
Copy
{
"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>"
}
}
}
]
}
Authorizations
API key authentication
Body
application/json
In an atomic operation delete all existing span policies and create the provided list by order.
Response
200
application/json
A successful response.
This data structue is obtained when overwriting span policies atomically.
Copy
const fetch = require('node-fetch');
let url = 'https://api.coralogix.com/mgmt/openapi/v1/policies:atomicOverwriteSpanPolicies';
let options = {
method: 'POST',
headers: {Authorization: 'Bearer <API_KEY>', 'content-type': 'application/json'},
body: '{"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"}]}}]}'
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error('error:' + err));
Copy
{
"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>"
}
}
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.