--- title: "List maintenances" method: GET path: "/api/v2/statuspages/maintenances" tags: ["Status Pages"] --- # List maintenances `GET /api/v2/statuspages/maintenances` Lists all maintenances for the organization. Optionally filter by status and page. ## Query parameters - `filter[page_id]` string - `page[offset]` integer - `page[limit]` integer - `include` string - `filter[status]` string - `sort` string ## Response `200` OK - MaintenanceArray — Response object for a list of maintenances. - `data` MaintenanceData[], required — A list of maintenance data objects. - `attributes` MaintenanceDataAttributes — The attributes of a maintenance. - `completed_date` string, date-time — Timestamp of when the maintenance was completed. - `completed_description` string — The description shown when the maintenance is completed. - `components_affected` MaintenanceDataAttributesComponentsAffectedItems[] — Components affected by the maintenance. - `id` string, uuid, required — The ID of the component. Must be a component of type `component`. - `name` string — The name of the component. - `status` 'operational' | 'maintenance', required — The status of the component. - `in_progress_description` string — The description shown while the maintenance is in progress. - `is_backfilled` boolean — Whether the maintenance was backfilled. - `modified_at` string, date-time — Timestamp of when the maintenance was last modified. - `published_date` string, date-time — Timestamp of when the maintenance was published. - `scheduled_description` string — The description shown when the maintenance is scheduled. - `start_date` string, date-time — Timestamp of when the maintenance is scheduled to start. - `status` 'scheduled' | 'in_progress' | 'completed' — The status of the maintenance. - `title` string — Title of the maintenance. - `updates` MaintenanceDataAttributesUpdatesItems[] — Past updates made to the maintenance. - `components_affected` MaintenanceDataAttributesUpdatesItemsComponentsAffectedItems[] — The components affected at the time of the update. - `id` string, uuid, required — Identifier of the component affected at the time of the update. - `name` string — The name of the component affected at the time of the update. - `status` 'operational' | 'maintenance', required — The status of the component. - `created_at` string, date-time — Timestamp of when the update was created. - `description` string — Description of the update. - `id` string, uuid — Identifier of the update. - `manual_transition` boolean — Whether the update was applied manually by a user (true) or automatically by the system (false). - `modified_at` string, date-time — Timestamp of when the update was last modified. - `started_at` string, date-time — Timestamp of when the update started. - `status` string — The status of the update. - `id` string, uuid — The ID of the maintenance. - `relationships` MaintenanceDataRelationships — The relationships of a maintenance. - `created_by_user` MaintenanceDataRelationshipsCreatedByUser — The Datadog user who created the maintenance. - `data` MaintenanceDataRelationshipsCreatedByUserData, required — The data object identifying the Datadog user who created the maintenance. - `id` string, uuid, required — The ID of the Datadog user who created the maintenance. - `type` 'users', required — Users resource type. - `last_modified_by_user` MaintenanceDataRelationshipsLastModifiedByUser — The Datadog user who last modified the maintenance. - `data` MaintenanceDataRelationshipsLastModifiedByUserData, required — The data object identifying the Datadog user who last modified the maintenance. - `id` string, uuid, required — The ID of the Datadog user who last modified the maintenance. - `type` 'users', required — Users resource type. - `status_page` MaintenanceDataRelationshipsStatusPage — The status page the maintenance belongs to. - `data` MaintenanceDataRelationshipsStatusPageData, required — The data object identifying the status page associated with a maintenance. - `id` string, uuid, required — The ID of the status page. - `type` 'status_pages', required — Status pages resource type. - `type` 'maintenances', required — Maintenances resource type. - `included` DegradationIncluded[] — The included related resources of a maintenance. Client must explicitly request these resources by name in the `include` query parameter. - union — An included resource related to a degradation or maintenance. - StatusPagesUser — The included Datadog user resource. - `attributes` StatusPagesUserAttributes — Attributes of the Datadog user. - `email` string — The email of the Datadog user. - `handle` string — The handle of the Datadog user. - `icon` string — The icon of the Datadog user. - `name` string — The name of the Datadog user. - `uuid` string — The UUID of the Datadog user. - `id` string, uuid — The ID of the Datadog user. - `type` 'users', required — Users resource type. - StatusPageAsIncluded — The included status page resource. - `attributes` StatusPageAsIncludedAttributes — The attributes of a status page. - `company_logo` string — The base64-encoded image data displayed in the company logo. - `components` StatusPageAsIncludedAttributesComponentsItems[] — Components displayed on the status page. - `components` StatusPageAsIncludedAttributesComponentsItemsComponentsItems[] — If the component is of type `group`, the components within the group. - … - `id` string, uuid — The ID of the component. - `name` string — The name of the component. - `position` integer — The zero-indexed position of the component. - `status` 'operational' | 'degraded' | 'partial_outage' | 'major_outage' | 'maintenance' — The status of the component. - `type` 'component' | 'group' — The type of the component. - `created_at` string, date-time — Timestamp of when the status page was created. - `custom_domain` string — If configured, the url that the status page is accessible at. - `custom_domain_enabled` boolean — Whether the custom domain is configured. - `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. - `email_header_image` string — Base64-encoded image data included in email notifications sent to status page subscribers. - `enabled` boolean — Whether the status page is enabled. - `favicon` string — Base64-encoded image data displayed in the browser tab. - `modified_at` string, date-time — Timestamp of when the status page was last modified. - `name` string — The name of the status page. - `page_url` string — The url that the status page is accessible at. - `slack_app_icon` string — The Slack app icon URL for the status page. - `slack_subscriptions_enabled` boolean — Whether Slack subscriptions are enabled for the status page. - `subscriptions_enabled` boolean — Whether users can subscribe to the status page. - `type` 'public' | 'internal' — The type of the status page controlling how the status page is accessed. - `visualization_type` 'bars_and_uptime_percentage' | 'bars_only' | 'component_name_only' — The visualization type of the status page. - `id` string, uuid — The ID of the status page. - `relationships` StatusPageAsIncludedRelationships — The relationships of a status page. - `created_by_user` StatusPageAsIncludedRelationshipsCreatedByUser — The Datadog user who created the status page. - `data` StatusPageAsIncludedRelationshipsCreatedByUserData, required — The data object identifying the Datadog user who created the status page. - … - `last_modified_by_user` StatusPageAsIncludedRelationshipsLastModifiedByUser — The Datadog user who last modified the status page. - `data` StatusPageAsIncludedRelationshipsLastModifiedByUserData, required — The data object identifying the Datadog user who last modified the status page. - … - `type` 'status_pages', required — Status pages resource type. - `meta` PaginationMeta — Response metadata. - `page` PaginationMetaPage — Offset-based pagination schema. - `first_offset` integer — Integer representing the offset to fetch the first page of results. - `last_offset` integer, nullable — Integer representing the offset to fetch the last page of results. - `limit` integer — Integer representing the number of elements to be returned in the results. - `next_offset` integer, nullable — Integer representing the index of the first element in the next page of results. Equal to page size added to the current offset. - `offset` integer — Integer representing the index of the first element in the results. - `prev_offset` integer, nullable — Integer representing the index of the first element in the previous page of results. - `total` integer, nullable — Integer representing the total number of elements available. - `type` 'offset_limit' — The pagination type used for offset-based pagination. ## Other responses - `429` — Too many requests --- [API](https://skmtc.net/datadog/apis/api-v2.md) · [All operations](https://skmtc.net/datadog/apis/api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/datadog/api-v2/revisions/da68bf029e4c/schema)