Check an API key
POST/login
Checks the API key in the x-api-key and x-api-key-secret headers and returns the name and description of the key, the key's permissions on object types and whether the key is an admin API key. The request has no body. The response has status 201, although the operation creates no object.
Permissions. None. Any valid API key can call the operation.
Authenticate describes the authentication headers.
Responses
- 201
- 401
- 503
The key is valid. The body contains the name and description of the key, the key's permissions on object types and the admin flag.
The authentication headers are missing or invalid, or the API key is inactive or expired. Errors lists the messages.
The API server could not check the key, for example because the database is unavailable (Unable to validate the API key; try again later). The key itself can be valid.