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

# Get a connection

> Returns one connection. Unlike the list, it has no `type`, `status`, or `metrics`.

**Required permission:** `connections:read`




## OpenAPI

````yaml /api-reference/openapi.yaml get /api/v1/connections/{slug}
openapi: 3.1.0
info:
  title: Igris Management API
  version: '1'
  description: >-
    REST API for managing Igris connections, policies, sessions, audit events
    and alerts.
servers:
  - url: https://api.igrisecurity.com
security:
  - bearerAuth: []
tags:
  - name: Connections
  - name: Policies
  - name: Sessions
  - name: Audit Events
  - name: Incidents
  - name: Webhooks
  - name: API Keys
  - name: Members
  - name: LLM Providers
  - name: LLM Cost
  - name: Observe
paths:
  /api/v1/connections/{slug}:
    get:
      tags:
        - Connections
      summary: Get a connection
      description: >
        Returns one connection. Unlike the list, it has no `type`, `status`, or
        `metrics`.


        **Required permission:** `connections:read`
      operationId: getConnection
      parameters:
        - $ref: '#/components/parameters/ConnectionSlug'
      responses:
        '200':
          description: The connection.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Connection'
              example:
                data:
                  id: 3f0c2a9e-0000-4000-8000-000000000001
                  slug: github-prod
                  name: GitHub Production
                  serverType: http
                  upstreamUrl: https://api.github.com/mcp
                  authType: bearer
                  customHeaders:
                    X-Team: ''
                  enabled: true
                  createdAt: '2026-01-01T00:00:00Z'
                  updatedAt: '2026-01-01T00:00:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    ConnectionSlug:
      name: slug
      in: path
      required: true
      description: The connection's slug.
      schema:
        type: string
        example: github-prod
  schemas:
    Connection:
      type: object
      description: >
        A connection. Credentials are never returned. Custom header values come
        back blank (names only).
      properties:
        id:
          type: string
          format: uuid
        organizationId:
          type: string
        slug:
          type: string
        name:
          type: string
        description:
          type:
            - string
            - 'null'
        serverType:
          type: string
          enum:
            - http
            - llm
        upstreamUrl:
          type:
            - string
            - 'null'
        authType:
          type: string
          enum:
            - none
            - bearer
            - header
            - api_key
        authHeaderName:
          type:
            - string
            - 'null'
        customHeaders:
          type:
            - object
            - 'null'
          description: Header names, with every value blanked to `""`.
          additionalProperties:
            type: string
        keyVersion:
          type: integer
        enabled:
          type: boolean
        llmProvider:
          type:
            - string
            - 'null'
        customBaseUrl:
          type:
            - string
            - 'null'
        allowedModels:
          type:
            - array
            - 'null'
          items:
            type: string
        logFullContent:
          type: boolean
        bodyRetentionDays:
          type: integer
        anomalyConfig:
          type:
            - object
            - 'null'
        authConfig:
          type:
            - object
            - 'null'
        timeoutSeconds:
          type: integer
        retries:
          type: integer
        rateLimitRpm:
          type:
            - integer
            - 'null'
        denyByDefault:
          type: boolean
        logSampling:
          type: string
          enum:
            - all
            - 10pct
            - 1pct
            - errors_only
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
    ForbiddenError:
      type: object
      properties:
        error:
          type: string
          example: Forbidden
        required:
          type: string
          description: The permission the caller lacks.
          example: policies:write
  responses:
    Unauthorized:
      description: No valid session or API key, or the key's creator is no longer a member.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Unauthorized
    Forbidden:
      description: The caller lacks the required permission.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ForbiddenError'
    NotFound:
      description: Not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Not found
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: ig_...
      description: >-
        An Igris API key. It acts with the current role and permission overrides
        of the member who created it.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.