Create Global API Key

Create a new global API key assigned to the authenticated user See Using Global API Keys for more information on permission and scope requirements.

SecuritybearerAuth
Request
Request Body schema: application/json
required
name
required
string [ 0 .. 255 ] characters

Name of the global API key

expires_at
string <date-time>

Optional expiration date for the API key (ISO 8601 format)

Responses
200

OK

400

Invalid Request

401

Access token is missing or invalid

403

You do not have permission to perform this action.

404

Entity not found

429

Too many requests

503

Service Unavailable

default

Invalid Request

post/global/api_keys
Request samples
application/json
{
  • "name": "New API Key",
  • "expires_at": "2025-08-20T23:59:59-05:00"
}
Response samples
application/json
{
  • "id": 1,
  • "name": "Test Multi Org Key",
  • "is_enabled": true,
  • "created_at": "2020-08-04T18:21:47-04:00",
  • "expires_at": "2020-08-05T18:21:47-04:00",
  • "user": {
    • "id": "123e4567-e89b-12d3-a456-426614174000",
    • "first_name": "John",
    • "last_name": "Doe",
    • "email": "john.doe@automox.com"
    }
}