Skip to main content

Temporal CLI cloud namespace command reference

This page provides a reference for the temporal cloud namespace commands. The flags applicable to each subcommand are presented in a table within the heading for the subcommand. Refer to Global Flags for flags that you can use with every subcommand.

apply

Apply a namespace configuration to Temporal Cloud. Creates a new namespace if it doesn't exist, or updates an existing one to match the specification.

The specification can be provided as inline JSON or loaded from a file by prefixing the path with '@'.

Example with inline JSON:

cloud namespace apply --spec '{"name": "namespace-name", "region": "us-west-2", "retention_days": 7}'

Example with file path:

cloud namespace apply --spec @namespace-spec.json

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--asyncNobool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-idNostring Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--idempotentNobool Succeed silently if the namespace already matches the specification. Without this flag, the command errors when no changes are needed.
--resource-version, -vNostring Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically.
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.
--specYesstring Namespace configuration in JSON format. Provide inline JSON directly, or use '@path/to/file.json' to load from a file.
--verbose-diffNobool Show detailed differences between the current and desired namespace configurations when changes are detected.

cert-ca

Commands for managing the client CA certificates of Temporal Cloud namespaces.

cert-ca create

Add client CA certificates to a Temporal Cloud namespace from a PEM file or base64 encoded string. These certificates are used to verify client connections and enable mTLS authentication.

Specify either --ca-certificate-file or --ca-certificate, but not both.

Example with file:

cloud namespace cert-ca create --namespace my-namespace.my-account --ca-certificate-file ca-cert.pem

Example with base64 encoded data:

cloud namespace cert-ca create --namespace my-namespace.my-account --ca-certificate <base64-encoded-cert>

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--asyncNobool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-idNostring Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--ca-certificateNostring Base64-encoded CA certificate for mTLS authentication. Mutually exclusive with --ca-certificate-file.
--ca-certificate-fileNostring Path to a CA certificate PEM file for mTLS authentication. Mutually exclusive with --ca-certificate.
--idempotentNobool Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--poll-intervalNoduration Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). Default is 1s.
--resource-version, -vNostring Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically.
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.

cert-ca delete

Delete client CA certificates from a Temporal Cloud namespace. This operation requires confirmation and will remove the specified certificates from the namespace configuration.

Specify either --ca-certificate-file or --ca-certificate, but not both.

Example with file:

cloud namespace cert-ca delete --namespace my-namespace.my-account --ca-certificate-file ca-cert.pem

Example with base64 encoded data:

cloud namespace cert-ca delete --namespace my-namespace.my-account --ca-certificate <base64-encoded-cert>

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--asyncNobool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-idNostring Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--ca-certificateNostring Base64-encoded CA certificate for mTLS authentication. Mutually exclusive with --ca-certificate-file.
--ca-certificate-fileNostring Path to a CA certificate PEM file for mTLS authentication. Mutually exclusive with --ca-certificate.
--idempotentNobool Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--poll-intervalNoduration Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). Default is 1s.
--resource-version, -vNostring Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically.
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.

cert-ca list

Retrieve the list of client CA certificates configured for a Temporal Cloud namespace. These certificates are used for client authentication.

Example:

cloud namespace cert-ca list --namespace my-namespace.my-account

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.

cert-filter

Commands for managing certificate filters for Temporal Cloud namespaces. Certificate filters restrict mTLS connections to client certificates with specific distinguished name properties.

cert-filter create

Add new certificate filters to a Temporal Cloud namespace. Certificate filters restrict mTLS connections to client certificates whose distinguished name properties match at least one of the filters.

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--asyncNobool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-idNostring Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--common-nameNostring The common name (CN) field from the certificate's distinguished name.
--idempotentNobool Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--organizationNostring The organization (O) field from the certificate's distinguished name.
--organizational-unitNostring The organizational unit (OU) field from the certificate's distinguished name.
--poll-intervalNoduration Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). Default is 1s.
--resource-version, -vNostring Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically.
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.
--subject-alternative-nameNostring The subject alternative name (SAN) from the certificate.

cert-filter delete

