Skip to main content
POST
/
api-key
curl --request POST \
  --url https://api.example.com/api-key \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Pontua Bot",
  "expiresIn": "7d",
  "permissions": [
    "read"
  ]
}
'
{
  "status": true,
  "mensagem": "OK"
}

Body

application/json

The API Key to be created

​
name
string
required

Name of the key

Example:

"Pontua Bot"

​
permissions
enum<string>[]
required

Permissions for the key

Available options:
read,
write,
update,
delete
​
expiresIn
enum<string>
default:7d
required

Expiration option

Available options:
7d,
30d,
45d,
90d,
180d,
1y,
5y

Response

The created API Key in message

​
status
boolean
required

Status da operação

Example:

true

​
mensagem
string

Mensagem de retorno

Example:

"OK"