Datadog/synthetics

@webframp/datadog/syntheticsv2026.10.21.1· Apache-2.0· 5d agoBEHAVIORS

01README

Datadog Synthetics — synthetic monitoring tests, results, and locations

02Release Notes

2026.10.21.1

Changed: Secrets Datadog returns are now stored in a vault, not in plaintext resource data. The stored resource holds a vault.get reference in place of each value:

patch_global_variable: value.value, the global variable's value
get_test_file_download_url: url, a presigned download URL
get_test_file_multipart_presigned_urls: multipart_presigned_urls_params, the presigned upload URLs

Changed: Because the model now declares sensitive output, swamp refuses to run any of its methods, reads included, until a vault exists. Without one a method fails with "no vault is configured"; create one with swamp vault create local_encryption datadog.

Changed: The json_patch argument of patch_global_variable is marked sensitive, so swamp masks its values in output. A patch that sets /value/value carries the variable's secret.

Changed: The README now shows how to store the API key and application key in a datadog vault and wire them with ${{ vault.get("datadog", "API_KEY") }} and ${{ vault.get("datadog", "APP_KEY") }}, and lists the fields stored in a vault. The previous example passed DD_API_KEY and DD_APP_KEY as literal global arguments, which swamp rejects for sensitive arguments. The apiKey and appKey descriptions now say the same.

Upgrade note: Anything that reads value.value, url or multipart_presigned_urls_params from data written by this version gets a vault reference instead of the plaintext value. Data stored by earlier versions is unchanged.

03Behaviors1

@webframp/datadog/syntheticsv2026.10.21.1datadog/synthetics.ts

Global Arguments

Argument	Type	Required	Description
apiKey	string	yes	Datadog API key (DD-API-KEY). Wire it with ${{ vault.get("datadog", "API_KEY") }}; never pass the literal value.
appKey	string	yes	Datadog application key (DD-APPLICATION-KEY). Wire it with ${{ vault.get("datadog", "APP_KEY") }}; never pass the literal value.
site?	enum	no	Datadog site

fn get_api_multistep_subtests(public_id: string)

Get available subtests for a multistep test

Argument	Type	Required	Description
public_id	string	yes	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	Required	Description
public_id	string	yes	The public ID of the subtest.

fn list_synthetics_downtimes(filter_test_ids?: string, filter_active?: string)

List Synthetics downtimes

Argument	Type	Required	Description
filter_test_ids?	string	no	Comma-separated list of Synthetics test public IDs to filter downtimes by.
filter_active?	string	no	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	Required	Description
description?	string	no	An optional description of the downtime.
isEnabled	boolean	yes	Whether the downtime is enabled.
name	string	yes	The name of the downtime.
tags?	unknown	no
testIds	unknown	yes
timeSlots	unknown	yes

fn get_synthetics_downtime(downtime_id: string)

Get a Synthetics downtime

Argument	Type	Required	Description
downtime_id	string	yes	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	Required	Description
downtime_id	string	yes	The ID of the downtime to update.
description?	string	no	An optional description of the downtime.
isEnabled	boolean	yes	Whether the downtime is enabled.
name	string	yes	The name of the downtime.
tags?	unknown	no
testIds	unknown	yes
timeSlots	unknown	yes

fn delete_synthetics_downtime(downtime_id: string)

Delete a Synthetics downtime

Argument	Type	Required	Description
downtime_id	string	yes	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	Required	Description
downtime_id	string	yes	The ID of the downtime.
test_id	string	yes	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	Required	Description
downtime_id	string	yes	The ID of the downtime.
test_id	string	yes	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	Required	Description
on_demand_concurrency_cap?	number	no	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	Required	Description
message?	string	no	Notification message associated with the suite.
monitor_id?	number	no	The associated monitor ID.
name	string	yes	Name of the suite.
options	unknown	yes
public_id?	string	no	The public ID for the test.
tags?	array	no	Array of tags attached to the suite.
tests	array	yes	Array of Synthetic tests included in the suite.
type	unknown	yes

fn delete_synthetics_suites(force_delete_dependencies?: boolean, public_ids: array)

Bulk delete suites

Argument	Type	Required	Description
force_delete_dependencies?	boolean	no	Whether to force deletion of suites that have dependent resources.
public_ids	array	yes	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	Required	Description
query?	string	no	The search query.
sort?	string	no	The sort order for the results (e.g., `name,asc` or `name,desc`).
facets_only?	boolean	no	If true, return only facets instead of full test details.
start?	number	no	The offset from which to start returning results.
count?	number	no	The maximum number of results to return.

fn get_synthetics_suite(public_id: string)

Get a suite

Argument	Type	Required	Description
public_id	string	yes	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	Required	Description
public_id	string	yes	The public ID of the suite to edit.
message?	string	no	Notification message associated with the suite.
monitor_id?	number	no	The associated monitor ID.
name	string	yes	Name of the suite.
options	unknown	yes
tags?	array	no	Array of tags attached to the suite.
tests	array	yes	Array of Synthetic tests included in the suite.
type	unknown	yes