Delete certificate filters from a Temporal Cloud namespace. Filters are matched by exact field equality.

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--asyncNobool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-idNostring Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--common-nameNostring The common name (CN) field from the certificate's distinguished name.
--idempotentNobool Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--organizationNostring The organization (O) field from the certificate's distinguished name.
--organizational-unitNostring The organizational unit (OU) field from the certificate's distinguished name.
--poll-intervalNoduration Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). Default is 1s.
--resource-version, -vNostring Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically.
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.
--subject-alternative-nameNostring The subject alternative name (SAN) from the certificate.

cert-filter list

List all certificate filters configured for a Temporal Cloud namespace.

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.

codec

Commands for managing the codec server configuration of Temporal Cloud namespaces.

The codec server is used to encode and decode payloads for workflows and activities.

codec delete

Delete the codec server configuration from a Temporal Cloud namespace.

Example:

cloud namespace codec delete --namespace my-namespace.my-account

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--asyncNobool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-idNostring Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--idempotentNobool Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--poll-intervalNoduration Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). Default is 1s.
--resource-version, -vNostring Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically.
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.

codec get

Retrieve the current codec server configuration for a Temporal Cloud namespace.

Example:

cloud namespace codec get --namespace my-namespace.my-account

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.

codec set

Set the codec server configuration for a Temporal Cloud namespace.

Example:

cloud namespace codec set --namespace my-namespace.my-account --endpoint https://my-codec.example.com

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--asyncNobool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-idNostring Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--custom-error-message-default-linkNostring A link to display alongside the custom error message for remote codec server errors.
--custom-error-message-default-messageNostring A custom message to display for remote codec server errors.
--endpointYesstring The codec server endpoint URL.
--idempotentNobool Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed.
--include-cross-origin-credentialsNobool Whether to include cross-origin credentials in requests to the codec server.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--pass-access-tokenNobool Whether to pass the user access token to the codec server endpoint.
--poll-intervalNoduration Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). Default is 1s.
--resource-version, -vNostring Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically.
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.

create

Create a new Temporal Cloud namespace with the specified configuration.

Options are passed as individual flags. To create or update a namespace using a full JSON specification, use 'namespace apply' instead.

Example:

cloud namespace create --name my-namespace --region aws-us-east-1 --retention-days 30

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--api-key-auth-enabledNobool Enable API key authentication for the namespace.
--asyncNobool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-idNostring Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--ca-certificateNostring Base64-encoded CA certificate for mTLS authentication. Mutually exclusive with --ca-certificate-file.
--ca-certificate-fileNostring Path to a CA certificate PEM file for mTLS authentication. Mutually exclusive with --ca-certificate.
--certificate-filterNostring[] Certificate filter as a JSON object (e.g. '{"commonName":"foo"}'). Repeat to add multiple.
--certificate-filter-fileNostring Path to a JSON file containing a certificate filter object.
--codec-endpointNostring HTTPS codec server endpoint URL.
--codec-include-cross-origin-credentialsNobool Include cross-origin credentials in codec server requests.
--codec-pass-access-tokenNobool Pass the user access token to the codec server endpoint.
--connection-rule-idNostring[] Private connectivity rule ID. Repeat to specify multiple.
--enable-delete-protectionNobool Prevent accidental deletion of this namespace.
--idempotentNobool Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed.
--name, -nYesstring The name for the new namespace (becomes part of the namespace ID).
--poll-intervalNoduration Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). Default is 1s.
--regionYesstring[] Cloud region where the namespace will be hosted. Repeat to specify multiple regions for High Availability (e.g. --region aws-us-east-1 --region aws-us-west-2).
--retention-daysNoint Number of days to retain closed workflow history. If not specified, the server default applies.
--search-attributeNostring[] Custom search attribute as 'name=Type' (e.g. --search-attribute myAttr=Keyword). Valid types: Text, Keyword, Int, Double, Bool, Datetime, KeywordList. Repeat to add multiple.
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.

delete

Delete a Temporal Cloud namespace and all associated data. This action is irreversible and will permanently remove all workflows, activities, and history within the namespace.

