--- title: List degradations description: Lists all degradations for the organization. Optionally filter by status and page. breadcrumbs: Docs > API > List degradations --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/llms.txt). # List degradations ## v2 (latest) | Datadog site | API endpoint | | ----------------- | ----------------------------------------------------------------- | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/statuspages/degradations | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/statuspages/degradations | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/statuspages/degradations | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/statuspages/degradations | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/statuspages/degradations | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/statuspages/degradations | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/statuspages/degradations | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/statuspages/degradations | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/statuspages/degradations | ### Overview Lists all degradations for the organization. Optionally filter by status and page. This endpoint requires the `status_pages_settings_read` permission. OAuth apps require the `status_pages_settings_read` authorization [scope](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/api/latest/scopes.md#status-pages) to access this endpoint. ### Arguments #### Query Strings | Field | Type | Description | | ----------------- | ------- | -------------------------------------------------------------------------------------------------------------------- | | filter[page_id] | string | Optional page id filter. | | page[offset] | integer | Offset to use as the start of the page. Default: `0`. | | page[limit] | integer | The number of degradations to return per page. Default: `50`. | | include | string | Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page. | | filter[status] | string | Optional degradation status filter. Supported values: investigating, identified, monitoring, resolved. | | sort | string | Sort order. Prefix with '-' for descending. Supported values: created_at, -created_at, modified_at, -modified_at. | | filter[source_id] | string | Optional source ID filter. Returns only degradations whose source matches this ID (for example, an incident ID). | ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} Response object for a list of degradations. | Parent field | Field | Type | Description | | --------------------- | --------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data [*required*] | [object] | A list of degradation data objects. | | data | attributes | object | The attributes of a degradation. | | attributes | components_affected | [object] | Components affected by the degradation. | | components_affected | id [*required*] | uuid | The ID of the component. | | components_affected | name | string | The name of the component. Read-only. | | components_affected | status [*required*] | enum | The status of the component. Allowed enum values: `operational`, `degraded`, `partial_outage`, `major_outage`, `maintenance`. | | attributes | created_at | date-time | Timestamp of when the degradation was created. | | attributes | description | string | Description of the degradation. | | attributes | is_backfilled | boolean | Whether the degradation was backfilled. | | attributes | modified_at | date-time | Timestamp of when the degradation was last modified. | | attributes | source | object | The source of the degradation. | | source | created_at [*required*] | date-time | Timestamp of when the source was created. | | source | source_id [*required*] | string | The ID of the source. | | source | type [*required*] | enum | The type of the source. Allowed enum values: `incident`. | | attributes | status | enum | The status of the degradation. Allowed enum values: `investigating`, `identified`, `monitoring`, `resolved`. | | attributes | title | string | Title of the degradation. | | attributes | updates | [object] | Past updates made to the degradation. | | updates | components_affected | [object] | The components affected at the time of the update. | | components_affected | id [*required*] | uuid | Identifier of the component affected at the time of the update. | | components_affected | name | string | The name of the component affected at the time of the update. Read-only. | | components_affected | status [*required*] | enum | The status of the component affected at the time of the update. Allowed enum values: `operational`, `degraded`, `partial_outage`, `major_outage`, `maintenance`. | | updates | created_at | date-time | Timestamp of when the update was created. Read-only. | | updates | deleted_at | string | The date and time the resource was deleted. | | updates | deleted_by_user_uuid | string | UUID of the user who deleted the resource. | | updates | description | string | Description of the update. | | updates | id | uuid | Identifier of the update. Read-only. | | updates | last_modified_by_user_uuid | string | UUID of the user who last modified the resource. | | updates | modified_at | date-time | Timestamp of when the update was last modified. Read-only. | | updates | started_at | date-time | Timestamp of when the update started. | | updates | status | enum | The status of the degradation. Allowed enum values: `investigating`, `identified`, `monitoring`, `resolved`. | | data | id | uuid | The ID of the degradation. | | data | relationships | object | The relationships of a degradation. | | relationships | created_by_user | object | The Datadog user who created the degradation. | | created_by_user | data [*required*] | object | The data object identifying the Datadog user who created the degradation. | | data | id [*required*] | string | The ID of the Datadog user who created the degradation. | | 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 degradation. | | last_modified_by_user | data [*required*] | object | The data object identifying the Datadog user who last modified the degradation. | | data | id [*required*] | string | The ID of the Datadog user who last modified the degradation. | | data | type [*required*] | enum | Users resource type. Allowed enum values: `users`. Default: `users`. | | relationships | status_page | object | The status page the degradation belongs to. | | status_page | data [*required*] | object | The data object identifying the status page the degradation belongs to. | | 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`. | | relationships | template | object | The template the degradation was created from. | | template | data [*required*] | object | The data object identifying the template the degradation was created from. | | data | id [*required*] | string | The ID of the degradation template. | | data | type [*required*] | enum | Degradation templates resource type. Allowed enum values: `degradation_templates`. Default: `degradation_templates`. | | data | type [*required*] | enum | Degradations resource type. Allowed enum values: `degradations`. Default: `degradations`. | | | included | [] | The included related resources of a degradation. 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`. | | included | | object | The included status page resource. | | | attributes | object | The attributes of a status page. | | attributes | company_logo | string | The base64-encoded image data displayed in the company logo. | | 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 grouped component. Read-only. | | components | name | string | The name of the grouped component. | | components | position | int64 | The zero-indexed position of the grouped 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. Read-only. | | 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`. | | | id | uuid | The ID of the status page. | | | 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`. | | | type [*required*] | enum | Status pages resource type. Allowed enum values: `status_pages`. Default: `status_pages`. | | | meta | object | Response metadata. Read-only. | | 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`. Default: `offset_limit`. | {% /tab %} {% tab label="Example" %} ```json { "data": [ { "attributes": { "components_affected": [ { "id": "1234abcd-12ab-34cd-56ef-123456abcdef", "name": "string", "status": "operational" } ], "created_at": "2019-09-19T10:00:00.000Z", "description": "string", "is_backfilled": false, "modified_at": "2019-09-19T10:00:00.000Z", "source": { "created_at": "", "source_id": "", "type": "incident" }, "status": "investigating", "title": "string", "updates": [ { "components_affected": [ { "id": "1234abcd-12ab-34cd-56ef-123456abcdef", "name": "string", "status": "operational" } ], "created_at": "2019-09-19T10:00:00.000Z", "deleted_at": "string", "deleted_by_user_uuid": "string", "description": "string", "id": "string", "last_modified_by_user_uuid": "string", "modified_at": "2019-09-19T10:00:00.000Z", "started_at": "2019-09-19T10:00:00.000Z", "status": "investigating" } ] }, "id": "string", "relationships": { "created_by_user": { "data": { "id": "", "type": "users" } }, "last_modified_by_user": { "data": { "id": "", "type": "users" } }, "status_page": { "data": { "id": "1234abcd-12ab-34cd-56ef-123456abcdef", "type": "status_pages" } }, "template": { "data": { "id": "", "type": "degradation_templates" } } }, "type": "degradations" } ], "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 %} {% /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 # 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 GET "https://api.${DD_SITE}/api/v2/statuspages/degradations" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ``` {% /tab %} {% tab label="Go" %} ```go // List degradations 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()) 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.ListDegradations(ctx, *datadogV2.NewListDegradationsOptionalParameters()) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `StatusPagesApi.ListDegradations`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `StatusPagesApi.ListDegradations`:\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 // List degradations 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.DegradationArray; 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); try { DegradationArray result = apiInstance.listDegradations(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling StatusPagesApi#listDegradations"); 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 """ List degradations 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 configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] with ApiClient(configuration) as api_client: api_instance = StatusPagesApi(api_client) response = api_instance.list_degradations() 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 # List degradations 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 p api_instance.list_degradations() ``` #### 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 // List degradations returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_status_pages::ListDegradationsOptionalParams; 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_degradations(ListDegradationsOptionalParams::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 /** * List degradations 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); apiInstance .listDegradations() .then((data: v2.DegradationArray) => { 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 %}