---
title: "Change a status page: title, description, address, published, and the sites it shows (the whole list)"
method: PATCH
path: "/status-pages/{pageId}"
tags: ["Status pages"]
---

# Change a status page: title, description, address, published, and the sites it shows (the whole list)

`PATCH /status-pages/{pageId}`

## Request

- Base URL: `https://hostingsurge.com/api/v1`
- URL: `https://hostingsurge.com/api/v1/status-pages/{pageId}`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `__Host-hs_session`

## Path parameters

- `pageId` string, uuid, required

## Request body

- object
  - `slug` string
  - `title` string
  - `description` string, nullable: null clears it
  - `published` boolean
  - `components` object[]: the whole list in display order (replaces the current one)
    - `monitorId` string, uuid, required
    - `name` string, required

## Response `200`

Saved

- object
  - `id` string, uuid, required
  - `organizationId` string, uuid, required
  - `slug` string, required
  - `url` string, required: the public address, e.g. https://hostingsurge.com/status/acme
  - `title` string, required
  - `description` string, nullable, required
  - `published` boolean, required
  - `components` object[], required
    - `id` string, uuid, required
    - `monitorId` string, uuid, required
    - `name` string, required: the name visitors see
    - `position` integer, required
    - `projectId` string, uuid, nullable, required
    - `projectName` string, nullable, required
    - `hostname` string, nullable, required: the checked address (never shown to visitors)
    - `state` 'operational' | 'down' | 'unknown', required
  - `createdAt` string, required: ISO-8601 timestamp
  - `updatedAt` string, required: ISO-8601 timestamp

## Other responses

- `400`: Invalid request (code invalid_request)
- `401`: Missing or invalid session/token (code unauthorized)
- `403`: Authenticated but not permitted (code forbidden)
- `404`: Not found or not visible to the caller (code not_found)
- `409`: Conflict (code conflict), e.g. the status page address is taken
- `413`: The request body is too large
- `429`: Too many requests (code rate_limited); see Retry-After or details.limit
- `501`: Not available on this server yet (code not_configured): migration 194 is not applied

---

[API](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api.md) · [All operations](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/revisions/4d08337cdff1?raw)
