Skip to content

Add OpenAPI documentation for Synthetics downtime endpoints #3442

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
api-clients-generation-pipeline merged 1 commit into from
Apr 28, 2026
Merged

Add OpenAPI documentation for Synthetics downtime endpoints #3442

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
949 changes: 949 additions & 0 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

105 changes: 105 additions & 0 deletions docs/datadog_api_client.v2.model.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31868,6 +31868,111 @@ datadog\_api\_client.v2.model.synthetics\_api\_multistep\_subtests\_response mod
:members:
:show-inheritance:

datadog\_api\_client.v2.model.synthetics\_downtime\_data module
---------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.synthetics_downtime_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.synthetics\_downtime\_data\_attributes\_request module
------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.synthetics_downtime_data_attributes_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.synthetics\_downtime\_data\_attributes\_response module
-------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.synthetics_downtime_data_attributes_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.synthetics\_downtime\_data\_request module
------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.synthetics_downtime_data_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.synthetics\_downtime\_frequency module
--------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.synthetics_downtime_frequency
:members:
:show-inheritance:

datadog\_api\_client.v2.model.synthetics\_downtime\_request module
------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.synthetics_downtime_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.synthetics\_downtime\_resource\_type module
-------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.synthetics_downtime_resource_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.synthetics\_downtime\_response module
-------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.synthetics_downtime_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.synthetics\_downtime\_time\_slot\_date module
---------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.synthetics_downtime_time_slot_date
:members:
:show-inheritance:

datadog\_api\_client.v2.model.synthetics\_downtime\_time\_slot\_recurrence\_request module
------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.synthetics_downtime_time_slot_recurrence_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.synthetics\_downtime\_time\_slot\_recurrence\_response module
-------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.synthetics_downtime_time_slot_recurrence_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.synthetics\_downtime\_time\_slot\_request module
------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.synthetics_downtime_time_slot_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.synthetics\_downtime\_time\_slot\_response module
-------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.synthetics_downtime_time_slot_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.synthetics\_downtime\_weekday module
------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.synthetics_downtime_weekday
:members:
:show-inheritance:

datadog\_api\_client.v2.model.synthetics\_downtimes\_response module
--------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.synthetics_downtimes_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.synthetics\_fast\_test\_result module
-------------------------------------------------------------------

Expand Down
16 changes: 16 additions & 0 deletions examples/v2/synthetics/AddTestToSyntheticsDowntime.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"""
Add a test to a Synthetics downtime returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.synthetics_api import SyntheticsApi

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = SyntheticsApi(api_client)
response = api_instance.add_test_to_synthetics_downtime(
downtime_id="00000000-0000-0000-0000-000000000001",
test_id="abc-def-123",
)

print(response)
47 changes: 47 additions & 0 deletions examples/v2/synthetics/CreateSyntheticsDowntime.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
"""
Create a Synthetics downtime returns "Created" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.synthetics_api import SyntheticsApi
from datadog_api_client.v2.model.synthetics_downtime_data_attributes_request import (
SyntheticsDowntimeDataAttributesRequest,
)
from datadog_api_client.v2.model.synthetics_downtime_data_request import SyntheticsDowntimeDataRequest
from datadog_api_client.v2.model.synthetics_downtime_request import SyntheticsDowntimeRequest
from datadog_api_client.v2.model.synthetics_downtime_resource_type import SyntheticsDowntimeResourceType
from datadog_api_client.v2.model.synthetics_downtime_time_slot_date import SyntheticsDowntimeTimeSlotDate
from datadog_api_client.v2.model.synthetics_downtime_time_slot_request import SyntheticsDowntimeTimeSlotRequest

body = SyntheticsDowntimeRequest(
data=SyntheticsDowntimeDataRequest(
attributes=SyntheticsDowntimeDataAttributesRequest(
is_enabled=True,
name="Weekly maintenance",
test_ids=[
"abc-def-123",
],
time_slots=[
SyntheticsDowntimeTimeSlotRequest(
duration=3600,
start=SyntheticsDowntimeTimeSlotDate(
day=15,
hour=10,
minute=30,
month=1,
year=2024,
),
timezone="Europe/Paris",
),
],
),
type=SyntheticsDowntimeResourceType.DOWNTIME,
),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = SyntheticsApi(api_client)
response = api_instance.create_synthetics_downtime(body=body)

print(response)
13 changes: 13 additions & 0 deletions examples/v2/synthetics/DeleteSyntheticsDowntime.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
"""
Delete a Synthetics downtime returns "No Content" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.synthetics_api import SyntheticsApi

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = SyntheticsApi(api_client)
api_instance.delete_synthetics_downtime(
downtime_id="00000000-0000-0000-0000-000000000001",
)
15 changes: 15 additions & 0 deletions examples/v2/synthetics/GetSyntheticsDowntime.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
"""
Get a Synthetics downtime returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.synthetics_api import SyntheticsApi

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = SyntheticsApi(api_client)
response = api_instance.get_synthetics_downtime(
downtime_id="00000000-0000-0000-0000-000000000001",
)

print(response)
13 changes: 13 additions & 0 deletions examples/v2/synthetics/ListSyntheticsDowntimes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
"""
List Synthetics downtimes returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.synthetics_api import SyntheticsApi

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = SyntheticsApi(api_client)
response = api_instance.list_synthetics_downtimes()

print(response)
16 changes: 16 additions & 0 deletions examples/v2/synthetics/RemoveTestFromSyntheticsDowntime.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"""
Remove a test from a Synthetics downtime returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.synthetics_api import SyntheticsApi

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = SyntheticsApi(api_client)
response = api_instance.remove_test_from_synthetics_downtime(
downtime_id="00000000-0000-0000-0000-000000000001",
test_id="abc-def-123",
)

print(response)
47 changes: 47 additions & 0 deletions examples/v2/synthetics/UpdateSyntheticsDowntime.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
"""
Update a Synthetics downtime returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.synthetics_api import SyntheticsApi
from datadog_api_client.v2.model.synthetics_downtime_data_attributes_request import (
SyntheticsDowntimeDataAttributesRequest,
)
from datadog_api_client.v2.model.synthetics_downtime_data_request import SyntheticsDowntimeDataRequest
from datadog_api_client.v2.model.synthetics_downtime_request import SyntheticsDowntimeRequest
from datadog_api_client.v2.model.synthetics_downtime_resource_type import SyntheticsDowntimeResourceType
from datadog_api_client.v2.model.synthetics_downtime_time_slot_date import SyntheticsDowntimeTimeSlotDate
from datadog_api_client.v2.model.synthetics_downtime_time_slot_request import SyntheticsDowntimeTimeSlotRequest

body = SyntheticsDowntimeRequest(
data=SyntheticsDowntimeDataRequest(
attributes=SyntheticsDowntimeDataAttributesRequest(
is_enabled=True,
name="Weekly maintenance",
test_ids=[
"abc-def-123",
],
time_slots=[
SyntheticsDowntimeTimeSlotRequest(
duration=3600,
start=SyntheticsDowntimeTimeSlotDate(
day=15,
hour=10,
minute=30,
month=1,
year=2024,
),
timezone="Europe/Paris",
),
],
),
type=SyntheticsDowntimeResourceType.DOWNTIME,
),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = SyntheticsApi(api_client)
response = api_instance.update_synthetics_downtime(downtime_id="00000000-0000-0000-0000-000000000001", body=body)

print(response)
Loading
Loading