Update a status page

Update a specific status page by id

PUT /v1/status-pages/{id}

Update a status page

cURL

curl --request PUT \
  --url https://api.rootly.com/v1/status-pages/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "status_pages",
    "attributes": {
      "title": "<string>",
      "public_title": "<string>",
      "description": "<string>",
      "public_description": "<string>",
      "header_color": "<string>",
      "footer_color": "<string>",
      "allow_search_engine_index": true,
      "show_uptime": true,
      "success_message": "<string>",
      "failure_message": "<string>",
      "authentication_method": "none",
      "authentication_enabled": false,
      "authentication_password": "<string>",
      "saml_idp_sso_service_url": "<string>",
      "saml_idp_slo_service_url": "<string>",
      "saml_idp_cert": "<string>",
      "section_order": [],
      "external_domain_names": [
        "<string>"
      ],
      "website_url": "<string>",
      "website_privacy_url": "<string>",
      "website_support_url": "<string>",
      "ga_tracking_id": "<string>",
      "time_zone": "Etc/UTC",
      "public": true,
      "service_ids": [
        "<string>"
      ],
      "functionality_ids": [
        "<string>"
      ],
      "enabled": true
    }
  }
}
'

import requests

url = "https://api.rootly.com/v1/status-pages/{id}"

payload = { "data": {
        "type": "status_pages",
        "attributes": {
            "title": "<string>",
            "public_title": "<string>",
            "description": "<string>",
            "public_description": "<string>",
            "header_color": "<string>",
            "footer_color": "<string>",
            "allow_search_engine_index": True,
            "show_uptime": True,
            "success_message": "<string>",
            "failure_message": "<string>",
            "authentication_method": "none",
            "authentication_enabled": False,
            "authentication_password": "<string>",
            "saml_idp_sso_service_url": "<string>",
            "saml_idp_slo_service_url": "<string>",
            "saml_idp_cert": "<string>",
            "section_order": [],
            "external_domain_names": ["<string>"],
            "website_url": "<string>",
            "website_privacy_url": "<string>",
            "website_support_url": "<string>",
            "ga_tracking_id": "<string>",
            "time_zone": "Etc/UTC",
            "public": True,
            "service_ids": ["<string>"],
            "functionality_ids": ["<string>"],
            "enabled": True
        }
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/vnd.api+json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/vnd.api+json'},
  body: JSON.stringify({
    data: {
      type: 'status_pages',
      attributes: {
        title: '<string>',
        public_title: '<string>',
        description: '<string>',
        public_description: '<string>',
        header_color: '<string>',
        footer_color: '<string>',
        allow_search_engine_index: true,
        show_uptime: true,
        success_message: '<string>',
        failure_message: '<string>',
        authentication_method: 'none',
        authentication_enabled: false,
        authentication_password: '<string>',
        saml_idp_sso_service_url: '<string>',
        saml_idp_slo_service_url: '<string>',
        saml_idp_cert: '<string>',
        section_order: [],
        external_domain_names: ['<string>'],
        website_url: '<string>',
        website_privacy_url: '<string>',
        website_support_url: '<string>',
        ga_tracking_id: '<string>',
        time_zone: 'Etc/UTC',
        public: true,
        service_ids: ['<string>'],
        functionality_ids: ['<string>'],
        enabled: true
      }
    }
  })
};

fetch('https://api.rootly.com/v1/status-pages/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rootly.com/v1/status-pages/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'data' => [
        'type' => 'status_pages',
        'attributes' => [
                'title' => '<string>',
                'public_title' => '<string>',
                'description' => '<string>',
                'public_description' => '<string>',
                'header_color' => '<string>',
                'footer_color' => '<string>',
                'allow_search_engine_index' => true,
                'show_uptime' => true,
                'success_message' => '<string>',
                'failure_message' => '<string>',
                'authentication_method' => 'none',
                'authentication_enabled' => false,
                'authentication_password' => '<string>',
                'saml_idp_sso_service_url' => '<string>',
                'saml_idp_slo_service_url' => '<string>',
                'saml_idp_cert' => '<string>',
                'section_order' => [
                                
                ],
                'external_domain_names' => [
                                '<string>'
                ],
                'website_url' => '<string>',
                'website_privacy_url' => '<string>',
                'website_support_url' => '<string>',
                'ga_tracking_id' => '<string>',
                'time_zone' => 'Etc/UTC',
                'public' => true,
                'service_ids' => [
                                '<string>'
                ],
                'functionality_ids' => [
                                '<string>'
                ],
                'enabled' => true
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/vnd.api+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rootly.com/v1/status-pages/{id}"

	payload := strings.NewReader("{\n  \"data\": {\n    \"type\": \"status_pages\",\n    \"attributes\": {\n      \"title\": \"<string>\",\n      \"public_title\": \"<string>\",\n      \"description\": \"<string>\",\n      \"public_description\": \"<string>\",\n      \"header_color\": \"<string>\",\n      \"footer_color\": \"<string>\",\n      \"allow_search_engine_index\": true,\n      \"show_uptime\": true,\n      \"success_message\": \"<string>\",\n      \"failure_message\": \"<string>\",\n      \"authentication_method\": \"none\",\n      \"authentication_enabled\": false,\n      \"authentication_password\": \"<string>\",\n      \"saml_idp_sso_service_url\": \"<string>\",\n      \"saml_idp_slo_service_url\": \"<string>\",\n      \"saml_idp_cert\": \"<string>\",\n      \"section_order\": [],\n      \"external_domain_names\": [\n        \"<string>\"\n      ],\n      \"website_url\": \"<string>\",\n      \"website_privacy_url\": \"<string>\",\n      \"website_support_url\": \"<string>\",\n      \"ga_tracking_id\": \"<string>\",\n      \"time_zone\": \"Etc/UTC\",\n      \"public\": true,\n      \"service_ids\": [\n        \"<string>\"\n      ],\n      \"functionality_ids\": [\n        \"<string>\"\n      ],\n      \"enabled\": true\n    }\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/vnd.api+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.rootly.com/v1/status-pages/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/vnd.api+json")
  .body("{\n  \"data\": {\n    \"type\": \"status_pages\",\n    \"attributes\": {\n      \"title\": \"<string>\",\n      \"public_title\": \"<string>\",\n      \"description\": \"<string>\",\n      \"public_description\": \"<string>\",\n      \"header_color\": \"<string>\",\n      \"footer_color\": \"<string>\",\n      \"allow_search_engine_index\": true,\n      \"show_uptime\": true,\n      \"success_message\": \"<string>\",\n      \"failure_message\": \"<string>\",\n      \"authentication_method\": \"none\",\n      \"authentication_enabled\": false,\n      \"authentication_password\": \"<string>\",\n      \"saml_idp_sso_service_url\": \"<string>\",\n      \"saml_idp_slo_service_url\": \"<string>\",\n      \"saml_idp_cert\": \"<string>\",\n      \"section_order\": [],\n      \"external_domain_names\": [\n        \"<string>\"\n      ],\n      \"website_url\": \"<string>\",\n      \"website_privacy_url\": \"<string>\",\n      \"website_support_url\": \"<string>\",\n      \"ga_tracking_id\": \"<string>\",\n      \"time_zone\": \"Etc/UTC\",\n      \"public\": true,\n      \"service_ids\": [\n        \"<string>\"\n      ],\n      \"functionality_ids\": [\n        \"<string>\"\n      ],\n      \"enabled\": true\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.rootly.com/v1/status-pages/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n  \"data\": {\n    \"type\": \"status_pages\",\n    \"attributes\": {\n      \"title\": \"<string>\",\n      \"public_title\": \"<string>\",\n      \"description\": \"<string>\",\n      \"public_description\": \"<string>\",\n      \"header_color\": \"<string>\",\n      \"footer_color\": \"<string>\",\n      \"allow_search_engine_index\": true,\n      \"show_uptime\": true,\n      \"success_message\": \"<string>\",\n      \"failure_message\": \"<string>\",\n      \"authentication_method\": \"none\",\n      \"authentication_enabled\": false,\n      \"authentication_password\": \"<string>\",\n      \"saml_idp_sso_service_url\": \"<string>\",\n      \"saml_idp_slo_service_url\": \"<string>\",\n      \"saml_idp_cert\": \"<string>\",\n      \"section_order\": [],\n      \"external_domain_names\": [\n        \"<string>\"\n      ],\n      \"website_url\": \"<string>\",\n      \"website_privacy_url\": \"<string>\",\n      \"website_support_url\": \"<string>\",\n      \"ga_tracking_id\": \"<string>\",\n      \"time_zone\": \"Etc/UTC\",\n      \"public\": true,\n      \"service_ids\": [\n        \"<string>\"\n      ],\n      \"functionality_ids\": [\n        \"<string>\"\n      ],\n      \"enabled\": true\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "data": {
    "id": "<string>",
    "type": "status_pages",
    "attributes": {
      "title": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "slug": "<string>",
      "public_title": "<string>",
      "description": "<string>",
      "public_description": "<string>",
      "header_color": "<string>",
      "footer_color": "<string>",
      "allow_search_engine_index": true,
      "show_uptime": true,
      "success_message": "<string>",
      "failure_message": "<string>",
      "authentication_method": "none",
      "authentication_enabled": false,
      "authentication_password": "<string>",
      "saml_idp_sso_service_url": "<string>",
      "saml_idp_slo_service_url": "<string>",
      "saml_idp_cert": "<string>",
      "saml_idp_cert_fingerprint": "<string>",
      "section_order": [],
      "website_url": "<string>",
      "website_privacy_url": "<string>",
      "website_support_url": "<string>",
      "ga_tracking_id": "<string>",
      "time_zone": "Etc/UTC",
      "public": true,
      "service_ids": [
        "<string>"
      ],
      "functionality_ids": [
        "<string>"
      ],
      "external_domain_names": [
        "<string>"
      ],
      "cname_records": {},
      "enabled": true
    }
  },
  "included": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {},
      "relationships": {}
    }
  ]
}

{
  "errors": [
    {
      "title": "<string>",
      "status": "<string>",
      "code": "<string>",
      "detail": "<string>"
    }
  ]
}

{
  "errors": [
    {
      "title": "<string>",
      "status": "<string>",
      "code": "<string>",
      "detail": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string<uuid> string · required

Resource UUID

Body

application/vnd.api+json

data · object · required

Show child attributes

Response

200

application/vnd.api+json

external_domain_names persisted

data · object · required

Show child attributes

included · object[]

Show child attributes