temporal cloud login reset flag
The --reset flag clears stored login credentials and configuration, then re-authenticates. Use this flag if you need to switch accounts or fix authentication issues.
cli
564 notes in this subject, read out of this brain and free to use. This is page 2 of 10.
temporal cloud login flags reference
The temporal cloud login command supports the following flags: --audience (string, optional) for OAuth audience parameter; --client-id (string, optional) for OAuth client identifier; --domain (string, optional) for authentication domain; --redirect-url (string, optional) for OAuth redirect URL; --reset (bool, optional) to clear stored login credentials and configuration and re-authenticate.
temporal cloud login headless environment
For headless environments, use the --disable-pop-up flag and follow the printed URL to complete OAuth authentication.
temporal cloud login command
The temporal cloud login command authenticates with Temporal Cloud using browser-based OAuth login. This command opens the default browser to complete authentication. Once logged in, credentials are stored locally for subsequent commands.
temporal cloud custom-role edit command
The 'temporal cloud custom-role edit' command opens a custom role configuration in the 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. Flags: - --api-key (No, string): API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines. - --async (No, bool): Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later. - --async-operation-id (No, string): Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically. - --idempotent (No, bool): Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed. - --poll-interval (No, duration): Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). - --resource-version, -v (No, string): Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically. - --role-id (Yes, string): The ID of the custom role. - --server (No, string): Override the Temporal Cloud API server address. Used for connecting to non-production environments. - --verbose-diff (No, bool): Show detailed differences between the current and desired namespace configurations when changes are detected.
Global flags for temporal cloud custom-role commands
The following global options can be used with any 'temporal cloud custom-role' subcommand: - --api-key (No, string): API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines. Default: empty. - --auto-confirm (No, bool): Automatically confirm prompts and actions that require user confirmation. Useful for scripting and automation. Default: empty. - --config-dir (No, string): Directory path where CLI configuration files are stored, including authentication tokens and settings. Default: empty. - --disable-pop-up (No, bool): Prevent the CLI from opening a browser window during authentication. Useful for headless environments or when using alternative auth methods. Default: empty. - --server (No, string): Override the Temporal Cloud API server address. Used for connecting to non-production environments. Default: saas-api.tmprl.cloud:443.
temporal cloud custom-role list command
The 'temporal cloud custom-role list' command lists all Temporal Cloud custom roles accessible with the current authentication credentials. Flags: - --api-key (No, string): API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines. - --page-size (No, int): Number of custom roles to return per page. Use for paginated results. - --page-token (No, string): Token for retrieving the next page of results in a paginated list. - --server (No, string): Override the Temporal Cloud API server address. Used for connecting to non-production environments.
temporal cloud custom-role get command
The 'temporal cloud custom-role get' command retrieves the configuration and status of a Temporal Cloud custom role. Flags: - --api-key (No, string): API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines. - --role-id (Yes, string): The ID of the custom role. - --server (No, string): Override the Temporal Cloud API server address. Used for connecting to non-production environments.
temporal cloud custom-role update command
The 'temporal cloud custom-role update' command updates an existing Temporal Cloud custom role from a JSON specification. It replaces the role's spec with the provided one. Flags: - --api-key (No, string): API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines. - --async (No, bool): Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later. - --async-operation-id (No, string): Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically. - --idempotent (No, bool): Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed. - --poll-interval (No, duration): Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). - --resource-version, -v (No, string): Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically. - --role-id (Yes, string): The ID of the custom role. - --server (No, string): Override the Temporal Cloud API server address. Used for connecting to non-production environments. - --spec (Yes, string): Custom role specification in JSON format. Provide inline JSON directly, or use '@path/to/file.json' to load from a file.
temporal cloud custom-role delete command
The 'temporal cloud custom-role delete' command deletes a Temporal Cloud custom role. This action is irreversible. Flags: - --api-key (No, string): API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines. - --async (No, bool): Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later. - --async-operation-id (No, string): Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically. - --idempotent (No, bool): Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed. - --poll-interval (No, duration): Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). - --resource-version, -v (No, string): Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically. - --role-id (Yes, string): The ID of the custom role. - --server (No, string): Override the Temporal Cloud API server address. Used for connecting to non-production environments.
temporal cloud custom-role create command
The 'temporal cloud custom-role create' command creates a new Temporal Cloud custom role from a JSON specification. The specification can be provided as inline JSON or loaded from a file by prefixing the path with '@'. Flags: - --api-key (No, string): API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines. - --async (No, bool): Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later. - --async-operation-id (No, string): Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically. - --idempotent (No, bool): Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed. - --poll-interval (No, duration): Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). - --server (No, string): Override the Temporal Cloud API server address. Used for connecting to non-production environments. - --spec (Yes, string): Custom role specification in JSON format. Provide inline JSON directly, or use '@path/to/file.json' to load from a file.
temporal cloud logout global flags
The temporal cloud logout command accepts the following global flags: --api-key (string, for authenticating with Temporal Cloud, can be used instead of interactive login for automation and CI/CD), --auto-confirm (bool, automatically confirm prompts), --config-dir (string, directory path where CLI configuration files are stored), --disable-pop-up (bool, prevent the CLI from opening a browser window during authentication), and --server (string, override the Temporal Cloud API server address, default is saas-api.tmprl.cloud:443).
temporal cloud logout --domain flag
The --domain flag is an optional string parameter for the temporal cloud logout command that specifies the authentication domain for the OAuth provider.
temporal cloud logout command
The temporal cloud logout command clears stored authentication tokens and credentials from the local configuration, effectively logging out from Temporal Cloud. The command is invoked as 'temporal cloud logout'.
temporal CLI global flags for cloud nexus commands
Global flags that can be used with any temporal cloud nexus command: | Flag | Required | Type | Description | Default | |------|----------|------|-------------|--------| | --api-key | No | string | API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines. | | | --auto-confirm | No | bool | Automatically confirm prompts and actions that require user confirmation. Useful for scripting and automation. | | | --config-dir | No | string | Directory path where CLI configuration files are stored, including authentication tokens and settings. | | | --disable-pop-up | No | bool | Prevent the CLI from opening a browser window during authentication. Useful for headless environments or when using alternative auth methods. | | | --server | No | string | Override the Temporal Cloud API server address. Used for connecting to non-production environments. | `saas-api.tmprl.cloud:443` |
temporal cloud nexus endpoint allowed-namespace list command options
The `temporal cloud nexus endpoint allowed-namespace list` command lists all namespaces that are allowed to call a Nexus Endpoint. Flags: | Flag | Required | Type | Description | |------|----------|------|-------------| | --api-key | No | string | API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines. | | --name | Yes | string | The name of the Nexus Endpoint. | | --server | No | string | Override the Temporal Cloud API server address. Used for connecting to non-production environments. |
temporal cloud nexus endpoint allowed-namespace remove command options
The `temporal cloud nexus endpoint allowed-namespace remove` command removes namespaces from the list of allowed callers of a Nexus Endpoint. Namespaces that are not currently allowed are silently ignored. Flags: | Flag | Required | Type | Description | |------|----------|------|-------------| | --api-key | No | string | API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines. | | --async | No | bool | Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later. | | --async-operation-id | No | string | Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically. | | --idempotent | No | bool | Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed. | | --name | Yes | string | The name of the Nexus Endpoint. | | --namespace | Yes | string[] | A namespace to remove. Can be specified multiple times. | | --poll-interval | No | duration | Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). | | --resource-version | No | string | Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically. | | --server | No | string | Override the Temporal Cloud API server address. Used for connecting to non-production environments. |
temporal cloud nexus endpoint get command options
The `temporal cloud nexus endpoint get` command retrieves a Nexus Endpoint configuration from the Cloud Account. Specify either --name or --id (exactly one is required). Flags: | Flag | Required | Type | Description | |------|----------|------|-------------| | --api-key | No | string | API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines. | | --id | No | string | The ID of the Nexus Endpoint to retrieve. | | --name | No | string | The name of the Nexus Endpoint to retrieve. | | --server | No | string | Override the Temporal Cloud API server address. Used for connecting to non-production environments. |
temporal cloud nexus endpoint list command options
The `temporal cloud nexus endpoint list` command lists Nexus Endpoint configurations on the Cloud Account. Flags: | Flag | Required | Type | Description | |------|----------|------|-------------| | --api-key | No | string | API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines. | | --page-size | No | int | Number of endpoints to return per page. If no page size is provided, it will default to 100. A maximum of 1000 endpoints can be fetched at a time. | | --page-token | No | string | Token for retrieving the next page of results. Initial value is empty string. | | --server | No | string | Override the Temporal Cloud API server address. Used for connecting to non-production environments. |
temporal cloud nexus endpoint delete command options
The `temporal cloud nexus endpoint delete` command deletes a Nexus Endpoint on the Cloud Account. Specify either --name or --id (exactly one is required). Flags: | Flag | Required | Type | Description | |------|----------|------|-------------| | --api-key | No | string | API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines. | | --async | No | bool | Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later. | | --async-operation-id | No | string | Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically. | | --id | No | string | The ID of the Nexus Endpoint to delete. | | --idempotent | No | bool | Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed. | | --name | No | string | The name of the Nexus Endpoint to delete. | | --poll-interval | No | duration | Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). | | --resource-version | No | string | Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically. | | --server | No | string | Override the Temporal Cloud API server address. Used for connecting to non-production environments. |
temporal cloud nexus endpoint update command options
The `temporal cloud nexus endpoint update` command updates an existing Nexus Endpoint on the Cloud Account. An endpoint name is used in workflow code to invoke Nexus operations. Specify either --name or --id to identify the endpoint (exactly one is required). The endpoint is patched leaving any existing fields for which flags are not provided as they were. Flags: | Flag | Required | Type | Description | |------|----------|------|-------------| | --api-key | No | string | API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines. | | --async | No | bool | Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later. | | --async-operation-id | No | string | Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically. | | --description | No | string | An optional endpoint description in markdown format. | | --description-file | No | string | Path to a file containing an endpoint description in markdown format. Mutually exclusive with --description. | | --id | No | string | The ID of the Nexus Endpoint to update. | | --idempotent | No | bool | Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed. | | --name | No | string | The name of the Nexus Endpoint to update. | | --poll-interval | No | duration | Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). | | --resource-version | No | string | Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically. | | --server | No | string | Override the Temporal Cloud API server address. Used for connecting to non-production environments. | | --target-namespace | No | string | The namespace in which a handler worker will be polling for Nexus tasks. | | --target-task-queue | No | string | The task queue on which a handler worker will be polling for Nexus tasks. | | --unset-description | No | bool | Unset the endpoint description. Cannot be used with --description or --description-file. | Example: `temporal cloud nexus endpoint update --name my-endpoint --target-namespace new-ns.my-account --target-task-queue new-tq`
temporal cloud nexus endpoint create command options
The `temporal cloud nexus endpoint create` command creates a new Nexus Endpoint on the Cloud Account. An endpoint name is used in workflow code to invoke Nexus operations. The endpoint target is a worker and both --target-namespace and --target-task-queue must be provided. This command fails if an endpoint with the same name is already registered. Flags: | Flag | Required | Type | Description | |------|----------|------|-------------| | --allow-namespace | No | string[] | A namespace that is allowed to call this endpoint. Can be specified multiple times. | | --api-key | No | string | API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines. | | --async | No | bool | Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later. | | --async-operation-id | No | string | Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically. | | --description | No | string | An optional endpoint description in markdown format. | | --description-file | No | string | Path to a file containing an endpoint description in markdown format. Mutually exclusive with --description. | | --idempotent | No | bool | Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed. | | --name | Yes | string | The name of the Nexus Endpoint to create. | | --poll-interval | No | duration | Time to wait between status checks when waiting for operation completion. Cannot be greater than 10 minutes. Supports minutes (m) and seconds (s). | | --server | No | string | Override the Temporal Cloud API server address. Used for connecting to non-production environments. | | --target-namespace | Yes | string | The namespace in which a handler worker will be polling for Nexus tasks. | | --target-task-queue | Yes | string | The task queue on which a handler worker will be polling for Nexus tasks. | Example: `temporal cloud nexus endpoint create --name my-endpoint --target-namespace my-ns.my-account --target-task-queue my-tq`
Projects provide account-level grouping in Temporal Cloud
Projects provide an account-level grouping for Temporal Cloud resources.
temporal cloud project update command
The 'temporal cloud project update' command updates an existing Temporal Cloud project. Only explicitly provided flags are changed. The project ID is required.
Project IDs generated by server in Temporal Cloud
When creating a new Temporal Cloud project, project IDs are generated by the server automatically.
temporal cloud project edit command
The 'temporal cloud project edit' command opens an existing project specification in the default editor and applies the edited configuration. The project ID is required.
temporal cloud project create command
The 'temporal cloud project create' command creates a new Temporal Cloud project. The display name is required, and description and delete protection can optionally be specified.
temporal cloud project delete command
The 'temporal cloud project delete' command deletes a Temporal Cloud project. The project ID is required.
temporal cloud project update flags
The 'temporal cloud project update' command supports the following flags: --api-key (string, optional), --async (bool, optional), --async-operation-id (string, optional), --description (string, optional), --display-name (string, optional), --enable-delete-protection (bool, optional), --idempotent (bool, optional), --poll-interval (duration, optional, max 10 minutes, supports m and s), --project-id (string, required), --resource-version/-v (string, optional, fetched automatically if not provided), --server (string, optional, default saas-api.tmprl.cloud:443).
temporal cloud project apply command
The 'temporal cloud project apply' command applies a project configuration to Temporal Cloud. If --project-id is provided, the existing project is updated. Otherwise, a new project is created because project IDs are generated by the server. The specification can be provided as inline JSON or loaded from a file by prefixing the path with '@'.
temporal cloud project list flags
The 'temporal cloud project list' command supports the following flags: --api-key (string, optional), --page-size (int, optional), --page-token (string, optional), --project-id (string[], optional, can be specified multiple times to filter), --server (string, optional, default saas-api.tmprl.cloud:443).
temporal cloud project get command
The 'temporal cloud project get' command retrieves the configuration and status of a Temporal Cloud project. The project ID is required.
temporal cloud project list command
The 'temporal cloud project list' command lists Temporal Cloud projects in the current account.
temporal cloud project get flags
The 'temporal cloud project get' command supports the following flags: --api-key (string, optional), --project-id (string, required), --server (string, optional, default saas-api.tmprl.cloud:443).
temporal cloud namespace export enable command flags
The 'temporal cloud namespace export enable' command enables a previously disabled workflow history export sink for a Temporal Cloud namespace. Required flags: --namespace (string, fully qualified namespace name), --sink-name (string, name of the export sink). Optional flags: --api-key (string, API key for authentication), --async (bool, return immediately), --async-operation-id (string, custom operation identifier), --idempotent (bool, succeed silently if no changes needed), --poll-interval (duration, max 10 minutes), --resource-version (string, for optimistic concurrency control), --server (string, override API server address).
temporal cloud namespace export azure-blob update command flags
The 'temporal cloud namespace export azure-blob update' command updates the configuration of an existing Azure Blob workflow history export sink. Only provided flags are changed; omitted flags keep current values. Enabled/disabled state and region are preserved. Required flags: --namespace (string, fully qualified namespace name), --sink-name (string, name of the export sink). Optional flags: --api-key (string, API key for authentication), --async (bool, return immediately), --async-operation-id (string, custom operation identifier), --container-name (string, destination Azure Blob container name; if omitted, current value kept), --idempotent (bool, succeed silently if no changes needed), --poll-interval (duration, max 10 minutes), --resource-group (string, Azure resource group; if omitted, current value kept), --resource-version (string, for optimistic concurrency control), --server (string, override API server address), --storage-account (string, Azure storage account name; if omitted, current value kept), --subscription-id (string, Azure subscription ID; if omitted, current value kept), --tenant-id (string, Azure tenant ID; if omitted, current value kept).
temporal cloud namespace export azure-blob create command flags
The 'temporal cloud namespace export azure-blob create' command creates a new Azure Blob workflow history export sink for a Temporal Cloud namespace in enabled state. Required flags: --namespace (string, fully qualified namespace name), --sink-name (string, name of the export sink), --tenant-id (string, Azure tenant ID), --subscription-id (string, Azure subscription ID), --resource-group (string, Azure resource group name), --storage-account (string, Azure storage account name), --container-name (string, destination Azure Blob container name), --region (string, region where Azure storage account is located). Optional flags: --api-key (string, API key for authentication), --async (bool, return immediately), --async-operation-id (string, custom operation identifier), --idempotent (bool, succeed silently if no changes needed), --poll-interval (duration, max 10 minutes), --server (string, override API server address).
temporal cloud namespace edit command flags and behavior
The 'temporal cloud namespace edit' command opens a namespace configuration in the 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. Required flags: --namespace (string, fully qualified namespace name in format 'namespace.account', e.g., 'my-namespace.my-account'). Optional flags: --api-key (string, API key for authentication), --async (bool, return immediately), --async-operation-id (string, custom operation identifier), --idempotent (bool, succeed silently if no changes were made), --resource-version (string, for optimistic concurrency control), --server (string, override API server address), --verbose-diff (bool, show detailed differences between current and desired configurations).
temporal cloud namespace delete command flags and behavior
The 'temporal cloud namespace delete' command deletes a Temporal Cloud namespace and all associated data. This action is irreversible and will permanently remove all workflows, activities, and history within the namespace. Required flags: --namespace (string, fully qualified namespace name in format 'namespace.account', e.g., 'my-namespace.my-account'). Optional flags: --api-key (string, API key for authentication), --async (bool, return immediately), --async-operation-id (string, custom operation identifier), --idempotent (bool, succeed silently if namespace does not exist), --resource-version (string, for optimistic concurrency control), --server (string, override API server address).
temporal cloud namespace create command flags
The 'temporal cloud namespace create' command creates a new Temporal Cloud namespace with specified configuration using individual flags. Required flags: --name (string, namespace name that becomes part of namespace ID), --region (string[], cloud region where namespace will be hosted; repeat for multiple regions for High Availability). Optional flags: --api-key (string, API key for authentication), --api-key-auth-enabled (bool, enable API key authentication), --async (bool, return immediately), --async-operation-id (string, custom operation identifier), --ca-certificate (string, Base64-encoded CA certificate for mTLS; mutually exclusive with --ca-certificate-file), --ca-certificate-file (string, path to CA certificate PEM file; mutually exclusive with --ca-certificate), --certificate-filter (string[], certificate filter as JSON object; repeat for multiple), --certificate-filter-file (string, path to JSON file with certificate filter), --codec-endpoint (string, HTTPS codec server endpoint URL), --codec-include-cross-origin-credentials (bool, include cross-origin credentials in codec requests), --codec-pass-access-token (bool, pass user access token to codec server), --connection-rule-id (string[], private connectivity rule ID; repeat for multiple), --enable-delete-protection (bool, prevent accidental deletion), --enable-task-queue-fairness (bool, enable task queue fairness), --idempotent (bool, succeed silently if no changes needed), --mtls-auth-enabled (bool, enable mTLS authentication), --poll-interval (duration, max 10 minutes), --retention-days (int, days to retain closed workflow history), --search-attribute (string[], custom search attribute as 'name=Type'; valid types: Text, Keyword, Int, Double, Bool, Datetime, KeywordList; repeat for multiple), --server (string, override API server address).
temporal cloud namespace connectivity list command flags
The 'temporal cloud namespace connectivity list' command lists all connectivity rules currently attached to a Temporal Cloud namespace. Required flags: --namespace (string, fully qualified namespace name in format 'namespace.account', e.g., 'my-namespace.my-account'). Optional flags: --api-key (string, API key for authentication), --server (string, override API server address).
temporal cloud namespace connectivity detach command flags
The 'temporal cloud namespace connectivity detach' command detaches a connectivity rule from a Temporal Cloud namespace. Required flags: --namespace (string, fully qualified namespace name), --connectivity-rule-id (string[], ID of a connectivity rule to detach; repeat to detach multiple). Optional flags: --api-key (string, API key for authentication), --async (bool, return immediately), --async-operation-id (string, custom operation identifier), --idempotent (bool, succeed silently if no changes needed), --poll-interval (duration, max 10 minutes), --resource-version (string, for optimistic concurrency control), --server (string, override API server address).
temporal cloud namespace codec set command flags
The 'temporal cloud namespace codec set' command sets the codec server configuration for a Temporal Cloud namespace. Required flags: --namespace (string, fully qualified namespace name), --endpoint (string, codec server endpoint URL). Optional flags: --api-key (string, API key for authentication), --async (bool, return immediately), --async-operation-id (string, custom operation identifier), --custom-error-message-default-link (string, link to display alongside custom error message), --custom-error-message-default-message (string, custom message to display for codec server errors), --idempotent (bool, succeed silently if no changes needed), --include-cross-origin-credentials (bool, include cross-origin credentials in requests), --pass-access-token (bool, pass user access token to codec server), --poll-interval (duration, max 10 minutes), --resource-version (string, for optimistic concurrency control), --server (string, override API server address).
temporal cloud namespace codec delete command flags
The 'temporal cloud namespace codec delete' command deletes the codec server configuration from a Temporal Cloud namespace. Required flags: --namespace (string, fully qualified namespace name in format 'namespace.account', e.g., 'my-namespace.my-account'). Optional flags: --api-key (string, API key for authentication), --async (bool, return immediately), --async-operation-id (string, custom operation identifier), --idempotent (bool, succeed silently if no changes needed), --poll-interval (duration, max 10 minutes), --resource-version (string, for optimistic concurrency control), --server (string, override API server address).
temporal cloud namespace export list command flags
The 'temporal cloud namespace export list' command lists all workflow history export sinks configured for a Temporal Cloud namespace. Required flags: --namespace (string, fully qualified namespace name in format 'namespace.account', e.g., 'my-namespace.my-account'). Optional flags: --api-key (string, API key for authentication), --server (string, override API server address).
temporal cloud namespace capacity update command flags
The 'temporal cloud namespace capacity update' command updates the capacity of a Temporal Cloud namespace, allowing switching between on-demand mode and provisioned mode (with fixed TRU allocation). Required flags: --namespace (string, fully qualified namespace name), --capacity-mode (string-enum, must be 'on_demand' or 'provisioned'). Optional flags: --api-key (string, API key for authentication), --async (bool, return immediately), --async-operation-id (string, custom operation identifier), --capacity-value (float, provisioned capacity in TRUs, required and must be greater than 0 when --capacity-mode is 'provisioned', ignored when 'on_demand'), --idempotent (bool, succeed silently if no changes needed), --poll-interval (duration, max 10 minutes), --resource-version (string, for optimistic concurrency control), --server (string, override API server address).
temporal cloud namespace capacity get command flags
The 'temporal cloud namespace capacity get' command retrieves capacity information for a Temporal Cloud namespace, including current mode (on-demand or provisioned), mode options, and recent usage stats. Required flags: --namespace (string, fully qualified namespace name in format 'namespace.account', e.g., 'my-namespace.my-account'). Optional flags: --api-key (string, API key for authentication), --server (string, override API server address).
temporal cloud namespace export gcs validate command flags
The 'temporal cloud namespace export gcs validate' command validates a GCS workflow history export sink configuration without creating or updating it. A successful response means the configuration is valid. Required flags: --namespace (string, fully qualified namespace name), --sink-name (string, name of the export sink), --service-account-email (string, email of customer service account that Temporal Cloud impersonates for writing to GCS, e.g., 'my-sa@my-project.iam.gserviceaccount.com'), --bucket-name (string, name of destination GCS bucket), --region (string, GCS bucket region). Optional flags: --api-key (string, API key for authentication), --server (string, override API server address).
temporal cloud namespace export s3 update command flags
The 'temporal cloud namespace export s3 update' command updates the configuration of an existing S3 workflow history export sink. Only provided flags are changed; omitted flags keep current values. Enabled/disabled state and region are preserved. Required flags: --namespace (string, fully qualified namespace name), --sink-name (string, name of the export sink). Optional flags: --api-key (string, API key for authentication), --async (bool, return immediately), --async-operation-id (string, custom operation identifier), --bucket-name (string, name of destination S3 bucket; if omitted, current value kept), --idempotent (bool, succeed silently if no changes needed), --kms-arn (string, AWS KMS key ARN; if omitted, current value kept), --poll-interval (duration, max 10 minutes), --resource-version (string, for optimistic concurrency control), --role-arn (string, IAM role ARN; if omitted, current value kept), --server (string, override API server address).
temporal cloud namespace connectivity attach command flags
The 'temporal cloud namespace connectivity attach' command attaches an existing connectivity rule to a Temporal Cloud namespace. Required flags: --namespace (string, fully qualified namespace name), --connectivity-rule-id (string[], ID of a connectivity rule to attach; repeat to attach multiple). Optional flags: --api-key (string, API key for authentication), --async (bool, return immediately), --async-operation-id (string, custom operation identifier), --idempotent (bool, succeed silently if no changes needed), --poll-interval (duration, max 10 minutes), --resource-version (string, for optimistic concurrency control), --server (string, override API server address).
temporal cloud namespace apply command flags and usage
The 'temporal cloud namespace apply' command 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 '@'. Required flags: --spec (string, namespace configuration in JSON format; provide inline JSON directly or use '@path/to/file.json' to load from a file). Optional flags: --api-key (string, API key for authentication), --async (bool, return immediately), --async-operation-id (string, custom operation identifier), --idempotent (bool, succeed silently if no changes needed), --resource-version (string, for optimistic concurrency control), --server (string, override API server address), --verbose-diff (bool, show detailed differences between current and desired configurations).
temporal cloud namespace api-key enable command flags
The 'temporal cloud namespace api-key enable' command enables API key authentication for a Temporal Cloud namespace. Required flags: --namespace (string, fully qualified namespace name in format 'namespace.account', e.g., 'my-namespace.my-account'). Optional flags: --api-key (string, API key for authentication), --async (bool, return immediately), --async-operation-id (string, custom operation identifier), --idempotent (bool, succeed silently if no changes needed), --poll-interval (duration, max 10 minutes, supports m and s), --resource-version (string, for optimistic concurrency control), --server (string, override API server address).
temporal cloud namespace export s3 validate command flags
The 'temporal cloud namespace export s3 validate' command validates an S3 workflow history export sink configuration without creating or updating it. A successful response means the configuration is valid. Required flags: --namespace (string, fully qualified namespace name), --sink-name (string, name of the export sink), --role-arn (string, IAM role ARN that Temporal Cloud assumes for writing to S3, e.g., 'arn:aws:iam::123456789012:role/my-role'), --bucket-name (string, name of destination S3 bucket), --region (string, AWS region where S3 bucket is located). Optional flags: --api-key (string, API key for authentication), --kms-arn (string, AWS KMS key ARN for server-side encryption), --server (string, override API server address).
temporal cloud namespace fairness get command flags
The 'temporal cloud namespace fairness get' command retrieves the current task queue fairness configuration for a Temporal Cloud namespace. Required flags: --namespace (string, fully qualified namespace name in format 'namespace.account', e.g., 'my-namespace.my-account'). Optional flags: --api-key (string, API key for authentication), --server (string, override API server address).
temporal cloud namespace ha region list command
The 'temporal cloud namespace ha region list' command lists all regions and their states for a Temporal Cloud namespace. Supported flags: --api-key (optional); --namespace/-n (required); --server (optional). Example: temporal cloud namespace ha region list --namespace my-namespace.my-account
temporal cloud namespace export gcs create command flags
The 'temporal cloud namespace export gcs create' command creates a new GCS workflow history export sink for a Temporal Cloud namespace in enabled state. Required flags: --namespace (string, fully qualified namespace name), --sink-name (string, name of the export sink), --service-account-email (string, email of customer service account that Temporal Cloud impersonates for writing to GCS, e.g., 'my-sa@my-project.iam.gserviceaccount.com'), --bucket-name (string, name of destination GCS bucket), --region (string, GCS bucket region). Optional flags: --api-key (string, API key for authentication), --async (bool, return immediately), --async-operation-id (string, custom operation identifier), --idempotent (bool, succeed silently if no changes needed), --poll-interval (duration, max 10 minutes), --server (string, override API server address).
temporal cloud namespace export gcs update command flags
The 'temporal cloud namespace export gcs update' command updates the configuration of an existing GCS workflow history export sink. Only provided flags are changed; omitted flags keep current values. Enabled/disabled state and region are preserved. Required flags: --namespace (string, fully qualified namespace name), --sink-name (string, name of the export sink). Optional flags: --api-key (string, API key for authentication), --async (bool, return immediately), --async-operation-id (string, custom operation identifier), --bucket-name (string, name of destination GCS bucket; if omitted, current value kept), --idempotent (bool, succeed silently if no changes needed), --poll-interval (duration, max 10 minutes), --resource-version (string, for optimistic concurrency control), --server (string, override API server address), --service-account-email (string, email of customer service account; if omitted, current value kept).
temporal cloud namespace export azure-blob validate command flags
The 'temporal cloud namespace export azure-blob validate' command validates an Azure Blob workflow history export sink configuration without creating or updating it. A successful response means the configuration is valid. Required flags: --namespace (string, fully qualified namespace name), --sink-name (string, name of the export sink), --tenant-id (string, Azure tenant ID), --subscription-id (string, Azure subscription ID), --resource-group (string, Azure resource group name), --storage-account (string, Azure storage account name), --container-name (string, destination Azure Blob container name), --region (string, region where Azure storage account is located). Optional flags: --api-key (string, API key for authentication), --server (string, override API server address).
temporal cloud namespace export s3 create command flags
The 'temporal cloud namespace export s3 create' command creates a new S3 workflow history export sink for a Temporal Cloud namespace in enabled state. Required flags: --namespace (string, fully qualified namespace name), --sink-name (string, name of the export sink), --role-arn (string, IAM role ARN that Temporal Cloud assumes for writing to S3, e.g., 'arn:aws:iam::123456789012:role/my-role'), --bucket-name (string, name of destination S3 bucket), --region (string, AWS region where S3 bucket is located). Optional flags: --api-key (string, API key for authentication), --async (bool, return immediately), --async-operation-id (string, custom operation identifier), --idempotent (bool, succeed silently if no changes needed), --kms-arn (string, AWS KMS key ARN for server-side encryption of exported data), --poll-interval (duration, max 10 minutes), --server (string, override API server address).
temporal cloud namespace fairness set command flags
The 'temporal cloud namespace fairness set' command sets the task queue fairness configuration for a Temporal Cloud namespace. Required flags: --namespace (string, fully qualified namespace name), --enable-task-queue-fairness (bool, enable or disable task queue fairness for the namespace). Optional flags: --api-key (string, API key for authentication), --async (bool, return immediately), --async-operation-id (string, custom operation identifier), --idempotent (bool, succeed silently if no changes needed), --poll-interval (duration, max 10 minutes), --resource-version (string, for optimistic concurrency control), --server (string, override API server address).