--- title: Update status page description: Updates an existing status page's attributes. To publish and unpublish status pages, use the dedicated publish and unpublish status page endpoints. breadcrumbs: Docs > API > Update status page --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/llms.txt). # Update status page ## v2 (latest) | Datadog site | API endpoint | | ----------------- | ---------------------------------------------------------------- | | app.datadoghq.com | PATCH https://api.datadoghq.com/api/v2/statuspages/{page_id} | | us3.datadoghq.com | PATCH https://api.us3.datadoghq.com/api/v2/statuspages/{page_id} | | us5.datadoghq.com | PATCH https://api.us5.datadoghq.com/api/v2/statuspages/{page_id} | | app.datadoghq.eu | PATCH https://api.datadoghq.eu/api/v2/statuspages/{page_id} | | ap1.datadoghq.com | PATCH https://api.ap1.datadoghq.com/api/v2/statuspages/{page_id} | | ap2.datadoghq.com | PATCH https://api.ap2.datadoghq.com/api/v2/statuspages/{page_id} | | uk1.datadoghq.com | PATCH https://api.uk1.datadoghq.com/api/v2/statuspages/{page_id} | | app.ddog-gov.com | PATCH https://api.ddog-gov.com/api/v2/statuspages/{page_id} | | us2.ddog-gov.com | PATCH https://api.us2.ddog-gov.com/api/v2/statuspages/{page_id} | ### Overview Updates an existing status page's attributes. To publish and unpublish status pages, use the dedicated [publish](#publish-status-page) and [unpublish](#unpublish-status-page) status page endpoints. This endpoint requires the `status_pages_settings_write` permission. OAuth apps require the `status_pages_settings_write` authorization [scope](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/api/latest/scopes.md#status-pages) to access this endpoint. ### Arguments #### Path Parameters | Field | Type | Description | | -------------------- | ------ | -------------------------- | | page_id [*required*] | string | The ID of the status page. | #### Query Strings | Field | Type | Description | | ------------------ | ------- | ------------------------------------------------------------------------------------------------------- | | delete_subscribers | boolean | Whether to delete existing subscribers when updating a status page's type. Default: `false`. | | include | string | Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user. | ### Request #### Body Data (required) {% tabs %} {% tab label="Model" %} | Parent field | Field | Type | Description | | ------------ | --------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data | object | The data object for updating a status page. | | data | attributes [*required*] | object | The supported attributes for updating a status page. | | attributes | company_logo | string | The base64-encoded image data displayed on the status page. | | attributes | domain_prefix | string | The subdomain of the status page's url taking the form `https://{domain_prefix}.statuspage.datadoghq.com`. Globally unique across Datadog Status Pages. | | attributes | email_header_image | string | The base64-encoded image data displayed in email notifications sent to status page subscribers. | | attributes | favicon | string | The base64-encoded image data displayed in the browser tab. | | attributes | name | string | The name of the status page. | | attributes | slack_app_icon | string | The Slack app icon URL for the status page. | | attributes | slack_subscriptions_enabled | boolean | Whether Slack subscriptions are enabled for the status page. | | attributes | subscriptions_enabled | boolean | Whether users can subscribe to the status page. | | attributes | type | enum | The type of the status page controlling how the status page is accessed. Allowed enum values: `public`, `internal`. | | attributes | visualization_type | enum | The visualization type of the status page. Allowed enum values: `bars_and_uptime_percentage`, `bars_only`, `component_name_only`. | | data | id [*required*] | uuid | The ID of the status page. | | data | type [*required*] | enum | Status pages resource type. Allowed enum values: `status_pages`. Default: `status_pages`. | {% /tab %} {% tab label="Example" %} ```json { "data": { "attributes": { "company_logo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAIKMMMM", "domain_prefix": "status-page-us1-east", "email_header_image": "data:image/png;base64,pQSLAw0KGgoAAAANSUhEUgAAAQ4AASJKFF", "favicon": "data:image/png;base64,kWMRNw0KGgoAAAANSUhEUgAAAEAAAABACA", "name": "Status Page US1 East", "subscriptions_enabled": false, "type": "internal", "visualization_type": "bars_only" }, "id": "1234abcd-12ab-34cd-56ef-123456abcdef", "type": "status_pages" } } ``` {% /tab %} {% /tabs %} ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} Response object for a single status page. | Parent field | Field | Type | Description | | --------------------- | --------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data | object | The data object for a status page. | | data | attributes | object | The attributes of a status page. | | attributes | company_logo | string | Base64-encoded image data displayed on the status page. | | attributes | components | [object] | Components displayed on the status page. | | components | components | [object] | If the component is of type `group`, the components within the group. | | components | id | uuid | The ID of the component. | | components | name | string | The name of the component. | | components | position | int64 | The zero-indexed position of the component. Relative to the other components in the group. | | components | status | enum | The status of the component. Read-only. Allowed enum values: `operational`, `degraded`, `partial_outage`, `major_outage`, `maintenance`. | | components | type | enum | The type of the component. Allowed enum values: `component`. | | components | id | uuid | The ID of the component. | | components | name | string | The name of the component. | | components | position | int64 | The zero-indexed position of the component. | | components | status | enum | The status of the component. Read-only. Allowed enum values: `operational`, `degraded`, `partial_outage`, `major_outage`, `maintenance`. | | components | type | enum | The type of the component. Allowed enum values: `component`, `group`. | | attributes | created_at | date-time | Timestamp of when the status page was created. | | attributes | custom_domain | string | If configured, the url that the status page is accessible at. | | attributes | custom_domain_enabled | boolean | Whether the custom domain is configured. | | attributes | domain_prefix | string | The subdomain of the status page's url taking the form `https://{domain_prefix}.statuspage.datadoghq.com`. Globally unique across Datadog Status Pages. | | attributes | email_header_image | string | Base64-encoded image data included in email notifications sent to status page subscribers. | | attributes | enabled | boolean | Whether the status page is enabled. | | attributes | favicon | string | Base64-encoded image data displayed in the browser tab. | | attributes | modified_at | date-time | Timestamp of when the status page was last modified. | | attributes | name | string | The name of the status page. | | attributes | page_url | string | The url that the status page is accessible at. | | attributes | slack_app_icon | string | The Slack app icon URL for the status page. | | attributes | slack_subscriptions_enabled | boolean | Whether Slack subscriptions are enabled for the status page. | | attributes | subscriptions_enabled | boolean | Whether users can subscribe to the status page. | | attributes | type | enum | The type of the status page controlling how the status page is accessed. Allowed enum values: `public`, `internal`. | | attributes | visualization_type | enum | The visualization type of the status page. Allowed enum values: `bars_and_uptime_percentage`, `bars_only`, `component_name_only`. | | data | id | uuid | The ID of the status page. | | data | relationships | object | The relationships of a status page. | | relationships | created_by_user | object | The Datadog user who created the status page. | | created_by_user | data [*required*] | object | The data object identifying the Datadog user who created the status page. | | data | id [*required*] | string | The ID of the Datadog user who created the status page. | | data | type [*required*] | enum | Users resource type. Allowed enum values: `users`. Default: `users`. | | relationships | last_modified_by_user | object | The Datadog user who last modified the status page. | | last_modified_by_user | data [*required*] | object | The data object identifying the Datadog user who last modified the status page. | | data | id [*required*] | string | The ID of the Datadog user who last modified the status page. | | data | type [*required*] | enum | Users resource type. Allowed enum values: `users`. Default: `users`. | | data | type [*required*] | enum | Status pages resource type. Allowed enum values: `status_pages`. Default: `status_pages`. | | | included | [] | The included related resources of a status page. Client must explicitly request these resources by name in the `include` query parameter. | | included | | object | The included Datadog user resource. | | | attributes | object | Attributes of the Datadog user. | | attributes | email | string | The email of the Datadog user. | | attributes | handle | string | The handle of the Datadog user. | | attributes | icon | string | The icon of the Datadog user. | | attributes | name | string | The name of the Datadog user. | | attributes | uuid | string | The UUID of the Datadog user. | | | id | uuid | The ID of the Datadog user. | | | type [*required*] | enum | Users resource type. Allowed enum values: `users`. Default: `users`. | {% /tab %} {% tab label="Example" %} ```json { "data": { "attributes": { "company_logo": "string", "components": [ { "components": [ { "id": "string", "name": "string", "position": "integer", "status": "string", "type": "component" } ], "id": "string", "name": "string", "position": "integer", "status": "string", "type": "component" } ], "created_at": "2019-09-19T10:00:00.000Z", "custom_domain": "string", "custom_domain_enabled": false, "domain_prefix": "string", "email_header_image": "string", "enabled": false, "favicon": "string", "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", "page_url": "string", "slack_app_icon": "string", "slack_subscriptions_enabled": false, "subscriptions_enabled": false, "type": "public", "visualization_type": "bars_and_uptime_percentage" }, "id": "string", "relationships": { "created_by_user": { "data": { "id": "", "type": "users" } }, "last_modified_by_user": { "data": { "id": "", "type": "users" } } }, "type": "status_pages" }, "included": [ { "attributes": { "email": "string", "handle": "string", "icon": "string", "name": "string", "uuid": "string" }, "id": "string", "type": "users" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Path parameters export page_id="1234abcd-12ab-34cd-56ef-123456abcdef" # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" curl -X PATCH "https://api.${DD_SITE}/api/v2/statuspages/${page_id}" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" \ -d @- << EOF { "data": { "attributes": { "company_logo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAIKMMMM", "domain_prefix": "status-page-us1-east", "email_header_image": "data:image/png;base64,pQSLAw0KGgoAAAANSUhEUgAAAQ4AASJKFF", "favicon": "data:image/png;base64,kWMRNw0KGgoAAAANSUhEUgAAAEAAAABACA", "name": "Status Page US1 East", "subscriptions_enabled": false, "type": "internal", "visualization_type": "bars_only" }, "id": "1234abcd-12ab-34cd-56ef-123456abcdef", "type": "status_pages" } } EOF ``` {% /tab %} {% tab label="Go" %} ```go // Update status page returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" "github.com/google/uuid" ) func main() { // there is a valid "status_page" in the system StatusPageDataID := uuid.MustParse(os.Getenv("STATUS_PAGE_DATA_ID")) body := datadogV2.PatchStatusPageRequest{ Data: &datadogV2.PatchStatusPageRequestData{ Attributes: datadogV2.PatchStatusPageRequestDataAttributes{ Name: datadog.PtrString("A Status Page in US1"), }, Id: StatusPageDataID, Type: datadogV2.STATUSPAGEDATATYPE_STATUS_PAGES, }, } ctx := datadog.NewDefaultContext(context.Background()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewStatusPagesApi(apiClient) resp, r, err := api.UpdateStatusPage(ctx, StatusPageDataID, body, *datadogV2.NewUpdateStatusPageOptionalParameters()) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `StatusPagesApi.UpdateStatusPage`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `StatusPagesApi.UpdateStatusPage`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" go run "main.go" ``` {% /tab %} {% tab label="Java" %} ```java // Update status page returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.StatusPagesApi; import com.datadog.api.client.v2.model.PatchStatusPageRequest; import com.datadog.api.client.v2.model.PatchStatusPageRequestData; import com.datadog.api.client.v2.model.PatchStatusPageRequestDataAttributes; import com.datadog.api.client.v2.model.StatusPage; import com.datadog.api.client.v2.model.StatusPageDataType; import java.util.UUID; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); StatusPagesApi apiInstance = new StatusPagesApi(defaultClient); // there is a valid "status_page" in the system UUID STATUS_PAGE_DATA_ID = null; try { STATUS_PAGE_DATA_ID = UUID.fromString(System.getenv("STATUS_PAGE_DATA_ID")); } catch (IllegalArgumentException e) { System.err.println("Error parsing UUID: " + e.getMessage()); } PatchStatusPageRequest body = new PatchStatusPageRequest() .data( new PatchStatusPageRequestData() .attributes( new PatchStatusPageRequestDataAttributes().name("A Status Page in US1")) .id(STATUS_PAGE_DATA_ID) .type(StatusPageDataType.STATUS_PAGES)); try { StatusPage result = apiInstance.updateStatusPage(STATUS_PAGE_DATA_ID, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling StatusPagesApi#updateStatusPage"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" java "Example.java" ``` {% /tab %} {% tab label="Python" %} ```python """ Update status page returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.status_pages_api import StatusPagesApi from datadog_api_client.v2.model.patch_status_page_request import PatchStatusPageRequest from datadog_api_client.v2.model.patch_status_page_request_data import PatchStatusPageRequestData from datadog_api_client.v2.model.patch_status_page_request_data_attributes import PatchStatusPageRequestDataAttributes from datadog_api_client.v2.model.status_page_data_type import StatusPageDataType # there is a valid "status_page" in the system STATUS_PAGE_DATA_ID = environ["STATUS_PAGE_DATA_ID"] body = PatchStatusPageRequest( data=PatchStatusPageRequestData( attributes=PatchStatusPageRequestDataAttributes( name="A Status Page in US1", ), id=STATUS_PAGE_DATA_ID, type=StatusPageDataType.STATUS_PAGES, ), ) configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] with ApiClient(configuration) as api_client: api_instance = StatusPagesApi(api_client) response = api_instance.update_status_page(page_id=STATUS_PAGE_DATA_ID, body=body) print(response) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" python3 "example.py" ``` {% /tab %} {% tab label="Ruby" %} ```ruby # Update status page returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] end api_instance = DatadogAPIClient::V2::StatusPagesAPI.new # there is a valid "status_page" in the system STATUS_PAGE_DATA_ID = ENV["STATUS_PAGE_DATA_ID"] body = DatadogAPIClient::V2::PatchStatusPageRequest.new({ data: DatadogAPIClient::V2::PatchStatusPageRequestData.new({ attributes: DatadogAPIClient::V2::PatchStatusPageRequestDataAttributes.new({ name: "A Status Page in US1", }), id: STATUS_PAGE_DATA_ID, type: DatadogAPIClient::V2::StatusPageDataType::STATUS_PAGES, }), }) p api_instance.update_status_page(STATUS_PAGE_DATA_ID, body) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" rb "example.rb" ``` {% /tab %} {% tab label="Rust" %} ```rust // Update status page returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_status_pages::StatusPagesAPI; use datadog_api_client::datadogV2::api_status_pages::UpdateStatusPageOptionalParams; use datadog_api_client::datadogV2::model::PatchStatusPageRequest; use datadog_api_client::datadogV2::model::PatchStatusPageRequestData; use datadog_api_client::datadogV2::model::PatchStatusPageRequestDataAttributes; use datadog_api_client::datadogV2::model::StatusPageDataType; #[tokio::main] async fn main() { // there is a valid "status_page" in the system let status_page_data_id = uuid::Uuid::parse_str(&std::env::var("STATUS_PAGE_DATA_ID").unwrap()) .expect("Invalid UUID"); let body = PatchStatusPageRequest::new().data(PatchStatusPageRequestData::new( PatchStatusPageRequestDataAttributes::new().name("A Status Page in US1".to_string()), status_page_data_id.clone(), StatusPageDataType::STATUS_PAGES, )); let configuration = datadog::Configuration::new(); let api = StatusPagesAPI::with_config(configuration); let resp = api .update_status_page( status_page_data_id.clone(), body, UpdateStatusPageOptionalParams::default(), ) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ``` {% /tab %} {% tab label="TypeScript" %} ```typescript /** * Update status page returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration({ authMethods: { AuthZ: { accessToken: process.env.DD_BEARER_TOKEN as string, }, }, }); const apiInstance = new v2.StatusPagesApi(configuration); // there is a valid "status_page" in the system const STATUS_PAGE_DATA_ID = process.env.STATUS_PAGE_DATA_ID as string; const params: v2.StatusPagesApiUpdateStatusPageRequest = { body: { data: { attributes: { name: "A Status Page in US1", }, id: STATUS_PAGE_DATA_ID, type: "status_pages", }, }, pageId: STATUS_PAGE_DATA_ID, }; apiInstance .updateStatusPage(params) .then((data: v2.StatusPage) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" tsc "example.ts" ``` {% /tab %} {% /tabs %}