Edit error response settings

put

https://{hostname}/api-definitions/v2/endpoints/{apiEndPointId}/versions/{versionNumber}/settings/error-responses

Updates the error response settings configured for an endpoint version.

Path Params

versionNumber

integer

required

The unique identifier for the endpoint version.

apiEndPointId

integer

required

The unique identifier for the endpoint.

Query Params

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

Error response settings configured for an endpoint. If an inbound client request fails, API Gateway returns a default error response with a JSON-formatted description and a status code. You can customize the descriptions, status codes, and headers of selected error responses to help API consumers identify the cause of an error and troubleshoot effectively. You can configure error response settings if the API Gateway product is in your contract.

API_KEY_FORBIDDEN

object

A customizable error response. You can customize the following error types: API_KEY_INVALID, API_KEY_FORBIDDEN, QUOTA_EXCEEDED, JWT_SIGNATURE_INVALID, JWT_CLAIM_VALUE_INVALID.

API_KEY_INVALID

object

A customizable error response. You can customize the following error types: API_KEY_INVALID, API_KEY_FORBIDDEN, QUOTA_EXCEEDED, JWT_SIGNATURE_INVALID, JWT_CLAIM_VALUE_INVALID.

JWT_CLAIM_VALUE_INVALID

object

A customizable error response. You can customize the following error types: API_KEY_INVALID, API_KEY_FORBIDDEN, QUOTA_EXCEEDED, JWT_SIGNATURE_INVALID, JWT_CLAIM_VALUE_INVALID.

JWT_SIGNATURE_INVALID

object

A customizable error response. You can customize the following error types: API_KEY_INVALID, API_KEY_FORBIDDEN, QUOTA_EXCEEDED, JWT_SIGNATURE_INVALID, JWT_CLAIM_VALUE_INVALID.

QUOTA_EXCEEDED

object

A customizable error response. You can customize the following error types: API_KEY_INVALID, API_KEY_FORBIDDEN, QUOTA_EXCEEDED, JWT_SIGNATURE_INVALID, JWT_CLAIM_VALUE_INVALID.

Headers

accept

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json