> ## Documentation Index
> Fetch the complete documentation index at: https://docs.chronosphere.io/llms.txt
> Use this file to discover all available pages before exploring further.

# ReadExternalConnections



## OpenAPI

````yaml openapi/api_v1_config_openapi3_DOCUMENTATION_ONLY.json GET /api/v1/config/external-connections/{slug}
openapi: 3.0.3
info:
  description: >

    The Config API provides standard HTTP/JSON REST endpoints for creating,
    reading,

    updating, deleting, and listing configurable Chronosphere resources.


    Use this link to download the raw Swagger specification:

    <a href="/api/v1/config/swagger.json">/api/v1/config/swagger.json</a>
  title: Config V1 API
  version: v1
servers:
  - url: https://{tenant}.chronosphere.io
    variables:
      tenant:
        default: tenant
        description: tenant ID assigned by the service provider
security:
  - ApiKeyAuth: []
tags:
  - name: ConfigV1
paths:
  /api/v1/config/external-connections/{slug}:
    get:
      tags:
        - ExternalConnection
      operationId: ReadExternalConnection
      parameters:
        - in: path
          name: slug
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configv1ReadExternalConnectionResponse'
          description: A successful response.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot read the ExternalConnection because the slug does not exist.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: An unexpected error response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/genericError'
          description: An undefined error response.
components:
  schemas:
    configv1ReadExternalConnectionResponse:
      properties:
        external_connection:
          $ref: '#/components/schemas/configv1ExternalConnection'
      type: object
    apiError:
      properties:
        message:
          description: An error message describing what went wrong.
          type: string
      type: object
    genericError:
      additionalProperties: true
      type: object
    configv1ExternalConnection:
      properties:
        cloudflare:
          $ref: '#/components/schemas/ExternalConnectionCloudflareConfig'
        created_at:
          description: >-
            Timestamp of when the ExternalConnection was created. Cannot be set
            by clients.
          format: date-time
          readOnly: true
          type: string
        mongodb_atlas:
          $ref: '#/components/schemas/ExternalConnectionMongoDbAtlasConfig'
        name:
          description: >-
            The name of the ExternalConnection. You can modify this value after
            the ExternalConnection is created.
          type: string
        ops_genie:
          $ref: '#/components/schemas/configv1ExternalConnectionOpsGenieConfig'
        pagerduty:
          $ref: '#/components/schemas/configv1ExternalConnectionPagerdutyConfig'
        sendgrid:
          $ref: '#/components/schemas/ExternalConnectionSendgridConfig'
        slack:
          $ref: '#/components/schemas/configv1ExternalConnectionSlackConfig'
        slug:
          description: >-
            The unique identifier of the ExternalConnection. If a `slug` isn't
            provided, one is generated based on the `name` field. You can't
            modify this field after the ExternalConnection is created.
          type: string
        updated_at:
          description: >-
            Timestamp of when the ExternalConnection was last updated. Cannot be
            set by clients.
          format: date-time
          readOnly: true
          type: string
        victor_ops:
          $ref: '#/components/schemas/configv1ExternalConnectionVictorOpsConfig'
        webhook:
          $ref: '#/components/schemas/configv1ExternalConnectionWebhookConfig'
      required:
        - name
      type: object
    ExternalConnectionCloudflareConfig:
      properties:
        api_token:
          description: |-
            Cloudflare API Token. Accepts User API Tokens (cfut_ prefix) and
            Account API Tokens (cfat_ prefix).
          type: string
      type: object
    ExternalConnectionMongoDbAtlasConfig:
      properties:
        client_id:
          description: Service Account client ID.
          type: string
        client_secret:
          description: Service Account client secret.
          type: string
      type: object
    configv1ExternalConnectionOpsGenieConfig:
      properties:
        api_key:
          type: string
        api_url:
          type: string
        http_config:
          $ref: '#/components/schemas/configv1ExternalConnectionHTTPConfig'
      type: object
    configv1ExternalConnectionPagerdutyConfig:
      properties:
        events:
          allOf:
            - $ref: '#/components/schemas/PagerdutyConfigPagerdutyEventsConfig'
          description: PagerDuty Events API configuration for outbound alert delivery.
        rest:
          allOf:
            - $ref: '#/components/schemas/PagerdutyConfigPagerdutyRESTConfig'
          description: PagerDuty REST API configuration for inbound incident/note polling.
      type: object
    ExternalConnectionSendgridConfig:
      properties:
        api_key:
          description: SendGrid API key (Bearer token).
          type: string
      type: object
    configv1ExternalConnectionSlackConfig:
      properties:
        api_url:
          type: string
        token:
          type: string
      type: object
    configv1ExternalConnectionVictorOpsConfig:
      properties:
        api_key:
          type: string
        api_url:
          type: string
      type: object
    configv1ExternalConnectionWebhookConfig:
      properties:
        http_config:
          $ref: '#/components/schemas/configv1ExternalConnectionHTTPConfig'
        url:
          type: string
      type: object
    configv1ExternalConnectionHTTPConfig:
      properties:
        basic_auth:
          $ref: '#/components/schemas/configv1ExternalConnectionHTTPConfigBasicAuth'
        bearer_token:
          type: string
        tls_config:
          $ref: '#/components/schemas/configv1ExternalConnectionHTTPConfigTLSConfig'
      type: object
    PagerdutyConfigPagerdutyEventsConfig:
      properties:
        api_key:
          description: >-
            The PagerDuty integration key used to authenticate with the Events
            API.

            PagerDuty calls this the "routing key" in Events v2 and the

            "service key" in Events v1.
          type: string
        version:
          allOf:
            - $ref: '#/components/schemas/configv1PagerdutyEventsVersion'
          description: |-
            The PagerDuty Events API version to use. Defaults to V2 if unset.
            V2 is recommended for new integrations.
      type: object
    PagerdutyConfigPagerdutyRESTConfig:
      properties:
        api_key:
          description: The PagerDuty REST API token used to authenticate note polling.
          type: string
      type: object
    configv1ExternalConnectionHTTPConfigBasicAuth:
      properties:
        password:
          type: string
        username:
          type: string
      type: object
    configv1ExternalConnectionHTTPConfigTLSConfig:
      properties:
        insecure_skip_verify:
          type: boolean
      type: object
    configv1PagerdutyEventsVersion:
      description: |-
        PagerdutyEventsVersion selects the PagerDuty Events API version.
        The version determines which PagerDuty Events API payload format is used
        when delivering alerts through this external connection.

         - PAGERDUTY_EVENTS_VERSION_V1: V1 is the legacy PagerDuty Events API version.
         - PAGERDUTY_EVENTS_VERSION_V2: V2 is the default and recommended version.
      enum:
        - PAGERDUTY_EVENTS_VERSION_V1
        - PAGERDUTY_EVENTS_VERSION_V2
      type: string
  securitySchemes:
    ApiKeyAuth:
      description: Chronosphere API token
      in: header
      name: API-Token
      type: apiKey

````