Set Status Code Policy

Sets the status code on the on the outgoing response.

Configuration

The configuration shows how to configure the policy in the 'policies.json' document.

Code(json)
 
{
  "name": "my-set-status-outbound-policy",
  "policyType": "set-status-outbound",
  "handler": {
    "export": "SetStatusOutboundPolicy",
    "module": "$import(@zuplo/runtime)",
    "options": {
      "status": 200,
      "statusText": "OK"
    }
  }
}

Policy Configuration

• name <string> - The name of your policy instance. This is used as a reference in your routes.
• policyType <string> - The identifier of the policy. This is used by the Zuplo UI. Value should be set-status-outbound.
• handler.export <string> - The name of the exported type. Value should be SetStatusOutboundPolicy.
• handler.module <string> - The module containing the policy. Value should be $import(@zuplo/runtime).
• handler.options <object> - The options for this policy. See Policy Options below.

Policy Options

The options for this policy are specified below. All properties are optional unless specifically marked as required.

• status <number> - The status code to be used in the response.
• statusText <string> - The statusText to be used in the response.

Using the Policy

Read more about how policies work