Skip to content

Update a custom response rule

PATCH
/api/v2/organizations/{organization}/projects/{project}/rules/custom-response/{rule}

Authorizations

Parameters

Path Parameters

organization
required
string

Organization identifier

project
required
string

Project identifier

rule
required
string

Rule identifier

Request Body required

object
custom_response_body
required

Custom response body content

string
<html><body>Custom maintenance page</body></html>
custom_response_status_code

HTTP status code for custom response

integer
default: 200
503
status_code

Legacy field for status code (deprecated)

integer
503
body

Legacy field for response body (deprecated)

string
<html><body>Maintenance</body></html>

Responses

200

The request has succeeded.

object
action_config
object
custom_response_body

Custom response body content

string
<html><body>Custom maintenance page</body></html>
custom_response_status_code

HTTP status code for custom response

integer
default: 200
503

400

The server could not understand the request due to invalid syntax.

object
message
required

Error message

string
The requested resource was not found
error
required

Error flag

boolean
true

403

Access is forbidden.

object
message
required

Error message

string
The requested resource was not found
error
required

Error flag

boolean
true