> ## 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 integration details

> No description available



## OpenAPI

````yaml openapi_v3.yaml get /integrations/integrations/v1/{id}
openapi: 3.0.0
info:
  title: ''
  version: 1.0.0
servers:
  - url: https://api.coralogix.com/mgmt/openapi/3
  - url: https://api.eu2.coralogix.com/mgmt/openapi/3
  - url: https://api.coralogix.us/mgmt/openapi/3
  - url: https://api.cx498.coralogix.com/mgmt/openapi/3
  - url: https://api.coralogix.in/mgmt/openapi/3
  - url: https://api.coralogixsg.com/mgmt/openapi/3
  - url: https://api.ap3.coralogix.com/mgmt/openapi/3
security:
  - apiKeyAuth: []
tags:
  - 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: 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: 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: Cases service
    description: >-
      Manage cases throughout their lifecycle. Create, view, assign,
      acknowledge, 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: SAML Configuration Service
    description: Manage your SAML configuration
    externalDocs:
      url: ''
  - name: Events2Metrics Service
    description: Manage your events2metrics.
    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: 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: API Keys Service
    description: Manage your API Keys.
    externalDocs:
      url: ''
  - 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: Scopes Service
    description: A service to manage scopes
    externalDocs:
      url: ''
  - name: IP access service
    description: >-
      IP access service provides the API for managing company IP access
      settings.
    externalDocs:
      url: ''
  - name: Dashboard service
    description: Get information about the Coralogix Dashboard catalog.
    externalDocs:
      url: ''
  - 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: Team Permissions Management Service
    description: Manage Team Groups.
    externalDocs:
      url: ''
  - 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: Extension testing service
    externalDocs:
      description: Find out more about extensions in our documentation.
      url: https://coralogix.com/docs/integrations/extensions/
  - name: Data Usage Service
    description: A service to manage data usage metrics.
    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: Contextual data integration service
    description: Query for contextual data integration information.
    externalDocs:
      url: ''
  - name: Custom Enrichments Service
    description: Manage your enrichments.
    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: Recording Rules Service
    description: A service to manage recording rules.
    externalDocs:
      url: ''
  - name: Folders for views service
    description: Create and manage view folders.
    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: Retentions Service
    description: View and manage retentions
    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: Enrichments Service
    description: Manage your enrichments.
    externalDocs:
      url: ''
  - name: Role Management Service
    description: Service for managing system and custom roles.
    externalDocs:
      url: ''
  - 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: Rule Groups Service
    description: A service to manage rule groups.
    externalDocs:
      url: ''
  - name: Policies Service
    description: View and manage your TCO policies
    externalDocs:
      url: ''
  - name: Alert Scheduler Rule service
    description: Manage your alert scheduler rules.
    externalDocs:
      url: ''
  - name: Dashboard folders service
    description: Manage your dashboard folders.
    externalDocs:
      url: ''
  - name: Actions Service
    description: A service for managing actions.
    externalDocs:
      url: ''
  - name: Slos Service
    description: A service for managing Service Level Objectives (SLOs).
    externalDocs:
      url: ''
  - name: Views service
    description: Create and manage views.
    externalDocs:
      url: ''
  - 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: SLO Service
    description: Manage your SLOs.
    externalDocs:
      url: ''
paths:
  /integrations/integrations/v1/{id}:
    get:
      tags:
        - Integration service
      summary: Get integration details
      description: No description available
      operationId: IntegrationService_GetIntegrationDetails
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
        - in: query
          name: include_testing_revision
          required: false
          schema:
            type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetIntegrationDetailsResponse'
          description: ''
        '400':
          content:
            application/json: {}
          description: Bad Request
        '401':
          content:
            application/json: {}
          description: Unauthorized request
        '500':
          content:
            application/json: {}
          description: Internal server error
      externalDocs:
        url: ''
