Skip to content

Commit 3eb37a5

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Add Publish and Unpublish API documentation for Status Pages (#3838)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent cafc7b3 commit 3eb37a5

File tree

51 files changed

+1151
-482
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+1151
-482
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 62 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107213,7 +107213,7 @@ paths:
107213107213
permissions:
107214107214
- status_pages_settings_read
107215107215
post:
107216-
description: Creates a new status page.
107216+
description: "Creates a new status page. **Note**: Publishing a status page on creation via the `enabled` property will be deprecated. Use the dedicated [publish](#publish-status-page) status page endpoint after creation instead."
107217107217
operationId: CreateStatusPage
107218107218
parameters:
107219107219
- description: "Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user."
@@ -107428,7 +107428,7 @@ paths:
107428107428
permissions:
107429107429
- status_pages_settings_read
107430107430
patch:
107431-
description: Updates an existing status page's attributes.
107431+
description: "Updates an existing status page's attributes. **Note**: Publishing and unpublishing via the `enabled` property will be deprecated on this endpoint. Use the dedicated [publish](#publish-status-page) and [unpublish](#unpublish-status-page) status page endpoints instead."
107432107432
operationId: UpdateStatusPage
107433107433
parameters:
107434107434
- description: Whether to delete existing subscribers when updating a status page's type.
@@ -108027,6 +108027,66 @@ paths:
108027108027
operator: AND
108028108028
permissions:
108029108029
- status_pages_incident_write
108030+
/api/v2/statuspages/{page_id}/publish:
108031+
post:
108032+
description: Publishes a status page. For pages of type `public`, makes the status page available on the public internet and requires the `status_pages_public_page_publish` permission. For pages of type `internal`, makes the status page available under the `status-pages/$domain_prefix/view` route within the Datadog organization and requires the `status_pages_internal_page_publish` permission. The `status_pages_settings_write` permission is temporarily honored as we migrate publishing functionality from the update status page endpoint to the publish status page endpoint.
108033+
operationId: PublishStatusPage
108034+
parameters:
108035+
- description: The ID of the status page.
108036+
in: path
108037+
name: page_id
108038+
required: true
108039+
schema:
108040+
format: uuid
108041+
type: string
108042+
responses:
108043+
"204":
108044+
description: No Content
108045+
"429":
108046+
$ref: "#/components/responses/TooManyRequestsResponse"
108047+
security:
108048+
- apiKeyAuth: []
108049+
appKeyAuth: []
108050+
- AuthZ: []
108051+
summary: Publish status page
108052+
tags:
108053+
- Status Pages
108054+
x-permission:
108055+
operator: OR
108056+
permissions:
108057+
- status_pages_settings_write
108058+
- status_pages_public_page_publish
108059+
- status_pages_internal_page_publish
108060+
/api/v2/statuspages/{page_id}/unpublish:
108061+
post:
108062+
description: Unpublishes a status page. For pages of type `public`, removes the status page from the public internet and requires the `status_pages_public_page_publish` permission. For pages of type `internal`, removes the `status-pages/$domain_prefix/view` route from the Datadog organization and requires the `status_pages_internal_page_publish` permission. The `status_pages_settings_write` permission is temporarily honored as we migrate unpublishing functionality from the update status page endpoint to the unpublish status page endpoint.
108063+
operationId: UnpublishStatusPage
108064+
parameters:
108065+
- description: The ID of the status page.
108066+
in: path
108067+
name: page_id
108068+
required: true
108069+
schema:
108070+
format: uuid
108071+
type: string
108072+
responses:
108073+
"204":
108074+
description: No Content
108075+
"429":
108076+
$ref: "#/components/responses/TooManyRequestsResponse"
108077+
security:
108078+
- apiKeyAuth: []
108079+
appKeyAuth: []
108080+
- AuthZ: []
108081+
summary: Unpublish status page
108082+
tags:
108083+
- Status Pages
108084+
x-permission:
108085+
operator: OR
108086+
permissions:
108087+
- status_pages_settings_write
108088+
- status_pages_public_page_publish
108089+
- status_pages_internal_page_publish
108030108090
/api/v2/synthetics/api-multistep/subtests/{public_id}:
108031108091
get:
108032108092
description: |-
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
"2026-02-24T17:00:35.997Z"
1+
"2026-03-31T18:43:45.443Z"

cassettes/v2/Status-Pages_1054991783/Create-component-returns-Created-response_1368822724/recording.har

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
},
99
"entries": [
1010
{
11-
"_id": "311210609114e4265052d34ab4a2e8a2",
11+
"_id": "1ab5246f885fabfdaf11742e3e49c704",
1212
"_order": 0,
1313
"cache": {},
1414
"request": {
@@ -26,13 +26,13 @@
2626
"value": "application/json"
2727
}
2828
],
29-
"headersSize": 560,
29+
"headersSize": 562,
3030
"httpVersion": "HTTP/1.1",
3131
"method": "POST",
3232
"postData": {
3333
"mimeType": "application/json",
3434
"params": [],
35-
"text": "{\"data\":{\"attributes\":{\"components\":[{\"components\":[{\"name\":\"Login\",\"position\":0,\"type\":\"component\"},{\"name\":\"Settings\",\"position\":1,\"type\":\"component\"}],\"name\":\"Application\",\"type\":\"group\"}],\"domain_prefix\":\"df531f11f71a2e23\",\"enabled\":true,\"name\":\"A Status Page\",\"type\":\"internal\",\"visualization_type\":\"bars_and_uptime_percentage\"},\"type\":\"status_pages\"}}"
35+
"text": "{\"data\":{\"attributes\":{\"components\":[{\"components\":[{\"name\":\"Login\",\"position\":0,\"type\":\"component\"},{\"name\":\"Settings\",\"position\":1,\"type\":\"component\"}],\"name\":\"Application\",\"type\":\"group\"}],\"domain_prefix\":\"9dbd15ff66733c82\",\"enabled\":true,\"name\":\"A Status Page\",\"type\":\"internal\",\"visualization_type\":\"bars_and_uptime_percentage\"},\"type\":\"status_pages\"}}"
3636
},
3737
"queryString": [],
3838
"url": "https://api.datadoghq.com/api/v2/statuspages"
@@ -42,7 +42,7 @@
4242
"content": {
4343
"mimeType": "application/vnd.api+json",
4444
"size": 1116,
45-
"text": "{\"data\":{\"id\":\"3483924e-54de-4b7f-9177-56f224f8c6e6\",\"type\":\"status_pages\",\"attributes\":{\"company_logo\":null,\"components\":[{\"id\":\"d03bffa2-720c-4f82-871e-3f1599d38089\",\"name\":\"Application\",\"type\":\"group\",\"position\":0,\"components\":[{\"id\":\"6fe382cb-5309-49bf-b56b-c9921a7d8153\",\"name\":\"Login\",\"type\":\"component\",\"status\":\"operational\",\"position\":0},{\"id\":\"b8a9ac5d-2470-4c43-b90d-817ba996822c\",\"name\":\"Settings\",\"type\":\"component\",\"status\":\"operational\",\"position\":1}]}],\"created_at\":\"2026-02-24T17:00:36.165599Z\",\"custom_domain\":null,\"custom_domain_enabled\":false,\"domain_prefix\":\"df531f11f71a2e23\",\"email_header_image\":null,\"enabled\":true,\"favicon\":null,\"modified_at\":\"2026-02-24T17:00:36.165599Z\",\"name\":\"A Status Page\",\"page_url\":\"https://frog.datadoghq.com/status-pages/3483924e-54de-4b7f-9177-56f224f8c6e6/view\",\"subscriptions_enabled\":false,\"type\":\"internal\",\"visualization_type\":\"bars_and_uptime_percentage\"},\"relationships\":{\"created_by_user\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"users\"}},\"last_modified_by_user\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"users\"}}}}}"
45+
"text": "{\"data\":{\"id\":\"daae96b1-2114-4979-8668-2f782fe4a82b\",\"type\":\"status_pages\",\"attributes\":{\"company_logo\":null,\"components\":[{\"id\":\"0827c72a-5886-4850-b9a0-3c0b62fd5cbd\",\"name\":\"Application\",\"type\":\"group\",\"position\":0,\"components\":[{\"id\":\"2944ac68-cc1f-43bc-9950-a81912daf613\",\"name\":\"Login\",\"type\":\"component\",\"status\":\"operational\",\"position\":0},{\"id\":\"7374a8e5-7d66-43be-83f0-4337a739bdfb\",\"name\":\"Settings\",\"type\":\"component\",\"status\":\"operational\",\"position\":1}]}],\"created_at\":\"2026-03-31T18:43:45.548049Z\",\"custom_domain\":null,\"custom_domain_enabled\":false,\"domain_prefix\":\"9dbd15ff66733c82\",\"email_header_image\":null,\"enabled\":true,\"favicon\":null,\"modified_at\":\"2026-03-31T18:43:45.548049Z\",\"name\":\"A Status Page\",\"page_url\":\"https://frog.datadoghq.com/status-pages/daae96b1-2114-4979-8668-2f782fe4a82b/view\",\"subscriptions_enabled\":false,\"type\":\"internal\",\"visualization_type\":\"bars_and_uptime_percentage\"},\"relationships\":{\"created_by_user\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"users\"}},\"last_modified_by_user\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"users\"}}}}}"
4646
},
4747
"cookies": [],
4848
"headers": [
@@ -57,11 +57,11 @@
5757
"status": 201,
5858
"statusText": "Created"
5959
},
60-
"startedDateTime": "2026-02-24T17:00:36.000Z",
61-
"time": 624
60+
"startedDateTime": "2026-03-31T18:43:45.448Z",
61+
"time": 530
6262
},
6363
{
64-
"_id": "b22511f36f59380bc0ac6c152b614707",
64+
"_id": "502c3e7100a9f1d1dd961f393aeea16f",
6565
"_order": 0,
6666
"cache": {},
6767
"request": {
@@ -79,7 +79,7 @@
7979
"value": "application/json"
8080
}
8181
],
82-
"headersSize": 606,
82+
"headersSize": 608,
8383
"httpVersion": "HTTP/1.1",
8484
"method": "POST",
8585
"postData": {
@@ -88,14 +88,14 @@
8888
"text": "{\"data\":{\"attributes\":{\"name\":\"Logs\",\"position\":0,\"type\":\"component\"},\"type\":\"components\"}}"
8989
},
9090
"queryString": [],
91-
"url": "https://api.datadoghq.com/api/v2/statuspages/3483924e-54de-4b7f-9177-56f224f8c6e6/components"
91+
"url": "https://api.datadoghq.com/api/v2/statuspages/daae96b1-2114-4979-8668-2f782fe4a82b/components"
9292
},
9393
"response": {
94-
"bodySize": 556,
94+
"bodySize": 558,
9595
"content": {
9696
"mimeType": "application/vnd.api+json",
97-
"size": 556,
98-
"text": "{\"data\":{\"id\":\"060dba63-7f63-4d0f-9278-aecabc6f9c30\",\"type\":\"components\",\"attributes\":{\"created_at\":\"2026-02-24T17:00:36.79986Z\",\"modified_at\":\"2026-02-24T17:00:36.79986Z\",\"name\":\"Logs\",\"position\":0,\"status\":\"operational\",\"type\":\"component\"},\"relationships\":{\"created_by_user\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"users\"}},\"group\":{\"data\":null},\"last_modified_by_user\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"users\"}},\"status_page\":{\"data\":{\"id\":\"3483924e-54de-4b7f-9177-56f224f8c6e6\",\"type\":\"status_pages\"}}}}}"
97+
"size": 558,
98+
"text": "{\"data\":{\"id\":\"dc1f6182-86a0-4f18-a4de-78f99ff1455f\",\"type\":\"components\",\"attributes\":{\"created_at\":\"2026-03-31T18:43:46.083871Z\",\"modified_at\":\"2026-03-31T18:43:46.083871Z\",\"name\":\"Logs\",\"position\":0,\"status\":\"operational\",\"type\":\"component\"},\"relationships\":{\"created_by_user\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"users\"}},\"group\":{\"data\":null},\"last_modified_by_user\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"users\"}},\"status_page\":{\"data\":{\"id\":\"daae96b1-2114-4979-8668-2f782fe4a82b\",\"type\":\"status_pages\"}}}}}"
9999
},
100100
"cookies": [],
101101
"headers": [
@@ -110,11 +110,11 @@
110110
"status": 201,
111111
"statusText": "Created"
112112
},
113-
"startedDateTime": "2026-02-24T17:00:36.634Z",
114-
"time": 182
113+
"startedDateTime": "2026-03-31T18:43:45.988Z",
114+
"time": 128
115115
},
116116
{
117-
"_id": "36ae825ce73c795043d3cb42af7312d9",
117+
"_id": "e52b72692876e1287497ad731a8df83d",
118118
"_order": 0,
119119
"cache": {},
120120
"request": {
@@ -127,11 +127,11 @@
127127
"value": "*/*"
128128
}
129129
],
130-
"headersSize": 580,
130+
"headersSize": 582,
131131
"httpVersion": "HTTP/1.1",
132132
"method": "DELETE",
133133
"queryString": [],
134-
"url": "https://api.datadoghq.com/api/v2/statuspages/3483924e-54de-4b7f-9177-56f224f8c6e6/components/060dba63-7f63-4d0f-9278-aecabc6f9c30"
134+
"url": "https://api.datadoghq.com/api/v2/statuspages/daae96b1-2114-4979-8668-2f782fe4a82b/components/dc1f6182-86a0-4f18-a4de-78f99ff1455f"
135135
},
136136
"response": {
137137
"bodySize": 0,
@@ -147,11 +147,11 @@
147147
"status": 204,
148148
"statusText": "No Content"
149149
},
150-
"startedDateTime": "2026-02-24T17:00:36.826Z",
151-
"time": 90
150+
"startedDateTime": "2026-03-31T18:43:46.127Z",
151+
"time": 132
152152
},
153153
{
154-
"_id": "0e65686eb30a34d27f6be2214bb96ce3",
154+
"_id": "4c9860009294c51429ae3f8dca5862b2",
155155
"_order": 0,
156156
"cache": {},
157157
"request": {
@@ -164,11 +164,11 @@
164164
"value": "*/*"
165165
}
166166
],
167-
"headersSize": 533,
167+
"headersSize": 535,
168168
"httpVersion": "HTTP/1.1",
169169
"method": "DELETE",
170170
"queryString": [],
171-
"url": "https://api.datadoghq.com/api/v2/statuspages/3483924e-54de-4b7f-9177-56f224f8c6e6"
171+
"url": "https://api.datadoghq.com/api/v2/statuspages/daae96b1-2114-4979-8668-2f782fe4a82b"
172172
},
173173
"response": {
174174
"bodySize": 0,
@@ -184,8 +184,8 @@
184184
"status": 204,
185185
"statusText": "No Content"
186186
},
187-
"startedDateTime": "2026-02-24T17:00:36.921Z",
188-
"time": 752
187+
"startedDateTime": "2026-03-31T18:43:46.266Z",
188+
"time": 556
189189
}
190190
],
191191
"pages": [],
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
"2026-02-24T17:00:37.682Z"
1+
"2026-03-31T18:43:46.834Z"

0 commit comments

Comments
 (0)