Example:

cloud namespace delete --namespace my-namespace.my-account

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--asyncNobool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-idNostring Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--idempotentNobool Succeed silently if the namespace does not exist. Without this flag, the command errors if the namespace is not found.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--resource-version, -vNostring Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically.
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.

edit

Open a namespace configuration in your default editor for interactive modification. After saving and closing the editor, the changes are applied to Temporal Cloud.

The editor is determined by the EDITOR environment variable, falling back to 'vi' if not set.

Example:

cloud namespace edit --namespace my-namespace.my-account

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--asyncNobool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-idNostring Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--idempotentNobool Succeed silently if no changes were made in the editor. Without this flag, the command errors when the configuration is unchanged.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--resource-version, -vNostring Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically.
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.
--verbose-diffNobool Show detailed differences between the current and desired namespace configurations when changes are detected.

export

Commands for managing workflow history export sinks for Temporal Cloud namespaces.

Export sinks define destinations (S3 or GCS) to which workflow history is exported.

export delete

Delete a workflow history export sink from a Temporal Cloud namespace.

Example:

cloud namespace export delete --namespace my-namespace.my-account --sink-name my-sink

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--asyncNobool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-idNostring Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--idempotentNobool Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--poll-intervalNoduration Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). Default is 1s.
--resource-version, -vNostring Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically.
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.
--sink-nameYesstring The name of the export sink.

export disable

Disable a workflow history export sink for a Temporal Cloud namespace. The sink configuration is preserved and can be re-enabled later.

Example:

cloud namespace export disable --namespace my-namespace.my-account --sink-name my-sink

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--asyncNobool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-idNostring Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--idempotentNobool Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--poll-intervalNoduration Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). Default is 1s.
--resource-version, -vNostring Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically.
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.
--sink-nameYesstring The name of the export sink.

export enable

Enable a previously disabled workflow history export sink for a Temporal Cloud namespace.

Example:

cloud namespace export enable --namespace my-namespace.my-account --sink-name my-sink

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--asyncNobool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-idNostring Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--idempotentNobool Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--poll-intervalNoduration Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). Default is 1s.
--resource-version, -vNostring Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically.
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.
--sink-nameYesstring The name of the export sink.

export gcs

Commands for managing GCS workflow history export sinks for Temporal Cloud namespaces.

export gcs create

Create a new GCS workflow history export sink for a Temporal Cloud namespace. The sink is created in the enabled state.

Example:

cloud namespace export gcs create --namespace my-namespace.my-account --sink-name my-sink \
--sa-id my-service-account@my-project.iam.gserviceaccount.com \
--bucket-name my-bucket --gcp-project-id my-project --region us-central1

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--asyncNobool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-idNostring Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--bucket-nameYesstring The name of the destination GCS bucket.
--gcp-project-idYesstring The GCP project ID associated with the bucket and service account.
--idempotentNobool Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--poll-intervalNoduration Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). Default is 1s.
--regionYesstring The GCS bucket region.
--sa-idYesstring The customer service account ID that Temporal Cloud impersonates for writing to GCS.
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.
--sink-nameYesstring The name of the export sink.

export gcs update

Update the configuration of an existing GCS workflow history export sink. The enabled/disabled state is preserved.

Example:

cloud namespace export gcs update --namespace my-namespace.my-account --sink-name my-sink \
--sa-id my-service-account@my-project.iam.gserviceaccount.com \
--bucket-name my-bucket --gcp-project-id my-project --region us-central1

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--asyncNobool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-idNostring Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--bucket-nameYesstring The name of the destination GCS bucket.
--gcp-project-idYesstring The GCP project ID associated with the bucket and service account.
--idempotentNobool Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--poll-intervalNoduration Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). Default is 1s.
--regionYesstring The GCS bucket region.
--resource-version, -vNostring Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically.
--sa-idYesstring The customer service account ID that Temporal Cloud impersonates for writing to GCS.
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.
--sink-nameYesstring The name of the export sink.

export gcs validate

Validate a GCS workflow history export sink configuration without creating or updating it. A successful response means the configuration is valid.

