--- title: List status pages description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Status Pages --- # List status pages{% #list-status-pages %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | ---------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/statuspages | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/statuspages | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/statuspages | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/statuspages | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/statuspages | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/statuspages | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/statuspages | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/statuspages | ### Overview Lists all status pages for the organization. This endpoint requires the `status_pages_settings_read` permission. OAuth apps require the `status_pages_settings_read` authorization [scope](https://docs.datadoghq.com/api/latest/scopes.md#status-pages) to access this endpoint. ### Arguments #### Query Strings | Name | Type | Description | | --------------------- | ------- | ------------------------------------------------------------------------------------------------------- | | page[offset] | integer | Offset to use as the start of the page. | | page[limit] | integer | The number of status pages to return per page. | | filter[domain_prefix] | string | Filter status pages by exact domain prefix match. Returns at most one result. | | include | string | Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user. | ### Response {% tab title="200" %} OK {% tab title="Model" %} Response object for a list of status pages. | Parent field | Field | Type | Description | | --------------------- | --------------------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data [*required*] | [object] | A list of status page data objects. | | 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. 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. 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` | | 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` | | data | type [*required*] | enum | Status pages resource type. Allowed enum values: `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 | Option 1 | object | The included Datadog user resource. | | Option 1 | 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. | | Option 1 | id | uuid | The ID of the Datadog user. | | Option 1 | type [*required*] | enum | Users resource type. Allowed enum values: `users` | | | meta | object | Response metadata. | | meta | page | object | Offset-based pagination schema. | | page | first_offset | int64 | Integer representing the offset to fetch the first page of results. | | page | last_offset | int64 | Integer representing the offset to fetch the last page of results. | | page | limit | int64 | Integer representing the number of elements to be returned in the results. | | page | next_offset | int64 | Integer representing the index of the first element in the next page of results. Equal to page size added to the current offset. | | page | offset | int64 | Integer representing the index of the first element in the results. | | page | prev_offset | int64 | Integer representing the index of the first element in the previous page of results. | | page | total | int64 | Integer representing the total number of elements available. | | page | type | enum | The pagination type used for offset-based pagination. Allowed enum values: `offset_limit` | {% /tab %} {% tab title="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" } ], "meta": { "page": { "first_offset": 0, "last_offset": 900, "limit": 100, "next_offset": 100, "offset": 0, "prev_offset": 100, "total": 1000, "type": "offset_limit" } } } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Curl command curl -X GET "https://api.datadoghq.com/api/v2/statuspages" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ List status pages returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.status_pages_api import StatusPagesApi configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = StatusPagesApi(api_client) response = api_instance.list_status_pages() print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # List status pages returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::StatusPagesAPI.new p api_instance.list_status_pages() ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // List status pages 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" ) func main() { ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewStatusPagesApi(apiClient) resp, r, err := api.ListStatusPages(ctx, *datadogV2.NewListStatusPagesOptionalParameters()) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `StatusPagesApi.ListStatusPages`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `StatusPagesApi.ListStatusPages`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // List status pages 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.StatusPageArray; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); StatusPagesApi apiInstance = new StatusPagesApi(defaultClient); try { StatusPageArray result = apiInstance.listStatusPages(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling StatusPagesApi#listStatusPages"); 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://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // List status pages returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_status_pages::ListStatusPagesOptionalParams; use datadog_api_client::datadogV2::api_status_pages::StatusPagesAPI; #[tokio::main] async fn main() { let configuration = datadog::Configuration::new(); let api = StatusPagesAPI::with_config(configuration); let resp = api .list_status_pages(ListStatusPagesOptionalParams::default()) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * List status pages returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.StatusPagesApi(configuration); apiInstance .listStatusPages() .then((data: v2.StatusPageArray) => { 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://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}