Full API and Integration Documentation

Page Profile

Your page profile drives basic settings for your status page including your company name, notification preferences, and time zone.

Get your page profile
ENDPOINT
  GET /pages/[page_id].json

SAMPLE CALL
  curl https://api.statuspage.io/v1/pages/qfn30z5r6s5h.json \
    -H "Authorization: OAuth 2a7b9d4aac30956d537ac76850f4d78de30994703680056cc103862d53cf8074"

RESPONSE CODES
  200 - Successful call

SAMPLE RESPONSE
  {
    "allow_email_subscribers": true, 
    "allow_incident_subscribers": true, 
    "allow_page_subscribers": true, 
    "allow_sms_subscribers": true, 
    "city": null, 
    "country": "United States", 
    "created_at": "2013-02-20T17:22:25Z", 
    "css_body_background_color": null, 
    "css_font_color": null, 
    "css_greens": null, 
    "css_light_font_color": null, 
    "css_oranges": null, 
    "css_reds": null, 
    "css_yellows": null, 
    "domain": "status.acmeapi.co", 
    "hero_cover": {
      "normal_url": "", 
      "original_url": "", 
      "retina_url": "", 
      "size": null, 
      "updated_at": null
    }, 
    "hidden_from_search": false, 
    "id": "nlrtts14f89x", 
    "layout": "basic", 
    "name": "Acme API Co.", 
    "notifications_from_email": null, 
    "state": null, 
    "subdomain": "acmeapico", 
    "time_zone": "Mountain Time (US & Canada)", 
    "transactional_logo": {
      "normal_url": "", 
      "original_url": "", 
      "retina_url": "", 
      "size": null, 
      "updated_at": null
    }, 
    "twitter_username": null, 
    "updated_at": "2013-03-02T19:59:47Z", 
    "url": "http://www.acmeapi.co"
  }
Update your page profile
ENDPOINT
  PATCH /pages/[page_id].json

MUTABLE ATTRIBUTES
  page[name] - name of your page to be displayed
  page[url] - the website of your page. clicking on your status page image will link here
  page[notifications_from_email] - if users reply to the incident notifications we send
  page[time_zone] - time zone to use for your status page display (must be a rails time zone)
  page[city] - city in which your page is headquartered
  page[state] - state in which your page is headquartered
  page[country] - country in which your page is headquartered
  page[subdomain] - subdomain at which to access your status page (your_subdomain.statuspage.io)
  page[domain] - CNAME alias for your status page (point DNS record to hosted.statuspage.io)
  page[layout] - which layout format to use for your status page. one of basic|premium
  page[allow_email_subscribers] - allow users to subscribe for email updates (t or f)
  page[allow_incident_subscribers] - allow users to subscribe to a single incident (t or f)
  page[allow_page_subscribers] - allow users to auto-subscribe to all incidents (t or f)
  page[allow_sms_subscribers] - allow users to subscribe for sms updates (t or f)
  page[hero_cover_url] - url of a hero cover image to be placed on your status page
                                 premium layout only, 850x315 or 1700x630 is best
  page[transactional_logo_url] - url of a transactional logo to be placed on your status page
                                         basic layout only, 170x45 or 340x90 is best
  page[css_body_background_color] - custom css color for your status page body background
  page[css_font_color] - custom css color for your status page font
  page[css_light_font_color] - custom css color for your status page light font
  page[css_greens] - custom css color for your status page greens
  page[css_oranges] - custom css color for your status page oranges
  page[css_reds] - custom css color for your status page reds
  page[css_yellows] - custom css color for your status page yellows


SAMPLE CALL
  curl https://api.statuspage.io/v1/pages/qfn30z5r6s5h.json \
    -H "Authorization: OAuth 2a7b9d4aac30956d537ac76850f4d78de30994703680056cc103862d53cf8074" \
    -X PATCH \
    -d "page[allow_page_subscribers]=false" \
    -d "page[allow_incident_subscribers]=false" \
    -d "page[city]=Raleigh" \
    -d "page[state]=NC"


RESPONSE CODES
  200 - Successful call

SAMPLE RESPONSE
  {
    "allow_email_subscribers": true, 
    "allow_incident_subscribers": false, 
    "allow_page_subscribers": false, 
    "allow_sms_subscribers": true, 
    "city": "Raleigh", 
    "country": "United States", 
    "created_at": "2013-02-20T17:22:25Z", 
    "css_body_background_color": null, 
    "css_font_color": null, 
    "css_greens": null, 
    "css_light_font_color": null, 
    "css_oranges": null, 
    "css_reds": null, 
    "css_yellows": null, 
    "domain": "status.acmeapi.co", 
    "hero_cover": {
      "normal_url": "", 
      "original_url": "", 
      "retina_url": "", 
      "size": null, 
      "updated_at": null
    }, 
    "hidden_from_search": false, 
    "id": "nlrtts14f89x", 
    "layout": "basic", 
    "name": "Acme API Co.", 
    "notifications_from_email": null, 
    "state": "NC", 
    "subdomain": "acmeapico", 
    "time_zone": "Mountain Time (US & Canada)", 
    "transactional_logo": {
      "normal_url": "", 
      "original_url": "", 
      "retina_url": "", 
      "size": null, 
      "updated_at": null
    }, 
    "twitter_username": null, 
    "updated_at": "2013-03-02T19:59:47Z", 
    "url": "http://www.acmeapi.co"
  }