api

Create a new api token

Changed on

Create a new api token to use on behalf of the user creating it.

put/tokens

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/tokens
  • Auth
    API key in header Authorization

Request body

createdstring

A timestamp when this api key was created. You cannot change this value.

expires_atstring

The date when this key expires.

idinteger

The unique, numeric id of this api key.

owner_idinteger

The user ID of the token owner. When creating a token for a bot user, set this to the bot's ID. If omitted, defaults to the authenticated user.

permissionsModelsAPIPermissions
titlestring

A human-readable name for this token

tokenstring

The actual api key. Only visible after creation.

Response

The created token.

createdstring

A timestamp when this api key was created. You cannot change this value.

expires_atstring

The date when this key expires.

idinteger

The unique, numeric id of this api key.

owner_idinteger

The user ID of the token owner. When creating a token for a bot user, set this to the bot's ID. If omitted, defaults to the authenticated user.

permissionsModelsAPIPermissions
titlestring

A human-readable name for this token

tokenstring

The actual api key. Only visible after creation.

Changes

  • b03f30dcad8eRevision changes
    • breaking

      removed the success response with the status

    • info

      added the success response with the status