# Create a status page — API reference > Creates a status page with a company name, public subdomain, branding, visibility and optional initial monitors or Scheduled jobs. Source: https://upfour.io/docs/api/status-pages/create-a-status-page [Developers](https://upfour.io/docs/api.md)/[Status pages](https://upfour.io/docs/api/status-pages.md) Creates a status page with a company name, public subdomain, branding, visibility and optional initial monitors or Scheduled jobs. POST https://app.upfour.io/v1/status-pages scope status_page.write stable [Idempotency-Key supported](https://upfour.io/docs/api/idempotency.md) returns 201 ## Body The 5 fields most calls use come first; the rest are grouped below. `application/json` required 36 fields company_namestring (required) In the app: **Company name** subdomainstring (required) In the app: **Public page slug** company_urlstring client_iduuid · nullable contact_urlstring Appearance22 fields accent_colorstring appearanceStatusPageAppearance · nullable Layout and brand surface. Omitted leaves the stored value unchanged (on create: none chosen), null resets it to the default design, an object is validated and stored: version must be 1, layout is required, ground defaults to paper, header_light and header_dark are #RRGGBB or empty. In the app: **Layout** Nested fields 5 fields | Field | Type | Description | | --- | --- | --- | | `ground` optional | string one of`paper` `white` `cool` | Empty is stored as paper. | | `header_dark` optional | string | #RRGGBB or empty for the platform default. | | `header_light` optional | string | #RRGGBB or empty for the platform default. | | `layout` optional | string one of`essential` `brand` `overview` | | | `version` optional | integer | Must be 1. | designstring No effect since Plan 82; accepted and stored only. design_template_applicationDesignTemplateApplication · nullable Nested fields 4 fields | Field | Type | Description | | --- | --- | --- | | `apply_assets` optional | boolean | Replaces the page's images (and logo_url) with the template's. | | `apply_css` optional | boolean | Fills custom_css from the template when the request sets none. | | `expected_revision` optional | integer | The template revision the caller looked at (at least 1); a different stored revision is a conflict. | | `template_id` optional | uuid | | header_layoutstring No effect since Plan 82; accepted and stored only. logo_urlstring custom_cssstring In the app: **Custom CSS** custom_jsstring Not supported: a non-empty value is rejected. themestring hide_from_search_enginesboolean remove_brandingboolean show_not_monitored_as_greenboolean uptime_decimalsinteger Publication and notifications9 fields announcementstring In the app: **Announcement** is_publishedboolean · nullable A page starts as a draft unless this is true. In the app: **Publish status page** subscribableboolean automatic_reportsboolean automatic_reports_notifyboolean auto_report_open_template_iduuid · nullable auto_report_resolve_template_iduuid · nullable reply_to_emailstring In the app: **Reply-to address for status e-mails** minimum_incident_lengthinteger Access and history6 fields passwordstring Write-only; stored as a hash when password_protected is true. Responses carry password_protected only. In the app: **Password** password_protectedboolean custom_domainstring Not accepted on create: leave it empty and connect a domain with PUT /status-pages/{pageID}/custom-domain. default_languagestring · nullable Language of the page's own communication; empty or omitted inherits from the client, then the company default. In the app: **Default language** history_daysinteger In the app: **How many days to display?** timezonestring Initial structure20 fields sectionsStructureSectionInput[] The initial structure. Not combinable with selected_monitor_ids or selected_heartbeat_ids. Nested fields 17 fields | Field | Type | Description | | --- | --- | --- | | `auto_group_id` optional | uuid · nullable | Required for monitor_group and job_group, rejected for the other sources. | | `auto_source` optional | string one of`none` `all_monitors` `all_jobs` `monitor_group` `job_group` | none (stored resources), all_monitors, all_jobs, monitor_group or job_group. An automatic section cannot also hold resources. | | `auto_widget_type` optional | string | How the components of an automatic section render; history by default. | | `name` optional | string | | | `resources` optional | StructureResourceInput[] | | | Each item · 12 fields FieldTypeDescription `auto_publish` optional boolean · nullable false keeps the automatic report for this component as an internal draft. Default true. `explanation` optional string `feed_component_id` optional string `feed_url` optional string Address of a vendor's status page (Atlassian Statuspage or Instatus); needs feed_component_id. `heartbeat_id` optional uuid · nullable `is_external` optional boolean Shown for transparency but never counted into the page's own status or availability. Always true for a feed component. `manual_status` optional string one of`""` `operational` `degraded` `down` `maintenance` Only for a component with no monitor, scheduled job or feed. Empty derives the status. `mark_degraded_for` optional string any_incident shows an open incident as degraded instead of down; any non-empty value also shows a slow but up monitor as degraded. Default no_incident. `mark_down_for` optional string any_incident (the default) shows the component as down while an incident is open; any other value shows it as degraded instead. `monitor_id` optional uuid · nullable At most one of monitor_id and heartbeat_id; with neither the component is manual (manual_status) or follows a vendor feed (feed_url). `public_name` optional string `widget_type` optional string How the component renders: history (daily bars, the default), plain, or response_times (monitors only). Not validated by the service. | | | selected_monitor_idsuuid[] Puts these monitors into one section, "Current status by service". Not combinable with sections. selected_heartbeat_idsuuid[] Puts these scheduled jobs into one section, "Current status by service". Not combinable with sections. ## Returns A successful request returns `201` with application/json. Response fields 1 top-level fields | Field | Type | Description | | --- | --- | --- | | `data` | StatusPage | | | StatusPage · 61 fields FieldTypeDescription `accent_color` string `announcement` string `appearance` StatusPageAppearanceResponse · nullable null until a layout was chosen; the page then renders the default design (essential layout, paper ground). StatusPageAppearanceResponse · 5 fields FieldTypeDescription `ground` string one of`paper` `white` `cool` Empty is stored as paper. `header_dark` string #RRGGBB or empty for the platform default. `header_light` string #RRGGBB or empty for the platform default. `layout` string one of`essential` `brand` `overview` `version` integer Must be 1. `automatic_reports` boolean `automatic_reports_notify` boolean `company_name` string `company_url` string `contact_url` string `created_at` string (date-time) `custom_css` string `custom_domain` string `custom_domain_certificate_status` string one of`none` `pending` `issued` `failed` `unknown` `custom_domain_status` string one of`none` `pending_dns` `queued` `provisioning` `active` `failed` `disabled` `conflict_requires_review` `custom_js` string Not supported: always empty. `default_language` string · nullable Language of the page's own communication; null inherits from the client, then the company default. `design` string No effect since Plan 82; accepted and stored only. `google_tag_id` string Not supported: always empty. `header_layout` string No effect since Plan 82; accepted and stored only. `hide_from_search_engines` boolean `history_days` integer `id` uuid `is_published` boolean `logo_url` string `minimum_incident_length` integer `organization_id` uuid `password_protected` boolean `remove_branding` boolean `show_not_monitored_as_green` boolean `subdomain` string `subscribable` boolean `theme` string `timezone` string `updated_at` string (date-time) `uptime_decimals` integer `access_restricted` boolean Whether any visitor gate (password, e-mail codes, IP allowlist or access token) is on. Only in GET /status-pages. `auto_report_open_template_id` uuid `auto_report_resolve_template_id` uuid `client_id` uuid `custom_domain_attempts` integer `custom_domain_cleanup_requested_at` string (date-time) `custom_domain_dns_target` string `custom_domain_error` string `custom_domain_last_checked_at` string (date-time) `custom_domain_next_retry_at` string (date-time) `custom_domain_pending_expires_at` string (date-time) `custom_domain_ploi_tenant` string `custom_domain_provisioned_at` string (date-time) `custom_domain_verification_token` string Value of the up4-status-verification TXT record that proves ownership of the domain. `custom_domain_verified_at` string (date-time) `favicon_url` string `logo_asset_url` string `logo_dark_asset_url` string `platform_url` string `public_url` string Where the page is reachable: the custom domain once active, else the platform address. `reply_to_email` string `subscriber_count` integer Confirmed, active subscribers. Only in GET /status-pages. | | | ## Errors Only the errors this operation can return. Every error uses the [same envelope](https://upfour.io/docs/api/responses.md). | Status | Code | Meaning | | --- | --- | --- | | 400 | [bad_request](https://upfour.io/docs/api/errors#code-bad_request) | The request is malformed or fails validation. | | 402 | [billing_action_unavailable](https://upfour.io/docs/api/errors#code-billing_action_unavailable) | The Company's billing state does not allow this action. **When:** A metered or limited action while the billing state, such as paused or without credit, blocks it; details holds the action and billing_state. **Fix:** Top up the credit or change the plan, then retry. | | 409 | [design_template_conflict](https://upfour.io/docs/api/errors#code-design_template_conflict) | The design template was changed after the caller read it. **When:** Updating or applying a design template that was changed after the caller read it. **Fix:** Reload the template and apply the change again. | | 404 | [design_template_not_found](https://upfour.io/docs/api/errors#code-design_template_not_found) | The design template does not exist or is not visible to the caller. **When:** A design template id in the path or body that is unknown or not visible to the caller. **Fix:** List design templates and use an id from the list. | | 402 | [payment_required](https://upfour.io/docs/api/errors#code-payment_required) | The account does not have the credit or plan required for this action. | | 403 | [permission_denied](https://upfour.io/docs/api/errors#code-permission_denied) | The credentials do not permit this action. | | 503 | [quota_gate_unavailable](https://upfour.io/docs/api/errors#code-quota_gate_unavailable) | The limit check itself failed, so the action was not carried out. **When:** The quota service could not decide while the request ran. **Fix:** Retry in a moment; nothing was changed. | | 403 / 429 | [quota_limit_reached](https://upfour.io/docs/api/errors#code-quota_limit_reached) | A usage or inventory limit of the Company was reached. **When:** Counters and concurrency limits answer 429 with Retry-After, inventory and capacity limits answer 403; details holds purpose, limit and window. **Fix:** On 429 wait Retry-After seconds; on 403 free something up, request a higher limit where details.raise_request is true, or buy an extension. `quota_limit_reached` (window `total`): the Company already holds the most of these it may have. `error.details` carries `purpose` and `limit`; remove one or ask support for a higher limit. | Every call can also return `unauthorized` (401), `rate_limit_exceeded` (429) or `internal_error` (500 / 502). See [Responses and errors](https://upfour.io/docs/api/responses.md). [PreviousList status pages](https://upfour.io/docs/api/status-pages/list-status-pages.md) [NextPreview a status feed](https://upfour.io/docs/api/status-pages/preview-a-status-feed.md) ## Request ### cURL ```bash curl -s -X POST "https://app.upfour.io/v1/status-pages" \ -H "Authorization: Bearer $UP4_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "announcement": "All systems are monitored by up4.", "company_name": "Acme GmbH", "subdomain": "acme-status" }' ``` ### JavaScript ```javascript const res = await fetch("https://app.upfour.io/v1/status-pages", { method: "POST", headers: { Authorization: `Bearer ${process.env.UP4_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ announcement: "All systems are monitored by up4.", company_name: "Acme GmbH", subdomain: "acme-status", }), }); console.log(res.status, await res.json()); ``` ### Python ```python import os import requests res = requests.post( "https://app.upfour.io/v1/status-pages", headers={"Authorization": f"Bearer {os.environ['UP4_API_KEY']}"}, json={ "announcement": "All systems are monitored by up4.", "company_name": "Acme GmbH", "subdomain": "acme-status", }, ) print(res.status_code, res.json()) ``` ### Go ```go package main import ( "fmt" "io" "net/http" "os" "strings" ) func main() { payload := strings.NewReader(`{ "announcement": "All systems are monitored by up4.", "company_name": "Acme GmbH", "subdomain": "acme-status" }`) req, _ := http.NewRequest("POST", "https://app.upfour.io/v1/status-pages", payload) req.Header.Set("Authorization", "Bearer "+os.Getenv("UP4_API_KEY")) req.Header.Set("Content-Type", "application/json") res, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer res.Body.Close() out, _ := io.ReadAll(res.Body) fmt.Println(res.StatusCode, string(out)) } ``` ### PHP ```php "POST", CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => [ "Authorization: Bearer " . getenv("UP4_API_KEY"), "Content-Type: application/json", ], CURLOPT_POSTFIELDS => $payload, ]); $response = curl_exec($ch); echo curl_getinfo($ch, CURLINFO_RESPONSE_CODE), " ", $response, "\n"; curl_close($ch); ``` ## Response ### 201 ```json { "data": { "accent_color": "", "announcement": "All systems are monitored by up4.", "appearance": null, "automatic_reports": false, "automatic_reports_notify": false, "company_name": "Acme GmbH", "company_url": "", "contact_url": "", "created_at": "2026-10-27T09:00:00Z", "custom_css": "", "custom_domain": "", "custom_domain_certificate_status": "none", "custom_domain_status": "none", "custom_js": "", "default_language": null, "design": "v2", "google_tag_id": "", "header_layout": "vertical", "hide_from_search_engines": false, "history_days": 90, "id": "00000000-0000-4000-8000-000000000001", "is_published": false, "logo_url": "", "minimum_incident_length": 0, "organization_id": "00000000-0000-4000-8000-000000000002", "password_protected": false, "platform_url": "https://example.com", "public_url": "https://example.com", "remove_branding": false, "show_not_monitored_as_green": false, "subdomain": "acme-status", "subscribable": false, "theme": "light", "timezone": "UTC", "updated_at": "2026-10-27T09:00:00Z", "uptime_decimals": 0 } } ``` ### 400 ```json { "error": { "code": "bad_request", "message": "The request is malformed or fails validation.", "request_id": "req_…" } } ``` ### 402 ```json { "error": { "code": "billing_action_unavailable", "message": "The Company's billing state does not allow this action.", "request_id": "req_…" } } ``` ### 403 ```json { "error": { "code": "permission_denied", "message": "The credentials do not permit this action.", "request_id": "req_…" } } ``` ### 404 ```json { "error": { "code": "design_template_not_found", "message": "The design template does not exist or is not visible to the caller.", "request_id": "req_…" } } ``` ### 409 ```json { "error": { "code": "design_template_conflict", "message": "The design template was changed after the caller read it.", "request_id": "req_…" } } ``` ### 429 ```json { "error": { "code": "quota_limit_reached", "message": "A usage or inventory limit of the Company was reached.", "request_id": "req_…" } } ``` ### 503 ```json { "error": { "code": "quota_gate_unavailable", "message": "The limit check itself failed, so the action was not carried out.", "request_id": "req_…" } } ```