jlacefie/api-cloud

Temporal cloud gRPC API and proto files

Temporal Cloud Operations API (Public Preview)

aka the Cloud Ops API
These apis (proto files) are currently offered as a Public Preview. While they are production worthy, they could change. Please reach out to Temporal Support if you have questions.

How to use

To use the Cloud Ops API in your project, preform the following 4 steps:

1. Copy over the protobuf files under temporal directory to your desired project directory
2. Use gRPC to compile and generate code in your desired programming language, typically handled as a part of your code build process
3. Create a client connection in your code using a Temporal Cloud API Key (see Samples below)
4. Use the Cloud Operations API services to automate Cloud Operations, such as creating users or namespaces

API Version

The client is expected to pass in a temporal-cloud-api-version header with the api version identifier with every request it makes to the apis. The backend will use the version to safely mutate resources.

Current Version:

https://github.com/temporalio/api-cloud/blob/main/VERSION#L1C1-L1C14

URL

The grpc URL the clients should connect to:

saas-api.tmprl.cloud:443

Samples

Refer cloud-samples-go sample repository demonstrating how to use the cloud ops api in a Go client.

This sample demonstrates how to automate Temporal Cloud operations using Temporal Workflows that make Cloud Ops API requests within Workflow Activities (Worker Sample README).
See here for a quick reference showing you how to connect to Temporal Cloud with an API Key for the Cloud Ops API in Go.

Refer temporal-cloud-api-client-typescript sample repository demonstrating how to use the cloud ops api in a Typescript client.
Refer temporal-cloud-api-client-java sample repository demonstrating how to use the cloud ops api in a Java client.
Refer temporal-cloud-api-client-kotlin sample repository demonstrating how to use the cloud ops api in a Kotlin client.

The Java, Typescript, and Kotlin sample apps all provide a simple HTML UI that demonstrates how to use the Cloud Ops API to CRUD Namespaces and Users.