> ## 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 definition > Returns the definition for the specified contextual data integration type. Requires the following permissions: - `contextual-data:ReadConfig` ## OpenAPI ````yaml openapi_v5.yaml get /integrations/contextual-data/v1/definitions/{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/definitions/{id}: get: tags: - Contextual data integration service summary: Get contextual data integration definition description: >- Returns the definition for the specified contextual data integration type. Requires the following permissions: - `contextual-data:ReadConfig` operationId: ContextualDataIntegrationService_GetContextualDataIntegrationDefinition parameters: - description: The unique identifier of the contextual data integration definition. in: path name: id required: true schema: minLength: 0 type: string description: >- The unique identifier of the contextual data integration definition. - description: Whether to include testing integrations in the results. in: query name: include_testing_integrations required: false schema: type: boolean description: Whether to include testing integrations in the results. responses: '200': content: application/json: schema: $ref: >- #/components/schemas/GetContextualDataIntegrationDefinitionResponse 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: GetContextualDataIntegrationDefinitionResponse: title: Get contextual data integration definition response type: object properties: integrationDefinition: $ref: '#/components/schemas/IntegrationDefinition' description: >- Response containing the definition of a contextual data integration type. 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. IntegrationDefinition: title: Integration definition type: object properties: featureFlag: minLength: 0 type: string description: The feature flag. integrationType: $ref: '#/components/schemas/v1.IntegrationType' key: minLength: 0 type: string description: The key. revisions: minItems: 0 type: array items: $ref: '#/components/schemas/IntegrationRevision' description: The revisions. description: This data structure represents a definition of an integration. 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: '' IntegrationRevision: title: Integration revision type: object oneOf: - required: - cloudFormation type: object - required: - managedService type: object - required: - helmChart type: object - required: - azureArmTemplate type: object - required: - rum type: object - required: - terraform type: object - type: object not: anyOf: - required: - cloudFormation type: object - required: - managedService type: object - required: - helmChart type: object - required: - azureArmTemplate type: object - required: - rum type: object - required: - terraform type: object properties: azureArmTemplate: $ref: '#/components/schemas/AzureArmTemplate' cloudFormation: $ref: '#/components/schemas/CloudFormationTemplate' featureFlag: minLength: 0 type: string description: The feature flag. fields: minItems: 0 type: array items: $ref: '#/components/schemas/FieldInformation' description: >- Configuration fields that users must fill in to deploy this integration revision. groups: minItems: 0 type: array items: $ref: '#/components/schemas/IntegrationRevision.Group' description: >- UI groups used to organize configuration fields into logical sections. helmChart: $ref: '#/components/schemas/HelmChart' id: minLength: 0 type: string description: Unique identifier. managedService: $ref: '#/components/schemas/ManagedService' revisionDeploymentSupported: type: boolean description: >- Whether this revision supports automated deployment through the Coralogix platform. rum: $ref: '#/components/schemas/Rum' terraform: $ref: '#/components/schemas/Terraform' upgradeInstructionsMd: minLength: 0 type: string description: >- Markdown-formatted upgrade instructions shown when upgrading from a previous revision. description: This data structure represents an integration revision. 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: '' AzureArmTemplate: title: Azure ARM template type: object properties: templateUrl: minLength: 0 type: string description: The template url. description: This data structure represents an azure ARM template. externalDocs: url: '' CloudFormationTemplate: title: CloudFormation template type: object properties: commands: minItems: 0 type: array items: $ref: '#/components/schemas/CommandInformation' description: The commands. parameters: type: object additionalProperties: minLength: 0 type: string description: The parameters. postInstallationSteps: type: object additionalProperties: minLength: 0 type: string description: The post installation steps. templateUrl: minLength: 0 type: string description: The template url. description: Cloud formation template. externalDocs: url: '' FieldInformation: title: Field information type: object oneOf: - required: - single type: object - required: - multiText type: object - required: - multipleSelection type: object - required: - singleBoolean type: object - required: - selection type: object - required: - singleNumber type: object - type: object not: anyOf: - required: - single type: object - required: - multiText type: object - required: - multipleSelection type: object - required: - singleBoolean type: object - required: - selection type: object - required: - singleNumber type: object properties: allowedPattern: minLength: 0 type: string description: >- Regular expression pattern that the field value must match for validation. applicableIf: $ref: '#/components/schemas/FieldCondition' documentationReference: minLength: 0 type: string description: Link to documentation providing more information about this field. groupId: minLength: 0 type: string description: >- Identifier of the UI group this field belongs to for form layout purposes. multiText: $ref: '#/components/schemas/ListTextValue' multipleSelection: $ref: '#/components/schemas/MultipleSelectionValue' name: minLength: 0 type: string description: Display name. placeholder: minLength: 0 type: string description: Placeholder text shown in the input field before a value is entered. predefined: type: boolean description: >- Whether this field has a predefined value that is suggested to the user. readonly: type: boolean description: Whether this field is read-only and cannot be modified by the user. required: type: boolean description: >- Whether this field must be filled in before the integration can be deployed. selection: $ref: '#/components/schemas/SelectionValue' single: $ref: '#/components/schemas/SingleValue' singleBoolean: $ref: '#/components/schemas/SingleBooleanValue' singleNumber: $ref: '#/components/schemas/IntegrationRevision.SingleNumericValue' templateParamName: minLength: 0 type: string description: >- Name of the template parameter this field maps to in the deployment template. tooltip: minLength: 0 type: string description: >- Tooltip text displayed on hover to provide additional context for this field. type: $ref: '#/components/schemas/InputType' upgradeNotice: minLength: 0 type: string description: >- Notice displayed to users when an upgrade is required to use this field. visible: type: boolean description: Whether this field is visible in the integration configuration UI. externalDocs: url: '' IntegrationRevision.Group: title: Group type: object properties: id: minLength: 0 type: string description: Unique identifier. name: minLength: 0 type: string description: Display name. externalDocs: url: '' HelmChart: title: Helm chart type: object properties: commands: minItems: 0 type: array items: $ref: '#/components/schemas/CommandInformation' description: The commands. guide: $ref: '#/components/schemas/IntegrationGuide' template: minLength: 0 type: string description: The template. description: This data structure represents a Helm chart. externalDocs: url: '' ManagedService: title: Managed service type: object additionalProperties: false description: This data structure represents a managed service. externalDocs: url: '' Rum: title: RUM type: object properties: browserSdkCommands: minItems: 0 type: array items: $ref: '#/components/schemas/CommandInformation' description: The browser sdk commands. sourceMapCommands: minItems: 0 type: array items: $ref: '#/components/schemas/CommandInformation' description: The source map commands. description: This data structure represents a RUM integration. externalDocs: url: '' Terraform: title: Terraform type: object properties: configurationBlocks: minItems: 0 type: array items: $ref: '#/components/schemas/ConfigurationBlock' description: The configuration blocks. description: This data structure represents a Terraform integration. externalDocs: url: '' Variant: enum: - DEFAULT - GCP - OAUTH - CUSTOM type: string description: Variant. CommandInformation: title: Command information type: object properties: command: minLength: 0 type: string description: The command. description: minLength: 0 type: string description: Human-readable description. language: $ref: '#/components/schemas/Language' links: minItems: 0 type: array items: $ref: '#/components/schemas/Link' description: List of links. name: minLength: 0 type: string description: Display name. tooltipText: minLength: 0 type: string description: The tooltip text. externalDocs: url: '' FieldCondition: title: Field condition type: object properties: type: $ref: '#/components/schemas/FieldCondition.ConditionType' values: minItems: 0 type: array items: $ref: '#/components/schemas/FieldCondition.FieldValue' description: List of values. description: Field condition. externalDocs: url: '' ListTextValue: title: List text value type: object properties: defaultValues: minItems: 0 type: array items: minLength: 0 type: string description: The default values. description: The default values. options: minItems: 0 type: array items: minLength: 0 type: string description: Options. description: Options. description: List text value. externalDocs: url: '' MultipleSelectionValue: title: Multiple selection value type: object properties: options: minItems: 0 type: array items: minLength: 0 type: string description: Options. description: Options. description: Multiple selection value. externalDocs: url: '' SelectionValue: title: Selection value type: object properties: defaultValue: minLength: 0 type: string description: The default value. options: minItems: 0 type: array items: minLength: 0 type: string description: Options. description: Options. description: Selection value. externalDocs: url: '' SingleValue: title: Single value type: object properties: defaultValue: minLength: 0 type: string description: The default value. description: Single value. externalDocs: url: '' SingleBooleanValue: title: Single boolean value type: object properties: defaultValue: type: boolean description: The default value. description: Single boolean value. externalDocs: url: '' IntegrationRevision.SingleNumericValue: title: Single numeric value type: object properties: defaultValue: type: number description: The default value. format: double description: Single numeric value. externalDocs: url: '' InputType: enum: - API_KEY - TEXT - LIST_TEXT - MULTIPLE_SELECTION - BOOLEAN - SELECT - JSON - NUMBER - SENSITIVE_DATA - JSON_OBJECT_ARRAY - AWS_REGION_SELECT - AWS_REGION_MULTISELECT - AWS_CLOUDWATCH_NAMESPACE_LIST type: string description: Input type. IntegrationGuide: title: Integration guide type: object properties: installationRequirements: minLength: 0 type: string description: The installation requirements. introduction: minLength: 0 type: string description: The introduction. description: Integration guide. externalDocs: url: '' ConfigurationBlock: title: Configuration block type: object properties: description: minLength: 0 type: string description: Human-readable description. name: minLength: 0 type: string description: Display name. value: minLength: 0 type: string description: The value. externalDocs: url: '' Language: enum: - UNKNOWN - BASH - JAVASCRIPT type: string description: Language. Link: title: Link type: object properties: key: minLength: 0 type: string description: The key. text: minLength: 0 type: string description: The text. url: minLength: 0 type: string description: URL. externalDocs: url: '' FieldCondition.ConditionType: enum: - UNKNOWN - OR - AND type: string description: Condition type. FieldCondition.FieldValue: title: Field value type: object properties: fieldName: minLength: 0 type: string description: The field name. valuePattern: minLength: 0 type: string description: The value pattern. externalDocs: url: '' securitySchemes: apiKeyAuth: type: apiKey in: header name: Authorization description: API key authentication ````