Cloudflare Gateways API

openapi: 3.0.3
info:
  title: Cloudflare / Accounts Gateways API
  description: Needs description.
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  version: 4.0.0
servers:
- url: https://api.cloudflare.com/client/v4
  description: Client API
security:
- api_email: []
  api_key: []
- api_token: []
- user_service_key: []
tags:
- name: Gateways
  description: Create, list, update, and delete AI Gateway instances.
paths:
  /accounts/{account_id}/ai-gateway/gateways:
    get:
      operationId: listAiGateways
      summary: Cloudflare List Ai Gateways
      description: Returns all AI Gateway instances for the account.
      tags:
      - Gateways
      parameters:
      - $ref: '#/components/parameters/AccountId'
      responses:
        '200':
          description: List of AI Gateway instances.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayListResponse'
              examples:
                Listaigateways200Example:
                  summary: Default listAiGateways 200 response
                  x-microcks-default: true
                  value:
                    result:
                    - id: abc123
                      name: Example Title
                      slug: example_value
                      cache_enabled: true
                      cache_ttl: 10
                      rate_limiting_enabled: true
                      rate_limiting_limit: 10
                      rate_limiting_interval: 10
                      log_enabled: true
                      created_at: '2026-01-15T10:30:00Z'
                      modified_at: '2026-01-15T10:30:00Z'
                    success: true
        '401':
          description: Unauthorized.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createAiGateway
      summary: Cloudflare Create Ai Gateway
      description: Create a new AI Gateway instance with the specified configuration for caching, rate limiting, and provider settings.
      tags:
      - Gateways
      parameters:
      - $ref: '#/components/parameters/AccountId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GatewayInput'
            examples:
              CreateaigatewayRequestExample:
                summary: Default createAiGateway request
                x-microcks-default: true
                value:
                  name: Example Title
                  cache_enabled: true
                  cache_ttl: 10
                  rate_limiting_enabled: true
                  rate_limiting_limit: 10
                  rate_limiting_interval: 10
                  log_enabled: true
      responses:
        '200':
          description: Gateway created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayResponse'
              examples:
                Createaigateway200Example:
                  summary: Default createAiGateway 200 response
                  x-microcks-default: true
                  value:
                    result:
                      id: abc123
                      name: Example Title
                      slug: example_value
                      cache_enabled: true
                      cache_ttl: 10
                      rate_limiting_enabled: true
                      rate_limiting_limit: 10
                      rate_limiting_interval: 10
                      log_enabled: true
                      created_at: '2026-01-15T10:30:00Z'
                      modified_at: '2026-01-15T10:30:00Z'
                    success: true
                    errors:
                    - {}
                    messages:
                    - {}
        '400':
          description: Bad request.
        '401':
          description: Unauthorized.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /accounts/{account_id}/ai-gateway/gateways/{gateway_id}:
    get:
      operationId: getAiGateway
      summary: Cloudflare Get Ai Gateway
      description: Retrieve details of a specific AI Gateway instance.
      tags:
      - Gateways
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/GatewayId'
      responses:
        '200':
          description: Gateway details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayResponse'
              examples:
                Getaigateway200Example:
                  summary: Default getAiGateway 200 response
                  x-microcks-default: true
                  value:
                    result:
                      id: abc123
                      name: Example Title
                      slug: example_value
                      cache_enabled: true
                      cache_ttl: 10
                      rate_limiting_enabled: true
                      rate_limiting_limit: 10
                      rate_limiting_interval: 10
                      log_enabled: true
                      created_at: '2026-01-15T10:30:00Z'
                      modified_at: '2026-01-15T10:30:00Z'
                    success: true
                    errors:
                    - {}
                    messages:
                    - {}
        '401':
          description: Unauthorized.
        '404':
          description: Gateway not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateAiGateway
      summary: Cloudflare Update Ai Gateway
      description: Update the configuration of an AI Gateway instance.
      tags:
      - Gateways
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/GatewayId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GatewayInput'
            examples:
              UpdateaigatewayRequestExample:
                summary: Default updateAiGateway request
                x-microcks-default: true
                value:
                  name: Example Title
                  cache_enabled: true
                  cache_ttl: 10
                  rate_limiting_enabled: true
                  rate_limiting_limit: 10
                  rate_limiting_interval: 10
                  log_enabled: true
      responses:
        '200':
          description: Gateway updated successfully.
        '401':
          description: Unauthorized.
        '404':
          description: Gateway not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteAiGateway
      summary: Cloudflare Delete Ai Gateway
      description: Delete an AI Gateway instance.
      tags:
      - Gateways
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/GatewayId'
      responses:
        '200':
          description: Gateway deleted successfully.
        '401':
          description: Unauthorized.
        '404':
          description: Gateway not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  parameters:
    AccountId:
      name: account_id
      in: path
      required: true
      description: The unique identifier of the Cloudflare account.
      schema:
        type: string
    GatewayId:
      name: gateway_id
      in: path
      required: true
      description: The unique identifier of the AI Gateway.
      schema:
        type: string
  schemas:
    GatewayResponse:
      type: object
      properties:
        result:
          $ref: '#/components/schemas/Gateway'
        success:
          type: boolean
          example: true
        errors:
          type: array
          items:
            type: object
          example: []
        messages:
          type: array
          items:
            type: object
          example: []
    GatewayListResponse:
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/Gateway'
          example: []
        success:
          type: boolean
          example: true
    GatewayInput:
      type: object
      required:
      - name
      properties:
        name:
          type: string
          description: The name of the gateway.
          example: Example Title
        cache_enabled:
          type: boolean
          description: Enable response caching.
          example: true
        cache_ttl:
          type: integer
          description: Cache TTL in seconds.
          example: 10
        rate_limiting_enabled:
          type: boolean
          description: Enable rate limiting.
          example: true
        rate_limiting_limit:
          type: integer
          description: Rate limit threshold.
          example: 10
        rate_limiting_interval:
          type: integer
          description: Rate limiting interval in seconds.
          example: 10
        log_enabled:
          type: boolean
          description: Enable request logging.
          example: true
    Gateway:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the gateway.
          example: abc123
        name:
          type: string
          description: The name of the gateway.
          example: Example Title
        slug:
          type: string
          description: URL-friendly slug for the gateway.
          example: example_value
        cache_enabled:
          type: boolean
          description: Whether response caching is enabled.
          example: true
        cache_ttl:
          type: integer
          description: Cache time-to-live in seconds.
          example: 10
        rate_limiting_enabled:
          type: boolean
          description: Whether rate limiting is enabled.
          example: true
        rate_limiting_limit:
          type: integer
          description: Maximum requests per rate limiting interval.
          example: 10
        rate_limiting_interval:
          type: integer
          description: Rate limiting interval in seconds.
          example: 10
        log_enabled:
          type: boolean
          description: Whether logging is enabled.
          example: true
        created_at:
          type: string
          format: date-time
          description: When the gateway was created.
          example: '2026-01-15T10:30:00Z'
        modified_at:
          type: string
          format: date-time
          description: When the gateway was last modified.
          example: '2026-01-15T10:30:00Z'