fn patch_test_suite(public_id: string, json_patch?: array)

Patch a test suite

Argument	Type	Required	Description
public_id	string	yes	The public ID of the Synthetic test suite to patch.
json_patch?	array	no	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	Required	Description
public_id	string	yes	The public ID of the Synthetic browser test for which to search results.
from_ts?	number	no	Timestamp in milliseconds from which to start querying results.
to_ts?	number	no	Timestamp in milliseconds up to which to query results.
status?	string	no	Filter results by status.
runType?	string	no	Filter results by run type.
probe_dc?	string	no	Locations for which to query results.
device_id?	string	no	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	Required	Description
public_id	string	yes	The public ID of the Synthetic browser test to which the target result belongs.
result_id	string	yes	The ID of the result to get.
event_id?	string	no	The event ID used to look up the result in the event store.
timestamp?	number	no	Timestamp in seconds to look up the result.

fn delete_synthetics_tests(force_delete_dependencies?: boolean, public_ids: array)

Bulk delete tests

Argument	Type	Required	Description
force_delete_dependencies?	boolean	no	Whether to force deletion of tests that have dependent resources.
public_ids	array	yes	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	Required	Description
id	string	yes	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	Required	Description
config	unknown	yes
locations	array	yes	Array of locations used to run the test. Network Path tests can be run from m...
message	string	yes	Notification message associated with the test.
monitor_id?	number	no	The associated monitor ID.
name	string	yes	Name of the test.
options	unknown	yes
public_id?	string	no	The public ID for the test.
status?	unknown	no
subtype?	unknown	no
tags?	array	no	Array of tags attached to the test.
type	unknown	yes

fn get_synthetics_network_test(public_id: string)

Get a Network Path test

Argument	Type	Required	Description
public_id	string	yes	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	Required	Description
public_id	string	yes	The public ID of the Network Path test to edit.
config	unknown	yes
locations	array	yes	Array of locations used to run the test. Network Path tests can be run from m...
message	string	yes	Notification message associated with the test.
monitor_id?	number	no	The associated monitor ID.
name	string	yes	Name of the test.
options	unknown	yes
status?	unknown	no
subtype?	unknown	no
tags?	array	no	Array of tags attached to the test.
type	unknown	yes

fn poll_synthetics_test_results(result_ids?: string)

Poll for test results

Argument	Type	Required	Description
result_ids?	string	no	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	Required	Description
public_id	string	yes	The public ID of the Synthetic test.
bucketKey	string	yes	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	Required	Description
public_id	string	yes	The public ID of the Synthetic test.
bucketKeyPrefix	unknown	yes
parts	array	yes	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	Required	Description
public_id	string	yes	The public ID of the Synthetic test.
key	string	yes	The full storage path of the file whose upload should be aborted.
uploadId	string	yes	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	Required	Description
public_id	string	yes	The public ID of the Synthetic test.
key	string	yes	The full storage path for the uploaded file.
parts	array	yes	Array of completed parts with their ETags.
uploadId	string	yes	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	Required	Description
public_id	string	yes	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	Required	Description
public_id	string	yes	The public ID of the Synthetic test for which to search results.
from_ts?	number	no	Timestamp in milliseconds from which to start querying results.
to_ts?	number	no	Timestamp in milliseconds up to which to query results.
status?	string	no	Filter results by status.
runType?	string	no	Filter results by run type.
probe_dc?	string	no	Locations for which to query results.
device_id?	string	no	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	Required	Description
public_id	string	yes	The public ID of the Synthetic test to which the target result belongs.
result_id	string	yes	The ID of the result to get.
event_id?	string	no	The event ID used to look up the result in the event store.
timestamp?	number	no	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	Required	Description
public_id	string	yes	The public ID of the Synthetic test.
last_version_number?	number	no	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	Required	Description
public_id	string	yes	The public ID of the Synthetic test.
version_number	string	yes	The version number to retrieve.
include_change_metadata?	boolean	no	If `true`, include change metadata in the response.
only_check_existence?	boolean	no	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	Required	Description
variable_id	string	yes	The ID of the global variable.
json_patch?	array	no	JSON Patch operations following RFC 6902. Can carry a secret: put it in a vault.get expression, never a literal value.

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

04Previous Versions13

2026.10.15.1Apache-2.0Oct 15, 2026

2026.10.15.1

Changed: Generated tests now include one execution test per method, so every method is covered. Nothing behavioral changed in the model code, schemas or resources.

2026.10.14.1Apache-2.0(was none)Oct 14, 2026

2026.10.14.1

Fixed: Methods that write a singleton resource failed on current swamp with Data name 'latest' is reserved for internal use.

Changed: Singleton get and action methods now write their data under on_demand_concurrency_cap-current, search_suites-current instead of latest. Anything that read data.latest("<model>", "latest") or queried name == "latest" must use the new name.

Upgrade note: Data previously stored under latest is not migrated; re-run the method to populate the new name. No attribute schemas changed.

