Create an Agent API token | Astronomer Documentation

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

{
  "createdAt": "2022-11-22T04:37:12Z",
  "description": "my token description",
  "id": "clm8q7f6q000008lcgyougpsk",
  "kind": "STANDARD",
  "name": "My token",
  "scope": "DEPLOYMENT",
  "shortToken": "short-token",
  "startAt": "2022-11-22T04:37:12Z",
  "updatedAt": "2022-11-22T04:37:12Z",
  "createdBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  },
  "endAt": "2022-11-22T04:37:12Z",
  "expiryPeriodInDays": 30,
  "lastRotatedAt": "2022-11-22T04:37:12Z",
  "lastUsedAt": "2022-11-22T04:37:12Z",
  "roles": [
    {
      "entityId": "clm8sgvai000008l794psbkdv",
      "entityType": "DEPLOYMENT",
      "role": "WORKSPACE_MEMBER",
      "deploymentId": "clm8t5u4q000008jq4qoc3031"
    }
  ],
  "token": "token",
  "updatedBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  }
}

Create an Agent API token for remote workers.

Authentication

AuthorizationBearer

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

Path parameters

organizationIdstringRequired

The ID of the organization that owns the deployment where you want to create the Agent API token.

deploymentIdstringRequired

The ID of the deployment where you want to create the Agent API token.

Request

This endpoint expects an object.

namestringRequired

The name of the API token.

descriptionstringOptional

The description for the API token.

tokenExpiryPeriodInDaysintegerOptional1-3650

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

Response

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.

kindenum

The kind of the API token.

namestring

The name of the API token.

scopeenum

The scope 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.

updatedAtdatetime

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

createdByobject

endAtdatetime

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.

lastRotatedAtdatetime

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

lastUsedAtdatetime

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

Create Agent Token Body Bad Request Error

401

Create Agent Token Body Unauthorized Error

403

Create Agent Token Body Forbidden Error

404

Create Agent Token Body Not Found Error

500

Create Agent Token Body Internal Server Error