Sign in

v1

latestOpenAPI 3.0.02026-07-17715665.1 KB
API Key

Create API key

post/api/api-key

Request body

descriptionstring required
role'USER' | 'QUANTIFIER' | 'FORWARDER' | 'ADMIN' | 'ROOT' | 'API_KEY_READWRITE' | 'API_KEY_READ' | 'API_KEY_DISCORD_BOT' | 'API_KEY_SETUP_WEB' required

Example request

{
  "description": "My API Key"
}

Response

API key created

_idstring required
namestring required
descriptionstring required
hashstring required
role'USER' | 'QUANTIFIER' | 'FORWARDER' | 'ADMIN' | 'ROOT' | 'API_KEY_READWRITE' | 'API_KEY_READ' | 'API_KEY_DISCORD_BOT' | 'API_KEY_SETUP_WEB' required
createdAtstring date-time required
updatedAtstring date-time required
keystring required

Example response

{
  "_id": "639b178f19296ee0f2d0585d",
  "name": "89f7edbd",
  "description": "My API Key",
  "hash": "$2b$10$hfRNI.V7ewuN/K.5eSt6oelaQ.FDj6irfUNR9wkKnL/qsNT23aE4i",
  "key": "1834a97caed67b244dd11fa5ef53aa74f13781ad0aea8148b8607d861d9f7535"
}