Edit an error response

put

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

Updates a customizable error response of the selected type.

Path Params

type

string

enum

required

Enum The type of the customizable error response.

Allowed:

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

body

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

statusCode

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

Language

URL

Response

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

application/json

application/problem+json

200The response reflects the updated error response.

400Bad request. Some of your request's input is invalid.

401Unauthorized. You aren't authorized to perform the action.

403Forbidden. You don't have permission to access the API endpoint.

404Not found. This API endpoint doesn't exist.

405Method not allowed.

415Unsupported Media Type.