Skip to main content
POST
Create status page

Restrictions

Usage

  • Page quota by On-call plan: public pages, 1 on Free and Standard and 5 on Professional; internal pages, Professional only, up to 20. Exceeding the quota returns InvalidParameter.
  • url_name is normalized to a lowercase slug and must be unique among the account’s pages of the same type; page_url_name in the response is the final value.
  • Public pages support only email subscription and are the only type that can use custom_domain; internal pages support only IM subscription.
  • 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
name
string
required

Display name of the status page.

Maximum string length: 255
url_name
string
required

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.

Maximum string length: 255
type
enum<string>
required

Visibility type: public accessible to anyone, internal restricted to logged-in members of this account.

Available options:
public,
internal
date_view
enum<string>
required

How change dates are displayed: calendar calendar view, list list view.

Available options:
calendar,
list
display_uptime_mode
enum<string>
required

Uptime display mode: chart_and_percentage chart plus percentage, chart chart only, none hidden.

Available options:
chart_and_percentage,
chart,
none
custom_domain
string

Custom domain; allowed only for public pages and must not be used by another status page.

Maximum string length: 255
page_title
string

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

page_header
string

Header content shown on the status page.

Footer content shown on the status page.

Custom navigation links shown on the status page.

contact_info
string

Get-in-touch contact, such as a mailto or website URL.

subscription
object

Subscription channel toggles; both default to false. A public page can enable only email and an internal page only im.

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

Operation-specific payload, documented in each operation's 200 response. Operations without a payload return {} or omit data entirely.