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
- application/json
Body
required
createApiTokenSchema
- MOD1
- MOD2
- MOD3
- MOD4
oneOf
The time when this token should expire.
2023-07-04T11:26:24+02:00
An admin token. Must be the string "admin" (not case sensitive).
Possible values: Value must match regular expression ^[Aa][Dd][Mm][Ii][Nn]$
admin
The name of the token.
token-64522
The time when this token should expire.
2023-07-04T11:26:24+02:00
An admin token. Must be the string "admin" (not case sensitive).
Possible values: Value must match regular expression ^[Aa][Dd][Mm][Ii][Nn]$
admin
The name of the token. This property was deprecated in v5. Use tokenName
instead.
token-64523
The time when this token should expire.
2023-07-04T11:26:24+02:00
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])$
frontend
The environment that the token should be valid for. Defaults to "default"
development
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.
project-851
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.
["project-851","project-852"]
The name of the token.
token-64522
The time when this token should expire.
2023-07-04T11:26:24+02:00
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])$
frontend
The environment that the token should be valid for. Defaults to "default"
development
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.
project-851
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.
["project-851","project-852"]
The name of the token. This property was deprecated in v5. Use tokenName
instead.
token-64523
Responses
- 201
- 400
- 401
- 403
- 404
The resource was successfully created.
Response Headers
location
string
The location of the newly created resource.
- application/json
- Schema
- Example (from schema)
Schema
The token used for authentication.
project:environment.xyzrandomstring
This property was deprecated in Unleash v5. Prefer the tokenName
property instead.
a-name
A unique name for this particular token
some-user
The type of API token
Possible values: [client
, admin
, frontend
]
client
The environment the token has access to. *
if it has access to all environments.
development
The project this token belongs to.
developerexperience
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 [*]
["developerexperience","enterprisegrowth"]
The token's expiration date. NULL if the token doesn't have an expiration set.
2023-04-19T08:15:14.000Z
When the token was created.
2023-04-19T08:15:14.000Z
When the token was last seen/used to authenticate with. NULL if the token has not yet been used for authentication.
2023-04-19T08:15:14.000Z
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.
randomid-or-some-alias
{
"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"
}
The request data does not match what we expect.
- application/json
- Schema
- Example (from schema)
Schema
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
ValidationError
A description of what went wrong.
The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent [].
{
"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 []."
}
Authorization information is missing or invalid. Provide a valid API token as the authorization
header, e.g. authorization:*.*.my-admin-token
.
- application/json
- Schema
- Example (from schema)
Schema
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
AuthenticationRequired
A description of what went wrong.
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.
{
"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."
}
The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation
- application/json
- Schema
- Example (from schema)
Schema
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
NoAccessError
A description of what went wrong.
You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "NoAccessError",
"message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}
The requested resource was not found.
- application/json
- Schema
- Example (from schema)
Schema
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
NotFoundError
A description of what went wrong.
Could not find the addon with ID "12345".
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "NotFoundError",
"message": "Could not find the addon with ID \"12345\"."
}