Amazon API Gateway Apis API

openapi: 3.1.0
info:
  title: Amazon API Gateway Management ApiKeys Apis 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: Apis
paths:
  /v2/apis:
    get:
      operationId: getApis
      summary: Amazon API Gateway List APIs
      description: Gets a collection of HTTP and WebSocket APIs.
      tags:
      - Apis
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Apis'
              examples:
                getApis200Example:
                  summary: Default getApis 200 response
                  x-microcks-default: true
                  value:
                    Items:
                    - example-value
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createApi
      summary: Amazon API Gateway Create an API
      description: Creates an HTTP or WebSocket API.
      tags:
      - Apis
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateApiRequest'
            examples:
              createApiRequestExample:
                summary: Default createApi request
                x-microcks-default: true
                value:
                  Name: my-resource
                  ProtocolType: HTTP
                  RouteSelectionExpression: example-value
                  Description: A description of this resource.
                  Target: example-value
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Api'
              examples:
                createApi201Example:
                  summary: Default createApi 201 response
                  x-microcks-default: true
                  value:
                    ApiId: abc123
                    Name: my-resource
                    ProtocolType: HTTP
                    ApiEndpoint: example-value
                    RouteSelectionExpression: example-value
                    CreatedDate: '2025-03-15T14:30:00Z'
        '400':
          $ref: '#/components/responses/BadRequest'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v2/apis/{api_id}:
    parameters:
    - $ref: '#/components/parameters/ApiId'
    get:
      operationId: getApi
      summary: Amazon API Gateway Get an API
      description: Retrieves a single HTTP or WebSocket API.
      tags:
      - Apis
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Api'
              examples:
                getApi200Example:
                  summary: Default getApi 200 response
                  x-microcks-default: true
                  value:
                    ApiId: abc123
                    Name: my-resource
                    ProtocolType: HTTP
                    ApiEndpoint: example-value
                    RouteSelectionExpression: example-value
                    CreatedDate: '2025-03-15T14:30:00Z'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteApi
      summary: Amazon API Gateway Delete an API
      description: Deletes the specified API.
      tags:
      - Apis
      responses:
        '204':
          description: No Content
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    CreateApiRequest:
      type: object
      required:
      - Name
      - ProtocolType
      properties:
        Name:
          type: string
          description: Name of the API.
          example: my-resource
        ProtocolType:
          type: string
          description: Protocol type for the API.
          enum:
          - HTTP
          - WEBSOCKET
          example: HTTP
        RouteSelectionExpression:
          type: string
          description: Route selection expression (required for WebSocket APIs).
          example: example-value
        Description:
          type: string
          description: Description of the API.
          example: A description of this resource.
        Target:
          type: string
          description: Quick-create target Lambda or HTTP endpoint URI.
          example: example-value
    Apis:
      type: object
      properties:
        Items:
          type: array
          items:
            $ref: '#/components/schemas/Api'
          example:
          - example-value
    Error:
      type: object
      properties:
        Message:
          type: string
          description: Human-readable error message.
          example: example-value
    Api:
      type: object
      properties:
        ApiId:
          type: string
          description: Identifier of the API.
          example: abc123
        Name:
          type: string
          description: Name of the API.
          example: my-resource
        ProtocolType:
          type: string
          description: API protocol (HTTP or WEBSOCKET).
          enum:
          - HTTP
          - WEBSOCKET
          example: HTTP
        ApiEndpoint:
          type: string
          description: Default endpoint for the API.
          example: example-value
        RouteSelectionExpression:
          type: string
          description: Route selection expression for the API.
          example: example-value
        CreatedDate:
          type: string
          format: date-time
          description: Timestamp when the API was created.
          example: '2025-03-15T14:30:00Z'
  responses:
    Unauthorized:
      description: The request was not authenticated.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: The request was malformed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    ApiId:
      name: api_id
      in: path
      required: true
      description: API identifier.
      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