Temporal Cluster API

openapi: 3.0.3
info:
  title: Temporal HTTP Cluster API
  description: The Temporal HTTP API is a first-party grpc-gateway that maps a REST/JSON subset of the Temporal WorkflowService (gRPC) onto HTTP paths under `/api/v1`. Temporal's primary and complete API surface is gRPC (WorkflowService and OperatorService, defined as protobuf in github.com/temporalio/api); this HTTP API exists for automation, CI/CD, and environments where gRPC is impractical, and it exposes only a subset of the gRPC methods. The worker task-polling and task-completion RPCs (PollWorkflowTaskQueue, PollActivityTaskQueue, RespondWorkflowTaskCompleted, PollNexusTaskQueue, and similar) are NOT exposed over HTTP and remain gRPC-only. On Temporal Cloud the HTTP API is served per namespace over HTTPS; self-hosted it is served by the frontend service when the HTTP port is enabled. Requests authenticate with a Bearer API key (or mTLS on self-hosted). The paths and verbs below are drawn from the google.api.http annotations on the WorkflowService proto and are modeled here, not exhaustively confirmed against a live namespace.
  version: '1.0'
  contact:
    name: Temporal Technologies
    url: https://temporal.io
  license:
    name: MIT
    url: https://github.com/temporalio/api/blob/master/LICENSE
servers:
- url: https://{namespace}.{account}.tmprl.cloud/api/v1
  description: Temporal Cloud (per-namespace HTTP API endpoint)
  variables:
    namespace:
      default: your-namespace
      description: Your Temporal Cloud namespace name.
    account:
      default: your-account
      description: Your Temporal Cloud account (short) ID.
- url: http://localhost:7243/api/v1
  description: Self-hosted frontend HTTP API (when the HTTP port is enabled)
security:
- bearerAuth: []
tags:
- name: Cluster
  description: Cluster and system information.
paths:
  /cluster-info:
    get:
      operationId: getClusterInfo
      tags:
      - Cluster
      summary: Get cluster info
      description: Returns information about the Temporal cluster (versions, capabilities). Maps to the gRPC GetClusterInfo RPC.
      responses:
        '200':
          description: Cluster information.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorized'
  /system-info:
    get:
      operationId: getSystemInfo
      tags:
      - Cluster
      summary: Get system info
      description: Returns server capabilities and system information. Maps to the gRPC GetSystemInfo RPC.
      responses:
        '200':
          description: System information and capabilities.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Status:
      type: object
      description: A google.rpc.Status-style error payload.
      properties:
        code:
          type: integer
        message:
          type: string
        details:
          type: array
          items:
            type: object
            additionalProperties: true
  responses:
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Status'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Bearer API key. On Temporal Cloud, pass an API key as `Authorization: Bearer <api-key>`. Self-hosted deployments may use mTLS instead. Requests are scoped to the namespace in the path.'