Create Key

View as Markdown

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
namestring or nullOptional

Optional human-readable key name.

scopeslist of strings or nullOptional

Explicit scope grants for this key. Omit or pass an empty list for a full-access key.

Response

API key created
full_accessboolean
Whether this key has full access because no scopes were attached.
idstring
keystring
key_prefixstring
scopeslist of strings
Explicit scopes attached to the key. Empty means full access.
namestring or null