Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Temporal Cluster API

Cluster and system information.

Temporal Cluster API is one of 8 APIs that Temporal publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Cluster. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 2 base URLs: https://{namespace}.{account}.tmprl.cloud/api/v1, http://localhost:7243/api/v1.

2 operations 2 paths 1 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://docs.temporal.io/references/api-reference
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Temporal Cluster API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer API key. On Temporal Cloud, pass an API key as Authorization: Bearer . Self-hosted deployments may use mTLS instead. Requests are scoped to the namespac…

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Cluster 2

Cluster and system information.

GET
/cluster-info
Get cluster info
getClusterInfo → 200401
GET
/system-info
Get system info
getSystemInfo → 200401

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Status (3 properties). Each schema is shown below with its type and property counts.

Status
object
A google.rpc.Status-style error payload.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

temporal-io-cluster-api-openapi.yml Raw ↑

Other APIs Temporal publishes across the network.

Temporal Operator Service API
Temporal Cloud Operations API
Temporal Nexus API
Temporal Namespaces API
Temporal Workflow Lifecycle API
Temporal Workflow Messaging API
Temporal Workflows API