Example:

cloud namespace export gcs validate --namespace my-namespace.my-account --sink-name my-sink \
--sa-id my-service-account@my-project.iam.gserviceaccount.com \
--bucket-name my-bucket --gcp-project-id my-project --region us-central1

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--bucket-nameYesstring The name of the destination GCS bucket.
--gcp-project-idYesstring The GCP project ID associated with the bucket and service account.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--regionYesstring The GCS bucket region.
--sa-idYesstring The customer service account ID that Temporal Cloud impersonates for writing to GCS.
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.
--sink-nameYesstring The name of the export sink.

export get

Retrieve the configuration and status of a workflow history export sink for a Temporal Cloud namespace.

Example:

cloud namespace export get --namespace my-namespace.my-account --sink-name my-sink

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.
--sink-nameYesstring The name of the export sink.

export list

List all workflow history export sinks configured for a Temporal Cloud namespace.

Example:

cloud namespace export list --namespace my-namespace.my-account

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.

export s3

Commands for managing S3 workflow history export sinks for Temporal Cloud namespaces.

export s3 create

Create a new S3 workflow history export sink for a Temporal Cloud namespace. The sink is created in the enabled state.

Example:

cloud namespace export s3 create --namespace my-namespace.my-account --sink-name my-sink \
--role-name arn:aws:iam::123456789012:role/my-role --bucket-name my-bucket \
--region us-east-1 --aws-account-id 123456789012

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--asyncNobool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-idNostring Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--aws-account-idYesstring The AWS account ID associated with the bucket and role.
--bucket-nameYesstring The name of the destination S3 bucket.
--idempotentNobool Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed.
--kms-arnNostring The AWS KMS key ARN for server-side encryption of exported data. Optional.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--poll-intervalNoduration Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). Default is 1s.
--regionYesstring The AWS region where the S3 bucket is located.
--role-nameYesstring The IAM role ARN that Temporal Cloud assumes for writing to S3.
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.
--sink-nameYesstring The name of the export sink.

export s3 update

Update the configuration of an existing S3 workflow history export sink. The enabled/disabled state is preserved.

Example:

cloud namespace export s3 update --namespace my-namespace.my-account --sink-name my-sink \
--role-name arn:aws:iam::123456789012:role/my-new-role --bucket-name my-bucket \
--region us-east-1 --aws-account-id 123456789012

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--asyncNobool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-idNostring Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--aws-account-idYesstring The AWS account ID associated with the bucket and role.
--bucket-nameYesstring The name of the destination S3 bucket.
--idempotentNobool Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed.
--kms-arnNostring The AWS KMS key ARN for server-side encryption of exported data. Optional.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--poll-intervalNoduration Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). Default is 1s.
--regionYesstring The AWS region where the S3 bucket is located.
--resource-version, -vNostring Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically.
--role-nameYesstring The IAM role ARN that Temporal Cloud assumes for writing to S3.
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.
--sink-nameYesstring The name of the export sink.

export s3 validate

Validate an S3 workflow history export sink configuration without creating or updating it. A successful response means the configuration is valid.

Example:

cloud namespace export s3 validate --namespace my-namespace.my-account --sink-name my-sink \
--role-name arn:aws:iam::123456789012:role/my-role --bucket-name my-bucket \
--region us-east-1 --aws-account-id 123456789012

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--aws-account-idYesstring The AWS account ID associated with the bucket and role.
--bucket-nameYesstring The name of the destination S3 bucket.
--kms-arnNostring The AWS KMS key ARN for server-side encryption of exported data. Optional.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--regionYesstring The AWS region where the S3 bucket is located.
--role-nameYesstring The IAM role ARN that Temporal Cloud assumes for writing to S3.
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.
--sink-nameYesstring The name of the export sink.

get

Retrieve the configuration and status of a Temporal Cloud namespace.

Returns details including region, retention period, endpoints, and certificate information.

Example:

cloud namespace get --namespace my-namespace.my-account

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.
--specNobool Output only the namespace specification in JSON format, omitting metadata and status information.

ha

