synthetics_test_version_histories

Creates, updates, deletes, gets or lists a synthetics_test_version_histories resource.

Overview

Name	synthetics_test_version_histories
Type	Resource
Id	datadog.monitoring.synthetics_test_version_histories

Fields

The following fields are returned by SELECT queries:

get_synthetics_test_version

Name	Datatype	Description
id	string	UUID of the version record. (example: 00000000-0000-0000-0000-000000000000)
attributes	object	Attributes of a specific Synthetic test version.
type	string	Type of the version resource. (version) (default: version, example: version)

list_synthetics_test_versions

Name	Datatype	Description
id	string	UUID of the version change record. (example: 00000000-0000-0000-0000-000000000000)
attributes	object	Attributes of a version change record.
type	string	Type of the version metadata resource. (version_metadata) (default: version_metadata, example: version_metadata)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_synthetics_test_version	select	public_id, version_number	include_change_metadata, only_check_existence	Get a specific version of a Synthetic test by its version number.
list_synthetics_test_versions	select	public_id	last_version_number, limit	Get the paginated version history for a Synthetic test.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
public_id	string	The public ID of the Synthetic test.
site	string	The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.
version_number	integer (int64)	The version number to retrieve.
include_change_metadata	boolean	If true, include change metadata in the response.
last_version_number	integer (int64)	The version number of the last item from the previous page. Omit to get the first page.
limit	integer (int64)	Maximum number of version records to return per page.
only_check_existence	boolean	If true, only check whether the version exists without returning its full payload. Returns an empty object if the version exists, or 404 if not.

SELECT examples

get_synthetics_test_version

Get a specific version of a Synthetic test by its version number.

SELECT
id,
attributes,
type
FROM datadog.monitoring.synthetics_test_version_histories
WHERE public_id = '{{ public_id }}' -- required
AND version_number = '{{ version_number }}' -- required
AND include_change_metadata = '{{ include_change_metadata }}'
AND only_check_existence = '{{ only_check_existence }}'
;

list_synthetics_test_versions

Get the paginated version history for a Synthetic test.

SELECT
id,
attributes,
type
FROM datadog.monitoring.synthetics_test_version_histories
WHERE public_id = '{{ public_id }}' -- required
AND last_version_number = '{{ last_version_number }}'
AND limit = '{{ limit }}'
;