Custom Response

Overview

The Custom Response policy action returns a hard-coded response back to the client that made a request to your endpoint.

Example

YAML

actions:
  - type: custom-response
    config:
      status_code: 400
      content_type: application/json
      content: '{"error":{"message":"Bad Request"}}'

JSON

{
  "actions": [
    {
      "type": "custom-response",
      "config": {
        "status_code": 400,
        "content_type": "application/json",
        "content": "{\"error\":{\"message\":\"Bad Request\"}}"
      }
    }
  ]
}

Behavior

When executed as an inbound policy, this action bypasses the upstream server and immediately returns to the caller with the configured response. When executed as an outbound policy, the response from the upstream server is overwritten with the configured response.

If this action is executed, no further actions in the traffic policy will be executed.

Configuration

Type
custom-response

Parameter		Description
status_code	int	The status code of the response.
content_type	string	The content type of the response body, which will be set on the Content-Type header. Required if content is set.
content	string	The body of the response.