Update status page settings

PUT

/api/status-page/settings

curl --request PUT \
  --url https://gateway.example.com/api/status-page/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "enabled": true, "title": "example", "description": "example", "domain": "", "nodeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "ingressGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "sslCertificateId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "proxyTemplateId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "upstreamUrl": "", "publicIncidentLimit": 1, "recentIncidentDays": 1, "autoDegradedEnabled": true, "autoOutageEnabled": true, "autoDegradedSeverity": "info", "autoOutageSeverity": "info", "autoCreateThresholdSeconds": 1, "autoResolveThresholdSeconds": 1 }'

• Your Gateway instance

Authorizations

• bearerAuth

Request Body^required

JSON request body

Media typeapplication/json

object

enabled

boolean

title

string

>= 1 characters <= 120 characters

description

string

<= 500 characters

domain

Any of:

string

string

/^([a-zA-Z0-9]([a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z]{2,}$/

string

string

Allowed values: ""

nodeId

string | null format: uuid

ingressGroupId

string | null format: uuid

sslCertificateId

string | null format: uuid

proxyTemplateId

string | null format: uuid

upstreamUrl

Any of:

string

string format: uri

string

string

Allowed values: ""

null

null

publicIncidentLimit

integer

>= 1 <= 100

recentIncidentDays

integer

>= 1 <= 365

autoDegradedEnabled

boolean

autoOutageEnabled

boolean

autoDegradedSeverity

string

Allowed values: info warning critical

autoOutageSeverity

string

Allowed values: info warning critical

autoCreateThresholdSeconds

integer

>= 30 <= 86400

autoResolveThresholdSeconds

integer

>= 30 <= 86400

Responses

200

Successful response

Media typeapplication/json

object

data

required

Resource object. Exact fields depend on the endpoint.

object

id

string

name

string

key

additional properties

Example

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "API",
    "status": "operational",
    "public": true
  }
}

400

Bad request

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "details": [
    {
      "path": [
        "name"
      ],
      "message": "Required"
    }
  ]
}

401

Authentication required

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNAUTHORIZED",
  "message": "Authentication required"
}

403

Forbidden

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "FORBIDDEN",
  "message": "Insufficient permissions"
}

404

Not found

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "NOT_FOUND",
  "message": "Resource not found"
}

409

Conflict

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "CONFLICT",
  "message": "Resource already exists"
}

422

Unprocessable entity

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNPROCESSABLE_ENTITY",
  "message": "Request could not be processed"
}

500

Internal server error

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "INTERNAL_ERROR",
  "message": "Internal server error"
}