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 misconfiguration or incorrect distribution deployment etc.

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 (fileId) 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 \
  https://api.{stack_name}.bloomreach.cloud/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 fileId using this query:

curl -X GET \
  https://api.{stack_name}.bloomreach.cloud/v3/appconfigfiles \
  -H 'authorization: Bearer eyJhXYZg' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json; charset=utf-8'