Create a project API token.

POST 
/api/admin/projects/:projectId/api-tokens

Endpoint that allows creation of project API tokens for the specified project.

Request

Path Parameters

projectId stringrequired

application/json

Body

required

createApiTokenSchema

oneOf

MOD1

expiresAt date-time

The time when this token should expire.

Example: 2023-07-04T11:26:24+02:00

type stringrequired

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

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

Example: admin

tokenName stringrequired

The name of the token.

Example: token-64522

MOD2

expiresAt date-time

The time when this token should expire.

Example: 2023-07-04T11:26:24+02:00

type stringrequired

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

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

Example: admin

username stringrequireddeprecated

The name of the token. This property was deprecated in v5. Use tokenName instead.

Example: token-64523

MOD3

expiresAt date-time

The time when this token should expire.

Example: 2023-07-04T11:26:24+02:00

type stringrequired

A client or frontend token. Must be one of the strings "client" or "frontend" (not case sensitive).

Possible values: Value must match regular expression ^([Cc][Ll][Ii][Ee][Nn][Tt]|[Ff][Rr][Oo][Nn][Tt][Ee][Nn][Dd])$

Example: frontend

environment string

The environment that the token should be valid for. Defaults to "default"

Example: development

project string

The project that the token should be valid for. Defaults to "*" meaning every project. This property is mutually incompatible with the projects property. If you specify one, you cannot specify the other.

Example: project-851

projects string[]

A list of projects that the token should be valid for. This property is mutually incompatible with the project property. If you specify one, you cannot specify the other.

Example: ["project-851","project-852"]

tokenName stringrequired

The name of the token.

Example: token-64522

MOD4

expiresAt date-time

The time when this token should expire.

Example: 2023-07-04T11:26:24+02:00

type stringrequired

A client or frontend token. Must be one of the strings "client" or "frontend" (not case sensitive).

Possible values: Value must match regular expression ^([Cc][Ll][Ii][Ee][Nn][Tt]|[Ff][Rr][Oo][Nn][Tt][Ee][Nn][Dd])$

Example: frontend

environment string

The environment that the token should be valid for. Defaults to "default"

Example: development

project string

The project that the token should be valid for. Defaults to "*" meaning every project. This property is mutually incompatible with the projects property. If you specify one, you cannot specify the other.

Example: project-851

projects string[]

A list of projects that the token should be valid for. This property is mutually incompatible with the project property. If you specify one, you cannot specify the other.

Example: ["project-851","project-852"]

username stringrequireddeprecated

The name of the token. This property was deprecated in v5. Use tokenName instead.

Example: token-64523

Responses

201

The resource was successfully created.

Response Headers

• location

  string

  The location of the newly created resource.

application/json

Schema

Schema

secret stringrequired
The token used for authentication.
Example: project:environment.xyzrandomstring
username stringdeprecated
This property was deprecated in Unleash v5. Prefer the tokenName property instead.
Example: a-name
tokenName stringrequired
A unique name for this particular token
Example: some-user
type stringrequired
The type of API token
Possible values: [client, admin, frontend]
Example: client
environment string
The environment the token has access to. * if it has access to all environments.
Example: development
project stringrequired
The project this token belongs to.
Example: developerexperience
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 [*]
Example: ["developerexperience","enterprisegrowth"]
expiresAt date-timenullable
The token's expiration date. NULL if the token doesn't have an expiration set.
Example: 2023-04-19T08:15:14.000Z
createdAt date-timerequired
When the token was created.
Example: 2023-04-19T08:15:14.000Z
seenAt date-timenullable
When the token was last seen/used to authenticate with. NULL if the token has not yet been used for authentication.
Example: 2023-04-19T08:15:14.000Z
alias stringnullable
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.
Example: randomid-or-some-alias

Example (from schema)

{
  "secret": "project:environment.xyzrandomstring",
  "tokenName": "some-user",
  "type": "client",
  "environment": "development",
  "project": "developerexperience",
  "projects": [
    "developerexperience",
    "enterprisegrowth"
  ],
  "expiresAt": "2023-04-19T08:15:14.000Z",
  "createdAt": "2023-04-19T08:15:14.000Z",
  "seenAt": "2023-04-19T08:15:14.000Z",
  "alias": "randomid-or-some-alias"
}

400

The request data does not match what we expect.

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: ValidationError
message string
A description of what went wrong.
Example: The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent [].

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "ValidationError",
  "message": "The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent []."
}

401

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: AuthenticationRequired
message string
A description of what went wrong.
Example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

403

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: NoAccessError
message string
A description of what went wrong.
Example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

404

The requested resource was not found.

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: NotFoundError
message string
A description of what went wrong.
Example: Could not find the addon with ID "12345".

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NotFoundError",
  "message": "Could not find the addon with ID \"12345\"."
}

Loading...