Create an API token

Create an API token. An API token is an alphanumeric token that grants programmatic access to Astro for automated workflows. An API token can be scoped to an Organization or a Workspace.

Path parameters

organizationIdstringRequired

The ID of the Organization where you want to create the token.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
namestringRequired

The name of the API token.

rolestringRequired

The role of the API token.

typeenumRequired

The scope of the API token.

Allowed values:
descriptionstringOptional

The description for the API token.

entityIdstringOptional

The ID of the Workspace or Deployment to which the API token is scoped. It is required if Type is WORKSPACE or DEPLOYMENT.

tokenExpiryPeriodInDaysintegerOptional>=1<=3650

The expiry period of the API token in days. If not specified, the token will never expire.

Response

OK

createdAtdatetime

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.

namestring

The name of the API token.

shortTokenstring

The short value of the API token.

startAtdatetime

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

typeenum

The type of the API token.

Allowed values:
updatedAtdatetime

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

createdByobjectOptional
endAtdatetimeOptional

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

expiryPeriodInDaysintegerOptional

The expiry period of the API token in days.

lastUsedAtdatetimeOptional

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

roleslist of objectsOptional

The roles of the API token.

tokenstringOptional

The value of the API token.

updatedByobjectOptional

Errors