Skip to content

Commit e4826a7

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Update Status Pages API documentation to reflect deprecation of creating a published status page (#3446)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent df939b7 commit e4826a7

52 files changed

Lines changed: 358 additions & 307 deletions

File tree

Some content is hidden

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

‎.generator/schemas/v2/openapi.yaml‎

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17311,7 +17311,6 @@ components:
1731117311
type: component
1731217312
domain_prefix: status-page-us1
1731317313
email_header_image: data:image/png;base64,pQSLAw0KGgoAAAANSUhEUgAAAQ4AASJKFF
17314-
enabled: true
1731517314
favicon: data:image/png;base64,kWMRNw0KGgoAAAANSUhEUgAAAEAAAABACA
1731617315
name: Status Page US1
1731717316
subscriptions_enabled: true
@@ -17370,10 +17369,6 @@ components:
1737017369
description: Base64-encoded image data included in email notifications sent to status page subscribers.
1737117370
example: data:image/png;base64,pQSLAw0KGgoAAAANSUhEUgAAAQ4AASJKFF
1737217371
type: string
17373-
enabled:
17374-
description: Whether the status page is enabled.
17375-
example: true
17376-
type: boolean
1737717372
favicon:
1737817373
description: Base64-encoded image data displayed in the browser tab.
1737917374
example: data:image/png;base64,kWMRNw0KGgoAAAANSUhEUgAAAEAAAABACA
@@ -17394,7 +17389,6 @@ components:
1739417389
example: bars_and_uptime_percentage
1739517390
required:
1739617391
- domain_prefix
17397-
- enabled
1739817392
- name
1739917393
- type
1740017394
- visualization_type
@@ -127501,7 +127495,7 @@ paths:
127501127495
permissions:
127502127496
- status_pages_settings_read
127503127497
post:
127504-
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."
127498+
description: "Creates a new status page in an unpublished state. Use the dedicated [publish](#publish-status-page) status page endpoint to publish the page after creation."
127505127499
operationId: CreateStatusPage
127506127500
parameters:
127507127501
- description: "Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user."
@@ -127537,7 +127531,6 @@ paths:
127537127531
type: component
127538127532
domain_prefix: status-page-us1
127539127533
email_header_image: data:image/png;base64,pQSLAw0KGgoAAAANSUhEUgAAAQ4AASJKFF
127540-
enabled: true
127541127534
favicon: data:image/png;base64,kWMRNw0KGgoAAAANSUhEUgAAAEAAAABACA
127542127535
name: Status Page US1
127543127536
subscriptions_enabled: true

‎examples/v2/status-pages/CreateStatusPage.py‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@
3838
position=1,
3939
),
4040
],
41-
enabled=True,
4241
type=CreateStatusPageRequestDataAttributesType.INTERNAL,
4342
visualization_type=CreateStatusPageRequestDataAttributesVisualizationType.BARS_AND_UPTIME_PERCENTAGE,
4443
),

‎examples/v2/status-pages/PublishStatusPage.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@
66
from datadog_api_client import ApiClient, Configuration
77
from datadog_api_client.v2.api.status_pages_api import StatusPagesApi
88

9-
# there is a valid "unpublished_status_page" in the system
10-
UNPUBLISHED_STATUS_PAGE_DATA_ID = environ["UNPUBLISHED_STATUS_PAGE_DATA_ID"]
9+
# there is a valid "status_page" in the system
10+
STATUS_PAGE_DATA_ID = environ["STATUS_PAGE_DATA_ID"]
1111

1212
configuration = Configuration()
1313
with ApiClient(configuration) as api_client:
1414
api_instance = StatusPagesApi(api_client)
1515
api_instance.publish_status_page(
16-
page_id=UNPUBLISHED_STATUS_PAGE_DATA_ID,
16+
page_id=STATUS_PAGE_DATA_ID,
1717
)

‎examples/v2/status-pages/UnpublishStatusPage.py‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,13 @@
22
Unpublish status page returns "No Content" response
33
"""
44

5-
from os import environ
65
from datadog_api_client import ApiClient, Configuration
76
from datadog_api_client.v2.api.status_pages_api import StatusPagesApi
8-
9-
# there is a valid "status_page" in the system
10-
STATUS_PAGE_DATA_ID = environ["STATUS_PAGE_DATA_ID"]
7+
from uuid import UUID
118

129
configuration = Configuration()
1310
with ApiClient(configuration) as api_client:
1411
api_instance = StatusPagesApi(api_client)
1512
api_instance.unpublish_status_page(
16-
page_id=STATUS_PAGE_DATA_ID,
13+
page_id=UUID("9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"),
1714
)

‎src/datadog_api_client/v2/api/status_pages_api.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -845,7 +845,7 @@ def create_status_page(
845845
) -> StatusPage:
846846
"""Create status page.
847847
848-
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.
848+
Creates a new status page in an unpublished state. Use the dedicated `publish <#publish-status-page>`_ status page endpoint to publish the page after creation.
849849
850850
:type body: CreateStatusPageRequest
851851
:param include: Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user.