Added: The manifest now declares license: Apache-2.0 (SPDX). The registry quality rubric scores a declared license separately from the bundled LICENSE.md.

2026.09.18.1Sep 20, 2026

2026.09.18.1

Upgrade note: Normalized npm:zod dependency version to 4.6.5 across the repo. No behavioral changes in this extension.

2026.09.15.1Sep 15, 2026

2026.09.15.1

Changed: Bump zod 4.4.3 → 4.6.5

2026.09.08.1

Added: Initial code-generated release of @webframp/datadog/synthetics with 35 methods covering the Datadog synthetics API surface.

2026.09.08.1Sep 9, 2026

2026.09.08.1

Added: Initial code-generated release of @webframp/datadog/synthetics with 35 methods covering the Datadog synthetics API surface.

2026.08.28.2Aug 28, 2026

2026.08.28.2

Hardened codegen: instance names sanitized against path traversal; string schema patterns emit regex validation; output schemas passthrough unknown fields.

updated labels

2026.08.28.1Aug 28, 2026

2026.08.28.1

Changed: Normalized the extension license to Apache-2.0 and corrected the copyright holder to "Sean Escriva". Extensions that previously shipped an MIT LICENSE.md are now Apache-2.0, consistent with the repository root and every other extension. No code or behavioral changes.

Upgrade note: License text only. No API, schema, or runtime behavior changed.

2026.08.26.2

Fixed: Restored inline npm:zod@4.4.3 import specifiers so the registry quality scorer can resolve dependencies and score the extension. An earlier release used a bare "zod" import-map specifier, which published but scored as unscored.

Changed: Retained explicit compilerOptions.strict in deno.json. No behavioral or schema changes.

2026.08.26.2Aug 27, 2026

2026.08.26.2

Changed: Retained explicit compilerOptions.strict in deno.json. No behavioral or schema changes.

2026.08.25.1Aug 26, 2026

2026.08.25.1

Changed: Updated labels for improved extension discoverability. Added cross-cutting category labels (security, observability, finops, infrastructure, networking, compliance, devops, ai, incident-response) where applicable.

updated labels

2026.08.24.1Aug 24, 2026

2026.08.24.1

Added: Output metadata attributes for observability.

durationMs: Method execution duration in milliseconds.
collectedBy: Extension name that produced the data.
fetchedAt: ISO 8601 timestamp when data was fetched (added to resources that previously lacked it).

2026.08.21.2Aug 22, 2026

2026.08.21.2

Changed: Error messages and input validation are more specific.

API errors now name the HTTP method and path that was attempted (e.g. Datadog API HTTP 404: GET /api/v2/synthetics/tests/browser/abc-123/results) instead of just the raw status code and response body.
A network-level failure (DNS error, connection reset, timeout) reaching the Datadog API now raises Datadog API request failed: <METHOD> <path>: <reason> instead of an unlabeled fetch error.
create_synthetics_suite and edit_synthetics_suite now reject an empty tests array before making a request.
get_test_file_multipart_presigned_urls and complete_test_file_multipart_upload now reject an empty parts array before making a request, instead of letting Datadog return an opaque validation error for a multipart upload with no parts.

No changes to request/response shapes or existing successful-path behavior.

2026.08.21.1

Changed: Tightened Zod schemas as part of a repo-wide schema audit.

Added .min(1) to apiKey and appKey in the global arguments schema — both are sent directly as request headers, and an empty value would never be accepted by the Datadog API.
Added .min(1) to the required public_id, downtime_id, test_id, and result_id path-parameter arguments across all methods that encodeURIComponent them directly into a request URL — an empty value would always produce a malformed path and a guaranteed API error.

No behavioral changes — these are validation tightenings only; every value these methods already accept from the Datadog API continues to validate.

2026.07.20.11

Added: Initial code-generated release of @webframp/datadog/synthetics with 35 methods covering the Datadog synthetics API surface.

2026.08.21.1Aug 21, 2026

2026.08.21.1

Changed: Tightened Zod schemas as part of a repo-wide schema audit.

Added .min(1) to apiKey and appKey in the global arguments schema — both are sent directly as request headers, and an empty value would never be accepted by the Datadog API.
Added .min(1) to the required public_id, downtime_id, test_id, and result_id path-parameter arguments across all methods that encodeURIComponent them directly into a request URL — an empty value would always produce a malformed path and a guaranteed API error.

No behavioral changes — these are validation tightenings only; every value these methods already accept from the Datadog API continues to validate.

2026.07.20.11

Added: Initial code-generated release of @webframp/datadog/synthetics with 35 methods covering the Datadog synthetics API surface.

2026.07.20.11Jul 20, 2026

2026.07.20.11

Added: Initial code-generated release of @webframp/datadog/synthetics with 35 methods covering the Datadog synthetics API surface.

05Stats

100 / 100

Downloads

Archive size

30.3 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
License2/2earned
Verified public repository2/2earned

Repository

https://github.com/webframp/swamp-extensions

06Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64

07Labels

#datadog #synthetics #monitoring #testing