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
Integration service
Get integration definition
GET
/
v1
/
integrations
/
definition
/
{id}
Copy
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));
Copy
{
"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": 123
},
"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": {},
"postInstallationSteps": {}
},
"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>"
}
}
Authorizations
API key authentication
Path Parameters
Query Parameters
Response
200
application/json
A successful response.
This data structure represents a list of outgoing webhook types.
Copy
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));
Copy
{
"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": 123
},
"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": {},
"postInstallationSteps": {}
},
"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>"
}
}
Assistant
Responses are generated using AI and may contain mistakes.