UPuptimerobot
Public Status Pages

Create a PSP

Changed on

Create a Public Status Page.

Send application/json unless you are uploading a logo — it is the only content type that can express nested objects and arrays without ambiguity. Reserve multipart/form-data for requests that carry a logo file. In multipart, send arrays as a repeated field (monitorIds=1&monitorIds=2) or with the bracket suffix (monitorIds[]=1), and send monitorIds[]= with no value for an empty array.

post/psps

Request

  • Base URL
    https://api.uptimerobot.com/v3
  • URL
    https://api.uptimerobot.com/v3/psps
  • Auth
    HTTP bearer

Request body

monitorIdsnumber[]

List of monitor IDs to be assigned to the PSP. [0] on its own is the sentinel for "every monitor in the account"; an empty array detaches all of them. In multipart/form-data, repeat the field (monitorIds=1&monitorIds=2) or use the bracket suffix (monitorIds[]=1); monitorIds[]= with no value is the empty array.

tagIdsnumber[]

List of tag IDs to be assigned to the PSP. Uses the same multipart encoding as monitorIds.

autoAddMonitorsboolean

If enabled all monitors (old and new) will be added to PSP automatically. An explicit "monitorIds" wins over this flag when both are sent — including an empty "monitorIds", which detaches every monitor.

friendlyNamestring required

Friendly name of the Public Status Page

logostring binary

Logo image file. Accepted formats: JPG, JPEG, PNG. Max file size: 150 KB. Dimensions: width 20-400px, height 10-200px.

iconstring binary

Icon image file. Accepted formats: JPG, JPEG, PNG. Max file size: 150 KB. Dimensions: width 20-400px, height 10-200px.

passwordstring

Password protection for the Public Status Page

customDomainstring

Provide when you want to use custom domain for the Public Status Page

hideUrlLinksboolean

This will hide "Powered by UptimeRobot" link in footer

noIndexboolean

Set HTML meta tag to allow or disallow search engines to index your status page

gaCodestring

Available only for a Custom Domain status page

sort'FriendlyNameAsc' | 'FriendlyNameDesc' | 'StatusUpDownPaused' | 'StatusDownUpPaused'

Sort monitors by friendly name or their statuses. Manual is read-only — a manual order can only be arranged in the dashboard.

status'PAUSED' | 'ENABLED'

Send "ENABLED" to publish the status page, "PAUSED" to un-publish it

subscriptionboolean

Subscribers can subscribe to receive announcements via an e-mail.

shareAnalyticsConsentboolean

Help us improve the Status Pages by sharing the analytics data with us.

homepageLinkstring

The link target for the logo (or main title) on status page. Usually leads to your homepage.

showCookieBarboolean

Available only for a Custom domain status page

useSmallCookieConsentModalboolean

Allowing visitor to interact with the page - should not be used on public pages

Example request

{
  "friendlyName": "My Status Page",
  "customDomain": "status.your-domain.com",
  "gaCode": "G-xxxxxxxxxx",
  "sort": "FriendlyNameAsc",
  "status": "ENABLED",
  "customSettings": {
    "font": {
      "family": "Roboto"
    },
    "page": {
      "layout": "logo_on_center",
      "theme": "light",
      "density": "normal"
    },
    "colors": {
      "main": "#131a26",
      "text": "#ffffff",
      "link": "#3bd671"
    }
  }
}

Response

idinteger required
friendlyNamestring required
customDomainstring nullable required
isPasswordSetboolean required
monitorIdsnumber[] nullable required
tagIdsnumber[] required
monitorsCountnumber nullable required
statusunknown required
urlKeystring required
homepageLinkstring nullable required
gaCodestring nullable required
shareAnalyticsConsentboolean required
useSmallCookieConsentModalboolean required
iconstring nullable required
noIndexboolean required
logostring nullable required
hideUrlLinksboolean required
subscriptionboolean required
showCookieBarboolean required
pinnedAnnouncementIdinteger nullable required

Changes

  • 191b37343aa3Revision changes
    • warning

      added the new 027-016 enum value to the response property for the response status

  • 8c686e2fe60aRevision changes
    • warning

      added the new 004-048 enum value to the response property for the response status

    • warning

      added the new 011-034 enum value to the response property for the response status

    • warning

      added the new 031-001 enum value to the response property for the response status

    • warning

      added the new 031-002 enum value to the response property for the response status

    • warning

      added the new 031-003 enum value to the response property for the response status

    • warning

      added the new 031-004 enum value to the response property for the response status

    • warning

      added the new 031-005 enum value to the response property for the response status