Admin APIApi keys
Revoke API Key
Revokes an API key. If the API key is a secret, it can't be used for authentication anymore. If it's publishable, it can't be used by client applications.
AuthorizationBearer <token>
In: header
Path Parameters
id*string
The API key's ID.
Query Parameters
fields?string
Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.
Request Body
application/json
revoke_in?number
The time in seconds to revoke the API key after. If not set, the API key is revoked immediately.
Response Body
application/json
application/json
text/plain
application/json
application/json
application/json
application/json
curl -X POST "https://{tenant}.api.myxclade.com/admin/api-keys/string/revoke" \ -H "Content-Type: application/json" \ -d '{}'{
"api_key": {
"id": "string",
"token": "string",
"redacted": "sk_...123",
"title": "string",
"type": "secret",
"last_used_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"created_at": "2019-08-24T14:15:22Z",
"revoked_by": "string",
"revoked_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
}{
"message": "Discount must be set to dynamic",
"type": "not_allowed"
}"Unauthorized"{
"message": "Entity with id 1 was not found",
"type": "not_found"
}{
"code": "unknown_error",
"message": "The request conflicted with another request. You may retry the request with the provided Idempotency-Key.",
"type": "QueryRunnerAlreadyReleasedError"
}{
"code": "invalid_request_error",
"message": "Discount with code TEST already exists.",
"type": "duplicate_error"
}{
"code": "api_error",
"message": "An error occured while hashing password",
"type": "database_error"
}