API

Edit an error response

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

Updates a customizable error response of the selected type.

Path Params
string
enum
required

Enum The type of the customizable error response.

Allowed:
integer
required

The unique identifier for the endpoint version.

integer
required

The unique identifier for the endpoint.

Query Params
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

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.

string

The response body to return in case of the error. The value should have the proper formatting to reflect the content type. For example, in case of a JSON body format, enclose the text in curly brackets ({}).

headers
array of objects

HTTP headers to return in case of the error. By default, API Gateway returns the Content-Type header with a value of application/problem+json which reflects the default response body. If the body member indicates a different content type, set the Content-Type header to the appropriate value. For example, in case of an XML body, the value could be application/problem+xml.

headers
integer
required

The status code to return in case of the error.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 4 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 4 months ago