Commands for managing High Availability (HA) settings of Temporal Cloud namespaces.

HA settings control active region, managed failover, and replica regions.

ha failover

Trigger a failover for a Temporal Cloud namespace to a different region. The target region must already be a replica region of the namespace.

Example:

cloud namespace ha failover --namespace my-namespace.my-account --region aws-us-west-2

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--asyncNobool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-idNostring Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--idempotentNobool Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--poll-intervalNoduration Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). Default is 1s.
--regionYesstring The target region to failover to (e.g., aws-us-west-2).
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.

ha get

Retrieve the current High Availability configuration for a Temporal Cloud namespace. Shows the active region and whether managed failover is enabled.

Example:

cloud namespace ha get --namespace my-namespace.my-account

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.

ha region

Commands for managing replica regions of Temporal Cloud namespaces.

ha region add

Add a replica region to a Temporal Cloud namespace. The region will be added as a passive replica and can later be used for failover.

Example:

cloud namespace ha region add --namespace my-namespace.my-account --region aws-us-west-2

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--asyncNobool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-idNostring Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--idempotentNobool Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--poll-intervalNoduration Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). Default is 1s.
--regionYesstring The region ID to add as a replica (e.g., aws-us-west-2).
--resource-version, -vNostring Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically.
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.

ha region delete

Remove a replica region from a Temporal Cloud namespace. Note that a 7-day cooldown period applies before the same region can be re-added.

Example:

cloud namespace ha region delete --namespace my-namespace.my-account --region aws-us-west-2

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--asyncNobool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-idNostring Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--idempotentNobool Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--poll-intervalNoduration Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). Default is 1s.
--regionYesstring The region ID to remove (e.g., aws-us-west-2).
--resource-version, -vNostring Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically.
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.

ha region list

List all regions and their states for a Temporal Cloud namespace.

Example:

cloud namespace ha region list --namespace my-namespace.my-account

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.

ha update

Update the High Availability configuration for a Temporal Cloud namespace. Use --disable-auto-failover to toggle Temporal-managed automatic failover.

Example:

cloud namespace ha update --namespace my-namespace.my-account --disable-auto-failover true

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--asyncNobool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-idNostring Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--disable-auto-failoverYesbool Set to true to disable Temporal-managed automatic failover for the namespace. Set to false to re-enable automatic failover.
--idempotentNobool Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--poll-intervalNoduration Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). Default is 1s.
--resource-version, -vNostring Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically.
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.

lifecycle

Commands for managing lifecycle settings of Temporal Cloud namespaces.

Lifecycle settings control the behavior and protection of namespaces, including delete protection to prevent accidental deletion.

lifecycle get

Retrieve the current lifecycle configuration for a Temporal Cloud namespace. Lifecycle settings include delete protection status.

Example:

cloud namespace lifecycle get --namespace my-namespace.my-account

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.

lifecycle set

Set the lifecycle configuration for a Temporal Cloud namespace. Lifecycle settings include delete protection to prevent accidental deletion.

Example:

cloud namespace lifecycle set --namespace my-namespace.my-account --enable-delete-protection true

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--asyncNobool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-idNostring Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--enable-delete-protectionYesbool Enable or disable delete protection for the namespace. When enabled, the namespace cannot be deleted until this flag is set to false.
--idempotentNobool Succeed silently if the lifecycle configuration is already set to the specified value. Without this flag, the command errors when no change is needed.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--resource-versionNostring Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically.
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.
--verbose-diffNobool Show detailed differences between the current and desired namespace configurations when changes are detected.

list

List all Temporal Cloud namespaces accessible with the current authentication credentials.

Example:

cloud namespace list

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--nameNostring Filter namespaces by the name as defined in the specification of the namespace.
--page-sizeNoint Number of namespaces to return per page. Use for paginated results.
--page-tokenNostring Token for retrieving the next page of results in a paginated list.
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.

retention

Commands for managing data retention settings of Temporal Cloud namespaces.

Retention determines how long closed workflow history data are stored before being automatically deleted.

retention get

Retrieve the current data retention period for a Temporal Cloud namespace. The retention period defines how long closed workflow history data are stored.

