synthetics_api_multistep_subtests

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

Overview

Name	synthetics_api_multistep_subtests
Type	Resource
Id	datadog.monitoring.synthetics_api_multistep_subtests

Fields

The following fields are returned by SELECT queries:

get_api_multistep_subtests

Name	Datatype	Description
id	string	The public ID of the subtest. (example: abc-def-123)
attributes	object	Attributes of a Synthetic API multistep subtest.
type	string	Type of the subtest resource. (subtest) (default: subtest, example: subtest)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_api_multistep_subtests	select	public_id		Get the list of API tests that can be added as subtests to a given API multistep test.<br />The current test is excluded from the list since a test cannot be a subtest of itself.

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 API multistep 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.

SELECT examples

get_api_multistep_subtests

Get the list of API tests that can be added as subtests to a given API multistep test.<br />The current test is excluded from the list since a test cannot be a subtest of itself.

SELECT
id,
attributes,
type
FROM datadog.monitoring.synthetics_api_multistep_subtests
WHERE public_id = '{{ public_id }}' -- required
;