CLI referenceastro deploymentastro deployment token

astro deployment token update

This command is only available on Astro.

Update an Astro Deployment API Token.

To use your API token in an automated process, see Authenticate an automation tool.

Usage

1astro deployment token update --deployment-id=MOCK_DEP_ID

Options

OptionDescriptionPossible Values
-d, --descriptionUpdated description of the token. If the description contains a space, specify the entire description in quotes "".String
-t,--nameThe current name of the token. If the name contains a space, specify the entire name within quotes "".String
-n, --new-nameThe token’s new name. If the new name contains a space, specify the entire name within quotes "".String
-r, --roleThe role for the token. Possible values are DEPLOYMENT_ADMIN or a custom role name.Any valid Deployment role.

Examples

$# The CLI prompts you to input a role for a token with Token ID assigned to a specific Deployment
>astro deployment token update <token-id> --deployment-id=clukapi6r000008l58530cg8i
>
># The CLI prompts you to input a role for a token identified by its name
>astro deployment token update --deployment-id=clukapi6r000008l58530cg8i --name="Token name"
>
># The CLI prompts you to select the token from a list and input a role
>astro deployment token update --deployment-id=clukapi6r000008l58530cg8i
>
># This command assigns a token with the specified TOKEN_ID the role `Deployment Admin` to a Deployment with the following ID.
>astro deployment token update TOKEN_ID --deployment-id=clukapi6r000008l58530cg8i --role=DEPLOYMENT_ADMIN