Datadog/synthetics
@webframp/datadog/syntheticsv2026.07.20.11
01README
Datadog Synthetics — synthetic monitoring tests, results, and locations
02Release Notes
2026.07.20.11
Added: Initial code-generated release of @webframp/datadog/synthetics with 35 methods covering the Datadog synthetics API surface.
03Models
@webframp/datadog/syntheticsv2026.07.20.11datadog/synthetics.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| apiKey | string | Datadog API key (DD-API-KEY) |
| appKey | string | Datadog application key (DD-APPLICATION-KEY) |
| site | enum | Datadog site |
fn get_api_multistep_subtests(public_id: string)
Get available subtests for a multistep test
| Argument | Type | Description |
|---|---|---|
| public_id | string | The public ID of the API multistep test. |
fn get_api_multistep_subtest_parents(public_id: string)
Get parent tests for a subtest
| Argument | Type | Description |
|---|---|---|
| public_id | string | The public ID of the subtest. |
fn list_synthetics_downtimes(filter_test_ids?: string, filter_active?: string)
List Synthetics downtimes
| Argument | Type | Description |
|---|---|---|
| filter_test_ids? | string | Comma-separated list of Synthetics test public IDs to filter downtimes by. |
| filter_active? | string | If set to `true`, return only downtimes that are currently active. |
fn create_synthetics_downtime(description?: string, isEnabled: boolean, name: string, tags?: unknown, testIds: unknown, timeSlots: unknown)
Create a Synthetics downtime
| Argument | Type | Description |
|---|---|---|
| description? | string | An optional description of the downtime. |
| isEnabled | boolean | Whether the downtime is enabled. |
| name | string | The name of the downtime. |
| tags? | unknown | |
| testIds | unknown | |
| timeSlots | unknown |
fn get_synthetics_downtime(downtime_id: string)
Get a Synthetics downtime
| Argument | Type | Description |
|---|---|---|
| downtime_id | string | The ID of the downtime to retrieve. |
fn update_synthetics_downtime(downtime_id: string, description?: string, isEnabled: boolean, name: string, tags?: unknown, testIds: unknown, timeSlots: unknown)
Update a Synthetics downtime
| Argument | Type | Description |
|---|---|---|
| downtime_id | string | The ID of the downtime to update. |
| description? | string | An optional description of the downtime. |
| isEnabled | boolean | Whether the downtime is enabled. |
| name | string | The name of the downtime. |
| tags? | unknown | |
| testIds | unknown | |
| timeSlots | unknown |
fn delete_synthetics_downtime(downtime_id: string)
Delete a Synthetics downtime
| Argument | Type | Description |
|---|---|---|
| downtime_id | string | The ID of the downtime to delete. |
fn add_test_to_synthetics_downtime(downtime_id: string, test_id: string)
Add a test to a Synthetics downtime
| Argument | Type | Description |
|---|---|---|
| downtime_id | string | The ID of the downtime. |
| test_id | string | The public ID of the Synthetics test to associate with the downtime. |
fn remove_test_from_synthetics_downtime(downtime_id: string, test_id: string)
Remove a test from a Synthetics downtime
| Argument | Type | Description |
|---|---|---|
| downtime_id | string | The ID of the downtime. |
| test_id | string | The public ID of the Synthetics test to disassociate from the downtime. |
fn get_on_demand_concurrency_cap()
Get the on-demand concurrency cap
fn set_on_demand_concurrency_cap(on_demand_concurrency_cap?: number)
Save new value for on-demand concurrency cap
| Argument | Type | Description |
|---|---|---|
| on_demand_concurrency_cap? | number | Value of the on-demand concurrency cap. |
fn create_synthetics_suite(message?: string, monitor_id?: number, name: string, options: unknown, public_id?: string, tags?: array, tests: array, type: unknown)
Create a test suite
| Argument | Type | Description |
|---|---|---|
| message? | string | Notification message associated with the suite. |
| monitor_id? | number | The associated monitor ID. |
| name | string | Name of the suite. |
| options | unknown | |
| public_id? | string | The public ID for the test. |
| tags? | array | Array of tags attached to the suite. |
| tests | array | Array of Synthetic tests included in the suite. |
| type | unknown |
fn delete_synthetics_suites(force_delete_dependencies?: boolean, public_ids: array)
Bulk delete suites
| Argument | Type | Description |
|---|---|---|
| force_delete_dependencies? | boolean | Whether to force deletion of suites that have dependent resources. |
| public_ids | array | List of public IDs of the Synthetic test suites to delete. |
fn search_suites(query?: string, sort?: string, facets_only?: boolean, start?: number, count?: number)
Search test suites
| Argument | Type | Description |
|---|---|---|
| query? | string | The search query. |
| sort? | string | The sort order for the results (e.g., `name,asc` or `name,desc`). |
| facets_only? | boolean | If true, return only facets instead of full test details. |
| start? | number | The offset from which to start returning results. |
| count? | number | The maximum number of results to return. |
fn get_synthetics_suite(public_id: string)
Get a suite
| Argument | Type | Description |
|---|---|---|
| public_id | string | The public ID of the suite to get details from. |
fn edit_synthetics_suite(public_id: string, message?: string, monitor_id?: number, name: string, options: unknown, tags?: array, tests: array, type: unknown)
Edit a test suite
| Argument | Type | Description |
|---|---|---|
| public_id | string | The public ID of the suite to edit. |
| message? | string | Notification message associated with the suite. |
| monitor_id? | number | The associated monitor ID. |
| name | string | Name of the suite. |
| options | unknown | |
| tags? | array | Array of tags attached to the suite. |
| tests | array | Array of Synthetic tests included in the suite. |
| type | unknown |
fn patch_test_suite(public_id: string, json_patch?: array)
Patch a test suite
| Argument | Type | Description |
|---|---|---|
| public_id | string | The public ID of the Synthetic test suite to patch. |
| json_patch? | array | JSON Patch operations following RFC 6902. |
fn list_synthetics_browser_test_latest_results(public_id: string, from_ts?: number, to_ts?: number, status?: string, runType?: string, probe_dc?: string, device_id?: string)
Get a browser test's latest results
| Argument | Type | Description |
|---|---|---|
| public_id | string | The public ID of the Synthetic browser test for which to search results. |
| from_ts? | number | Timestamp in milliseconds from which to start querying results. |
| to_ts? | number | Timestamp in milliseconds up to which to query results. |
| status? | string | Filter results by status. |
| runType? | string | Filter results by run type. |
| probe_dc? | string | Locations for which to query results. |
| device_id? | string | Device IDs for which to query results. |
fn get_synthetics_browser_test_result(public_id: string, result_id: string, event_id?: string, timestamp?: number)
Get a browser test result
| Argument | Type | Description |
|---|---|---|
| public_id | string | The public ID of the Synthetic browser test to which the target result belongs. |
| result_id | string | The ID of the result to get. |
| event_id? | string | The event ID used to look up the result in the event store. |
| timestamp? | number | Timestamp in seconds to look up the result. |
fn delete_synthetics_tests(force_delete_dependencies?: boolean, public_ids: array)
Bulk delete tests
| Argument | Type | Description |
|---|---|---|
| force_delete_dependencies? | boolean | Whether to force deletion of tests that have dependent resources. |
| public_ids | array | List of public IDs of the Synthetic tests to delete. |
fn get_synthetics_fast_test_result(id: string)
Get a fast test result
| Argument | Type | Description |
|---|---|---|
| id | string | The UUID of the fast test to retrieve the result for. |
fn create_synthetics_network_test(config: unknown, locations: array, message: string, monitor_id?: number, name: string, options: unknown, public_id?: string, status?: unknown, subtype?: unknown, tags?: array, type: unknown)
Create a Network Path test
| Argument | Type | Description |
|---|---|---|
| config | unknown | |
| locations | array | Array of locations used to run the test. Network Path tests can be run from m... |
| message | string | Notification message associated with the test. |
| monitor_id? | number | The associated monitor ID. |
| name | string | Name of the test. |
| options | unknown | |
| public_id? | string | The public ID for the test. |
| status? | unknown | |
| subtype? | unknown | |
| tags? | array | Array of tags attached to the test. |
| type | unknown |
fn get_synthetics_network_test(public_id: string)
Get a Network Path test
| Argument | Type | Description |
|---|---|---|
| public_id | string | The public ID of the Network Path test to get details from. |
fn update_synthetics_network_test(public_id: string, config: unknown, locations: array, message: string, monitor_id?: number, name: string, options: unknown, status?: unknown, subtype?: unknown, tags?: array, type: unknown)
Edit a Network Path test
| Argument | Type | Description |
|---|---|---|
| public_id | string | The public ID of the Network Path test to edit. |
| config | unknown | |
| locations | array | Array of locations used to run the test. Network Path tests can be run from m... |
| message | string | Notification message associated with the test. |
| monitor_id? | number | The associated monitor ID. |
| name | string | Name of the test. |
| options | unknown | |
| status? | unknown | |
| subtype? | unknown | |
| tags? | array | Array of tags attached to the test. |
| type | unknown |
fn poll_synthetics_test_results(result_ids?: string)
Poll for test results
| Argument | Type | Description |
|---|---|---|
| result_ids? | string | A JSON-encoded array of result IDs to poll for. |
fn get_test_file_download_url(public_id: string, bucketKey: string)
Get a presigned URL for downloading a test file
| Argument | Type | Description |
|---|---|---|
| public_id | string | The public ID of the Synthetic test. |
| bucketKey | string | The bucket key referencing the file to download. |
fn get_test_file_multipart_presigned_urls(public_id: string, bucketKeyPrefix: unknown, parts: array)
Get presigned URLs for uploading a test file
| Argument | Type | Description |
|---|---|---|
| public_id | string | The public ID of the Synthetic test. |
| bucketKeyPrefix | unknown | |
| parts | array | Array of part descriptors for the multipart upload. |
fn abort_test_file_multipart_upload(public_id: string, key: string, uploadId: string)
Abort a multipart upload of a test file
| Argument | Type | Description |
|---|---|---|
| public_id | string | The public ID of the Synthetic test. |
| key | string | The full storage path of the file whose upload should be aborted. |
| uploadId | string | The upload ID of the multipart upload to abort. |
fn complete_test_file_multipart_upload(public_id: string, key: string, parts: array, uploadId: string)
Complete a multipart upload of a test file
| Argument | Type | Description |
|---|---|---|
| public_id | string | The public ID of the Synthetic test. |
| key | string | The full storage path for the uploaded file. |
| parts | array | Array of completed parts with their ETags. |
| uploadId | string | The upload ID returned when the multipart upload was initiated. |
fn get_test_parent_suites(public_id: string)
Get parent suites for a test
| Argument | Type | Description |
|---|---|---|
| public_id | string | The public ID of the Synthetic test. |
fn list_synthetics_test_latest_results(public_id: string, from_ts?: number, to_ts?: number, status?: string, runType?: string, probe_dc?: string, device_id?: string)
Get a test's latest results
| Argument | Type | Description |
|---|---|---|
| public_id | string | The public ID of the Synthetic test for which to search results. |
| from_ts? | number | Timestamp in milliseconds from which to start querying results. |
| to_ts? | number | Timestamp in milliseconds up to which to query results. |
| status? | string | Filter results by status. |
| runType? | string | Filter results by run type. |
| probe_dc? | string | Locations for which to query results. |
| device_id? | string | Device IDs for which to query results. |
fn get_synthetics_test_result(public_id: string, result_id: string, event_id?: string, timestamp?: number)
Get a test result
| Argument | Type | Description |
|---|---|---|
| public_id | string | The public ID of the Synthetic test to which the target result belongs. |
| result_id | string | The ID of the result to get. |
| event_id? | string | The event ID used to look up the result in the event store. |
| timestamp? | number | Timestamp in seconds to look up the result. |
fn list_synthetics_test_versions(public_id: string, last_version_number?: number)
Get version history of a test
| Argument | Type | Description |
|---|---|---|
| public_id | string | The public ID of the Synthetic test. |
| last_version_number? | number | The version number of the last item from the previous page. Omit to get the f... |
fn get_synthetics_test_version(public_id: string, version_number: string, include_change_metadata?: boolean, only_check_existence?: boolean)
Get a specific version of a test
| Argument | Type | Description |
|---|---|---|
| public_id | string | The public ID of the Synthetic test. |
| version_number | string | The version number to retrieve. |
| include_change_metadata? | boolean | If `true`, include change metadata in the response. |
| only_check_existence? | boolean | If `true`, only check whether the version exists without returning its full p... |
fn patch_global_variable(variable_id: string, json_patch?: array)
Patch a global variable
| Argument | Type | Description |
|---|---|---|
| variable_id | string | The ID of the global variable. |
| json_patch? | array | JSON Patch operations following RFC 6902. |
Resources
api_multistep_subtests(infinite)— Get available subtests for a multistep test
api_multistep_subtest_parents(infinite)— Get parent tests for a subtest
synthetics_downtimes(infinite)— List Synthetics downtimes
synthetics_downtime(infinite)— Create a Synthetics downtime
add_test_to_synthetics_downtime(infinite)— Add a test to a Synthetics downtime
on_demand_concurrency_cap(infinite)— Get the on-demand concurrency cap
set_on_demand_concurrency_cap(infinite)— Save new value for on-demand concurrency cap
synthetics_suite(infinite)— Create a test suite
synthetics_suites(infinite)— Bulk delete suites
search_suites(infinite)— Search test suites
edit_synthetics_suite(infinite)— Edit a test suite
patch_test_suite(infinite)— Patch a test suite
synthetics_browser_test_latest_results(infinite)— Get a browser test's latest results
synthetics_browser_test_result(infinite)— Get a browser test result
synthetics_tests(infinite)— Bulk delete tests
synthetics_fast_test_result(infinite)— Get a fast test result
synthetics_network_test(infinite)— Create a Network Path test
poll_synthetics_test_results(infinite)— Poll for test results
test_file_download_url(infinite)— Get a presigned URL for downloading a test file
test_file_multipart_presigned_urls(infinite)— Get presigned URLs for uploading a test file
abort_test_file_multipart_upload(infinite)— Abort a multipart upload of a test file
complete_test_file_multipart_upload(infinite)— Complete a multipart upload of a test file
test_parent_suites(infinite)— Get parent suites for a test
synthetics_test_latest_results(infinite)— Get a test's latest results
synthetics_test_result(infinite)— Get a test result
synthetics_test_versions(infinite)— Get version history of a test
synthetics_test_version(infinite)— Get a specific version of a test
patch_global_variable(infinite)— Patch a global variable
04Stats
A
100 / 100
Downloads
0
Archive size
30.9 KB
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
05Platforms
06Labels