Create an Agent API token
Create an Agent API token for remote workers.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the organization that owns the deployment where you want to create the Agent API token.
The ID of the deployment where you want to create the Agent API token.
Body
The request body for creating an Agent API Token.
The name of the API token.
"My token"
The description for the API token.
"This is my API token"
The expiry period of the API token in days. If not specified, the token will never expire.
1 <= x <= 365030
Response
OK
The time when the API token was created in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.
"2022-11-22T04:37:12Z"
The description of the API token.
"my token description"
The API token's ID.
"clm8q7f6q000008lcgyougpsk"
The kind of the API token.
STANDARD, DIRECT_ACCESS "STANDARD"
The name of the API token.
"My token"
The scope of the API token.
DEPLOYMENT, WORKSPACE, ORGANIZATION "WORKSPACE"
The short value of the API token.
"short-token"
The time when the API token will become valid in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.
"2022-11-22T04:37:12Z"
The time when the API token was last updated in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.
"2022-11-22T04:37:12Z"
The time when the API token expires in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.
"2022-11-22T04:37:12Z"
The expiry period of the API token in days.
30
The time when the API token was last rotated in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.
"2022-11-22T04:37:12Z"
The time when the API token was last used in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.
"2022-11-22T04:37:12Z"
The roles of the API token.
The value of the API token.
"token"