components:
  schemas:
    GetIntegrationDetailsResponse:
      title: Get integration details response
      type: object
      properties:
        integrationDetail:
          $ref: '#/components/schemas/IntegrationDetails'
      externalDocs:
        url: ''
    IntegrationDetails:
      oneOf:
        - $ref: '#/components/schemas/IntegrationDetailsLocal'
        - $ref: '#/components/schemas/IntegrationDetailsExternal'
    IntegrationDetailsLocal:
      title: Integration details
      type: object
      properties:
        default:
          $ref: '#/components/schemas/DefaultIntegrationDetails'
        docs:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationDoc'
        extensions:
          type: array
          items:
            $ref: '#/components/schemas/v1.Extension'
        integration:
          $ref: '#/components/schemas/Integration'
        local:
          $ref: '#/components/schemas/LocalChangelog'
      additionalProperties: false
      description: This data structure represents a set of integration details.
      externalDocs:
        url: ''
    IntegrationDetailsExternal:
      title: Integration details
      type: object
      properties:
        default:
          $ref: '#/components/schemas/DefaultIntegrationDetails'
        docs:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationDoc'
        extensions:
          type: array
          items:
            $ref: '#/components/schemas/v1.Extension'
        external:
          $ref: '#/components/schemas/ExternalUrl'
        integration:
          $ref: '#/components/schemas/Integration'
      additionalProperties: false
      description: This data structure represents a set of integration details.
      externalDocs:
        url: ''
    DefaultIntegrationDetails:
      title: Default integration details
      type: object
      properties:
        registered:
          type: array
          items:
            $ref: '#/components/schemas/RegisteredInstance'
      externalDocs:
        url: ''
    IntegrationDoc:
      title: Integration doc
      type: object
      properties:
        link:
          type: string
        name:
          type: string
      description: This data structure represents integration documentation.
      externalDocs:
        url: ''
    v1.Extension:
      title: Extension metadata
      type: object
      properties:
        changelog:
          type: array
          items:
            $ref: '#/components/schemas/ChangelogEntry'
        darkModeImage:
          type: string
        deprecation:
          $ref: '#/components/schemas/Deprecation'
        id:
          type: string
        image:
          type: string
        integrations:
          type: array
          items:
            type: string
        isHidden:
          type: boolean
        keywords:
          type: array
          items:
            type: string
        name:
          type: string
        permissionDeniedRevisions:
          type: array
          items:
            $ref: '#/components/schemas/ExtensionRevision'
        revisions:
          type: array
          items:
            $ref: '#/components/schemas/ExtensionRevision'
      externalDocs:
        url: ''
    Integration:
      title: Integration
      type: object
      properties:
        darkIcon:
          type: string
        description:
          type: string
        featureFlag:
          type: string
        icon:
          type: string
        id:
          type: string
        integrationType:
          $ref: '#/components/schemas/v1.IntegrationType'
        name:
          type: string
        tags:
          type: array
          items:
            type: string
        versions:
          type: array
          items:
            type: string
      description: This data structure represents an integration
      externalDocs:
        url: ''
    LocalChangelog:
      title: Local changelog
      type: object
      properties:
        changes:
          type: array
          items:
            $ref: '#/components/schemas/RevisionRef'
      externalDocs:
        url: ''
    ExternalUrl:
      title: External URL
      type: object
      properties:
        url:
          type: string
      externalDocs:
        url: ''
    RegisteredInstance:
      oneOf:
        - $ref: '#/components/schemas/RegisteredInstanceEmpty'
        - $ref: '#/components/schemas/RegisteredInstanceCloudformation'
        - $ref: '#/components/schemas/RegisteredInstanceArm'
    ChangelogEntry:
      title: Changelog entry
      type: object
      properties:
        descriptionMd:
          type: string
        version:
          type: string
      externalDocs:
        url: ''
    Deprecation:
      title: Deprecation
      type: object
      properties:
        reason:
          type: string
        replacementExtensions:
          type: array
          items:
            type: string
      externalDocs:
        url: ''
    ExtensionRevision:
      title: Extension revision
      type: object
      properties:
        binaries:
          type: array
          items:
            $ref: '#/components/schemas/ExtensionBinary'
        description:
          type: string
        excerpt:
          type: string
        integrationDetails:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationDetail'
        isTesting:
          type: boolean
        items:
          type: array
          items:
            $ref: '#/components/schemas/ExtensionItem'
        labels:
          type: array
          items:
            type: string
        permissionDeniedItems:
          type: array
          items:
            $ref: '#/components/schemas/ExtensionItem'
        version:
          type: string
      externalDocs:
        url: ''
    v1.IntegrationType:
      oneOf:
        - $ref: '#/components/schemas/V1IntegrationTypeManaged'
        - $ref: '#/components/schemas/V1IntegrationTypeUntracked'
        - $ref: '#/components/schemas/V1IntegrationTypeCloudformation'
        - $ref: '#/components/schemas/V1IntegrationTypeArm'
        - $ref: '#/components/schemas/V1IntegrationTypePushBasedContextualData'
        - $ref: '#/components/schemas/V1IntegrationTypeContextualData'
        - $ref: '#/components/schemas/V1IntegrationTypeGenericWebhook'
    RevisionRef:
      title: Revision reference
      type: object
      properties:
        descriptionMd:
          type: string
        version:
          type: string
      externalDocs:
        url: ''
    RegisteredInstanceEmpty:
      title: Registered instance
      type: object
      properties:
        definitionVersion:
          type: string
        empty:
          $ref: '#/components/schemas/NoDeployment'
        id:
          type: string
        integrationStatus:
          $ref: '#/components/schemas/IntegrationStatus'
        isTesting:
          type: boolean
        lastUpdated:
          type: string
          format: date-time
        parameters:
          type: array
          items:
            $ref: '#/components/schemas/Parameter'
      additionalProperties: false
      externalDocs:
        url: ''
    RegisteredInstanceCloudformation:
      title: Registered instance
      type: object
      properties:
        cloudformation:
          $ref: '#/components/schemas/CloudFormationStack'
        definitionVersion:
          type: string
        id:
          type: string
        integrationStatus:
          $ref: '#/components/schemas/IntegrationStatus'
        isTesting:
          type: boolean
        lastUpdated:
          type: string
          format: date-time
        parameters:
          type: array
          items:
            $ref: '#/components/schemas/Parameter'
      additionalProperties: false
      externalDocs:
        url: ''
    RegisteredInstanceArm:
      title: Registered instance
      type: object
      properties:
        arm:
          $ref: '#/components/schemas/ARMStack'
        definitionVersion:
          type: string
        id:
          type: string
        integrationStatus:
          $ref: '#/components/schemas/IntegrationStatus'
        isTesting:
          type: boolean
        lastUpdated:
          type: string
          format: date-time
        parameters:
          type: array
          items:
            $ref: '#/components/schemas/Parameter'
      additionalProperties: false
      externalDocs:
        url: ''
    ExtensionBinary:
      title: Extension binary
      type: object
      properties:
        data:
          type: string
        type:
          $ref: '#/components/schemas/ExtensionBinary.BinaryType'
      externalDocs:
        url: ''
    IntegrationDetail:
      title: Integration detail
      type: object
      properties:
        link:
          type: string
        name:
          type: string
      externalDocs:
        url: ''
    ExtensionItem:
      title: Extension item
      type: object
      properties:
        binaries:
          type: array
          items:
            $ref: '#/components/schemas/ExtensionItemBinary'
        data:
          type: object
        description:
          type: string
        extendedInternalId:
          type: string
        id:
          type: string
        isMandatory:
          type: boolean
        name:
          type: string
        permissionResource:
          $ref: '#/components/schemas/PermissionResource'
        stableId:
          type: string
        targetDomain:
          $ref: '#/components/schemas/TargetDomain'
        uniqueId:
          type: string
      externalDocs:
        url: ''
    V1IntegrationTypeManaged:
      title: Integration type
      type: object
      properties:
        managed:
          $ref: '#/components/schemas/Managed'
      additionalProperties: false
      description: This data structure represents an integration type.
      externalDocs:
        url: ''
    V1IntegrationTypeUntracked:
      title: Integration type
      type: object
      properties:
        untracked:
          $ref: '#/components/schemas/Untracked'
      additionalProperties: false
      description: This data structure represents an integration type.
      externalDocs:
        url: ''
    V1IntegrationTypeCloudformation:
      title: Integration type
      type: object
      properties:
        cloudformation:
          $ref: '#/components/schemas/Cloudformation'
      additionalProperties: false
      description: This data structure represents an integration type.
      externalDocs:
        url: ''
    V1IntegrationTypeArm:
      title: Integration type
      type: object
      properties:
        arm:
          $ref: '#/components/schemas/AzureArm'
      additionalProperties: false
      description: This data structure represents an integration type.
      externalDocs:
        url: ''
    V1IntegrationTypePushBasedContextualData:
      title: Integration type
      type: object
      properties:
        pushBasedContextualData:
          $ref: '#/components/schemas/PushBasedContextualData'
      additionalProperties: false
      description: This data structure represents an integration type.
      externalDocs:
        url: ''
    V1IntegrationTypeContextualData:
      title: Integration type
      type: object
      properties:
        contextualData:
          $ref: '#/components/schemas/ContextualData'
      additionalProperties: false
      description: This data structure represents an integration type.
      externalDocs:
        url: ''
    V1IntegrationTypeGenericWebhook:
      title: Integration type
      type: object
      properties:
        genericWebhook:
          $ref: '#/components/schemas/GenericWebhook'
      additionalProperties: false
      description: This data structure represents an integration type.
      externalDocs:
        url: ''
    NoDeployment:
      title: No deployment
      type: object
      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:
            type: string
        messages:
          type: array
          items:
            type: string
      description: This data structure represents an integration status.
      externalDocs:
        url: ''
    Parameter:
      oneOf:
        - $ref: '#/components/schemas/ParameterStringList'
        - $ref: '#/components/schemas/ParameterApiKey'
        - $ref: '#/components/schemas/ParameterNumericValue'
        - $ref: '#/components/schemas/ParameterSensitiveData'
        - $ref: '#/components/schemas/ParameterStringValue'
        - $ref: '#/components/schemas/ParameterBooleanValue'
    CloudFormationStack:
      title: CloudFormation stack
      type: object
      properties:
        arn:
          type: string
        region:
          type: string
      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/
    ARMStack:
      title: ARM stack
      type: object
      properties:
        resourceGroupName:
          type: string
        subscriptionId:
          type: string
      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/
    ExtensionBinary.BinaryType:
      enum:
        - KIBANA_INDEX_PATTERN
      type: string
    ExtensionItemBinary:
      title: Extension item binary
      type: object
      properties:
        data:
          type: string
        fileName:
          type: string
        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
    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
    Managed:
      title: Managed
      type: object
      properties:
        variant:
          $ref: '#/components/schemas/Variant'
      description: This data structure represents a managed integration.
      externalDocs:
        url: ''
    Untracked:
      title: Untracked
      type: object
      description: This data structure represents an untracked integration.
      externalDocs:
        url: ''
    Cloudformation:
      title: CloudFormation
      type: object
      description: This data structure represents a CloudFormation integration.
      externalDocs:
        url: ''
    AzureArm:
      title: Azure ARM
      type: object
      description: This data structure represents an Azure ARM integration.
      externalDocs:
        url: ''
    PushBasedContextualData:
      title: Push based contextual data
      type: object
      description: This data structure represents a push based contextual data integration.
      externalDocs:
        url: ''
    ContextualData:
      title: Contextual data
      type: object
      description: This data structure represents a contextual data integration.
      externalDocs:
        url: ''
    GenericWebhook:
      title: Generic webhook
      type: object
      description: This data structure represents a generic webhook integration.
      externalDocs:
        url: ''
    ConnectionStatus:
      enum:
        - PENDING
        - ACTIVE
        - FAILING
        - STATUS_UNKNOWN
      type: string
    ParameterStringList:
      title: Parameter
      type: object
      properties:
        key:
          type: string
        stringList:
          $ref: '#/components/schemas/StringList'
      additionalProperties: false
      externalDocs:
        url: ''
    ParameterApiKey:
      title: Parameter
      type: object
      properties:
        apiKey:
          $ref: '#/components/schemas/ApiKeyData'
        key:
          type: string
      additionalProperties: false
      externalDocs:
        url: ''
    ParameterNumericValue:
      title: Parameter
      type: object
      properties:
        key:
          type: string
        numericValue:
          type: number
          format: double
      additionalProperties: false
      externalDocs:
        url: ''
    ParameterSensitiveData:
      title: Parameter
      type: object
      properties:
        key:
          type: string
        sensitiveData:
          $ref: '#/components/schemas/SensitiveDataPlaceholder'
      additionalProperties: false
      externalDocs:
        url: ''
    ParameterStringValue:
      title: Parameter
      type: object
      properties:
        key:
          type: string
        stringValue:
          type: string
      additionalProperties: false
      externalDocs:
        url: ''
    ParameterBooleanValue:
      title: Parameter
      type: object
      properties:
        booleanValue:
          type: boolean
        key:
          type: string
      additionalProperties: false
      externalDocs:
        url: ''
    ExtensionItemBinary.BinaryType:
      enum:
        - PREVIEW_IMAGE
        - KIBANA_DASHBOARD_DEFINITION
        - GRAFANA_DASHBOARD_DEFINITION
        - ENRICHMENT_CSV
        - CX_CUSTOM_DASHBOARD_DEFINITION
      type: string
    Variant:
      enum:
        - DEFAULT
        - GCP
        - OAUTH
        - CUSTOM
      type: string
    StringList:
      title: String list
      type: object
      properties:
        values:
          type: array
          items:
            type: string
      externalDocs:
        url: ''
    ApiKeyData:
      title: API key data
      type: object
      properties:
        id:
          type: string
        value:
          type: string
      externalDocs:
        url: ''
    SensitiveDataPlaceholder:
      title: Sensitive data placeholder
      type: object
      externalDocs:
        url: ''
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: API key authentication

````