Temporal CLI cloud nexus command reference

This page provides a reference for the temporal cloud nexus 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.

endpoint

Commands for managing Nexus Endpoints in Temporal Cloud.

endpoint allowed-namespace

Commands for managing allowed namespaces for Nexus Endpoints.

endpoint allowed-namespace add

Add namespaces that are allowed to call this Nexus Endpoint. Namespaces that are already allowed are silently ignored.

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.

Flag	Required	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 allow. 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). Default is 1s.
--resource-version, -v	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.

endpoint allowed-namespace list

List all namespaces that are allowed to call this Nexus Endpoint.

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.

Flag	Required	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.

endpoint allowed-namespace remove

Remove namespaces from the list of allowed callers of this Nexus Endpoint. Namespaces that are not currently allowed are silently ignored.

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.

Flag	Required	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). Default is 1s.
--resource-version, -v	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.

endpoint allowed-namespace set

Set the full list of namespaces that are allowed to call this Nexus Endpoint, replacing any previously allowed namespaces.

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.

Flag	Required	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 allow. 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). Default is 1s.
--resource-version, -v	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.

endpoint create

Create 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 --target-namespace and --target-task-queue must both be provided. This will fail if an endpoint with the same name is already registered.

Example:

cloud nexus endpoint create --name my-endpoint --target-namespace my-ns.my-account --target-task-queue my-tq

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.

Flag	Required	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). Default is 1s.
--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.

endpoint delete

Delete a Nexus Endpoint on the Cloud 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.

Flag	Required	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 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). Default is 1s.
--resource-version, -v	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.

endpoint get

This command gets a Nexus Endpoint configuration by name from the Cloud 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.

Flag	Required	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 to retrieve.
--server	No	string Override the Temporal Cloud API server address. Used for connecting to non-production environments.

endpoint list

List all Nexus Endpoint configurations on the Cloud 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.

Flag	Required	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.
--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.

endpoint update

Update an existing 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 --target-namespace and --target-task-queue must both be provided.

The endpoint is patched leaving any existing fields for which flags are not provided as they were.

Example:

cloud nexus endpoint update --name my-endpoint --target-namespace new-ns.my-account --target-task-queue new-tq

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.

Flag	Required	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.
--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 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). Default is 1s.
--resource-version, -v	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.

Global Flags

The following options can be used with any command.

Flag	Required	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-test.cloud:443