Skip to main content

Create API token

POST /api/admin/api-tokens

Create an API token of a specific type: one of client, admin, frontend.

Request​

Body

required

createApiTokenSchema

    oneOf
  • expiresAt date-time

    The time when this token should expire.

  • type string required

    Possible values: Value must match regular expression ^[Aa][Dd][Mm][Ii][Nn]$

    An admin token. Must be the string "admin" (not case sensitive).

  • tokenName string required

    The name of the token.

Responses

The resource was successfully created.

Response Headers
  • location string

    The location of the newly created resource.

Schema
  • secret string required

    The token used for authentication.

  • username string deprecated

    This property was deprecated in Unleash v5. Prefer the tokenName property instead.

  • tokenName string required

    A unique name for this particular token

  • type string required

    Possible values: [client, admin, frontend]

    The type of API token

  • environment string

    The environment the token has access to. * if it has access to all environments.

  • project string required

    The project this token belongs to.

  • projects string[] required

    The list of projects this token has access to. If the token has access to specific projects they will be listed here. If the token has access to all projects it will be represented as [*]

  • expiresAt date-time nullable

    The token's expiration date. NULL if the token doesn't have an expiration set.

  • createdAt date-time required

    When the token was created.

  • seenAt date-time nullable

    When the token was last seen/used to authenticate with. NULL if the token has not yet been used for authentication.

  • alias string nullable

    Alias is no longer in active use and will often be NULL. It's kept around as a way of allowing old proxy tokens created with the old metadata format to keep working.

Loading...