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 details
GET
/
v1
/
integrations
/
{id}
Copy
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));
Copy
{
"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": "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": "false",
"integrations": [
"[]"
],
"keywords": [
"[]"
],
"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": [
"[]"
]
}
}
],
"docs": [
{
"name": "<string>",
"link": "<string>"
}
],
"default": {
"registered": [
{
"id": "<string>",
"definitionVersion": "<string>",
"lastUpdated": "2023-11-07T05:31:56Z",
"parameters": [
{
"key": "<string>",
"stringValue": "<string>",
"booleanValue": true,
"stringList": {
"values": [
"<string>"
]
},
"apiKey": {
"id": "<string>",
"value": "<string>"
},
"numericValue": 123,
"sensitiveData": {}
}
],
"integrationStatus": {
"connectionStatus": "PENDING",
"details": {},
"messages": [
"<string>"
]
},
"empty": {},
"cloudformation": {
"arn": "<string>",
"region": "<string>"
},
"arm": {
"subscriptionId": "<string>",
"resourceGroupName": "<string>"
},
"isTesting": true
}
]
},
"local": {
"changes": [
{
"version": "<string>",
"descriptionMd": "<string>"
}
]
},
"external": {
"url": "<string>"
}
}
}
Authorizations
API key authentication
Path Parameters
Query Parameters
Response
200
application/json
A successful response.
The response is of type object
.
Copy
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));
Copy
{
"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": "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": "false",
"integrations": [
"[]"
],
"keywords": [
"[]"
],
"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": [
"[]"
]
}
}
],
"docs": [
{
"name": "<string>",
"link": "<string>"
}
],
"default": {
"registered": [
{
"id": "<string>",
"definitionVersion": "<string>",
"lastUpdated": "2023-11-07T05:31:56Z",
"parameters": [
{
"key": "<string>",
"stringValue": "<string>",
"booleanValue": true,
"stringList": {
"values": [
"<string>"
]
},
"apiKey": {
"id": "<string>",
"value": "<string>"
},
"numericValue": 123,
"sensitiveData": {}
}
],
"integrationStatus": {
"connectionStatus": "PENDING",
"details": {},
"messages": [
"<string>"
]
},
"empty": {},
"cloudformation": {
"arn": "<string>",
"region": "<string>"
},
"arm": {
"subscriptionId": "<string>",
"resourceGroupName": "<string>"
},
"isTesting": true
}
]
},
"local": {
"changes": [
{
"version": "<string>",
"descriptionMd": "<string>"
}
]
},
"external": {
"url": "<string>"
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.