> ## Documentation Index > Fetch the complete documentation index at: https://docs.coralogix.com/llms.txt > Use this file to discover all available pages before exploring further. # Get contextual data integration details > Returns the details of the specified contextual data integration. Requires the following permissions: - `contextual-data:ReadConfig` ## OpenAPI ````yaml openapi_v5.yaml get /integrations/contextual-data/v1/{id} openapi: 3.0.0 info: title: '' version: 1.0.0 servers: - url: https://api.coralogix.com/mgmt/openapi/5 - url: https://api.eu2.coralogix.com/mgmt/openapi/5 - url: https://api.coralogix.us/mgmt/openapi/5 - url: https://api.cx498.coralogix.com/mgmt/openapi/5 - url: https://api.coralogix.in/mgmt/openapi/5 - url: https://api.coralogixsg.com/mgmt/openapi/5 - url: https://api.ap3.coralogix.com/mgmt/openapi/5 security: - apiKeyAuth: [] tags: - name: AI Applications Service description: Manage the catalog of AI applications discovered from spans. externalDocs: url: '' - name: AI Evaluations Service description: >- Manage AI evaluations and the custom evaluation catalog for AI applications. externalDocs: url: '' - name: API Keys Admin Service description: Administrative operations for API Keys management. externalDocs: url: '' - name: API Keys Service description: Manage your API Keys. externalDocs: url: '' - name: Actions Service description: View and manage your Actions. externalDocs: url: '' - name: Alert Scheduler Rule service description: Manage your alert scheduler rules. externalDocs: url: '' - name: Alert definitions service description: >- View and manage your alerts using alert definitions - data structures that contain the configuration required to create an alert. externalDocs: description: Learn more about alerts in our documentation url: https://coralogix.com/docs/user-guides/alerting/introduction-to-alerts/ - name: Alert events service description: >- Get information regarding your alert events - instances of alerts being triggered. externalDocs: description: Learn more about alert events and incidents in our documentation. url: https://coralogix.com/docs/user-guides/alerting/incidents/ - name: Case Events service description: Manage case events, comments, and external thread synchronization. externalDocs: url: '' - name: Case Settings service description: Manage case settings team configurations. externalDocs: url: '' - name: Cases notification service description: Track notification adjacent data for cases. externalDocs: url: '' - name: Cases service description: >- Manage cases throughout their lifecycle. Create, view, assign, acknowledge, unacknowledge, resolve, and close cases to streamline investigations and follow-ups. externalDocs: description: Learn more about Cases in our documentation url: https://coralogix.com/docs/user-guides/cases/ - name: Connector Schema service description: Retrieve connector schemas for notification center integrations externalDocs: description: Learn more about connectors in our documentation url: >- https://coralogix.com/docs/user-guides/notification-center/connectors/introduction/ - name: Connectors service description: >- View and manage your connectors - integration instances for notification destinations externalDocs: description: Lean more about connectors in our documentation url: >- https://coralogix.com/docs/user-guides/notification-center/connectors/introduction/ - name: Contextual data integration service description: Query for contextual data integration information. externalDocs: url: '' - name: Custom Enrichments Service description: Manage your enrichments. externalDocs: url: '' - name: Dashboard folders service description: Manage your dashboard folders. externalDocs: url: '' - name: Dashboard service description: Get information about the Coralogix Dashboard catalog. externalDocs: url: '' - name: Data Usage Query service description: >- Query billable data usage through the public Coralogix API using daily or hourly bucketed aggregations over supported labels. externalDocs: url: '' - name: Data Usage Service description: A service to manage data usage metrics. externalDocs: url: '' - name: Enrichments Service description: Manage your enrichments. externalDocs: url: '' - name: Entities service description: Query information about registered entities in the notification center externalDocs: description: Lean more about the notification center in our documentation url: https://coralogix.com/docs/user-guides/notification-center/introduction/ - name: Events Service description: A service for querying events. externalDocs: description: Learn more about alerts in our documentation url: https://coralogix.com/docs/user-guides/alerting/introduction-to-alerts/ - name: Events2Metrics Service description: Manage your events2metrics. externalDocs: url: '' - name: Extension deployment service description: A service that enables querying for extension deployment information. externalDocs: description: Find out more about extensions in our documentation. url: https://coralogix.com/docs/integrations/extensions/ - name: Extension service description: A service that enables querying for extension information. externalDocs: description: Learn more about extensions in our documentation. url: https://coralogix.com/docs/integrations/extensions/ - name: Folders for views service description: Create and manage view folders. externalDocs: url: '' - name: Global routers service description: >- View and manage your global routers - entities that direct notifications to configured destinations based on conditions externalDocs: description: Lean more about global routers in our documentation url: >- https://coralogix.com/docs/user-guides/notification-center/routing/introduction/ - name: IP access service description: >- IP access service provides the API for managing company IP access settings. externalDocs: url: '' - name: Incidents service description: >- Handle all operations related to incident management within Coralogix. Identify, manage, and resolve incidents efficiently through automated workflows and team collaboration. externalDocs: description: Find out more about incident management in our documentation url: https://coralogix.com/docs/user-guides/alerting/incidents/ - name: Integration service description: A service that enables querying for integration information. externalDocs: description: Find out more about integrations in our documentation. url: https://coralogix.com/docs/integrations/getting-started/ - name: Metrics Data Archive Service description: View and manage your storage targets for metrics. externalDocs: description: Find out more about archives url: >- https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/ - name: Notifications testing service description: >- Test your notification center configurations including connectors, presets, and templates externalDocs: description: Lean more about the notification center in our documentation url: https://coralogix.com/docs/user-guides/notification-center/introduction/ - name: Outgoing webhooks service externalDocs: description: Find out more about outbound webhooks in our documentation. url: >- https://coralogix.com/docs/user-guides/alerting/outbound-webhooks/generic-outbound-webhooks-alert-webhooks/ - name: Policies Service description: View and manage your TCO policies externalDocs: url: '' - name: Presets service description: >- View and manage your presets - pre-configured templates for notification content rendering externalDocs: description: Lean more about presets in our documentation url: >- https://coralogix.com/docs/user-guides/notification-center/presets/introduction/ - name: Quota Allocation Rule Set service description: Manage quota allocation rules for different entity types. externalDocs: url: '' - name: Recording Rules Service description: A service to manage recording rules. externalDocs: url: '' - name: Retentions Service description: View and manage retentions externalDocs: url: '' - name: Role Management Service description: Service for managing system and custom roles. externalDocs: url: '' - name: Rule Groups Service description: A service to manage rule groups. externalDocs: url: '' - name: SAML Configuration Service description: Manage your SAML configuration externalDocs: url: '' - name: Scopes Service description: A service to manage scopes externalDocs: url: '' - name: Slos Service description: A service for managing Service Level Objectives (SLOs). externalDocs: url: '' - name: Target Service description: View and manage your storage targets for logs. externalDocs: description: Find out more about archives url: >- https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/ - name: Team Groups Management Service description: Manage Team Groups. externalDocs: url: '' - name: Users Management Service description: >- Manage team members (users) including creation, updates, search, and status management. externalDocs: url: '' - name: Views service description: Create and manage views. externalDocs: url: '' paths: /integrations/contextual-data/v1/{id}: get: tags: - Contextual data integration service summary: Get contextual data integration details description: |- Returns the details of the specified contextual data integration. Requires the following permissions: - `contextual-data:ReadConfig` operationId: ContextualDataIntegrationService_GetContextualDataIntegrationDetails parameters: - description: The unique identifier of the contextual data integration. in: path name: id required: true schema: minLength: 0 type: string description: The unique identifier of the contextual data integration. example: 076f4188-05e0-4ed3-afeb-653ad182ccb7 - description: Whether to include testing revisions in the results. in: query name: include_testing_revisions required: false schema: type: boolean description: Whether to include testing revisions in the results. responses: '200': content: application/json: schema: $ref: >- #/components/schemas/GetContextualDataIntegrationDetailsResponse description: '' '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized request '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Internal server error externalDocs: url: '' components: schemas: GetContextualDataIntegrationDetailsResponse: title: Get contextual data integration details response type: object properties: integrationDetail: $ref: '#/components/schemas/IntegrationDetails' description: Response containing the details of a contextual data integration. externalDocs: url: '' Error: type: object properties: code: maximum: 599 minimum: 100 type: integer description: HTTP status code of the error (for example 400, 404, 500). format: int32 message: maxLength: 4096 minLength: 0 pattern: ^[\s\S]*$ type: string description: Human-readable description of the error. description: Standard error response body returned for a failed request. IntegrationDetails: title: Integration details type: object oneOf: - required: - local type: object - required: - external type: object - type: object not: anyOf: - required: - local type: object - required: - external type: object properties: default: $ref: '#/components/schemas/DefaultIntegrationDetails' docs: minItems: 0 type: array items: $ref: '#/components/schemas/IntegrationDoc' description: Documentation links associated with this integration. extensions: minItems: 0 type: array items: $ref: '#/components/schemas/v1.Extension' description: >- Extensions bundled with this integration for pre-built dashboards and alerts. external: $ref: '#/components/schemas/ExternalUrl' integration: $ref: '#/components/schemas/Integration' local: $ref: '#/components/schemas/LocalChangelog' description: This data structure represents a set of integration details. externalDocs: url: '' DefaultIntegrationDetails: title: Default integration details type: object properties: registered: minItems: 0 type: array items: $ref: '#/components/schemas/RegisteredInstance' description: The registered. description: Default integration details. externalDocs: url: '' IntegrationDoc: title: Integration doc type: object properties: link: minLength: 0 type: string description: Link. name: minLength: 0 type: string description: Display name. description: This data structure represents integration documentation. externalDocs: url: '' v1.Extension: title: Extension metadata type: object properties: changelog: minItems: 0 type: array items: $ref: '#/components/schemas/ChangelogEntry' description: The changelog. darkModeImage: minLength: 0 type: string description: The dark mode image. deprecation: $ref: '#/components/schemas/Deprecation' id: minLength: 0 type: string description: Unique identifier of the extension. image: minLength: 0 type: string description: Image reference. integrations: minItems: 0 type: array items: minLength: 0 type: string description: The integrations. description: The integrations. isHidden: type: boolean description: The is hidden. keywords: minItems: 0 type: array items: minLength: 0 type: string description: The keywords. description: The keywords. name: minLength: 0 type: string description: Display name of the extension. permissionDeniedRevisions: minItems: 0 type: array items: $ref: '#/components/schemas/ExtensionRevision' description: The permission denied revisions. revisions: minItems: 0 type: array items: $ref: '#/components/schemas/ExtensionRevision' description: The revisions. description: Represents a Coralogix extension package containing pre-built resources. externalDocs: url: '' ExternalUrl: title: External URL type: object properties: url: minLength: 0 type: string description: URL. description: External url. externalDocs: url: '' Integration: title: Integration type: object properties: darkIcon: minLength: 0 type: string description: The dark icon. description: minLength: 0 type: string description: Human-readable description. featureFlag: minLength: 0 type: string description: The feature flag. icon: minLength: 0 type: string description: Icon identifier. id: minLength: 0 type: string description: Unique identifier. integrationType: $ref: '#/components/schemas/v1.IntegrationType' name: minLength: 0 type: string description: Display name. revisions: minItems: 0 type: array items: $ref: '#/components/schemas/v1.RevisionSummary' description: The revisions. tags: minItems: 0 type: array items: minLength: 0 type: string description: List of tags. description: List of tags. versions: minItems: 0 type: array items: minLength: 0 type: string description: The versions. description: The versions. description: This data structure represents an integration externalDocs: url: '' LocalChangelog: title: Local changelog type: object properties: changes: minItems: 0 type: array items: $ref: '#/components/schemas/RevisionRef' description: The changes. description: Local changelog. externalDocs: url: '' RegisteredInstance: title: Registered instance type: object oneOf: - required: - empty type: object - required: - cloudformation type: object - required: - arm type: object - type: object not: anyOf: - required: - empty type: object - required: - cloudformation type: object - required: - arm type: object properties: arm: $ref: '#/components/schemas/ARMStack' cloudformation: $ref: '#/components/schemas/CloudFormationStack' definitionVersion: minLength: 0 type: string description: The definition version. empty: $ref: '#/components/schemas/NoDeployment' id: minLength: 0 type: string description: Unique identifier. integrationStatus: $ref: '#/components/schemas/IntegrationStatus' isTesting: type: boolean description: >- Whether this is a testing instance used for validation purposes only. lastUpdated: minLength: 0 type: string description: Timestamp of the last update to this integration instance. format: date-time parameters: minItems: 0 type: array items: $ref: '#/components/schemas/Parameter' description: The parameters. revisionLifecycle: $ref: '#/components/schemas/RevisionLifecycle' externalDocs: url: '' ChangelogEntry: title: Changelog entry type: object properties: descriptionMd: minLength: 0 type: string description: The description md. version: minLength: 0 type: string description: Version. externalDocs: url: '' Deprecation: title: Deprecation type: object properties: reason: minLength: 0 type: string description: Reason. replacementExtensions: minItems: 0 type: array items: minLength: 0 type: string description: The replacement extensions. description: The replacement extensions. description: Deprecation. externalDocs: url: '' ExtensionRevision: title: Extension revision type: object properties: binaries: minItems: 0 type: array items: $ref: '#/components/schemas/ExtensionBinary' description: The binaries. description: minLength: 0 type: string description: Human-readable description. excerpt: minLength: 0 type: string description: The excerpt. integrationDetails: minItems: 0 type: array items: $ref: '#/components/schemas/IntegrationDetail' description: The integration details. isTesting: type: boolean description: The is testing. items: minItems: 0 type: array items: $ref: '#/components/schemas/ExtensionItem' description: List of items. labels: minItems: 0 type: array items: minLength: 0 type: string description: List of labels. description: List of labels. permissionDeniedItems: minItems: 0 type: array items: $ref: '#/components/schemas/ExtensionItem' description: The permission denied items. version: minLength: 0 type: string description: Version. externalDocs: url: '' v1.IntegrationType: title: Integration type type: object oneOf: - required: - managed type: object - required: - untracked type: object - required: - cloudformation type: object - required: - arm type: object - required: - pushBasedContextualData type: object - required: - contextualData type: object - required: - genericWebhook type: object - type: object not: anyOf: - required: - managed type: object - required: - untracked type: object - required: - cloudformation type: object - required: - arm type: object - required: - pushBasedContextualData type: object - required: - contextualData type: object - required: - genericWebhook type: object properties: arm: $ref: '#/components/schemas/AzureArm' cloudformation: $ref: '#/components/schemas/Cloudformation' contextualData: $ref: '#/components/schemas/ContextualData' genericWebhook: $ref: '#/components/schemas/GenericWebhook' managed: $ref: '#/components/schemas/Managed' pushBasedContextualData: $ref: '#/components/schemas/PushBasedContextualData' untracked: $ref: '#/components/schemas/Untracked' description: This data structure represents an integration type. externalDocs: url: '' v1.RevisionSummary: type: object properties: lifecycle: $ref: '#/components/schemas/RevisionLifecycle' version: minLength: 0 type: string description: Version number. RevisionRef: title: Revision reference type: object properties: descriptionMd: minLength: 0 type: string description: The description md. version: minLength: 0 type: string description: Version number. externalDocs: url: '' ARMStack: title: ARM stack type: object properties: resourceGroupName: minLength: 0 type: string description: The resource group name. subscriptionId: minLength: 0 type: string description: The subscription id. description: This data structure represents an Azure Resource Manager stack. externalDocs: description: >- Find out more about the Azure Resource Manager (ARM) integration in our documentation url: >- https://coralogix.com/docs/integrations/azure/azure-resource-manager-integration-packages/ CloudFormationStack: title: CloudFormation stack type: object properties: arn: minLength: 0 type: string description: The arn. region: minLength: 0 type: string description: Region. description: This data structure represents a CloudFormation stack. externalDocs: description: >- Find out more about the AWS CloudFormation integration in our documentation url: https://coralogix.com/docs/integrations/aws/aws-cloudformation-logs/ NoDeployment: title: No deployment type: object additionalProperties: false description: >- This data structure represents an integration that does not require deployment. externalDocs: url: '' IntegrationStatus: title: Integration status type: object properties: connectionStatus: $ref: '#/components/schemas/ConnectionStatus' details: type: object additionalProperties: minLength: 0 type: string description: List of details. messages: minItems: 0 type: array items: minLength: 0 type: string description: The messages. description: The messages. description: This data structure represents an integration status. externalDocs: url: '' Parameter: title: Parameter type: object oneOf: - required: - stringValue type: object - required: - booleanValue type: object - required: - stringList type: object - required: - apiKey type: object - required: - numericValue type: object - required: - sensitiveData type: object - type: object not: anyOf: - required: - stringValue type: object - required: - booleanValue type: object - required: - stringList type: object - required: - apiKey type: object - required: - numericValue type: object - required: - sensitiveData type: object properties: apiKey: $ref: '#/components/schemas/ApiKeyData' booleanValue: type: boolean description: Boolean value for this integration parameter. key: minLength: 0 type: string description: The key. numericValue: type: number description: Numeric value for this integration parameter. format: double sensitiveData: $ref: '#/components/schemas/SensitiveDataPlaceholder' stringList: $ref: '#/components/schemas/StringList' stringValue: minLength: 0 type: string description: String value for this integration parameter. externalDocs: url: '' RevisionLifecycle: enum: - REVISION_LIFECYCLE_UNSPECIFIED - REVISION_LIFECYCLE_ALPHA - REVISION_LIFECYCLE_PRIVATE_BETA - REVISION_LIFECYCLE_PUBLIC_BETA - REVISION_LIFECYCLE_GA - REVISION_LIFECYCLE_DEPRECATED type: string description: Revision lifecycle. ExtensionBinary: title: Extension binary type: object properties: data: minLength: 0 type: string description: Data payload. type: $ref: '#/components/schemas/ExtensionBinary.BinaryType' externalDocs: url: '' IntegrationDetail: title: Integration detail type: object properties: link: minLength: 0 type: string description: Link. name: minLength: 0 type: string description: Display name. externalDocs: url: '' ExtensionItem: title: Extension item type: object properties: binaries: minItems: 0 type: array items: $ref: '#/components/schemas/ExtensionItemBinary' description: The binaries. data: type: object description: Data payload. description: minLength: 0 type: string description: Human-readable description. extendedInternalId: minLength: 0 type: string description: The extended internal id. id: minLength: 0 type: string description: Unique identifier. isMandatory: type: boolean description: The is mandatory. name: minLength: 0 type: string description: Display name. permissionResource: $ref: '#/components/schemas/PermissionResource' stableId: minLength: 0 type: string description: The stable id. targetDomain: $ref: '#/components/schemas/TargetDomain' uniqueId: minLength: 0 type: string description: The unique id. externalDocs: url: '' AzureArm: title: Azure ARM type: object additionalProperties: false description: This data structure represents an Azure ARM integration. externalDocs: url: '' Cloudformation: title: CloudFormation type: object additionalProperties: false description: This data structure represents a CloudFormation integration. externalDocs: url: '' ContextualData: title: Contextual data type: object additionalProperties: false description: This data structure represents a contextual data integration. externalDocs: url: '' GenericWebhook: title: Generic webhook type: object additionalProperties: false description: This data structure represents a generic webhook integration. externalDocs: url: '' Managed: title: Managed type: object properties: variant: $ref: '#/components/schemas/Variant' description: This data structure represents a managed integration. externalDocs: url: '' PushBasedContextualData: title: Push based contextual data type: object additionalProperties: false description: This data structure represents a push based contextual data integration. externalDocs: url: '' Untracked: title: Untracked type: object additionalProperties: false description: This data structure represents an untracked integration. externalDocs: url: '' ConnectionStatus: enum: - PENDING - ACTIVE - FAILING - STATUS_UNKNOWN type: string description: Connection status. ApiKeyData: title: API key data type: object properties: id: minLength: 0 type: string description: Unique identifier. value: minLength: 0 type: string description: The value. description: Api key data. externalDocs: url: '' SensitiveDataPlaceholder: title: Sensitive data placeholder type: object additionalProperties: false description: Sensitive data placeholder. externalDocs: url: '' StringList: title: String list type: object properties: values: minItems: 0 type: array items: minLength: 0 type: string description: List of values. description: List of values. description: String list. externalDocs: url: '' ExtensionBinary.BinaryType: enum: - KIBANA_INDEX_PATTERN type: string description: Type of binary content stored in the extension. ExtensionItemBinary: title: Extension item binary type: object properties: data: minLength: 0 type: string description: Data payload. fileName: minLength: 0 type: string description: The file name. type: $ref: '#/components/schemas/ExtensionItemBinary.BinaryType' externalDocs: url: '' PermissionResource: enum: - UNKNOWN - ACTION - ALERT - CUSTOM_ENRICHMENT - GEO_ENRICHMENT - SECURITY_ENRICHMENT - RESOURCE_CLOUD_METADATA_ENRICHMENT - GRAFANA_DASHBOARD - KIBANA_DASHBOARD - PARSING_RULE - SAVED_VIEW - CX_CUSTOM_DASHBOARD - METRICS_RULE_GROUP - SPAN_EVENTS_TO_METRICS - LOGS_EVENTS_TO_METRICS type: string description: Permission resource. TargetDomain: enum: - ACTION - ALERT - ENRICHMENT - GRAFANA_DASHBOARD - KIBANA_DASHBOARD - PARSING_RULE - SAVED_VIEW - CX_CUSTOM_DASHBOARD - METRICS_RULE_GROUP - EVENTS_TO_METRICS - ALERT_V3 type: string description: Target domain. Variant: enum: - DEFAULT - GCP - OAUTH - CUSTOM type: string description: Variant. ExtensionItemBinary.BinaryType: enum: - PREVIEW_IMAGE - KIBANA_DASHBOARD_DEFINITION - GRAFANA_DASHBOARD_DEFINITION - ENRICHMENT_CSV - CX_CUSTOM_DASHBOARD_DEFINITION type: string description: Binary type. securitySchemes: apiKeyAuth: type: apiKey in: header name: Authorization description: API key authentication ````