Skip to main content

Rotate an API key's secret


Replaces an API key's secret with the backup secret. If no backup secret is set, the secret will be replaced with a newly generated value.


Path Parameters

    id stringrequired

    The id of the API Key


200: Successful response

401: Authentication error

403: Authorization error

404: Resource not found

Request samples

curl -L -X POST '' \
-H 'Accept: application/json'

Response samples

"data": {
"id": "f30e7596-586e-44e1-ae7d-53db10f144d3",
"description": "Tommy's Key",
"secret": "XXXXXXXXXXXXX",
"backup_secret": "XXXXXXXXXXXXX",
"status": "active",
"permission_groups": [
"admin": true,
"record_type": "api_key",
"created_at": "2018-02-08T18:49:22.998023Z",
"updated_at": "2018-02-08T18:49:22.998023Z"