Rotate API token

POST

Rotate an API token. Creates a new API token and invalidates the one you specify. Any workflows using the previous value stop working.

Path parameters

organizationIdstringRequired

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

tokenIdstringRequired

The token to rotate

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
Allowed values: DEPLOYMENTWORKSPACEORGANIZATION

The type of the API token.

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
Built with