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

# Get protocol document

> Returns the full protocol specification document.



## OpenAPI

````yaml /products/link/openapi.yaml get /api/admin/protocols/{id}
openapi: 3.0.0
info:
  description: >-
    Admin API for managing Link protocols and backends (Bundled and Standalone
    editions).
  title: Link API
  version: '1.0'
servers:
  - url: https://{instance}.{env}.on-hellgate.cloud
    description: Managed instance of Link
    variables:
      instance:
        default: my-instance
        description: Your unique instance slug, provided during onboarding.
      env:
        default: eu1
        description: Deployment environment (currently eu1).
security: []
tags: []
paths:
  /api/admin/protocols/{id}:
    get:
      tags:
        - Protocols
      summary: Get protocol document
      description: Returns the full protocol specification document.
      operationId: protocols_get
      parameters:
        - description: Protocol local ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProtocolDocument'
          description: Protocol document
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forbidden'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
          description: Not found
      callbacks: {}
      security:
        - bearerAuth: []
components:
  schemas:
    ProtocolDocument:
      description: Full protocol specification document.
      properties:
        $id:
          example: https://developer.hellgate.io/protocols/specter/v1
          type: string
        $schema:
          example: https://developer.hellgate.io/schemas/link-protocol/v1
          type: string
        actions:
          additionalProperties: true
          description: >-
            The operations the protocol defines, keyed by action name. Each
            action declares its method, request schema (optionally discriminated
            into variants), and per-status response schemas.
          example:
            assess:
              method: POST
              description: Score a transaction for fraud risk.
              request:
                discriminator: $.credential.type
                variants:
                  pan:
                    type: object
                    properties:
                      credential:
                        $ref: '#/components/schemas/PanCredential'
                    required:
                      - credential
                required_variants:
                  - pan
              responses:
                '200':
                  content:
                    application/json:
                      schema:
                        type: object
                        properties:
                          value:
                            type: string
                            enum:
                              - ALLOW
                              - REVIEW
                              - BLOCK
          type: object
        components:
          additionalProperties: true
          description: Reusable schema definitions referenced by actions via `$ref`.
          example:
            schemas:
              PanCredential:
                type: object
                properties:
                  value:
                    type: string
                  scheme:
                    type: string
                required:
                  - value
          type: object
        name:
          example: Specter v1
          type: string
        version:
          example: 1.0.0
          type: string
      title: ProtocolDocument
      type: object
    Unauthorized:
      description: No valid authentication was provided.
      example:
        classifier: UNAUTHORIZED
        code: 401
        message: No valid means of authentication was provided
      properties:
        classifier:
          enum:
            - UNAUTHORIZED
          type: string
        code:
          enum:
            - 401
          type: integer
        message:
          type: string
      required:
        - classifier
        - code
        - message
      title: Unauthorized
      type: object
    Forbidden:
      description: The token lacks the scope required for this operation.
      example:
        classifier: FORBIDDEN
        code: 403
        message: Not allowed to access this resource or feature
      properties:
        classifier:
          enum:
            - FORBIDDEN
          type: string
        code:
          enum:
            - 403
          type: integer
        message:
          type: string
      required:
        - classifier
        - code
        - message
      title: Forbidden
      type: object
    NotFound:
      description: The requested resource does not exist.
      example:
        classifier: NOT_FOUND
        code: 404
        message: The requested resource does not exist
      properties:
        classifier:
          enum:
            - NOT_FOUND
          type: string
        code:
          enum:
            - 404
          type: integer
        message:
          type: string
      required:
        - classifier
        - code
        - message
      title: NotFound
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http

````