Proxy Rules

Update a Proxy Rule

patch/api/proxy-rules/{id}

Request

  • Base URL: https://hellosafe.com
  • URL: https://hellosafe.com/api/proxy-rules/{id}
  • Auth: OAuth 2 (password, token URL /api//openapi-auth)

Request body

urlstring nullable
domain'hellosafe.ca' | 'hellosafe.fr' | 'hellosafe.be' | 'hellosafe.ch' | 'hellosafe.es' | 'hellosafe.it' | 'hellosafe.pt' | 'hellosafe.nl' | 'hellosafe.com.br' | 'hellosafe.com.mx' | 'hellosafe.com' | 'hellosafe.co.uk' | 'hellosafe.ma' | 'hellosafe.jp' | 'hellosafe.com.au' | 'hellosafe.sg' | 'hellosafe.cn' | 'hellosafe.vn' | 'hellosafe.tw' | 'hellosafe.hk' | 'hellosafe.fi' | 'hellosafe.pl' | 'hellosafe.cz' | 'hellosafe.at' | 'hellosafe.ie' | 'hellosafe.in' | 'hellosafe.ph' | 'hellosafe.ae' | 'hellosafe.co.za' | 'hellosafe.nz' | 'hellosafe.lu' | 'hello-safe.de' | 'hello-safe.se' | 'hello-safe.dk'

The HelloSafe domain whose URL you want to override.

sourcePathstring

The exact path on that domain to override. Leading slash, no query string.

targetstring

Absolute URL whose page is rendered in place of the source URL (a Payload page, a static page, etc.).

pagestring

ID of the pages

pageLocalestring nullable

Which locale of that page this rule publishes (e.g. fr-ma for hellosafe.ma).

status'draft' | 'active'

Only "active" rules are served to the interceptors.

Response

Proxy Rule object

idstring required
urlstring nullable
domain'hellosafe.ca' | 'hellosafe.fr' | 'hellosafe.be' | 'hellosafe.ch' | 'hellosafe.es' | 'hellosafe.it' | 'hellosafe.pt' | 'hellosafe.nl' | 'hellosafe.com.br' | 'hellosafe.com.mx' | 'hellosafe.com' | 'hellosafe.co.uk' | 'hellosafe.ma' | 'hellosafe.jp' | 'hellosafe.com.au' | 'hellosafe.sg' | 'hellosafe.cn' | 'hellosafe.vn' | 'hellosafe.tw' | 'hellosafe.hk' | 'hellosafe.fi' | 'hellosafe.pl' | 'hellosafe.cz' | 'hellosafe.at' | 'hellosafe.ie' | 'hellosafe.in' | 'hellosafe.ph' | 'hellosafe.ae' | 'hellosafe.co.za' | 'hellosafe.nz' | 'hellosafe.lu' | 'hello-safe.de' | 'hello-safe.se' | 'hello-safe.dk' required

The HelloSafe domain whose URL you want to override.

sourcePathstring required

The exact path on that domain to override. Leading slash, no query string.

targetstring required

Absolute URL whose page is rendered in place of the source URL (a Payload page, a static page, etc.).

pageLocalestring nullable

Which locale of that page this rule publishes (e.g. fr-ma for hellosafe.ma).

status'draft' | 'active' required

Only "active" rules are served to the interceptors.

updatedAtstring required
createdAtstring required

Changes

No recorded changes to this operation across all 1 revision of this API.