Skip to main content

Temporal Platform references

View Markdown

API reference

API documentation for the Temporal SDKs, Temporal Server, Temporal CLI, and Temporal Cloud.

Temporal Service metrics

Metrics a self-hosted Temporal Service emits, covering request rates, latencies, errors, and Nexus Operations.

Commands

Every Command a Worker can issue after completing a Workflow Task, and its corresponding Event.

Temporal Service configuration

The development.yaml settings for global options, persistence, service roles, and archival.

Dynamic configuration

Keys that tune rate limits, size limits, and retry defaults without restarting the Temporal Service.

Errors

Every Workflow Task error, with its cause and resolution steps.

Events

Every Event that can appear in a Workflow Execution's Event History.

Environment configuration

Environment variables and TOML keys that configure a Temporal Client or the Temporal CLI.

Failures

Failure types for Workflows, Activities, and Nexus Operations, and their SDK classes or exceptions.

Temporal Cloud operations

Operations Temporal Cloud rate-limits per Namespace, with each operation's priority and throttling effect.

SDK metrics

Metrics emitted by Temporal Clients and Workers, with each metric's type and SDK availability.

Server options

ServerOptions for embedding the Temporal Server in a Go application, including auth, TLS, and metrics.

Temporal Web UI configuration

The development.yaml settings for the Web UI Server, including auth, TLS, and Cloud UI options.

Web UI environment variables

Environment variables that configure the Temporal Web UI in Docker, such as TEMPORAL_ADDRESS and TLS.

Glossary

Definitions of terms used across the Temporal Platform.