GET
/
v1
/
integrations
/
{id}
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": "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

Authorization
string
header
required

API key authentication

Path Parameters

id
string
required

Query Parameters

includeTestingRevision
boolean

Response

200
application/json

A successful response.

The response is of type object.