Skip to main content
POST
Update status page

Restrictions

Usage

  • A field that is omitted or null keeps its value; an empty string clears a string field.
  • custom_links cannot be cleared: an omitted or empty array keeps the current links.
  • A new url_name is normalized to a slug and must be unique among the account’s pages of the same type; custom_domain is rejected for internal pages.
  • Every call is recorded in the account audit log. Don’t put secrets in request fields.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

Parameters for updating an existing status page. All fields except page_id are optional; omit a field or pass null to keep its existing value.

page_id
integer<int64>
required

Status page ID; obtain it from GET /status-page/list.

name
string | null

Display name of the status page. Omit or pass null to keep the existing value.

Maximum string length: 255
url_name
string | null

URL-safe slug; normalized to lowercase with non-alphanumeric characters replaced by hyphens, and must be unique among the account's pages of the same type. Omit or pass null to keep the existing value.

Maximum string length: 255
custom_domain
string | null

Custom domain for a public status page; must not be used by another status page. Rejected for internal pages. Omit or pass null to keep the existing value; an empty string removes the domain.

Maximum string length: 255
page_title
string | null

Accepted for compatibility but not stored; it has no effect.

logo
string | null

Logo image of the status page. Omit or pass null to keep the existing value.

dark_logo
string | null

Dark-mode logo image of the status page. Omit or pass null to keep the existing value.

logo_url
string | null

URL opened when the logo is clicked. Omit or pass null to keep the existing value.

Maximum string length: 255
favicon
string | null

Favicon of the status page. Omit or pass null to keep the existing value.

page_header
string | null

Header content shown on the status page. Omit or pass null to keep the existing value.

Footer content shown on the status page. Omit or pass null to keep the existing value.

date_view
enum<string> | null

How event dates are displayed: calendar uses a calendar view, list uses a list view. Omit or pass null to keep the current value; an empty string clears the setting.

Available options:
calendar,
list,
,
null
display_uptime_mode
enum<string> | null

How uptime is displayed: chart_and_percentage shows the chart and the percentage, chart shows only the chart, none hides uptime. Omit or pass null to keep the current value; an empty string clears the setting.

Available options:
chart_and_percentage,
chart,
none,
,
null

Custom navigation links shown on the status page. Omit or pass an empty array to keep the current links.

contact_info
string | null

Get-in-touch contact, such as a mailto or website URL. Omit or pass null to keep the existing value.

subscription
object

Subscription channel toggles. A public page can enable only email and an internal page only im. Omit or pass null to keep the existing value.

template_preference
enum<string> | null

Event template mode used when publishing events in the console: message (status descriptions: per-status texts) or pre_defined (full status updates: complete examples with title, status, and description). Omit or pass null to keep the current value; the value is not validated.

Available options:
pre_defined,
message,
null

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

No payload. Depending on the operation, data is {} or omitted from the envelope; rely only on the HTTP 200 status and the absence of error.