Platform APIAPI Key Management

Update an API key

When authenticated with an API key, this operation requires api-admin.

Authentication

AuthorizationBearer
Console user session or Mixlayer API key supplied as a Bearer token.

Path parameters

org_idstringRequired
Organization ID
key_idstringRequired
API key ID

Request

This endpoint expects an object.
activebooleanOptional
Set to false to disable the key or true to enable it.
expires_atdatetime or nullOptional
Timestamp sets the expiration, null clears it, and omission leaves it unchanged. A new timestamp must be in the future.
namestringOptional<=200 characters
New key name. Whitespace is trimmed and the maximum length is 200 characters.
permissionslist of enumsOptional
Replacement permission list, which must contain at least one permission.

Response

API key updated

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
413
Content Too Large Error
415
Unsupported Media Type Error
422
Unprocessable Entity Error
500
Internal Server Error