synthetics_test_files

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

Overview

Name	synthetics_test_files
Type	Resource
Id	datadog.monitoring.synthetics_test_files

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_test_file_download_url	exec	public_id, bucketKey		Get a presigned URL to download a file attached to a Synthetic test.<br />The returned URL is temporary and expires after a short period.
get_test_file_multipart_presigned_urls	exec	public_id, bucketKeyPrefix, parts		Get presigned URLs for uploading a file to a Synthetic test using multipart upload.<br />Returns the presigned URLs for each part along with the bucket key that references the file.
abort_test_file_multipart_upload	exec	public_id, uploadId, key		Abort an in-progress multipart file upload for a Synthetic test. This cancels the upload<br />and releases any storage used by already-uploaded parts.
complete_test_file_multipart_upload	exec	public_id, uploadId, key, parts		Complete a multipart file upload for a Synthetic test. Call this endpoint after all parts<br />have been uploaded using the presigned URLs obtained from the multipart presigned URLs endpoint.

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.

Lifecycle Methods

EXEC variables use wire (API) names.

get_test_file_download_url

Get a presigned URL to download a file attached to a Synthetic test.<br />The returned URL is temporary and expires after a short period.

EXEC datadog.monitoring.synthetics_test_files.get_test_file_download_url 
@public_id='{{ public_id }}' --required, 
@@json=
'{
"bucketKey": "{{ bucketKey }}"
}'
;

get_test_file_multipart_presigned_urls

Get presigned URLs for uploading a file to a Synthetic test using multipart upload.<br />Returns the presigned URLs for each part along with the bucket key that references the file.

EXEC datadog.monitoring.synthetics_test_files.get_test_file_multipart_presigned_urls 
@public_id='{{ public_id }}' --required, 
@@json=
'{
"bucketKeyPrefix": "{{ bucketKeyPrefix }}", 
"parts": "{{ parts }}"
}'
;

abort_test_file_multipart_upload

Abort an in-progress multipart file upload for a Synthetic test. This cancels the upload<br />and releases any storage used by already-uploaded parts.

EXEC datadog.monitoring.synthetics_test_files.abort_test_file_multipart_upload 
@public_id='{{ public_id }}' --required, 
@@json=
'{
"key": "{{ key }}", 
"uploadId": "{{ uploadId }}"
}'
;

complete_test_file_multipart_upload

Complete a multipart file upload for a Synthetic test. Call this endpoint after all parts<br />have been uploaded using the presigned URLs obtained from the multipart presigned URLs endpoint.

EXEC datadog.monitoring.synthetics_test_files.complete_test_file_multipart_upload 
@public_id='{{ public_id }}' --required, 
@@json=
'{
"key": "{{ key }}", 
"parts": "{{ parts }}", 
"uploadId": "{{ uploadId }}"
}'
;