BEbetagouv
Keys

Create Key

Changed on

Create a new API key for the authenticated user.

post/v1/keys

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Request body

namestring required

Name of the key.

expiresinteger nullable

Expiration time, as Unix timestamp. If None, uses the configured maximum key lifetime when set, otherwise the key never expires.

Example request

{
  "name": "key-1"
}

Response

Successful Response

object'key'

Type of the object.

idinteger required

ID of the key.

namestring required

Name of the key.

valuestring required

Value of the key.

user_idinteger required

ID of the user that owns the key.

expiresinteger nullable

Time of expiration, as Unix timestamp. If None, the key never expires.

createdinteger required

Time of creation, as Unix timestamp.

revokedboolean required

Whether the key has been revoked.

Changes