Configure a Custom Error Page

Introduction

Goal

Direct traffic to a 503 error page when distribution deployment goes wrong.

Background

The custom error page configuration feature allows you to configure a project specific HTML error page with custom information, like contact details or alternate website, when the site is unavailable due to mis-configuration or incorrect distribution deployment etc.

Note: UI for this is work in progress, we will update when it is available.

Instructions

Custom error page enablement is done in two steps:

1. Upload the custom errorpage.html in Mission Control through Files > Configurations (switch tab) > Upload configuration file.
2. Associate the custom error page (file-id) to the error code '503'.

For Step 1, you can use both API and Mission Control, for step 2 only API (for now) as below

curl -X POST \
  http://api-{stack name}.onehippo.io/v3/customerrorpages/503 \
  -H 'authorization: Bearer eyJhXYZg' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -d '{
  "fileId": "aaaaad-1111-111a-a1aa-aaaaaaaaaa"
}'

You can find the file-id by this query:

curl -X GET \
  http://api-{stack name}.onehippo.io/v3/distributions \
  -H 'authorization: Bearer eyJhXYZg' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json; charset=utf-8'