Update an API token | Astronomer Documentation

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

organizationIdstringRequired

The ID of the Organization where you want to update an API token.

tokenIdstringRequired

The API token you want to update.

Request

The request body for updating a token.

namestringRequired1-256 characters

The name of the API token.

descriptionstringOptional<=500 characters

The description of the API token.

Response

OK

createdAtstringformat: "date-time"

The time when the API token was created in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

descriptionstring

The description of the API token.

idstring

The API token's ID.

kindenum

The kind of the API token.

Allowed values:

namestring

The name of the API token.

scopeenum

The scope of the API token.

Allowed values:

shortTokenstring

The short value of the API token.

startAtstringformat: "date-time"

The time when the API token will become valid in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

updatedAtstringformat: "date-time"

The time when the API token was last updated in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

createdByobject

endAtstringformat: "date-time"

The time when the API token expires in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

expiryPeriodInDaysinteger

The expiry period of the API token in days.

lastRotatedAtstringformat: "date-time"

The time when the API token was last rotated in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

lastUsedAtstringformat: "date-time"

The time when the API token was last used in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

roleslist of objects

The roles of the API token.

tokenstring

The value of the API token.

updatedByobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

$	curl -X POST https://api.astronomer.io/v1/organizations/organizationId/tokens/tokenId \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "My token"
>	}'

1	{
2	"createdAt": "2022-11-22T04:37:12Z",
3	"description": "my token description",
4	"id": "clm8q7f6q000008lcgyougpsk",
5	"kind": "STANDARD",
6	"name": "My token",
7	"scope": "WORKSPACE",
8	"shortToken": "short-token",
9	"startAt": "2022-11-22T04:37:12Z",
10	"updatedAt": "2022-11-22T04:37:12Z",
11	"createdBy": {
12	"id": "clm8qv74h000008mlf08scq7k",
13	"apiTokenName": "my-token",
14	"avatarUrl": "https://avatar.url",
15	"fullName": "Jane Doe",
16	"subjectType": "USER",
17	"username": "user1@company.com"
18	},
19	"endAt": "2022-11-22T04:37:12Z",
20	"expiryPeriodInDays": 30,
21	"lastRotatedAt": "2022-11-22T04:37:12Z",
22	"lastUsedAt": "2022-11-22T04:37:12Z",
23	"roles": [
24	{
25	"entityId": "clm8sgvai000008l794psbkdv",
26	"entityType": "WORKSPACE",
27	"role": "WORKSPACE_MEMBER",
28	"deploymentId": "clm8t5u4q000008jq4qoc3031"
29	}
30	],
31	"token": "token",
32	"updatedBy": {
33	"id": "clm8qv74h000008mlf08scq7k",
34	"apiTokenName": "my-token",
35	"avatarUrl": "https://avatar.url",
36	"fullName": "Jane Doe",
37	"subjectType": "USER",
38	"username": "user1@company.com"
39	}
40	}