Suspend an API key
POST
/api/api-keys/{id}/suspend
deprecated
Requires: ApiKeyAuthorization.ApiKeys, ApiKeyAuthorization.ApiKeys.Suspend, merchant scope.
Temporarily takes the key out of service. The next request presenting it is refused with KEY_SUSPENDED. Unlike revoking, this can be undone: the same key value works again once it is reinstated. A revoked key cannot be suspended, because revocation is permanent. A suspended key cannot be rotated until it is reinstated.
Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.
Example request
Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.
The request body is a SuspendApiKeyDto. See the Request body section below for its fields.
Parameters
Request body
application/json
, required
| Field | Type | Description |
|---|---|---|
reason
required |
string | Gets or sets an optional operator-supplied reason, retained on the key while the suspension
is in force and recorded in the audit trail.
nullablemax length 256
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This request body has no documented fields.
Responses
200 OK
Body:
ApiKeyDto
ApiKeyDto
Each item has these fields.
| Field | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
id
required |
string (uuid) | Unique identifier of the API key record
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
name
required |
string | Human-friendly label used to identify the key in UI and logs
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
keyPrefix
required |
string | Gets or sets the leading characters of the key value, safe to display. `null` for a key
the rewrap backfill has not reached.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
last4
required |
string | Gets or sets the trailing characters of the key value, safe to display. `null` for a key
the rewrap backfill has not reached.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
environment
required |
ApiKeyEnvironment ApiKeyEnvironment | Gets or sets which world the key acts in, or `null` when it has never been stamped.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
status
required |
ApiKeyStatus ApiKeyStatus | Gets or sets the key's administrative state.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
maskedKey
required |
string | Gets the key's display form: its retained prefix, an ellipsis, and its last characters. This
is the only representation of the value any read path carries.
nullableread only
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
lastUsedAt
required |
string (date-time) | Gets or sets the UTC instant the key was last used to authenticate, or `null` when it
has no recorded use.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
creationTime
required |
string (date-time) | Gets or sets the UTC instant the key was created.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
merchantId
required |
string (uuid) | Gets or sets the merchant the key was minted for, or `null` when it is not tied to one.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
active
required |
boolean | Indicates whether the key is currently enabled for use
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
expireAt
required |
string (date-time) | Optional UTC timestamp when the key will expire (null means no expiration)
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
userId
required |
string (uuid) | Identifier of the user or service account that owns this key
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
replacesKeyId
required |
string (uuid) | Gets or sets the key this one was minted to replace, or `null` when it was not created
by a rotation.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
replacedByKeyId
required |
string (uuid) | Gets or sets the key minted to replace this one, or `null` when it has not been rotated.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
overlapExpiresAt
required |
string (date-time) | Gets or sets when this key's rotation overlap closes and it stops authenticating, or
`null` when it is not in one.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
allowedCidrs
required |
array of string array of | Gets or sets the source addresses this key may be used from, as CIDR ranges or bare
addresses, or `null` when it is not bound to any and may be used from anywhere.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
scopes
required |
array of string array of | Gets or sets the capability scopes this key is restricted to, or `null` when it is
unrestricted and may reach everything its owner can.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This response has no documented body fields.
403 Forbidden
Body:
RemoteServiceErrorResponse
RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo RemoteServiceErrorInfo |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This response has no documented body fields.
401 Unauthorized
Body:
RemoteServiceErrorResponse
RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo RemoteServiceErrorInfo |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This response has no documented body fields.
400 Bad Request
Body:
RemoteServiceErrorResponse
RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo RemoteServiceErrorInfo |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This response has no documented body fields.
404 Not Found
Body:
RemoteServiceErrorResponse
RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo RemoteServiceErrorInfo |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This response has no documented body fields.
501 Not Implemented
Body:
RemoteServiceErrorResponse
RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo RemoteServiceErrorInfo |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This response has no documented body fields.
500 Internal Server Error
Body:
RemoteServiceErrorResponse
RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo RemoteServiceErrorInfo |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This response has no documented body fields.
default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take. The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take.
Body:
RemoteServiceErrorResponse
RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo RemoteServiceErrorInfo |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This response has no documented body fields.
429 The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.
Body:
RemoteServiceErrorResponse
RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo RemoteServiceErrorInfo |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This response has no documented body fields.
Errors
A failed request returns the platform error envelope. The
error reference lists every value
error.code can carry and shows the four response shapes.