Skip to main content

tcld apikey command reference

The tcld apikey commands manage API Keys in Temporal Cloud.

Alias: ak

create​

The tcld apikey create command creates an API Key in Temporal Cloud.

tcld apikey create --name <name> --description <description> --duration <duration> --expiry <expiry> --request-id <request_id>

The following options control the behavior of the command.

--name​

Required modifier

Specify the display name of the API Key.

Alias: -n

Example

tcld apikey create --name <name>

--description​

Specify a description for the API Key.

Alias: -desc

Example

tcld apikey create --name <name> --description "Your API Key"

--duration​

Specify the duration from now when the API Key will expire. This will be ignored if the expiry flag is set.

Example format: 24h (default: 0s).

Alias: -d

Example

tcld apikey create --name <name> --duration 24h

--expiry​

Specify the absolute timestamp (RFC3339) when the API Key will expire.

Example: 2023-11-28T09:23:24-08:00.

Alias: -e

Example

tcld apikey create --name <name> --expiry '2023-11-28T09:23:24-08:00'

--request-id​

Specify a request-id for the asynchronous operation. If not set, the server will assign one.

Alias: -r

Example

tcld apikey create --name <name> --request-id <request_id>

get​

The tcld apikey get command retrieves the details of a specified API Key in Temporal Cloud.

tcld apikey get --id <id>

The following option controls the behavior of the command.

--id​

Required modifier

Specify the ID of the API Key to retrieve.

Alias: -i

Example

tcld apikey get --id <apikey_id>

list​

The tcld apikey list command lists all API Keys in Temporal Cloud.

tcld apikey list

This command does not require any specific options.

Alias: l

Example

tcld apikey list

delete​

The tcld apikey delete command deletes an API Key in Temporal Cloud.

tcld apikey delete --id <id> [--resource-version <version>] [--request-id <request_id>]

The following options control the behavior of the command.

--id​

Required modifier

Specify the ID of the API Key to delete.

Alias: -i

Example

tcld apikey delete --id <apikey_id>

--resource-version​

Specify the resource-version (etag) to update from. If not set, the CLI will use the latest.

Alias: -v

Example

tcld apikey delete --id <apikey_id> --resource-version <version>

--request-id​

Specify a request-id for the asynchronous operation. If not set, the server will assign one.

Alias: -r

Example

tcld apikey delete --id <apikey_id> --request-id <request_id>

disable​

The tcld apikey disable command disables an API Key in Temporal Cloud.

tcld apikey disable --id <id> [--resource-version <version>] [--request-id <request_id>]

The following options control the behavior of the command.

--id​

Required modifier

Specify the ID of the API Key to disable.

Alias: -i

Example

tcld apikey disable --id <apikey_id>

--resource-version​

Specify the resource-version (etag) to update from. If not set, the CLI will use the latest.

Alias: -v

Example

tcld apikey disable --id <apikey_id> --resource-version <version>

--request-id​

Specify a request-id for the asynchronous operation. If not set, the server will assign one.

Alias: -r

Example

tcld apikey disable --id <apikey_id> --request-id <request_id>

enable​

The tcld apikey enable command enables a disabled API Key in Temporal Cloud.

tcld apikey enable --id <id> [--resource-version <version>] [--request-id <request_id>]

The following options control the behavior of the command.

--id​

Required modifier

Specify the ID of the API Key to enable.

Alias: -i

Example

tcld apikey enable --id <apikey_id>

--resource-version​

Specify the resource-version (etag) to update from. If not set, the CLI will use the latest.

Alias: -v

Example

tcld apikey enable --id <apikey_id> --resource-version <version>

--request-id​

Specify a request-id for the asynchronous operation. If not set, the server will assign one.

Alias: -r

Example

tcld apikey enable --id <apikey_id> --request-id <request_id>