> ## 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.

# Test contextual data integration

> Tests the specified contextual data integration.

Requires the following permissions:
- `contextual-data:UpdateConfig`



## OpenAPI

````yaml openapi_v5.yaml post /integrations/contextual-data/v1/test/{integration_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/test/{integration_id}:
    post:
      tags:
        - Contextual data integration service
      summary: Test contextual data integration
      description: |-
        Tests the specified contextual data integration.

        Requires the following permissions:
        - `contextual-data:UpdateConfig`
      operationId: ContextualDataIntegrationService_TestContextualDataIntegration
      parameters:
        - description: The unique identifier of the contextual data integration to test.
          in: path
          name: integration_id
          required: true
          schema:
            minLength: 0
            type: string
            description: The unique identifier of the contextual data integration to test.
      requestBody:
        content:
          application/json:
            schema:
              description: Request for testing a contextual data integration.
              properties:
                integrationData:
                  $ref: '#/components/schemas/IntegrationMetadata'
              title: Test contextual data integration request
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestContextualDataIntegrationResponse'
          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:
    IntegrationMetadata:
      title: Integration metadata
      type: object
      properties:
        integrationKey:
          minLength: 0
          type: string
          description: The integration key.
        integrationParameters:
          $ref: '#/components/schemas/GenericIntegrationParameters'
        version:
          minLength: 0
          type: string
          description: Version number.
      description: This data structure represents the metadata of an integration.
      externalDocs:
        url: ''
    TestContextualDataIntegrationResponse:
      title: Test contextual data integration response
      type: object
      properties:
        result:
          $ref: '#/components/schemas/TestIntegrationResult'
      description: Response containing the results of a contextual data integration test.
      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.
    GenericIntegrationParameters:
      title: Generic integration parameters
      type: object
      properties:
        parameters:
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/Parameter'
          description: The parameters.
      description: Generic integration parameters.
      externalDocs:
        url: ''
    TestIntegrationResult:
      title: Test integration result
      type: object
      oneOf:
        - required:
            - success
          type: object
        - required:
            - failure
          type: object
        - type: object
          not:
            anyOf:
              - required:
                  - success
                type: object
              - required:
                  - failure
                type: object
      properties:
        failure:
          $ref: '#/components/schemas/v1.Failure'
        success:
          $ref: '#/components/schemas/TestIntegrationResult.Success'
      description: Test integration result.
      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: ''
    v1.Failure:
      title: Failure
      type: object
      properties:
        errorMessage:
          minLength: 0
          type: string
          description: The error message.
      description: Failure.
      externalDocs:
        url: ''
    TestIntegrationResult.Success:
      title: Success
      type: object
      additionalProperties: false
      description: Success.
      externalDocs:
        url: ''
    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: ''
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: API key authentication

````