Sign in
api-key

Generate Api Key

Generate an api key for the user

post/api/v1/api-key

Request body

descriptionstring
read_onlyboolean
expires_atstring date-time nullable
workspacesstring[] nullable
role_idstring uuid nullable
org_role_idstring uuid nullable
default_workspace_idstring uuid nullable

Response

Successful Response

created_atstring date-time nullable
idstring uuid required
short_keystring required
descriptionstring required
read_onlyboolean
last_used_atstring date-time nullable
expires_atstring date-time nullable
workspace_namesstring[] nullable
default_workspace_namestring nullable
keystring required

Changes

Changed in 2 of the 48 revisions of this API.11

  • 7bbcecd856b21See the full diff
    • ●

      removed the optional property default_workspace_name from the response with the 200 status

      response-optional-property-removed

    This revision also has 25 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 22a3d45c511e1See the full diff
    • ○

      added the optional property default_workspace_name to the response with the 200 status

      response-optional-property-added