Update Global API Key

Update the metadata of an existing global API key See Using Global API Keys for more information on permission and scope requirements.

SecuritybearerAuth
Request
path Parameters
keyId
required
integer <int64> ( 0 .. 999999999 ]

API key ID

Request Body schema: application/json
required
is_enabled
required
boolean

Whether the API key is enabled

Responses
200

OK

4XX

Invalid Request

default

Invalid Request

put/global/api_keys/{keyId}
Request samples
application/json
{
  • "is_enabled": true
}
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"
    }
}