Example:

cloud namespace retention get --namespace my-namespace.my-account

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.

retention set

Set the data retention period for a Temporal Cloud namespace. The retention period defines how long closed workflow history data are stored.

Example:

cloud namespace retention set --namespace my-namespace.my-account --retention-days 14

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--asyncNobool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-idNostring Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--idempotentNobool Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--poll-intervalNoduration Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). Default is 1s.
--resource-version, -vNostring Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically.
--retention-daysYesint New retention period in days for closed workflow history data.
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.

search-attribute

Commands for managing custom search attributes for Temporal Cloud namespaces. Search attributes enable filtering and searching workflows by custom fields.

search-attribute create

Create a new custom search attribute for a Temporal Cloud namespace.

Example:

cloud namespace search-attribute create --namespace my-namespace.my-account --name MyField --type Keyword

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--asyncNobool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-idNostring Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--idempotentNobool Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed.
--nameYesstring The name of the search attribute to create.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--poll-intervalNoduration Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). Default is 1s.
--resource-version, -vNostring Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically.
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.
--typeYesstring The type of the search attribute. Valid values: Text, Keyword, Int, Double, Bool, Datetime, KeywordList.

search-attribute list

List all custom search attributes configured for a Temporal Cloud namespace.

Example:

cloud namespace search-attribute list --namespace my-namespace.my-account

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.

search-attribute rename

Rename an existing custom search attribute for a Temporal Cloud namespace. This operation preserves all existing data associated with the search attribute.

Example:

cloud namespace search-attribute rename --namespace my-namespace.my-account --existing-name OldField --new-name NewField

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--asyncNobool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-idNostring Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--existing-nameYesstring The current name of the search attribute to rename.
--idempotentNobool Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--new-nameYesstring The new name for the search attribute.
--poll-intervalNoduration Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). Default is 1s.
--resource-version, -vNostring Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically.
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.

tag

Commands for managing tags of Temporal Cloud namespaces.

Tags are key-value pairs used for organization and categorization of namespaces.

tag create

Create a new tag for a Temporal Cloud namespace. Fails if a tag with the specified key already exists.

Example:

cloud namespace tag create --namespace my-namespace.my-account --key environment --value production

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--asyncNobool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-idNostring Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--idempotentNobool Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed.
--keyYesstring The tag key.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--poll-intervalNoduration Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). Default is 1s.
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.
--valueYesstring The tag value.

tag delete

Delete a tag from a Temporal Cloud namespace by its key.

Example:

cloud namespace tag delete --namespace my-namespace.my-account --key environment

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--asyncNobool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-idNostring Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--idempotentNobool Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed.
--keyYesstring The tag key to delete.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--poll-intervalNoduration Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). Default is 1s.
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.

tag list

List all tags configured for a Temporal Cloud namespace.

Example:

cloud namespace tag list --namespace my-namespace.my-account

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.

tag update

Update the value of an existing tag for a Temporal Cloud namespace. Fails if the specified tag key does not exist.

Example:

cloud namespace tag update --namespace my-namespace.my-account --key environment --value staging

Use the following options to change the behavior of this command. You can also use any of the global flags that apply to all subcommands.

FlagRequiredDescription
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--asyncNobool Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later.
--async-operation-idNostring Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically.
--idempotentNobool Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed.
--keyYesstring The tag key to update.
--namespace, -nYesstring The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account').
--poll-intervalNoduration Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). Default is 1s.
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.
--valueYesstring The new value for the tag.

Global Flags

The following options can be used with any command.

FlagRequiredDescriptionDefault
--api-keyNostring API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines.
--auto-confirmNobool Automatically confirm prompts and actions that require user confirmation. Useful for scripting and automation.
--config-dirNostring Directory path where CLI configuration files are stored, including authentication tokens and settings.
--disable-pop-upNobool Prevent the CLI from opening a browser window during authentication. Useful for headless environments or when using alternative auth methods.
--serverNostring Override the Temporal Cloud API server address. Used for connecting to non-production environments.saas-api.tmprl-test.cloud:443