‎src/datadog_api_client/v2/model/create_status_page_request_data_attributes.py‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@ def openapi_types(_):
4343
"components": ([CreateStatusPageRequestDataAttributesComponentsItems],),
4444
"domain_prefix": (str,),
4545
"email_header_image": (str,),
46-
"enabled": (bool,),
4746
"favicon": (str,),
4847
"name": (str,),
4948
"subscriptions_enabled": (bool,),
@@ -56,7 +55,6 @@ def openapi_types(_):
5655
"components": "components",
5756
"domain_prefix": "domain_prefix",
5857
"email_header_image": "email_header_image",
59-
"enabled": "enabled",
6058
"favicon": "favicon",
6159
"name": "name",
6260
"subscriptions_enabled": "subscriptions_enabled",
@@ -67,7 +65,6 @@ def openapi_types(_):
6765
def __init__(
6866
self_,
6967
domain_prefix: str,
70-
enabled: bool,
7168
name: str,
7269
type: CreateStatusPageRequestDataAttributesType,
7370
visualization_type: CreateStatusPageRequestDataAttributesVisualizationType,
@@ -93,9 +90,6 @@ def __init__(
9390
:param email_header_image: Base64-encoded image data included in email notifications sent to status page subscribers.
9491
:type email_header_image: str, optional
9592
96-
:param enabled: Whether the status page is enabled.
97-
:type enabled: bool
98-
9993
:param favicon: Base64-encoded image data displayed in the browser tab.
10094
:type favicon: str, optional
10195
@@ -124,7 +118,6 @@ def __init__(
124118
super().__init__(kwargs)
125119

126120
self_.domain_prefix = domain_prefix
127-
self_.enabled = enabled
128121
self_.name = name
129122
self_.type = type
130123
self_.visualization_type = visualization_type

‎tests/v2/cassettes/test_scenarios/test_create_component_returns_created_response.frozen‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2026-03-31T18:43:45.443Z
1+
2026-04-24T14:12:37.493Z

‎tests/v2/cassettes/test_scenarios/test_create_component_returns_created_response.yaml‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
interactions:
22
- request:
3-
body: '{"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
3+
body: '{"data":{"attributes":{"components":[{"components":[{"name":"Login","position":0,"type":"component"},{"name":"Settings","position":1,"type":"component"}],"name":"Application","type":"group"}],"domain_prefix":"f456820b7958024f","name":"A
44
Status Page","type":"internal","visualization_type":"bars_and_uptime_percentage"},"type":"status_pages"}}'
55
headers:
66
accept:
@@ -11,8 +11,8 @@ interactions:
1111
uri: https://api.datadoghq.com/api/v2/statuspages
1212
response:
1313
body:
14-
string: '{"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
15-
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"}}}}}'
14+
string: '{"data":{"id":"b02801ff-949d-467e-967d-5943c8f1c7af","type":"status_pages","attributes":{"company_logo":null,"components":[{"id":"7f96e5c3-f033-4640-bf8a-7018e134c8b5","name":"Application","type":"group","position":0,"components":[{"id":"feefa8d8-7485-4bfb-82a6-86268c1d68b3","name":"Login","type":"component","status":"operational","position":0},{"id":"b2f95a96-3261-40fb-bb5a-f95203741608","name":"Settings","type":"component","status":"operational","position":1}]}],"created_at":"2026-04-24T14:12:37.623742Z","custom_domain":null,"custom_domain_enabled":false,"domain_prefix":"f456820b7958024f","email_header_image":null,"enabled":false,"favicon":null,"modified_at":"2026-04-24T14:12:37.623742Z","name":"A
15+
Status Page","page_url":"https://frog.datadoghq.com/status-pages/b02801ff-949d-467e-967d-5943c8f1c7af/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"}}}}}'
1616
headers:
1717
content-type:
1818
- application/vnd.api+json
@@ -27,10 +27,10 @@ interactions:
2727
content-type:
2828
- application/json
2929
method: POST
30-
uri: https://api.datadoghq.com/api/v2/statuspages/daae96b1-2114-4979-8668-2f782fe4a82b/components
30+
uri: https://api.datadoghq.com/api/v2/statuspages/b02801ff-949d-467e-967d-5943c8f1c7af/components
3131
response:
3232
body:
33-
string: '{"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"}}}}}'
33+
string: '{"data":{"id":"ef964967-c6b6-465a-a260-0468b697036c","type":"components","attributes":{"created_at":"2026-04-24T14:12:38.188993Z","modified_at":"2026-04-24T14:12:38.188993Z","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":"b02801ff-949d-467e-967d-5943c8f1c7af","type":"status_pages"}}}}}'
3434
headers:
3535
content-type:
3636
- application/vnd.api+json
@@ -43,7 +43,7 @@ interactions:
4343
accept:
4444
- '*/*'
4545
method: DELETE
46-
uri: https://api.datadoghq.com/api/v2/statuspages/daae96b1-2114-4979-8668-2f782fe4a82b/components/dc1f6182-86a0-4f18-a4de-78f99ff1455f
46+
uri: https://api.datadoghq.com/api/v2/statuspages/b02801ff-949d-467e-967d-5943c8f1c7af/components/ef964967-c6b6-465a-a260-0468b697036c
4747
response:
4848
body:
4949
string: ''
@@ -57,7 +57,7 @@ interactions:
5757
accept:
5858
- '*/*'
5959
method: DELETE
60-
uri: https://api.datadoghq.com/api/v2/statuspages/daae96b1-2114-4979-8668-2f782fe4a82b
60+
uri: https://api.datadoghq.com/api/v2/statuspages/b02801ff-949d-467e-967d-5943c8f1c7af
6161
response:
6262
body:
6363
string: ''

‎tests/v2/cassettes/test_scenarios/test_create_degradation_returns_created_response.frozen‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2026-03-31T18:43:46.834Z
1+
2026-04-24T14:12:38.944Z

‎tests/v2/cassettes/test_scenarios/test_create_degradation_returns_created_response.yaml‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
interactions:
22
- request:
3-
body: '{"data":{"attributes":{"components":[{"components":[{"name":"Login","position":0,"type":"component"},{"name":"Settings","position":1,"type":"component"}],"name":"Application","type":"group"}],"domain_prefix":"5ddb4afc3c8db319","enabled":true,"name":"A
3+
body: '{"data":{"attributes":{"components":[{"components":[{"name":"Login","position":0,"type":"component"},{"name":"Settings","position":1,"type":"component"}],"name":"Application","type":"group"}],"domain_prefix":"6fadaccff9a14c1b","name":"A
44
Status Page","type":"internal","visualization_type":"bars_and_uptime_percentage"},"type":"status_pages"}}'
55
headers:
66
accept:
@@ -11,16 +11,16 @@ interactions:
1111
uri: https://api.datadoghq.com/api/v2/statuspages
1212
response:
1313
body:
14-
string: '{"data":{"id":"8c7a1055-f55b-49de-a9d0-f6ab38d62627","type":"status_pages","attributes":{"company_logo":null,"components":[{"id":"b8a1027c-f5f9-4fc9-8cb7-94412286e410","name":"Application","type":"group","position":0,"components":[{"id":"e92b23fc-fc4e-4f12-b1a7-66a78f4b950e","name":"Login","type":"component","status":"operational","position":0},{"id":"18cca9eb-d603-4051-806f-18557d6669b7","name":"Settings","type":"component","status":"operational","position":1}]}],"created_at":"2026-03-31T18:43:46.876375Z","custom_domain":null,"custom_domain_enabled":false,"domain_prefix":"5ddb4afc3c8db319","email_header_image":null,"enabled":true,"favicon":null,"modified_at":"2026-03-31T18:43:46.876375Z","name":"A
15-
Status Page","page_url":"https://frog.datadoghq.com/status-pages/8c7a1055-f55b-49de-a9d0-f6ab38d62627/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"}}}}}'
14+
string: '{"data":{"id":"7a6eba5d-657a-416e-943f-59102f88c3b5","type":"status_pages","attributes":{"company_logo":null,"components":[{"id":"c72b2d6b-f4fb-4934-a68c-265e4f9991d6","name":"Application","type":"group","position":0,"components":[{"id":"13dfd7ee-e741-41f9-af1a-d40fa4caf459","name":"Login","type":"component","status":"operational","position":0},{"id":"e2cffa19-a102-43e1-ac3c-7b36a7a61f52","name":"Settings","type":"component","status":"operational","position":1}]}],"created_at":"2026-04-24T14:12:39.042853Z","custom_domain":null,"custom_domain_enabled":false,"domain_prefix":"6fadaccff9a14c1b","email_header_image":null,"enabled":false,"favicon":null,"modified_at":"2026-04-24T14:12:39.042853Z","name":"A
15+
Status Page","page_url":"https://frog.datadoghq.com/status-pages/7a6eba5d-657a-416e-943f-59102f88c3b5/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"}}}}}'
1616
headers:
1717
content-type:
1818
- application/vnd.api+json
1919
status:
2020
code: 201
2121
message: Created
2222
- request:
23-
body: '{"data":{"attributes":{"components_affected":[{"id":"e92b23fc-fc4e-4f12-b1a7-66a78f4b950e","status":"major_outage"}],"description":"Our
23+
body: '{"data":{"attributes":{"components_affected":[{"id":"13dfd7ee-e741-41f9-af1a-d40fa4caf459","status":"major_outage"}],"description":"Our
2424
API is experiencing elevated latency. We are investigating the issue.","status":"investigating","title":"Elevated
2525
API Latency"},"type":"degradations"}}'
2626
headers:
@@ -29,13 +29,13 @@ interactions:
2929
content-type:
3030
- application/json
3131
method: POST
32-
uri: https://api.datadoghq.com/api/v2/statuspages/8c7a1055-f55b-49de-a9d0-f6ab38d62627/degradations
32+
uri: https://api.datadoghq.com/api/v2/statuspages/7a6eba5d-657a-416e-943f-59102f88c3b5/degradations
3333
response:
3434
body:
35-
string: '{"data":{"id":"461d1f73-cfa7-4d35-a7c9-7335243f5d71","type":"degradations","attributes":{"components_affected":[{"id":"e92b23fc-fc4e-4f12-b1a7-66a78f4b950e","name":"Login","status":"major_outage"}],"created_at":"2026-03-31T18:43:47.589302Z","description":"Our
36-
API is experiencing elevated latency. We are investigating the issue.","modified_at":"2026-03-31T18:43:47.589302Z","status":"investigating","title":"Elevated
37-
API Latency","updates":[{"id":"4917a25f-2e54-43c5-bf9c-58002b97e464","created_at":"2026-03-31T18:43:47.589302Z","modified_at":"2026-03-31T18:43:47.589302Z","started_at":"2026-03-31T18:43:47.589302Z","status":"investigating","description":"Our
38-
API is experiencing elevated latency. We are investigating the issue.","components_affected":[{"id":"e92b23fc-fc4e-4f12-b1a7-66a78f4b950e","name":"Login","status":"major_outage"}]}]},"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"}},"status_page":{"data":{"id":"8c7a1055-f55b-49de-a9d0-f6ab38d62627","type":"status_pages"}}}}}'
35+
string: '{"data":{"id":"ee2a3955-7bbf-4215-a80e-e989ecd58228","type":"degradations","attributes":{"components_affected":[{"id":"13dfd7ee-e741-41f9-af1a-d40fa4caf459","name":"Login","status":"major_outage"}],"created_at":"2026-04-24T14:12:39.710666Z","description":"Our
36+
API is experiencing elevated latency. We are investigating the issue.","modified_at":"2026-04-24T14:12:39.710666Z","status":"investigating","title":"Elevated
37+
API Latency","updates":[{"id":"59590192-d12c-468e-8e7e-fe34167ed517","created_at":"2026-04-24T14:12:39.710666Z","modified_at":"2026-04-24T14:12:39.710666Z","started_at":"2026-04-24T14:12:39.710666Z","status":"investigating","description":"Our
38+
API is experiencing elevated latency. We are investigating the issue.","components_affected":[{"id":"13dfd7ee-e741-41f9-af1a-d40fa4caf459","name":"Login","status":"major_outage"}]}]},"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"}},"status_page":{"data":{"id":"7a6eba5d-657a-416e-943f-59102f88c3b5","type":"status_pages"}}}}}'
3939
headers:
4040
content-type:
4141
- application/vnd.api+json
@@ -48,7 +48,7 @@ interactions:
4848
accept:
4949
- '*/*'
5050
method: DELETE
51-
uri: https://api.datadoghq.com/api/v2/statuspages/8c7a1055-f55b-49de-a9d0-f6ab38d62627/degradations/461d1f73-cfa7-4d35-a7c9-7335243f5d71
51+
uri: https://api.datadoghq.com/api/v2/statuspages/7a6eba5d-657a-416e-943f-59102f88c3b5/degradations/ee2a3955-7bbf-4215-a80e-e989ecd58228
5252
response:
5353
body:
5454
string: ''
@@ -62,7 +62,7 @@ interactions:
6262
accept:
6363
- '*/*'
6464
method: DELETE
65-
uri: https://api.datadoghq.com/api/v2/statuspages/8c7a1055-f55b-49de-a9d0-f6ab38d62627
65+
uri: https://api.datadoghq.com/api/v2/statuspages/7a6eba5d-657a-416e-943f-59102f88c3b5
6666
response:
6767
body:
6868
string: ''

0 commit comments

Comments
 (0)