Amazon API Gateway Connections API

openapi: 3.2.0
info:
  title: Amazon API Gateway Management Connections API
  description: The API Gateway Management API allows backend services to send messages to connected clients of a deployed WebSocket API and to disconnect clients. Requests are made against the deployed stage's callback URL.
  version: '2018-11-29'
  contact:
    name: AWS Support
    url: https://aws.amazon.com/premiumsupport/
  termsOfService: https://aws.amazon.com/service-terms/
servers:
- url: https://{api_id}.execute-api.{region}.amazonaws.com/{stage}
  description: WebSocket API callback endpoint
  variables:
    api_id:
      default: example
      description: WebSocket API identifier
    region:
      default: us-east-1
      description: AWS region
    stage:
      default: prod
      description: Deployment stage name
security:
- sigv4: []
tags:
- name: Connections
  description: Manage and message active WebSocket connections
paths:
  /@connections/{connectionId}:
    parameters:
    - $ref: '#/components/parameters/ConnectionId'
    get:
      operationId: getConnection
      summary: Amazon API Gateway Get Connection Info
      description: Retrieves information about the connection with the provided id.
      tags:
      - Connections
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection'
              examples:
                getConnection200Example:
                  summary: Default getConnection 200 response
                  x-microcks-default: true
                  value:
                    ConnectedAt: '2025-03-15T14:30:00Z'
                    LastActiveAt: '2025-03-15T14:30:00Z'
                    Identity:
                      SourceIp: example-value
                      UserAgent: example-value
        '404':
          $ref: '#/components/responses/NotFound'
        '410':
          $ref: '#/components/responses/Gone'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: postToConnection
      summary: Amazon API Gateway Send Message to Connection
      description: Sends a message to the connected WebSocket client identified by connectionId.
      tags:
      - Connections
      requestBody:
        required: true
        description: Raw message payload to send to the client.
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
              description: Message bytes delivered to the WebSocket client.
      responses:
        '200':
          description: Message accepted for delivery.
        '404':
          $ref: '#/components/responses/NotFound'
        '410':
          $ref: '#/components/responses/Gone'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteConnection
      summary: Amazon API Gateway Disconnect a Client
      description: Forcibly disconnects the WebSocket client identified by connectionId.
      tags:
      - Connections
      responses:
        '204':
          description: Disconnected.
        '404':
          $ref: '#/components/responses/NotFound'
        '410':
          $ref: '#/components/responses/Gone'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Error:
      type: object
      properties:
        Message:
          type: string
          description: Human-readable error message.
          example: example-value
    Identity:
      type: object
      properties:
        SourceIp:
          type: string
          description: Source IP address of the client.
          example: example-value
        UserAgent:
          type: string
          description: User agent string from the client.
          example: example-value
    Connection:
      type: object
      properties:
        ConnectedAt:
          type: string
          format: date-time
          description: Timestamp when the client connected.
          example: '2025-03-15T14:30:00Z'
        LastActiveAt:
          type: string
          format: date-time
          description: Timestamp of the most recent activity on the connection.
          example: '2025-03-15T14:30:00Z'
        Identity:
          $ref: '#/components/schemas/Identity'
  responses:
    NotFound:
      description: The specified connection does not exist.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Gone:
      description: The connection is no longer available.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    ConnectionId:
      name: connectionId
      in: path
      required: true
      description: Identifier of the WebSocket connection.
      schema:
        type: string
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4 signed request.
externalDocs:
  description: Amazon API Gateway Management API Reference
  url: https://docs.aws.amazon.com/apigatewaymanagementapi/latest/reference/Welcome.html