API 테스트 편집하기
https://api.datadoghq.com/api/v1/synthetics/tests/api/{public_id}https://api.us3.datadoghq.com/api/v1/synthetics/tests/api/{public_id}https://api.us5.datadoghq.com/api/v1/synthetics/tests/api/{public_id}https://api.datadoghq.eu/api/v1/synthetics/tests/api/{public_id}https://api.ap1.datadoghq.com/api/v1/synthetics/tests/api/{public_id}https://api.ap2.datadoghq.com/api/v1/synthetics/tests/api/{public_id}https://api.uk1.datadoghq.com/api/v1/synthetics/tests/api/{public_id}https://api.ddog-gov.com/api/v1/synthetics/tests/api/{public_id}https://api.us2.ddog-gov.com/api/v1/synthetics/tests/api/{public_id}개요
Synthetic API 테스트의 구성을 편집합니다.
OAuth apps require the synthetics_write authorization scope to access this endpoint.
인수
경로 파라미터
public_id [required]The public ID of the test to get details from.
요청
Body Data (required)
저장할 새 테스트 세부 정보입니다.
config [required]Synthetic API 테스트에 대한 세부 정보를 포함하는 객체입니다.
assertionsArray of assertions used for the test. Required for single API tests.
Object 1An assertion which uses a simple target.
operator [required]Assertion operator to apply.
contains, doesNotContain, is, isNot, lessThan, lessThanOrEqual, moreThan, moreThanOrEqual, matches, doesNotMatchShow 5 more
validates, isInMoreThan, isInLessThan, doesNotExist, isUndefinedpropertyThe associated assertion property.
target [required]Value used by the operator.
Object 1Numeric value used by the operator in assertions.
Object 2String value used by the operator in assertions. Supports templated variables.
timingsScopeTimings scope for response time assertions.
all, withoutDNStype [required]Type of the assertion.
body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersionShow 13 more
latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection, multiNetworkHop, jitter, mcpToolNameLength, mcpToolCountObject 2An assertion which targets body hash.
operator [required]Assertion operator to apply.
md5, sha1, sha256target [required]Value used by the operator.
Object 1Numeric value used by the operator in assertions.
Object 2String value used by the operator in assertions. Supports templated variables.
type [required]Type of the assertion.
bodyHashObject 3An assertion for the validatesJSONPath operator.
operator [required]Assertion operator to apply.
validatesJSONPathpropertyThe associated assertion property.
targetComposed target for validatesJSONPath operator.
elementsOperatorThe element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.
jsonPathThe JSON path to assert.
operatorThe specific operator to use on the path.
targetValueThe path target value to compare to.
Object 1Numeric value used by the operator in assertions.
Object 2String value used by the operator in assertions. Supports templated variables.
type [required]Type of the assertion.
body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersionShow 13 more
latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection, multiNetworkHop, jitter, mcpToolNameLength, mcpToolCountObject 4An assertion for the validatesJSONSchema operator.
operator [required]Assertion operator to apply.
validatesJSONSchematargetComposed target for validatesJSONSchema operator.
jsonSchemaThe JSON Schema to assert.
metaSchemaThe JSON Schema meta-schema version used in the assertion.
draft-07, draft-06type [required]Type of the assertion.
body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersionShow 13 more
latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection, multiNetworkHop, jitter, mcpToolNameLength, mcpToolCountObject 5An assertion for the validatesXPath operator.
operator [required]Assertion operator to apply.
validatesXPathpropertyThe associated assertion property.
targetComposed target for validatesXPath operator.
operatorThe specific operator to use on the path.
targetValueThe path target value to compare to.
Object 1Numeric value used by the operator in assertions.
Object 2String value used by the operator in assertions. Supports templated variables.
xPathThe X path to assert.
type [required]Type of the assertion.
body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersionShow 13 more
latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection, multiNetworkHop, jitter, mcpToolNameLength, mcpToolCountObject 6A JavaScript assertion.
code [required]The JavaScript code that performs the assertions.
type [required]Type of the assertion.
javascriptObject 7An assertion that checks that an MCP server advertises the expected capabilities.
operator [required]Assertion operator to apply.
contains, doesNotContain, is, isNot, lessThan, lessThanOrEqual, moreThan, moreThanOrEqual, matches, doesNotMatchShow 5 more
validates, isInMoreThan, isInLessThan, doesNotExist, isUndefinedtarget [required]List of MCP server capabilities to assert against.
type [required]Type of the assertion.
mcpServerCapabilitiesObject 8An assertion that verifies the MCP server response respects the MCP specification.
type [required]Type of the assertion.
mcpRespectsSpecificationconfigVariablesArray of variables used for the test.
exampleExample for the variable.
idID of the variable for global variables.
name [required]Name of the variable.
patternPattern of the variable.
secureWhether the value of this variable will be obfuscated in test results. Only for config variables of type text.
type [required]Type of the configuration variable.
global, text, emailrequestObject describing the Synthetic test request.
allow_insecureAllows loading insecure content for an HTTP request in a multistep test step.
basicAuthObject to handle basic authentication when performing the test.
<type=web>Object to handle basic authentication when performing the test.
passwordPassword to use for the basic authentication.
typeThe type of basic authentication to use when performing the test.
webwebusernameUsername to use for the basic authentication.
<type=sigv4>Object to handle SIGV4 authentication when performing the test.
accessKey [required]Access key for the SIGV4 authentication.
regionRegion for the SIGV4 authentication.
secretKey [required]Secret key for the SIGV4 authentication.
serviceNameService name for the SIGV4 authentication.
sessionTokenSession token for the SIGV4 authentication.
type [required]The type of authentication to use when performing the test.
sigv4sigv4<type=ntlm>Object to handle NTLM authentication when performing the test.
domainDomain for the authentication to use when performing the test.
passwordPassword for the authentication to use when performing the test.
type [required]The type of authentication to use when performing the test.
ntlmntlmusernameUsername for the authentication to use when performing the test.
workstationWorkstation for the authentication to use when performing the test.
<type=digest>Object to handle digest authentication when performing the test.
password [required]Password to use for the digest authentication.
type [required]The type of basic authentication to use when performing the test.
digestdigestusername [required]Username to use for the digest authentication.
<type=oauth-client>Object to handle oauth client authentication when performing the test.
accessTokenUrl [required]Access token URL to use when performing the authentication.
audienceAudience to use when performing the authentication.
clientId [required]Client ID to use when performing the authentication.
clientSecret [required]Client secret to use when performing the authentication.
resourceResource to use when performing the authentication.
scopeScope to use when performing the authentication.
tokenApiAuthentication [required]Type of token to use when performing the authentication.
header, bodytype [required]The type of basic authentication to use when performing the test.
oauth-clientoauth-client<type=oauth-rop>Object to handle oauth rop authentication when performing the test.
accessTokenUrl [required]Access token URL to use when performing the authentication.
audienceAudience to use when performing the authentication.
clientIdClient ID to use when performing the authentication.
clientSecretClient secret to use when performing the authentication.
password [required]Password to use when performing the authentication.
resourceResource to use when performing the authentication.
scopeScope to use when performing the authentication.
tokenApiAuthentication [required]Type of token to use when performing the authentication.
header, bodytype [required]The type of basic authentication to use when performing the test.
oauth-ropoauth-ropusername [required]Username to use when performing the authentication.
<type=jwt>Object to handle JWT authentication when performing the test.
addClaimsStandard JWT claims to automatically inject.
expWhether to inject the exp (expiration) claim.
iatWhether to inject the iat (issued at) claim.
algorithm [required]Algorithm to use for the JWT authentication.
HS256, RS256, ES256expiresInToken time-to-live in seconds.
headerCustom JWT header as a JSON string.
payload [required]JWT claims as a JSON string.
secret [required]Signing key for the JWT authentication. Use the shared secret for HS256
or the private key (PEM format) for RS256 and ES256.
tokenPrefixPrefix added before the token in the Authorization header. Defaults to Bearer.
type [required]The type of authentication to use when performing the test.
jwtjwtbodyBody to include in the test.
bodyTypeType of the request body.
text/plain, application/json, text/xml, text/html, application/x-www-form-urlencoded, graphql, application/octet-stream, multipart/form-datacallTypeThe type of call to perform. Used by gRPC steps (healthcheck, unary)
and MCP steps (init, tool_list, tool_call). Valid values depend on
the parent step's subtype.
healthcheck, unary, init, tool_list, tool_callcertificateClient certificate to use when performing the test request.
certDefine a request certificate.
contentContent of the certificate or key.
filenameFile name for the certificate or key.
updatedAtDate of update of the certificate or key, ISO format.
keyDefine a request certificate.
contentContent of the certificate or key.
filenameFile name for the certificate or key.
updatedAtDate of update of the certificate or key, ISO format.
certificateDomainsBy default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.
checkCertificateRevocationCheck for certificate revocation.
compressedJsonDescriptorA protobuf JSON descriptor that needs to be gzipped first then base64 encoded.
compressedProtoFileA protobuf file that needs to be gzipped first then base64 encoded.
disableAiaIntermediateFetchingDisable fetching intermediate certificates from AIA.
dnsServerDNS server to use for DNS tests.
dnsServerPortDNS server port to use for DNS tests.
Object 1Integer DNS server port number to use when performing the test.
Object 2String DNS server port number to use when performing the test. Supports templated variables.
filesFiles to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
bucketKeyBucket key of the file.
contentContent of the file.
encodingEncoding of the file content. The only supported value is base64, indicating the content field contains base64-encoded data.
nameName of the file.
originalFileNameOriginal name of the file.
sizeSize of the file.
typeType of the file.
follow_redirectsSpecifies whether or not the request follows redirects.
formForm to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
<any-key>A single form entry.
headersHeaders to include when performing the test.
<any-key>A single Header.
hostHost name to perform the test with.
httpVersionHTTP version to use for a Synthetic test.
http1, http2, anyignore_certificate_validationFor SSL tests, whether the test should ignore certificate validation.
isMessageBase64EncodedWhether the message is base64 encoded.
mcpProtocolVersionThe MCP protocol version used by the step. See https://modelcontextprotocol.io/specification.
2025-06-18messageMessage to send for UDP or WebSocket tests.
metadataMetadata to include when performing the gRPC test.
<any-key>A single metadatum.
methodEither the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.
noSavingResponseBodyDetermines whether or not to save the response body.
numberOfPacketsNumber of pings to use per test.
persistCookiesPersist cookies across redirects.
portPort to use when performing the test.
Object 1Integer Port number to use when performing the test.
Object 2String Port number to use when performing the test. Supports templated variables.
proxyThe proxy to perform the test.
headersHeaders to include when performing the test.
<any-key>A single Header.
url [required]URL of the proxy to perform the test.
queryQuery to use for the test.
servernameFor SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.
serviceThe gRPC service on which you want to perform the gRPC call.
shouldTrackHopsTurns on a traceroute probe to discover all gateways along the path to the host destination.
timeoutTimeout in seconds for the test.
toolArgsArguments to pass to the MCP tool. Free-form object whose shape depends on the tool. Used when callType is tool_call.
toolNameThe name of the MCP tool to call. Required when callType is tool_call.
urlURL to perform the test with.
stepsWhen the test subtype is multi, the steps of the test.
Object 1The Test step used in a Synthetic multi-step API test.
allowFailureDetermines whether or not to continue with test if this step fails.
assertions [required]Array of assertions used for the test.
Object 1An assertion which uses a simple target.
operator [required]Assertion operator to apply.
contains, doesNotContain, is, isNot, lessThan, lessThanOrEqual, moreThan, moreThanOrEqual, matches, doesNotMatchShow 5 more
validates, isInMoreThan, isInLessThan, doesNotExist, isUndefinedpropertyThe associated assertion property.
target [required]Value used by the operator.
Object 1Numeric value used by the operator in assertions.
Object 2String value used by the operator in assertions. Supports templated variables.
timingsScopeTimings scope for response time assertions.
all, withoutDNStype [required]Type of the assertion.
body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersionShow 13 more
latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection, multiNetworkHop, jitter, mcpToolNameLength, mcpToolCountObject 2An assertion which targets body hash.
operator [required]Assertion operator to apply.
md5, sha1, sha256target [required]Value used by the operator.
Object 1Numeric value used by the operator in assertions.
Object 2String value used by the operator in assertions. Supports templated variables.
type [required]Type of the assertion.
bodyHashObject 3An assertion for the validatesJSONPath operator.
operator [required]Assertion operator to apply.
validatesJSONPathpropertyThe associated assertion property.
targetComposed target for validatesJSONPath operator.
elementsOperatorThe element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.
jsonPathThe JSON path to assert.
operatorThe specific operator to use on the path.
targetValueThe path target value to compare to.
Object 1Numeric value used by the operator in assertions.
Object 2String value used by the operator in assertions. Supports templated variables.
type [required]Type of the assertion.
body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersionShow 13 more
latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection, multiNetworkHop, jitter, mcpToolNameLength, mcpToolCountObject 4An assertion for the validatesJSONSchema operator.
operator [required]Assertion operator to apply.
validatesJSONSchematargetComposed target for validatesJSONSchema operator.
jsonSchemaThe JSON Schema to assert.
metaSchemaThe JSON Schema meta-schema version used in the assertion.
draft-07, draft-06type [required]Type of the assertion.
body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersionShow 13 more
latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection, multiNetworkHop, jitter, mcpToolNameLength, mcpToolCountObject 5An assertion for the validatesXPath operator.
operator [required]Assertion operator to apply.
validatesXPathpropertyThe associated assertion property.
targetComposed target for validatesXPath operator.
operatorThe specific operator to use on the path.
targetValueThe path target value to compare to.
Object 1Numeric value used by the operator in assertions.
Object 2String value used by the operator in assertions. Supports templated variables.
xPathThe X path to assert.
type [required]Type of the assertion.
body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersionShow 13 more
latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection, multiNetworkHop, jitter, mcpToolNameLength, mcpToolCountObject 6A JavaScript assertion.
code [required]The JavaScript code that performs the assertions.
type [required]Type of the assertion.
javascriptObject 7An assertion that checks that an MCP server advertises the expected capabilities.
operator [required]Assertion operator to apply.
contains, doesNotContain, is, isNot, lessThan, lessThanOrEqual, moreThan, moreThanOrEqual, matches, doesNotMatchShow 5 more
validates, isInMoreThan, isInLessThan, doesNotExist, isUndefinedtarget [required]List of MCP server capabilities to assert against.
type [required]Type of the assertion.
mcpServerCapabilitiesObject 8An assertion that verifies the MCP server response respects the MCP specification.
type [required]Type of the assertion.
mcpRespectsSpecificationexitIfSucceedDetermines whether or not to exit the test if the step succeeds.
extractedValuesArray of values to parse and save as variables from the response.
fieldWhen type is http_header or grpc_metadata, name of the header or metadatum to extract.
nameName of the variable to extract.
parserDetails of the parser to use for the global variable.
type [required]Type of parser for a Synthetic global variable from a synthetics test.
raw, json_path, regex, x_pathvalueRegex or JSON path used for the parser. Not used with type raw.
secureDetermines whether or not the extracted value will be obfuscated.
typeProperty of the Synthetic Test Response to extract into a local variable.
grpc_message, grpc_metadata, http_body, http_header, http_status_codeextractedValuesFromScriptGenerate variables using JavaScript.
isCriticalDetermines whether or not to consider the entire test as failed if this step fails.
Can be used only if allowFailure is true.
name [required]The name of the step.
request [required]Object describing the Synthetic test request.
allow_insecureAllows loading insecure content for an HTTP request in a multistep test step.
basicAuthObject to handle basic authentication when performing the test.
<type=web>Object to handle basic authentication when performing the test.
passwordPassword to use for the basic authentication.
typeThe type of basic authentication to use when performing the test.
webwebusernameUsername to use for the basic authentication.
<type=sigv4>Object to handle SIGV4 authentication when performing the test.
accessKey [required]Access key for the SIGV4 authentication.
regionRegion for the SIGV4 authentication.
secretKey [required]Secret key for the SIGV4 authentication.
serviceNameService name for the SIGV4 authentication.
sessionTokenSession token for the SIGV4 authentication.
type [required]The type of authentication to use when performing the test.
sigv4sigv4<type=ntlm>Object to handle NTLM authentication when performing the test.
domainDomain for the authentication to use when performing the test.
passwordPassword for the authentication to use when performing the test.
type [required]The type of authentication to use when performing the test.
ntlmntlmusernameUsername for the authentication to use when performing the test.
workstationWorkstation for the authentication to use when performing the test.
<type=digest>Object to handle digest authentication when performing the test.
password [required]Password to use for the digest authentication.
type [required]The type of basic authentication to use when performing the test.
digestdigestusername [required]Username to use for the digest authentication.
<type=oauth-client>Object to handle oauth client authentication when performing the test.
accessTokenUrl [required]Access token URL to use when performing the authentication.
audienceAudience to use when performing the authentication.
clientId [required]Client ID to use when performing the authentication.
clientSecret [required]Client secret to use when performing the authentication.
resourceResource to use when performing the authentication.
scopeScope to use when performing the authentication.
tokenApiAuthentication [required]Type of token to use when performing the authentication.
header, bodytype [required]The type of basic authentication to use when performing the test.
oauth-clientoauth-client<type=oauth-rop>Object to handle oauth rop authentication when performing the test.
accessTokenUrl [required]Access token URL to use when performing the authentication.
audienceAudience to use when performing the authentication.
clientIdClient ID to use when performing the authentication.
clientSecretClient secret to use when performing the authentication.
password [required]Password to use when performing the authentication.
resourceResource to use when performing the authentication.
scopeScope to use when performing the authentication.
tokenApiAuthentication [required]Type of token to use when performing the authentication.
header, bodytype [required]The type of basic authentication to use when performing the test.
oauth-ropoauth-ropusername [required]Username to use when performing the authentication.
<type=jwt>Object to handle JWT authentication when performing the test.
addClaimsStandard JWT claims to automatically inject.
expWhether to inject the exp (expiration) claim.
iatWhether to inject the iat (issued at) claim.
algorithm [required]Algorithm to use for the JWT authentication.
HS256, RS256, ES256expiresInToken time-to-live in seconds.
headerCustom JWT header as a JSON string.
payload [required]JWT claims as a JSON string.
secret [required]Signing key for the JWT authentication. Use the shared secret for HS256
or the private key (PEM format) for RS256 and ES256.
tokenPrefixPrefix added before the token in the Authorization header. Defaults to Bearer.
type [required]The type of authentication to use when performing the test.
jwtjwtbodyBody to include in the test.
bodyTypeType of the request body.
text/plain, application/json, text/xml, text/html, application/x-www-form-urlencoded, graphql, application/octet-stream, multipart/form-datacallTypeThe type of call to perform. Used by gRPC steps (healthcheck, unary)
and MCP steps (init, tool_list, tool_call). Valid values depend on
the parent step's subtype.
healthcheck, unary, init, tool_list, tool_callcertificateClient certificate to use when performing the test request.
certDefine a request certificate.
contentContent of the certificate or key.
filenameFile name for the certificate or key.
updatedAtDate of update of the certificate or key, ISO format.
keyDefine a request certificate.
contentContent of the certificate or key.
filenameFile name for the certificate or key.
updatedAtDate of update of the certificate or key, ISO format.
certificateDomainsBy default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.
checkCertificateRevocationCheck for certificate revocation.
compressedJsonDescriptorA protobuf JSON descriptor that needs to be gzipped first then base64 encoded.
compressedProtoFileA protobuf file that needs to be gzipped first then base64 encoded.
disableAiaIntermediateFetchingDisable fetching intermediate certificates from AIA.
dnsServerDNS server to use for DNS tests.
dnsServerPortDNS server port to use for DNS tests.
Object 1Integer DNS server port number to use when performing the test.
Object 2String DNS server port number to use when performing the test. Supports templated variables.
filesFiles to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
bucketKeyBucket key of the file.
contentContent of the file.
encodingEncoding of the file content. The only supported value is base64, indicating the content field contains base64-encoded data.
nameName of the file.
originalFileNameOriginal name of the file.
sizeSize of the file.
typeType of the file.
follow_redirectsSpecifies whether or not the request follows redirects.
formForm to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
<any-key>A single form entry.
headersHeaders to include when performing the test.
<any-key>A single Header.
hostHost name to perform the test with.
httpVersionHTTP version to use for a Synthetic test.
http1, http2, anyignore_certificate_validationFor SSL tests, whether the test should ignore certificate validation.
isMessageBase64EncodedWhether the message is base64 encoded.
mcpProtocolVersionThe MCP protocol version used by the step. See https://modelcontextprotocol.io/specification.
2025-06-18messageMessage to send for UDP or WebSocket tests.
metadataMetadata to include when performing the gRPC test.
<any-key>A single metadatum.
methodEither the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.
noSavingResponseBodyDetermines whether or not to save the response body.
numberOfPacketsNumber of pings to use per test.
persistCookiesPersist cookies across redirects.
portPort to use when performing the test.
Object 1Integer Port number to use when performing the test.
Object 2String Port number to use when performing the test. Supports templated variables.
proxyThe proxy to perform the test.
headersHeaders to include when performing the test.
<any-key>A single Header.
url [required]URL of the proxy to perform the test.
queryQuery to use for the test.
servernameFor SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.
serviceThe gRPC service on which you want to perform the gRPC call.
shouldTrackHopsTurns on a traceroute probe to discover all gateways along the path to the host destination.
timeoutTimeout in seconds for the test.
toolArgsArguments to pass to the MCP tool. Free-form object whose shape depends on the tool. Used when callType is tool_call.
toolNameThe name of the MCP tool to call. Required when callType is tool_call.
urlURL to perform the test with.
retryObject describing the retry strategy to apply to a Synthetic test.
countNumber of times a test needs to be retried before marking a location as failed. Defaults to 0.
intervalTime interval between retries (in milliseconds). Defaults to 300ms.
subtype [required]The subtype of the Synthetic multi-step API test step.
http, grpc, ssl, dns, tcp, udp, icmp, websocket, mcp<subtype=wait>The Wait step used in a Synthetic multi-step API test.
name [required]The name of the step.
subtype [required]The subtype of the Synthetic multi-step API wait step.
waitvalue [required]The time to wait in seconds. Minimum value: 0. Maximum value: 180.
<subtype=playSubTest>The subtest step used in a Synthetics multi-step API test.
allowFailureDetermines whether or not to continue with test if this step fails.
alwaysExecuteA boolean set to always execute this step even if the previous step failed or was skipped.
exitIfSucceedDetermines whether or not to exit the test if the step succeeds.
extractedValuesFromScriptGenerate variables using JavaScript.
isCriticalDetermines whether or not to consider the entire test as failed if this step fails.
Can be used only if allowFailure is true.
name [required]The name of the step.
retryObject describing the retry strategy to apply to a Synthetic test.
countNumber of times a test needs to be retried before marking a location as failed. Defaults to 0.
intervalTime interval between retries (in milliseconds). Defaults to 300ms.
subtestPublicId [required]Public ID of the test to be played as part of a playSubTest step type.
subtype [required]The subtype of the Synthetic multi-step API subtest step.
playSubTestvariablesFromScriptVariables defined from JavaScript code.
locations [required]Array of locations used to run the test.
message [required]Notification message associated with the test.
name [required]Name of the test.
options [required]Object describing the extra options for a Synthetic test.
accept_self_signedFor SSL tests, whether or not the test should allow self signed certificates.
allow_insecureAllows loading insecure content for an HTTP request in an API test.
bits_ai_auto_investigateWhether Bits AI automatically investigates alerts from the test monitor.
blockedRequestPatternsArray of URL patterns to block.
captureNetworkPayloadsCapture HTTP request/response headers and bodies for Fetch/XHR calls made during browser tests.
checkCertificateRevocationFor SSL tests, whether or not the test should fail on revoked certificate in stapled OCSP.
ciCI/CD options for a Synthetic test.
executionRule [required]Execution rule for a Synthetic test.
blocking, non_blocking, skippeddevice_idsFor browser test, array with the different device IDs used to run the test.
disableAiaIntermediateFetchingFor SSL tests, whether or not the test should disable fetching intermediate certificates from AIA.
disableCorsWhether or not to disable CORS mechanism.
disableCspDisable Content Security Policy for browser tests.
enableProfilingEnable profiling for browser tests.
enableSecurityTestingDEPRECATED Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.
follow_redirectsFor API HTTP test, whether or not the test should follow redirects.
httpVersionHTTP version to use for a Synthetic test.
http1, http2, anyignoreServerCertificateErrorIgnore server certificate error for browser tests.
ignore_certificate_validationFor SSL tests, whether the test should ignore certificate validation.
initialNavigationTimeoutTimeout before declaring the initial step as failed (in seconds) for browser tests.
min_failure_durationMinimum amount of time in failure required to trigger an alert.
min_location_failedMinimum number of locations in failure required to trigger an alert.
monitor_nameThe monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
monitor_optionsObject containing the options for a Synthetic test as a monitor (for example, renotification).
escalation_messageMessage to include in the escalation notification.
notification_preset_nameThe name of the preset for the notification for the monitor.
show_all, hide_all, hide_query, hide_handles, hide_query_and_handles, show_only_snapshot, hide_handles_and_footerrenotify_intervalTime interval before renotifying if the test is still failing (in minutes).
renotify_occurrencesThe number of times to renotify if the test is still failing.
monitor_priorityInteger from 1 (high) to 5 (low) indicating alert severity.
noScreenshotPrevents saving screenshots of the steps.
restricted_rolesDEPRECATED A list of role identifiers that can be pulled from the Roles API, for restricting read and write access. This field is deprecated. Use the restriction policies API to manage permissions.
retryObject describing the retry strategy to apply to a Synthetic test.
countNumber of times a test needs to be retried before marking a location as failed. Defaults to 0.
intervalTime interval between retries (in milliseconds). Defaults to 300ms.
rumSettingsThe RUM data collection settings for the Synthetic browser test. Note: There are 3 ways to format RUM settings:
{ isEnabled: false }
RUM data is not collected.
{ isEnabled: true }
RUM data is collected from the Synthetic test's default application.
{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }
RUM data is collected using the specified application.
applicationIdRUM application ID used to collect RUM data for the browser test.
clientTokenIdRUM application API key ID used to collect RUM data for the browser test.
isEnabled [required]Determines whether RUM data is collected during test runs.
schedulingObject containing timeframes and timezone used for advanced scheduling.
timeframes [required]Array containing objects describing the scheduling pattern to apply to each day.
day [required]Number representing the day of the week.
from [required]The hour of the day on which scheduling starts.
to [required]The hour of the day on which scheduling ends.
timezone [required]Timezone in which the timeframe is based.
tick_everyThe frequency at which to run the Synthetic test (in seconds).
statusDefine whether you want to start (live) or pause (paused) a
Synthetic test.
live, pausedsubtypeThe subtype of the Synthetic API test, http, ssl, tcp,
dns, icmp, udp, websocket, grpc or multi.
http, ssl, tcp, dns, multi, icmp, udp, websocket, grpctagsArray of tags attached to the test.
type [required]Type of the Synthetic test, api.
apiapi{
"config": {
"assertions": [
{
"operator": "is",
"property": "{{ PROPERTY }}",
"target": "text/html",
"type": "header"
},
{
"operator": "lessThan",
"target": 2000,
"type": "responseTime"
},
{
"operator": "validatesJSONPath",
"target": {
"jsonPath": "topKey",
"operator": "isNot",
"targetValue": "0"
},
"type": "body"
},
{
"operator": "validatesJSONSchema",
"target": {
"metaSchema": "draft-07",
"jsonSchema": "{\"type\": \"object\", \"properties\":{\"slideshow\":{\"type\":\"object\"}}}"
},
"type": "body"
}
],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text"
}
],
"request": {
"certificate": {
"cert": {
"filename": "cert-filename",
"updatedAt": "2020-10-16T09:23:24.857Z"
},
"key": {
"filename": "key-filename",
"updatedAt": "2020-10-16T09:23:24.857Z"
}
},
"headers": {
"unique": "examplesynthetic"
},
"method": "GET",
"timeout": 10,
"url": "https://datadoghq.com"
}
},
"locations": [
"aws:us-east-2"
],
"message": "BDD test payload: synthetics_api_test_payload.json",
"name": "Example-Synthetic-updated",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"monitor_name": "Test-TestSyntheticsAPITestLifecycle-1623076664",
"monitor_priority": 5,
"retry": {
"count": 3,
"interval": 10
},
"tick_every": 60
},
"status": "live",
"subtype": "http",
"tags": [
"testing:api"
],
"type": "api"
}응답
OK
Object containing details about a Synthetic API test.
config [required]Configuration object for a Synthetic API test.
assertionsArray of assertions used for the test. Required for single API tests.
Object 1An assertion which uses a simple target.
operator [required]Assertion operator to apply.
contains, doesNotContain, is, isNot, lessThan, lessThanOrEqual, moreThan, moreThanOrEqual, matches, doesNotMatchShow 5 more
validates, isInMoreThan, isInLessThan, doesNotExist, isUndefinedpropertyThe associated assertion property.
target [required]Value used by the operator.
Object 1Numeric value used by the operator in assertions.
Object 2String value used by the operator in assertions. Supports templated variables.
timingsScopeTimings scope for response time assertions.
all, withoutDNStype [required]Type of the assertion.
body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersionShow 13 more
latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection, multiNetworkHop, jitter, mcpToolNameLength, mcpToolCountObject 2An assertion which targets body hash.
operator [required]Assertion operator to apply.
md5, sha1, sha256target [required]Value used by the operator.
Object 1Numeric value used by the operator in assertions.
Object 2String value used by the operator in assertions. Supports templated variables.
type [required]Type of the assertion.
bodyHashObject 3An assertion for the validatesJSONPath operator.
operator [required]Assertion operator to apply.
validatesJSONPathpropertyThe associated assertion property.
targetComposed target for validatesJSONPath operator.
elementsOperatorThe element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.
jsonPathThe JSON path to assert.
operatorThe specific operator to use on the path.
targetValueThe path target value to compare to.
Object 1Numeric value used by the operator in assertions.
Object 2String value used by the operator in assertions. Supports templated variables.
type [required]Type of the assertion.
body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersionShow 13 more
latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection, multiNetworkHop, jitter, mcpToolNameLength, mcpToolCountObject 4An assertion for the validatesJSONSchema operator.
operator [required]Assertion operator to apply.
validatesJSONSchematargetComposed target for validatesJSONSchema operator.
jsonSchemaThe JSON Schema to assert.
metaSchemaThe JSON Schema meta-schema version used in the assertion.
draft-07, draft-06type [required]Type of the assertion.
body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersionShow 13 more
latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection, multiNetworkHop, jitter, mcpToolNameLength, mcpToolCountObject 5An assertion for the validatesXPath operator.
operator [required]Assertion operator to apply.
validatesXPathpropertyThe associated assertion property.
targetComposed target for validatesXPath operator.
operatorThe specific operator to use on the path.
targetValueThe path target value to compare to.
Object 1Numeric value used by the operator in assertions.
Object 2String value used by the operator in assertions. Supports templated variables.
xPathThe X path to assert.
type [required]Type of the assertion.
body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersionShow 13 more
latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection, multiNetworkHop, jitter, mcpToolNameLength, mcpToolCountObject 6A JavaScript assertion.
code [required]The JavaScript code that performs the assertions.
type [required]Type of the assertion.
javascriptObject 7An assertion that checks that an MCP server advertises the expected capabilities.
operator [required]Assertion operator to apply.
contains, doesNotContain, is, isNot, lessThan, lessThanOrEqual, moreThan, moreThanOrEqual, matches, doesNotMatchShow 5 more
validates, isInMoreThan, isInLessThan, doesNotExist, isUndefinedtarget [required]List of MCP server capabilities to assert against.
type [required]Type of the assertion.
mcpServerCapabilitiesObject 8An assertion that verifies the MCP server response respects the MCP specification.
type [required]Type of the assertion.
mcpRespectsSpecificationconfigVariablesArray of variables used for the test.
exampleExample for the variable.
idID of the variable for global variables.
name [required]Name of the variable.
patternPattern of the variable.
secureWhether the value of this variable will be obfuscated in test results. Only for config variables of type text.
type [required]Type of the configuration variable.
global, text, emailrequestObject describing the Synthetic test request.
allow_insecureAllows loading insecure content for an HTTP request in a multistep test step.
basicAuthObject to handle basic authentication when performing the test.
<type=web>Object to handle basic authentication when performing the test.
passwordPassword to use for the basic authentication.
typeThe type of basic authentication to use when performing the test.
webwebusernameUsername to use for the basic authentication.
<type=sigv4>Object to handle SIGV4 authentication when performing the test.
accessKey [required]Access key for the SIGV4 authentication.
regionRegion for the SIGV4 authentication.
secretKey [required]Secret key for the SIGV4 authentication.
serviceNameService name for the SIGV4 authentication.
sessionTokenSession token for the SIGV4 authentication.
type [required]The type of authentication to use when performing the test.
sigv4sigv4<type=ntlm>Object to handle NTLM authentication when performing the test.
domainDomain for the authentication to use when performing the test.
passwordPassword for the authentication to use when performing the test.
type [required]The type of authentication to use when performing the test.
ntlmntlmusernameUsername for the authentication to use when performing the test.
workstationWorkstation for the authentication to use when performing the test.
<type=digest>Object to handle digest authentication when performing the test.
password [required]Password to use for the digest authentication.
type [required]The type of basic authentication to use when performing the test.
digestdigestusername [required]Username to use for the digest authentication.
<type=oauth-client>Object to handle oauth client authentication when performing the test.
accessTokenUrl [required]Access token URL to use when performing the authentication.
audienceAudience to use when performing the authentication.
clientId [required]Client ID to use when performing the authentication.
clientSecret [required]Client secret to use when performing the authentication.
resourceResource to use when performing the authentication.
scopeScope to use when performing the authentication.
tokenApiAuthentication [required]Type of token to use when performing the authentication.
header, bodytype [required]The type of basic authentication to use when performing the test.
oauth-clientoauth-client<type=oauth-rop>Object to handle oauth rop authentication when performing the test.
accessTokenUrl [required]Access token URL to use when performing the authentication.
audienceAudience to use when performing the authentication.
clientIdClient ID to use when performing the authentication.
clientSecretClient secret to use when performing the authentication.
password [required]Password to use when performing the authentication.
resourceResource to use when performing the authentication.
scopeScope to use when performing the authentication.
tokenApiAuthentication [required]Type of token to use when performing the authentication.
header, bodytype [required]The type of basic authentication to use when performing the test.
oauth-ropoauth-ropusername [required]Username to use when performing the authentication.
<type=jwt>Object to handle JWT authentication when performing the test.
addClaimsStandard JWT claims to automatically inject.
expWhether to inject the exp (expiration) claim.
iatWhether to inject the iat (issued at) claim.
algorithm [required]Algorithm to use for the JWT authentication.
HS256, RS256, ES256expiresInToken time-to-live in seconds.
headerCustom JWT header as a JSON string.
payload [required]JWT claims as a JSON string.
secret [required]Signing key for the JWT authentication. Use the shared secret for HS256
or the private key (PEM format) for RS256 and ES256.
tokenPrefixPrefix added before the token in the Authorization header. Defaults to Bearer.
type [required]The type of authentication to use when performing the test.
jwtjwtbodyBody to include in the test.
bodyTypeType of the request body.
text/plain, application/json, text/xml, text/html, application/x-www-form-urlencoded, graphql, application/octet-stream, multipart/form-datacallTypeThe type of call to perform. Used by gRPC steps (healthcheck, unary)
and MCP steps (init, tool_list, tool_call). Valid values depend on
the parent step's subtype.
healthcheck, unary, init, tool_list, tool_callcertificateClient certificate to use when performing the test request.
certDefine a request certificate.
contentContent of the certificate or key.
filenameFile name for the certificate or key.
updatedAtDate of update of the certificate or key, ISO format.
keyDefine a request certificate.
contentContent of the certificate or key.
filenameFile name for the certificate or key.
updatedAtDate of update of the certificate or key, ISO format.
certificateDomainsBy default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.
checkCertificateRevocationCheck for certificate revocation.
compressedJsonDescriptorA protobuf JSON descriptor that needs to be gzipped first then base64 encoded.
compressedProtoFileA protobuf file that needs to be gzipped first then base64 encoded.
disableAiaIntermediateFetchingDisable fetching intermediate certificates from AIA.
dnsServerDNS server to use for DNS tests.
dnsServerPortDNS server port to use for DNS tests.
Object 1Integer DNS server port number to use when performing the test.
Object 2String DNS server port number to use when performing the test. Supports templated variables.
filesFiles to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
bucketKeyBucket key of the file.
contentContent of the file.
encodingEncoding of the file content. The only supported value is base64, indicating the content field contains base64-encoded data.
nameName of the file.
originalFileNameOriginal name of the file.
sizeSize of the file.
typeType of the file.
follow_redirectsSpecifies whether or not the request follows redirects.
formForm to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
<any-key>A single form entry.
headersHeaders to include when performing the test.
<any-key>A single Header.
hostHost name to perform the test with.
httpVersionHTTP version to use for a Synthetic test.
http1, http2, anyignore_certificate_validationFor SSL tests, whether the test should ignore certificate validation.
isMessageBase64EncodedWhether the message is base64 encoded.
mcpProtocolVersionThe MCP protocol version used by the step. See https://modelcontextprotocol.io/specification.
2025-06-18messageMessage to send for UDP or WebSocket tests.
metadataMetadata to include when performing the gRPC test.
<any-key>A single metadatum.
methodEither the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.
noSavingResponseBodyDetermines whether or not to save the response body.
numberOfPacketsNumber of pings to use per test.
persistCookiesPersist cookies across redirects.
portPort to use when performing the test.
Object 1Integer Port number to use when performing the test.
Object 2String Port number to use when performing the test. Supports templated variables.
proxyThe proxy to perform the test.
headersHeaders to include when performing the test.
<any-key>A single Header.
url [required]URL of the proxy to perform the test.
queryQuery to use for the test.
servernameFor SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.
serviceThe gRPC service on which you want to perform the gRPC call.
shouldTrackHopsTurns on a traceroute probe to discover all gateways along the path to the host destination.
timeoutTimeout in seconds for the test.
toolArgsArguments to pass to the MCP tool. Free-form object whose shape depends on the tool. Used when callType is tool_call.
toolNameThe name of the MCP tool to call. Required when callType is tool_call.
urlURL to perform the test with.
stepsWhen the test subtype is multi, the steps of the test.
Object 1The Test step used in a Synthetic multi-step API test.
allowFailureDetermines whether or not to continue with test if this step fails.
assertions [required]Array of assertions used for the test.
Object 1An assertion which uses a simple target.
operator [required]Assertion operator to apply.
contains, doesNotContain, is, isNot, lessThan, lessThanOrEqual, moreThan, moreThanOrEqual, matches, doesNotMatchShow 5 more
validates, isInMoreThan, isInLessThan, doesNotExist, isUndefinedpropertyThe associated assertion property.
target [required]Value used by the operator.
Object 1Numeric value used by the operator in assertions.
Object 2String value used by the operator in assertions. Supports templated variables.
timingsScopeTimings scope for response time assertions.
all, withoutDNStype [required]Type of the assertion.
body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersionShow 13 more
latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection, multiNetworkHop, jitter, mcpToolNameLength, mcpToolCountObject 2An assertion which targets body hash.
operator [required]Assertion operator to apply.
md5, sha1, sha256target [required]Value used by the operator.
Object 1Numeric value used by the operator in assertions.
Object 2String value used by the operator in assertions. Supports templated variables.
type [required]Type of the assertion.
bodyHashObject 3An assertion for the validatesJSONPath operator.
operator [required]Assertion operator to apply.
validatesJSONPathpropertyThe associated assertion property.
targetComposed target for validatesJSONPath operator.
elementsOperatorThe element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.
jsonPathThe JSON path to assert.
operatorThe specific operator to use on the path.
targetValueThe path target value to compare to.
Object 1Numeric value used by the operator in assertions.
Object 2String value used by the operator in assertions. Supports templated variables.
type [required]Type of the assertion.
body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersionShow 13 more
latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection, multiNetworkHop, jitter, mcpToolNameLength, mcpToolCountObject 4An assertion for the validatesJSONSchema operator.
operator [required]Assertion operator to apply.
validatesJSONSchematargetComposed target for validatesJSONSchema operator.
jsonSchemaThe JSON Schema to assert.
metaSchemaThe JSON Schema meta-schema version used in the assertion.
draft-07, draft-06type [required]Type of the assertion.
body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersionShow 13 more
latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection, multiNetworkHop, jitter, mcpToolNameLength, mcpToolCountObject 5An assertion for the validatesXPath operator.
operator [required]Assertion operator to apply.
validatesXPathpropertyThe associated assertion property.
targetComposed target for validatesXPath operator.
operatorThe specific operator to use on the path.
targetValueThe path target value to compare to.
Object 1Numeric value used by the operator in assertions.
Object 2String value used by the operator in assertions. Supports templated variables.
xPathThe X path to assert.
type [required]Type of the assertion.
body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersionShow 13 more
latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection, multiNetworkHop, jitter, mcpToolNameLength, mcpToolCountObject 6A JavaScript assertion.
code [required]The JavaScript code that performs the assertions.
type [required]Type of the assertion.
javascriptObject 7An assertion that checks that an MCP server advertises the expected capabilities.
operator [required]Assertion operator to apply.
contains, doesNotContain, is, isNot, lessThan, lessThanOrEqual, moreThan, moreThanOrEqual, matches, doesNotMatchShow 5 more
validates, isInMoreThan, isInLessThan, doesNotExist, isUndefinedtarget [required]List of MCP server capabilities to assert against.
type [required]Type of the assertion.
mcpServerCapabilitiesObject 8An assertion that verifies the MCP server response respects the MCP specification.
type [required]Type of the assertion.
mcpRespectsSpecificationexitIfSucceedDetermines whether or not to exit the test if the step succeeds.
extractedValuesArray of values to parse and save as variables from the response.
fieldWhen type is http_header or grpc_metadata, name of the header or metadatum to extract.
nameName of the variable to extract.
parserDetails of the parser to use for the global variable.
type [required]Type of parser for a Synthetic global variable from a synthetics test.
raw, json_path, regex, x_pathvalueRegex or JSON path used for the parser. Not used with type raw.
secureDetermines whether or not the extracted value will be obfuscated.
typeProperty of the Synthetic Test Response to extract into a local variable.
grpc_message, grpc_metadata, http_body, http_header, http_status_codeextractedValuesFromScriptGenerate variables using JavaScript.
idID of the step.
isCriticalDetermines whether or not to consider the entire test as failed if this step fails.
Can be used only if allowFailure is true.
name [required]The name of the step.
request [required]Object describing the Synthetic test request.
allow_insecureAllows loading insecure content for an HTTP request in a multistep test step.
basicAuthObject to handle basic authentication when performing the test.
<type=web>Object to handle basic authentication when performing the test.
passwordPassword to use for the basic authentication.
typeThe type of basic authentication to use when performing the test.
webwebusernameUsername to use for the basic authentication.
<type=sigv4>Object to handle SIGV4 authentication when performing the test.
accessKey [required]Access key for the SIGV4 authentication.
regionRegion for the SIGV4 authentication.
secretKey [required]Secret key for the SIGV4 authentication.
serviceNameService name for the SIGV4 authentication.
sessionTokenSession token for the SIGV4 authentication.
type [required]The type of authentication to use when performing the test.
sigv4sigv4<type=ntlm>Object to handle NTLM authentication when performing the test.
domainDomain for the authentication to use when performing the test.
passwordPassword for the authentication to use when performing the test.
type [required]The type of authentication to use when performing the test.
ntlmntlmusernameUsername for the authentication to use when performing the test.
workstationWorkstation for the authentication to use when performing the test.
<type=digest>Object to handle digest authentication when performing the test.
password [required]Password to use for the digest authentication.
type [required]The type of basic authentication to use when performing the test.
digestdigestusername [required]Username to use for the digest authentication.
<type=oauth-client>Object to handle oauth client authentication when performing the test.
accessTokenUrl [required]Access token URL to use when performing the authentication.
audienceAudience to use when performing the authentication.
clientId [required]Client ID to use when performing the authentication.
clientSecret [required]Client secret to use when performing the authentication.
resourceResource to use when performing the authentication.
scopeScope to use when performing the authentication.
tokenApiAuthentication [required]Type of token to use when performing the authentication.
header, bodytype [required]The type of basic authentication to use when performing the test.
oauth-clientoauth-client<type=oauth-rop>Object to handle oauth rop authentication when performing the test.
accessTokenUrl [required]Access token URL to use when performing the authentication.
audienceAudience to use when performing the authentication.
clientIdClient ID to use when performing the authentication.
clientSecretClient secret to use when performing the authentication.
password [required]Password to use when performing the authentication.
resourceResource to use when performing the authentication.
scopeScope to use when performing the authentication.
tokenApiAuthentication [required]Type of token to use when performing the authentication.
header, bodytype [required]The type of basic authentication to use when performing the test.
oauth-ropoauth-ropusername [required]Username to use when performing the authentication.
<type=jwt>Object to handle JWT authentication when performing the test.
addClaimsStandard JWT claims to automatically inject.
expWhether to inject the exp (expiration) claim.
iatWhether to inject the iat (issued at) claim.
algorithm [required]Algorithm to use for the JWT authentication.
HS256, RS256, ES256expiresInToken time-to-live in seconds.
headerCustom JWT header as a JSON string.
payload [required]JWT claims as a JSON string.
secret [required]Signing key for the JWT authentication. Use the shared secret for HS256
or the private key (PEM format) for RS256 and ES256.
tokenPrefixPrefix added before the token in the Authorization header. Defaults to Bearer.
type [required]The type of authentication to use when performing the test.
jwtjwtbodyBody to include in the test.
bodyTypeType of the request body.
text/plain, application/json, text/xml, text/html, application/x-www-form-urlencoded, graphql, application/octet-stream, multipart/form-datacallTypeThe type of call to perform. Used by gRPC steps (healthcheck, unary)
and MCP steps (init, tool_list, tool_call). Valid values depend on
the parent step's subtype.
healthcheck, unary, init, tool_list, tool_callcertificateClient certificate to use when performing the test request.
certDefine a request certificate.
contentContent of the certificate or key.
filenameFile name for the certificate or key.
updatedAtDate of update of the certificate or key, ISO format.
keyDefine a request certificate.
contentContent of the certificate or key.
filenameFile name for the certificate or key.
updatedAtDate of update of the certificate or key, ISO format.
certificateDomainsBy default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.
checkCertificateRevocationCheck for certificate revocation.
compressedJsonDescriptorA protobuf JSON descriptor that needs to be gzipped first then base64 encoded.
compressedProtoFileA protobuf file that needs to be gzipped first then base64 encoded.
disableAiaIntermediateFetchingDisable fetching intermediate certificates from AIA.
dnsServerDNS server to use for DNS tests.
dnsServerPortDNS server port to use for DNS tests.
Object 1Integer DNS server port number to use when performing the test.
Object 2String DNS server port number to use when performing the test. Supports templated variables.
filesFiles to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
bucketKeyBucket key of the file.
contentContent of the file.
encodingEncoding of the file content. The only supported value is base64, indicating the content field contains base64-encoded data.
nameName of the file.
originalFileNameOriginal name of the file.
sizeSize of the file.
typeType of the file.
follow_redirectsSpecifies whether or not the request follows redirects.
formForm to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
<any-key>A single form entry.
headersHeaders to include when performing the test.
<any-key>A single Header.
hostHost name to perform the test with.
httpVersionHTTP version to use for a Synthetic test.
http1, http2, anyignore_certificate_validationFor SSL tests, whether the test should ignore certificate validation.
isMessageBase64EncodedWhether the message is base64 encoded.
mcpProtocolVersionThe MCP protocol version used by the step. See https://modelcontextprotocol.io/specification.
2025-06-18messageMessage to send for UDP or WebSocket tests.
metadataMetadata to include when performing the gRPC test.
<any-key>A single metadatum.
methodEither the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.
noSavingResponseBodyDetermines whether or not to save the response body.
numberOfPacketsNumber of pings to use per test.
persistCookiesPersist cookies across redirects.
portPort to use when performing the test.
Object 1Integer Port number to use when performing the test.
Object 2String Port number to use when performing the test. Supports templated variables.
proxyThe proxy to perform the test.
headersHeaders to include when performing the test.
<any-key>A single Header.
url [required]URL of the proxy to perform the test.
queryQuery to use for the test.
servernameFor SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.
serviceThe gRPC service on which you want to perform the gRPC call.
shouldTrackHopsTurns on a traceroute probe to discover all gateways along the path to the host destination.
timeoutTimeout in seconds for the test.
toolArgsArguments to pass to the MCP tool. Free-form object whose shape depends on the tool. Used when callType is tool_call.
toolNameThe name of the MCP tool to call. Required when callType is tool_call.
urlURL to perform the test with.
retryObject describing the retry strategy to apply to a Synthetic test.
countNumber of times a test needs to be retried before marking a location as failed. Defaults to 0.
intervalTime interval between retries (in milliseconds). Defaults to 300ms.
subtype [required]The subtype of the Synthetic multi-step API test step.
http, grpc, ssl, dns, tcp, udp, icmp, websocket, mcp<subtype=wait>The Wait step used in a Synthetic multi-step API test.
idID of the step.
name [required]The name of the step.
subtype [required]The subtype of the Synthetic multi-step API wait step.
waitvalue [required]The time to wait in seconds. Minimum value: 0. Maximum value: 180.
<subtype=playSubTest>The subtest step used in a Synthetics multi-step API test.
allowFailureDetermines whether or not to continue with test if this step fails.
alwaysExecuteA boolean set to always execute this step even if the previous step failed or was skipped.
exitIfSucceedDetermines whether or not to exit the test if the step succeeds.
extractedValuesFromScriptGenerate variables using JavaScript.
idID of the step.
isCriticalDetermines whether or not to consider the entire test as failed if this step fails.
Can be used only if allowFailure is true.
name [required]The name of the step.
retryObject describing the retry strategy to apply to a Synthetic test.
countNumber of times a test needs to be retried before marking a location as failed. Defaults to 0.
intervalTime interval between retries (in milliseconds). Defaults to 300ms.
subtestPublicId [required]Public ID of the test to be played as part of a playSubTest step type.
subtype [required]The subtype of the Synthetic multi-step API subtest step.
playSubTestvariablesFromScriptVariables defined from JavaScript code.
locations [required]Array of locations used to run the test.
message [required]Notification message associated with the test.
monitor_idThe associated monitor ID.
name [required]Name of the test.
options [required]Object describing the extra options for a Synthetic test.
accept_self_signedFor SSL tests, whether or not the test should allow self signed certificates.
allow_insecureAllows loading insecure content for an HTTP request in an API test.
bits_ai_auto_investigateWhether Bits AI automatically investigates alerts from the test monitor.
blockedRequestPatternsArray of URL patterns to block.
captureNetworkPayloadsCapture HTTP request/response headers and bodies for Fetch/XHR calls made during browser tests.
checkCertificateRevocationFor SSL tests, whether or not the test should fail on revoked certificate in stapled OCSP.
ciCI/CD options for a Synthetic test.
executionRule [required]Execution rule for a Synthetic test.
blocking, non_blocking, skippeddevice_idsFor browser test, array with the different device IDs used to run the test.
disableAiaIntermediateFetchingFor SSL tests, whether or not the test should disable fetching intermediate certificates from AIA.
disableCorsWhether or not to disable CORS mechanism.
disableCspDisable Content Security Policy for browser tests.
enableProfilingEnable profiling for browser tests.
enableSecurityTestingDEPRECATED Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.
follow_redirectsFor API HTTP test, whether or not the test should follow redirects.
httpVersionHTTP version to use for a Synthetic test.
http1, http2, anyignoreServerCertificateErrorIgnore server certificate error for browser tests.
ignore_certificate_validationFor SSL tests, whether the test should ignore certificate validation.
initialNavigationTimeoutTimeout before declaring the initial step as failed (in seconds) for browser tests.
min_failure_durationMinimum amount of time in failure required to trigger an alert.
min_location_failedMinimum number of locations in failure required to trigger an alert.
monitor_nameThe monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
monitor_optionsObject containing the options for a Synthetic test as a monitor (for example, renotification).
escalation_messageMessage to include in the escalation notification.
notification_preset_nameThe name of the preset for the notification for the monitor.
show_all, hide_all, hide_query, hide_handles, hide_query_and_handles, show_only_snapshot, hide_handles_and_footerrenotify_intervalTime interval before renotifying if the test is still failing (in minutes).
renotify_occurrencesThe number of times to renotify if the test is still failing.
monitor_priorityInteger from 1 (high) to 5 (low) indicating alert severity.
noScreenshotPrevents saving screenshots of the steps.
restricted_rolesDEPRECATED A list of role identifiers that can be pulled from the Roles API, for restricting read and write access. This field is deprecated. Use the restriction policies API to manage permissions.
retryObject describing the retry strategy to apply to a Synthetic test.
countNumber of times a test needs to be retried before marking a location as failed. Defaults to 0.
intervalTime interval between retries (in milliseconds). Defaults to 300ms.
rumSettingsThe RUM data collection settings for the Synthetic browser test. Note: There are 3 ways to format RUM settings:
{ isEnabled: false }
RUM data is not collected.
{ isEnabled: true }
RUM data is collected from the Synthetic test's default application.
{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }
RUM data is collected using the specified application.
applicationIdRUM application ID used to collect RUM data for the browser test.
clientTokenIdRUM application API key ID used to collect RUM data for the browser test.
isEnabled [required]Determines whether RUM data is collected during test runs.
schedulingObject containing timeframes and timezone used for advanced scheduling.
timeframes [required]Array containing objects describing the scheduling pattern to apply to each day.
day [required]Number representing the day of the week.
from [required]The hour of the day on which scheduling starts.
to [required]The hour of the day on which scheduling ends.
timezone [required]Timezone in which the timeframe is based.
tick_everyThe frequency at which to run the Synthetic test (in seconds).
public_idThe public ID for the test.
statusDefine whether you want to start (live) or pause (paused) a
Synthetic test.
live, pausedsubtypeThe subtype of the Synthetic API test, http, ssl, tcp,
dns, icmp, udp, websocket, grpc or multi.
http, ssl, tcp, dns, multi, icmp, udp, websocket, grpctagsArray of tags attached to the test.
type [required]Type of the Synthetic test, api.
apiapi{
"config": {
"assertions": [
[]
],
"configVariables": [
{
"example": "string",
"id": "string",
"name": "VARIABLE_NAME",
"pattern": "string",
"secure": false,
"type": "text"
}
],
"request": {
"allow_insecure": false,
"basicAuth": {
"password": "PaSSw0RD!",
"type": "web",
"username": "my_username"
},
"body": "string",
"bodyType": "text/plain",
"callType": "unary",
"certificate": {
"cert": {
"content": "string",
"filename": "string",
"updatedAt": "string"
},
"key": {
"content": "string",
"filename": "string",
"updatedAt": "string"
}
},
"certificateDomains": [],
"checkCertificateRevocation": false,
"compressedJsonDescriptor": "string",
"compressedProtoFile": "string",
"disableAiaIntermediateFetching": false,
"dnsServer": "string",
"dnsServerPort": {
"description": "undefined",
"format": "undefined",
"type": "undefined"
},
"files": [
{
"bucketKey": "string",
"content": "string",
"encoding": "string",
"name": "string",
"originalFileName": "string",
"size": "integer",
"type": "string"
}
],
"follow_redirects": false,
"form": {
"<any-key>": "string"
},
"headers": {
"<any-key>": "string"
},
"host": "string",
"httpVersion": "string",
"ignore_certificate_validation": false,
"isMessageBase64Encoded": false,
"mcpProtocolVersion": "2025-06-18",
"message": "string",
"metadata": {
"<any-key>": "string"
},
"method": "string",
"noSavingResponseBody": false,
"numberOfPackets": "integer",
"persistCookies": false,
"port": {
"description": "undefined",
"format": "undefined",
"type": "undefined"
},
"proxy": {
"headers": {
"<any-key>": "string"
},
"url": "https://example.com"
},
"query": {},
"servername": "string",
"service": "Greeter",
"shouldTrackHops": false,
"timeout": "number",
"toolArgs": {},
"toolName": "search",
"url": "https://example.com"
},
"steps": [],
"variablesFromScript": "dd.variable.set(\"FOO\", \"foo\")"
},
"locations": [
"aws:eu-west-3"
],
"message": "Notification message",
"monitor_id": 12345678,
"name": "Example test name",
"options": {
"accept_self_signed": false,
"allow_insecure": false,
"bits_ai_auto_investigate": false,
"blockedRequestPatterns": [],
"captureNetworkPayloads": false,
"checkCertificateRevocation": false,
"ci": {
"executionRule": "blocking"
},
"device_ids": [
"chrome.laptop_large"
],
"disableAiaIntermediateFetching": false,
"disableCors": false,
"disableCsp": false,
"enableProfiling": false,
"enableSecurityTesting": false,
"follow_redirects": false,
"httpVersion": "string",
"ignoreServerCertificateError": false,
"ignore_certificate_validation": false,
"initialNavigationTimeout": "integer",
"min_failure_duration": "integer",
"min_location_failed": "integer",
"monitor_name": "string",
"monitor_options": {
"escalation_message": "string",
"notification_preset_name": "string",
"renotify_interval": "integer",
"renotify_occurrences": "integer"
},
"monitor_priority": "integer",
"noScreenshot": false,
"restricted_roles": [
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
],
"retry": {
"count": "integer",
"interval": "number"
},
"rumSettings": {
"applicationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"clientTokenId": 12345,
"isEnabled": true
},
"scheduling": {
"timeframes": [
{
"day": 1,
"from": "07:00",
"to": "16:00"
}
],
"timezone": "America/New_York"
},
"tick_every": "integer"
},
"public_id": "123-abc-456",
"status": "live",
"subtype": "http",
"tags": [
"env:production"
],
"type": "api"
}- JSON format is wrong - Updating sub-type is forbidden
Error response object.
errors [required]Array of errors returned by the API.
{
"errors": [
"Bad Request"
]
}Forbidden
Error response object.
errors [required]Array of errors returned by the API.
{
"errors": [
"Bad Request"
]
}- Synthetic Monitoring is not activated for the user - Test is not owned by the user - Test can't be found
Error response object.
errors [required]Array of errors returned by the API.
{
"errors": [
"Bad Request"
]
}Too many requests
Error response object.
errors [required]Array of errors returned by the API.
{
"errors": [
"Bad Request"
]
}코드 예시
# Path parameters
export public_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PUT "https://api.${DD_SITE}/api/v1/synthetics/tests/api/${public_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [
{
"operator": "is",
"property": "{{ PROPERTY }}",
"target": "text/html",
"type": "header"
},
{
"operator": "lessThan",
"target": 2000,
"type": "responseTime"
},
{
"operator": "validatesJSONPath",
"target": {
"jsonPath": "topKey",
"operator": "isNot",
"targetValue": "0"
},
"type": "body"
},
{
"operator": "validatesJSONSchema",
"target": {
"metaSchema": "draft-07",
"jsonSchema": "{\"type\": \"object\", \"properties\":{\"slideshow\":{\"type\":\"object\"}}}"
},
"type": "body"
}
],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text"
}
],
"request": {
"certificate": {
"cert": {
"filename": "cert-filename",
"updatedAt": "2020-10-16T09:23:24.857Z"
},
"key": {
"filename": "key-filename",
"updatedAt": "2020-10-16T09:23:24.857Z"
}
},
"headers": {
"unique": "examplesynthetic"
},
"method": "GET",
"timeout": 10,
"url": "https://datadoghq.com"
}
},
"locations": [
"aws:us-east-2"
],
"message": "BDD test payload: synthetics_api_test_payload.json",
"name": "Example-Synthetic-updated",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"monitor_name": "Test-TestSyntheticsAPITestLifecycle-1623076664",
"monitor_priority": 5,
"retry": {
"count": 3,
"interval": 10
},
"tick_every": 60
},
"status": "live",
"subtype": "http",
"tags": [
"testing:api"
],
"type": "api"
}
EOF# Path parameters
export public_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PUT "https://api.${DD_SITE}/api/v1/synthetics/tests/api/${public_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [
{
"operator": "is",
"property": "{{ PROPERTY }}",
"target": "text/html",
"type": "header"
},
{
"operator": "lessThan",
"target": 2000,
"type": "responseTime"
},
{
"operator": "validatesJSONPath",
"target": {
"jsonPath": "topKey",
"operator": "isNot",
"targetValue": "0"
},
"type": "body"
},
{
"operator": "validatesJSONSchema",
"target": {
"metaSchema": "draft-07",
"jsonSchema": "{\"type\": \"object\", \"properties\":{\"slideshow\":{\"type\":\"object\"}}}"
},
"type": "body"
}
],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text"
}
],
"request": {
"certificate": {
"cert": {
"filename": "cert-filename",
"updatedAt": "2020-10-16T09:23:24.857Z"
},
"key": {
"filename": "key-filename",
"updatedAt": "2020-10-16T09:23:24.857Z"
}
},
"headers": {
"unique": "examplesynthetic"
},
"method": "GET",
"timeout": 10,
"url": "https://datadoghq.com"
}
},
"locations": [
"aws:us-east-2"
],
"message": "BDD test payload: synthetics_api_test_payload.json",
"name": "Example-Synthetic-updated",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"monitor_name": "Test-TestSyntheticsAPITestLifecycle-1623076664",
"monitor_priority": 5,
"retry": {
"count": 3,
"interval": 10
},
"tick_every": 60
},
"status": "live",
"subtype": "http",
"tags": [
"testing:api"
],
"type": "api"
}
EOF# Path parameters
export public_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PUT "https://api.${DD_SITE}/api/v1/synthetics/tests/api/${public_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [
{
"operator": "is",
"property": "{{ PROPERTY }}",
"target": "text/html",
"type": "header"
},
{
"operator": "lessThan",
"target": 2000,
"type": "responseTime"
},
{
"operator": "validatesJSONPath",
"target": {
"jsonPath": "topKey",
"operator": "isNot",
"targetValue": "0"
},
"type": "body"
},
{
"operator": "validatesJSONSchema",
"target": {
"metaSchema": "draft-07",
"jsonSchema": "{\"type\": \"object\", \"properties\":{\"slideshow\":{\"type\":\"object\"}}}"
},
"type": "body"
}
],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text"
}
],
"request": {
"certificate": {
"cert": {
"filename": "cert-filename",
"updatedAt": "2020-10-16T09:23:24.857Z"
},
"key": {
"filename": "key-filename",
"updatedAt": "2020-10-16T09:23:24.857Z"
}
},
"headers": {
"unique": "examplesynthetic"
},
"method": "GET",
"timeout": 10,
"url": "https://datadoghq.com"
}
},
"locations": [
"aws:us-east-2"
],
"message": "BDD test payload: synthetics_api_test_payload.json",
"name": "Example-Synthetic-updated",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"monitor_name": "Test-TestSyntheticsAPITestLifecycle-1623076664",
"monitor_priority": 5,
"retry": {
"count": 3,
"interval": 10
},
"tick_every": 60
},
"status": "live",
"subtype": "http",
"tags": [
"testing:api"
],
"type": "api"
}
EOF# Path parameters
export public_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PUT "https://api.${DD_SITE}/api/v1/synthetics/tests/api/${public_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [
{
"operator": "is",
"property": "{{ PROPERTY }}",
"target": "text/html",
"type": "header"
},
{
"operator": "lessThan",
"target": 2000,
"type": "responseTime"
},
{
"operator": "validatesJSONPath",
"target": {
"jsonPath": "topKey",
"operator": "isNot",
"targetValue": "0"
},
"type": "body"
},
{
"operator": "validatesJSONSchema",
"target": {
"metaSchema": "draft-07",
"jsonSchema": "{\"type\": \"object\", \"properties\":{\"slideshow\":{\"type\":\"object\"}}}"
},
"type": "body"
}
],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text"
}
],
"request": {
"certificate": {
"cert": {
"filename": "cert-filename",
"updatedAt": "2020-10-16T09:23:24.857Z"
},
"key": {
"filename": "key-filename",
"updatedAt": "2020-10-16T09:23:24.857Z"
}
},
"headers": {
"unique": "examplesynthetic"
},
"method": "GET",
"timeout": 10,
"url": "https://datadoghq.com"
}
},
"locations": [
"aws:us-east-2"
],
"message": "BDD test payload: synthetics_api_test_payload.json",
"name": "Example-Synthetic-updated",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"monitor_name": "Test-TestSyntheticsAPITestLifecycle-1623076664",
"monitor_priority": 5,
"retry": {
"count": 3,
"interval": 10
},
"tick_every": 60
},
"status": "live",
"subtype": "http",
"tags": [
"testing:api"
],
"type": "api"
}
EOF# Path parameters
export public_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PUT "https://api.${DD_SITE}/api/v1/synthetics/tests/api/${public_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [
{
"operator": "is",
"property": "{{ PROPERTY }}",
"target": "text/html",
"type": "header"
},
{
"operator": "lessThan",
"target": 2000,
"type": "responseTime"
},
{
"operator": "validatesJSONPath",
"target": {
"jsonPath": "topKey",
"operator": "isNot",
"targetValue": "0"
},
"type": "body"
},
{
"operator": "validatesJSONSchema",
"target": {
"metaSchema": "draft-07",
"jsonSchema": "{\"type\": \"object\", \"properties\":{\"slideshow\":{\"type\":\"object\"}}}"
},
"type": "body"
}
],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text"
}
],
"request": {
"certificate": {
"cert": {
"filename": "cert-filename",
"updatedAt": "2020-10-16T09:23:24.857Z"
},
"key": {
"filename": "key-filename",
"updatedAt": "2020-10-16T09:23:24.857Z"
}
},
"headers": {
"unique": "examplesynthetic"
},
"method": "GET",
"timeout": 10,
"url": "https://datadoghq.com"
}
},
"locations": [
"aws:us-east-2"
],
"message": "BDD test payload: synthetics_api_test_payload.json",
"name": "Example-Synthetic-updated",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"monitor_name": "Test-TestSyntheticsAPITestLifecycle-1623076664",
"monitor_priority": 5,
"retry": {
"count": 3,
"interval": 10
},
"tick_every": 60
},
"status": "live",
"subtype": "http",
"tags": [
"testing:api"
],
"type": "api"
}
EOF# Path parameters
export public_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PUT "https://api.${DD_SITE}/api/v1/synthetics/tests/api/${public_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [
{
"operator": "is",
"property": "{{ PROPERTY }}",
"target": "text/html",
"type": "header"
},
{
"operator": "lessThan",
"target": 2000,
"type": "responseTime"
},
{
"operator": "validatesJSONPath",
"target": {
"jsonPath": "topKey",
"operator": "isNot",
"targetValue": "0"
},
"type": "body"
},
{
"operator": "validatesJSONSchema",
"target": {
"metaSchema": "draft-07",
"jsonSchema": "{\"type\": \"object\", \"properties\":{\"slideshow\":{\"type\":\"object\"}}}"
},
"type": "body"
}
],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text"
}
],
"request": {
"certificate": {
"cert": {
"filename": "cert-filename",
"updatedAt": "2020-10-16T09:23:24.857Z"
},
"key": {
"filename": "key-filename",
"updatedAt": "2020-10-16T09:23:24.857Z"
}
},
"headers": {
"unique": "examplesynthetic"
},
"method": "GET",
"timeout": 10,
"url": "https://datadoghq.com"
}
},
"locations": [
"aws:us-east-2"
],
"message": "BDD test payload: synthetics_api_test_payload.json",
"name": "Example-Synthetic-updated",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"monitor_name": "Test-TestSyntheticsAPITestLifecycle-1623076664",
"monitor_priority": 5,
"retry": {
"count": 3,
"interval": 10
},
"tick_every": 60
},
"status": "live",
"subtype": "http",
"tags": [
"testing:api"
],
"type": "api"
}
EOF# Path parameters
export public_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PUT "https://api.${DD_SITE}/api/v1/synthetics/tests/api/${public_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [
{
"operator": "is",
"property": "{{ PROPERTY }}",
"target": "text/html",
"type": "header"
},
{
"operator": "lessThan",
"target": 2000,
"type": "responseTime"
},
{
"operator": "validatesJSONPath",
"target": {
"jsonPath": "topKey",
"operator": "isNot",
"targetValue": "0"
},
"type": "body"
},
{
"operator": "validatesJSONSchema",
"target": {
"metaSchema": "draft-07",
"jsonSchema": "{\"type\": \"object\", \"properties\":{\"slideshow\":{\"type\":\"object\"}}}"
},
"type": "body"
}
],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text"
}
],
"request": {
"certificate": {
"cert": {
"filename": "cert-filename",
"updatedAt": "2020-10-16T09:23:24.857Z"
},
"key": {
"filename": "key-filename",
"updatedAt": "2020-10-16T09:23:24.857Z"
}
},
"headers": {
"unique": "examplesynthetic"
},
"method": "GET",
"timeout": 10,
"url": "https://datadoghq.com"
}
},
"locations": [
"aws:us-east-2"
],
"message": "BDD test payload: synthetics_api_test_payload.json",
"name": "Example-Synthetic-updated",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"monitor_name": "Test-TestSyntheticsAPITestLifecycle-1623076664",
"monitor_priority": 5,
"retry": {
"count": 3,
"interval": 10
},
"tick_every": 60
},
"status": "live",
"subtype": "http",
"tags": [
"testing:api"
],
"type": "api"
}
EOF# Path parameters
export public_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PUT "https://api.${DD_SITE}/api/v1/synthetics/tests/api/${public_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [
{
"operator": "is",
"property": "{{ PROPERTY }}",
"target": "text/html",
"type": "header"
},
{
"operator": "lessThan",
"target": 2000,
"type": "responseTime"
},
{
"operator": "validatesJSONPath",
"target": {
"jsonPath": "topKey",
"operator": "isNot",
"targetValue": "0"
},
"type": "body"
},
{
"operator": "validatesJSONSchema",
"target": {
"metaSchema": "draft-07",
"jsonSchema": "{\"type\": \"object\", \"properties\":{\"slideshow\":{\"type\":\"object\"}}}"
},
"type": "body"
}
],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text"
}
],
"request": {
"certificate": {
"cert": {
"filename": "cert-filename",
"updatedAt": "2020-10-16T09:23:24.857Z"
},
"key": {
"filename": "key-filename",
"updatedAt": "2020-10-16T09:23:24.857Z"
}
},
"headers": {
"unique": "examplesynthetic"
},
"method": "GET",
"timeout": 10,
"url": "https://datadoghq.com"
}
},
"locations": [
"aws:us-east-2"
],
"message": "BDD test payload: synthetics_api_test_payload.json",
"name": "Example-Synthetic-updated",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"monitor_name": "Test-TestSyntheticsAPITestLifecycle-1623076664",
"monitor_priority": 5,
"retry": {
"count": 3,
"interval": 10
},
"tick_every": 60
},
"status": "live",
"subtype": "http",
"tags": [
"testing:api"
],
"type": "api"
}
EOF# Path parameters
export public_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PUT "https://api.${DD_SITE}/api/v1/synthetics/tests/api/${public_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [
{
"operator": "is",
"property": "{{ PROPERTY }}",
"target": "text/html",
"type": "header"
},
{
"operator": "lessThan",
"target": 2000,
"type": "responseTime"
},
{
"operator": "validatesJSONPath",
"target": {
"jsonPath": "topKey",
"operator": "isNot",
"targetValue": "0"
},
"type": "body"
},
{
"operator": "validatesJSONSchema",
"target": {
"metaSchema": "draft-07",
"jsonSchema": "{\"type\": \"object\", \"properties\":{\"slideshow\":{\"type\":\"object\"}}}"
},
"type": "body"
}
],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text"
}
],
"request": {
"certificate": {
"cert": {
"filename": "cert-filename",
"updatedAt": "2020-10-16T09:23:24.857Z"
},
"key": {
"filename": "key-filename",
"updatedAt": "2020-10-16T09:23:24.857Z"
}
},
"headers": {
"unique": "examplesynthetic"
},
"method": "GET",
"timeout": 10,
"url": "https://datadoghq.com"
}
},
"locations": [
"aws:us-east-2"
],
"message": "BDD test payload: synthetics_api_test_payload.json",
"name": "Example-Synthetic-updated",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"monitor_name": "Test-TestSyntheticsAPITestLifecycle-1623076664",
"monitor_priority": 5,
"retry": {
"count": 3,
"interval": 10
},
"tick_every": 60
},
"status": "live",
"subtype": "http",
"tags": [
"testing:api"
],
"type": "api"
}
EOF// Edit an API test returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV1"
)
func main() {
// there is a valid "synthetics_api_test" in the system
SyntheticsAPITestPublicID := os.Getenv("SYNTHETICS_API_TEST_PUBLIC_ID")
body := datadogV1.SyntheticsAPITest{
Config: datadogV1.SyntheticsAPITestConfig{
Assertions: []datadogV1.SyntheticsAssertion{
datadogV1.SyntheticsAssertion{
SyntheticsAssertionTarget: &datadogV1.SyntheticsAssertionTarget{
Operator: datadogV1.SYNTHETICSASSERTIONOPERATOR_IS,
Property: datadog.PtrString("{{ PROPERTY }}"),
Target: datadogV1.SyntheticsAssertionTargetValue{
SyntheticsAssertionTargetValueString: datadog.PtrString("text/html")},
Type: datadogV1.SYNTHETICSASSERTIONTYPE_HEADER,
}},
datadogV1.SyntheticsAssertion{
SyntheticsAssertionTarget: &datadogV1.SyntheticsAssertionTarget{
Operator: datadogV1.SYNTHETICSASSERTIONOPERATOR_LESS_THAN,
Target: datadogV1.SyntheticsAssertionTargetValue{
SyntheticsAssertionTargetValueNumber: datadog.PtrFloat64(2000)},
Type: datadogV1.SYNTHETICSASSERTIONTYPE_RESPONSE_TIME,
}},
datadogV1.SyntheticsAssertion{
SyntheticsAssertionJSONPathTarget: &datadogV1.SyntheticsAssertionJSONPathTarget{
Operator: datadogV1.SYNTHETICSASSERTIONJSONPATHOPERATOR_VALIDATES_JSON_PATH,
Target: &datadogV1.SyntheticsAssertionJSONPathTargetTarget{
JsonPath: datadog.PtrString("topKey"),
Operator: datadog.PtrString("isNot"),
TargetValue: &datadogV1.SyntheticsAssertionTargetValue{
SyntheticsAssertionTargetValueString: datadog.PtrString("0")},
},
Type: datadogV1.SYNTHETICSASSERTIONTYPE_BODY,
}},
datadogV1.SyntheticsAssertion{
SyntheticsAssertionJSONSchemaTarget: &datadogV1.SyntheticsAssertionJSONSchemaTarget{
Operator: datadogV1.SYNTHETICSASSERTIONJSONSCHEMAOPERATOR_VALIDATES_JSON_SCHEMA,
Target: &datadogV1.SyntheticsAssertionJSONSchemaTargetTarget{
MetaSchema: datadogV1.SYNTHETICSASSERTIONJSONSCHEMAMETASCHEMA_DRAFT_07.Ptr(),
JsonSchema: datadog.PtrString(`{"type": "object", "properties":{"slideshow":{"type":"object"}}}`),
},
Type: datadogV1.SYNTHETICSASSERTIONTYPE_BODY,
}},
},
ConfigVariables: []datadogV1.SyntheticsConfigVariable{
{
Example: datadog.PtrString("content-type"),
Name: "PROPERTY",
Pattern: datadog.PtrString("content-type"),
Type: datadogV1.SYNTHETICSCONFIGVARIABLETYPE_TEXT,
},
},
Request: &datadogV1.SyntheticsTestRequest{
Certificate: &datadogV1.SyntheticsTestRequestCertificate{
Cert: &datadogV1.SyntheticsTestRequestCertificateItem{
Filename: datadog.PtrString("cert-filename"),
UpdatedAt: datadog.PtrString("2020-10-16T09:23:24.857Z"),
},
Key: &datadogV1.SyntheticsTestRequestCertificateItem{
Filename: datadog.PtrString("key-filename"),
UpdatedAt: datadog.PtrString("2020-10-16T09:23:24.857Z"),
},
},
Headers: map[string]string{
"unique": "examplesynthetic",
},
Method: datadog.PtrString("GET"),
Timeout: datadog.PtrFloat64(10),
Url: datadog.PtrString("https://datadoghq.com"),
},
},
Locations: []string{
"aws:us-east-2",
},
Message: "BDD test payload: synthetics_api_test_payload.json",
Name: "Example-Synthetic-updated",
Options: datadogV1.SyntheticsTestOptions{
AcceptSelfSigned: datadog.PtrBool(false),
AllowInsecure: datadog.PtrBool(true),
FollowRedirects: datadog.PtrBool(true),
MinFailureDuration: datadog.PtrInt64(10),
MinLocationFailed: datadog.PtrInt64(1),
MonitorName: datadog.PtrString("Test-TestSyntheticsAPITestLifecycle-1623076664"),
MonitorPriority: datadog.PtrInt32(5),
Retry: &datadogV1.SyntheticsTestOptionsRetry{
Count: datadog.PtrInt64(3),
Interval: datadog.PtrFloat64(10),
},
TickEvery: datadog.PtrInt64(60),
},
Status: datadogV1.SYNTHETICSTESTPAUSESTATUS_LIVE.Ptr(),
Subtype: datadogV1.SYNTHETICSTESTDETAILSSUBTYPE_HTTP.Ptr(),
Tags: []string{
"testing:api",
},
Type: datadogV1.SYNTHETICSAPITESTTYPE_API,
}
ctx := datadog.NewDefaultContext(context.Background())
ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV1.NewSyntheticsApi(apiClient)
resp, r, err := api.UpdateAPITest(ctx, SyntheticsAPITestPublicID, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SyntheticsApi.UpdateAPITest`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `SyntheticsApi.UpdateAPITest`:\n%s\n", responseContent)
}
Instructions
First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"// Edit an API test returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.SyntheticsApi;
import com.datadog.api.client.v1.model.SyntheticsAPITest;
import com.datadog.api.client.v1.model.SyntheticsAPITestConfig;
import com.datadog.api.client.v1.model.SyntheticsAPITestType;
import com.datadog.api.client.v1.model.SyntheticsAssertion;
import com.datadog.api.client.v1.model.SyntheticsAssertionJSONPathOperator;
import com.datadog.api.client.v1.model.SyntheticsAssertionJSONPathTarget;
import com.datadog.api.client.v1.model.SyntheticsAssertionJSONPathTargetTarget;
import com.datadog.api.client.v1.model.SyntheticsAssertionJSONSchemaMetaSchema;
import com.datadog.api.client.v1.model.SyntheticsAssertionJSONSchemaOperator;
import com.datadog.api.client.v1.model.SyntheticsAssertionJSONSchemaTarget;
import com.datadog.api.client.v1.model.SyntheticsAssertionJSONSchemaTargetTarget;
import com.datadog.api.client.v1.model.SyntheticsAssertionOperator;
import com.datadog.api.client.v1.model.SyntheticsAssertionTarget;
import com.datadog.api.client.v1.model.SyntheticsAssertionTargetValue;
import com.datadog.api.client.v1.model.SyntheticsAssertionType;
import com.datadog.api.client.v1.model.SyntheticsConfigVariable;
import com.datadog.api.client.v1.model.SyntheticsConfigVariableType;
import com.datadog.api.client.v1.model.SyntheticsTestDetailsSubType;
import com.datadog.api.client.v1.model.SyntheticsTestOptions;
import com.datadog.api.client.v1.model.SyntheticsTestOptionsRetry;
import com.datadog.api.client.v1.model.SyntheticsTestPauseStatus;
import com.datadog.api.client.v1.model.SyntheticsTestRequest;
import com.datadog.api.client.v1.model.SyntheticsTestRequestCertificate;
import com.datadog.api.client.v1.model.SyntheticsTestRequestCertificateItem;
import java.util.Arrays;
import java.util.Collections;
import java.util.Map;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
SyntheticsApi apiInstance = new SyntheticsApi(defaultClient);
// there is a valid "synthetics_api_test" in the system
String SYNTHETICS_API_TEST_PUBLIC_ID = System.getenv("SYNTHETICS_API_TEST_PUBLIC_ID");
SyntheticsAPITest body =
new SyntheticsAPITest()
.config(
new SyntheticsAPITestConfig()
.assertions(
Arrays.asList(
new SyntheticsAssertion(
new SyntheticsAssertionTarget()
.operator(SyntheticsAssertionOperator.IS)
.property("{{ PROPERTY }}")
.target(new SyntheticsAssertionTargetValue("text/html"))
.type(SyntheticsAssertionType.HEADER)),
new SyntheticsAssertion(
new SyntheticsAssertionTarget()
.operator(SyntheticsAssertionOperator.LESS_THAN)
.target(new SyntheticsAssertionTargetValue(2000.0))
.type(SyntheticsAssertionType.RESPONSE_TIME)),
new SyntheticsAssertion(
new SyntheticsAssertionJSONPathTarget()
.operator(
SyntheticsAssertionJSONPathOperator.VALIDATES_JSON_PATH)
.target(
new SyntheticsAssertionJSONPathTargetTarget()
.jsonPath("topKey")
.operator("isNot")
.targetValue(new SyntheticsAssertionTargetValue("0")))
.type(SyntheticsAssertionType.BODY)),
new SyntheticsAssertion(
new SyntheticsAssertionJSONSchemaTarget()
.operator(
SyntheticsAssertionJSONSchemaOperator.VALIDATES_JSON_SCHEMA)
.target(
new SyntheticsAssertionJSONSchemaTargetTarget()
.metaSchema(
SyntheticsAssertionJSONSchemaMetaSchema.DRAFT_07)
.jsonSchema(
"""
{"type": "object", "properties":{"slideshow":{"type":"object"}}}
"""))
.type(SyntheticsAssertionType.BODY))))
.configVariables(
Collections.singletonList(
new SyntheticsConfigVariable()
.example("content-type")
.name("PROPERTY")
.pattern("content-type")
.type(SyntheticsConfigVariableType.TEXT)))
.request(
new SyntheticsTestRequest()
.certificate(
new SyntheticsTestRequestCertificate()
.cert(
new SyntheticsTestRequestCertificateItem()
.filename("cert-filename")
.updatedAt("2020-10-16T09:23:24.857Z"))
.key(
new SyntheticsTestRequestCertificateItem()
.filename("key-filename")
.updatedAt("2020-10-16T09:23:24.857Z")))
.headers(Map.ofEntries(Map.entry("unique", "examplesynthetic")))
.method("GET")
.timeout(10.0)
.url("https://datadoghq.com")))
.locations(Collections.singletonList("aws:us-east-2"))
.message("BDD test payload: synthetics_api_test_payload.json")
.name("Example-Synthetic-updated")
.options(
new SyntheticsTestOptions()
.acceptSelfSigned(false)
.allowInsecure(true)
.followRedirects(true)
.minFailureDuration(10L)
.minLocationFailed(1L)
.monitorName("Test-TestSyntheticsAPITestLifecycle-1623076664")
.monitorPriority(5)
.retry(new SyntheticsTestOptionsRetry().count(3L).interval(10.0))
.tickEvery(60L))
.status(SyntheticsTestPauseStatus.LIVE)
.subtype(SyntheticsTestDetailsSubType.HTTP)
.tags(Collections.singletonList("testing:api"))
.type(SyntheticsAPITestType.API);
try {
SyntheticsAPITest result = apiInstance.updateAPITest(SYNTHETICS_API_TEST_PUBLIC_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SyntheticsApi#updateAPITest");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Instructions
First install the library and its dependencies and then save the example to Example.java and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java""""
Edit an API test returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.synthetics_api import SyntheticsApi
from datadog_api_client.v1.model.synthetics_api_test import SyntheticsAPITest
from datadog_api_client.v1.model.synthetics_api_test_config import SyntheticsAPITestConfig
from datadog_api_client.v1.model.synthetics_api_test_type import SyntheticsAPITestType
from datadog_api_client.v1.model.synthetics_assertion_json_path_operator import SyntheticsAssertionJSONPathOperator
from datadog_api_client.v1.model.synthetics_assertion_json_path_target import SyntheticsAssertionJSONPathTarget
from datadog_api_client.v1.model.synthetics_assertion_json_path_target_target import (
SyntheticsAssertionJSONPathTargetTarget,
)
from datadog_api_client.v1.model.synthetics_assertion_json_schema_meta_schema import (
SyntheticsAssertionJSONSchemaMetaSchema,
)
from datadog_api_client.v1.model.synthetics_assertion_json_schema_operator import SyntheticsAssertionJSONSchemaOperator
from datadog_api_client.v1.model.synthetics_assertion_json_schema_target import SyntheticsAssertionJSONSchemaTarget
from datadog_api_client.v1.model.synthetics_assertion_json_schema_target_target import (
SyntheticsAssertionJSONSchemaTargetTarget,
)
from datadog_api_client.v1.model.synthetics_assertion_operator import SyntheticsAssertionOperator
from datadog_api_client.v1.model.synthetics_assertion_target import SyntheticsAssertionTarget
from datadog_api_client.v1.model.synthetics_assertion_type import SyntheticsAssertionType
from datadog_api_client.v1.model.synthetics_config_variable import SyntheticsConfigVariable
from datadog_api_client.v1.model.synthetics_config_variable_type import SyntheticsConfigVariableType
from datadog_api_client.v1.model.synthetics_test_details_sub_type import SyntheticsTestDetailsSubType
from datadog_api_client.v1.model.synthetics_test_headers import SyntheticsTestHeaders
from datadog_api_client.v1.model.synthetics_test_options import SyntheticsTestOptions
from datadog_api_client.v1.model.synthetics_test_options_retry import SyntheticsTestOptionsRetry
from datadog_api_client.v1.model.synthetics_test_pause_status import SyntheticsTestPauseStatus
from datadog_api_client.v1.model.synthetics_test_request import SyntheticsTestRequest
from datadog_api_client.v1.model.synthetics_test_request_certificate import SyntheticsTestRequestCertificate
from datadog_api_client.v1.model.synthetics_test_request_certificate_item import SyntheticsTestRequestCertificateItem
# there is a valid "synthetics_api_test" in the system
SYNTHETICS_API_TEST_PUBLIC_ID = environ["SYNTHETICS_API_TEST_PUBLIC_ID"]
body = SyntheticsAPITest(
config=SyntheticsAPITestConfig(
assertions=[
SyntheticsAssertionTarget(
operator=SyntheticsAssertionOperator.IS,
_property="{{ PROPERTY }}",
target="text/html",
type=SyntheticsAssertionType.HEADER,
),
SyntheticsAssertionTarget(
operator=SyntheticsAssertionOperator.LESS_THAN,
target=2000,
type=SyntheticsAssertionType.RESPONSE_TIME,
),
SyntheticsAssertionJSONPathTarget(
operator=SyntheticsAssertionJSONPathOperator.VALIDATES_JSON_PATH,
target=SyntheticsAssertionJSONPathTargetTarget(
json_path="topKey",
operator="isNot",
target_value="0",
),
type=SyntheticsAssertionType.BODY,
),
SyntheticsAssertionJSONSchemaTarget(
operator=SyntheticsAssertionJSONSchemaOperator.VALIDATES_JSON_SCHEMA,
target=SyntheticsAssertionJSONSchemaTargetTarget(
meta_schema=SyntheticsAssertionJSONSchemaMetaSchema.DRAFT_07,
json_schema='{"type": "object", "properties":{"slideshow":{"type":"object"}}}',
),
type=SyntheticsAssertionType.BODY,
),
],
config_variables=[
SyntheticsConfigVariable(
example="content-type",
name="PROPERTY",
pattern="content-type",
type=SyntheticsConfigVariableType.TEXT,
),
],
request=SyntheticsTestRequest(
certificate=SyntheticsTestRequestCertificate(
cert=SyntheticsTestRequestCertificateItem(
filename="cert-filename",
updated_at="2020-10-16T09:23:24.857Z",
),
key=SyntheticsTestRequestCertificateItem(
filename="key-filename",
updated_at="2020-10-16T09:23:24.857Z",
),
),
headers=SyntheticsTestHeaders(
unique="examplesynthetic",
),
method="GET",
timeout=10.0,
url="https://datadoghq.com",
),
),
locations=[
"aws:us-east-2",
],
message="BDD test payload: synthetics_api_test_payload.json",
name="Example-Synthetic-updated",
options=SyntheticsTestOptions(
accept_self_signed=False,
allow_insecure=True,
follow_redirects=True,
min_failure_duration=10,
min_location_failed=1,
monitor_name="Test-TestSyntheticsAPITestLifecycle-1623076664",
monitor_priority=5,
retry=SyntheticsTestOptionsRetry(
count=3,
interval=10.0,
),
tick_every=60,
),
status=SyntheticsTestPauseStatus.LIVE,
subtype=SyntheticsTestDetailsSubType.HTTP,
tags=[
"testing:api",
],
type=SyntheticsAPITestType.API,
)
configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
with ApiClient(configuration) as api_client:
api_instance = SyntheticsApi(api_client)
response = api_instance.update_api_test(public_id=SYNTHETICS_API_TEST_PUBLIC_ID, body=body)
print(response)
Instructions
First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"# Edit an API test returns "OK" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.access_token = ENV["DD_BEARER_TOKEN"]
end
api_instance = DatadogAPIClient::V1::SyntheticsAPI.new
# there is a valid "synthetics_api_test" in the system
SYNTHETICS_API_TEST_PUBLIC_ID = ENV["SYNTHETICS_API_TEST_PUBLIC_ID"]
body = DatadogAPIClient::V1::SyntheticsAPITest.new({
config: DatadogAPIClient::V1::SyntheticsAPITestConfig.new({
assertions: [
DatadogAPIClient::V1::SyntheticsAssertionTarget.new({
operator: DatadogAPIClient::V1::SyntheticsAssertionOperator::IS,
property: "{{ PROPERTY }}",
target: "text/html",
type: DatadogAPIClient::V1::SyntheticsAssertionType::HEADER,
}),
DatadogAPIClient::V1::SyntheticsAssertionTarget.new({
operator: DatadogAPIClient::V1::SyntheticsAssertionOperator::LESS_THAN,
target: 2000,
type: DatadogAPIClient::V1::SyntheticsAssertionType::RESPONSE_TIME,
}),
DatadogAPIClient::V1::SyntheticsAssertionJSONPathTarget.new({
operator: DatadogAPIClient::V1::SyntheticsAssertionJSONPathOperator::VALIDATES_JSON_PATH,
target: DatadogAPIClient::V1::SyntheticsAssertionJSONPathTargetTarget.new({
json_path: "topKey",
operator: "isNot",
target_value: "0",
}),
type: DatadogAPIClient::V1::SyntheticsAssertionType::BODY,
}),
DatadogAPIClient::V1::SyntheticsAssertionJSONSchemaTarget.new({
operator: DatadogAPIClient::V1::SyntheticsAssertionJSONSchemaOperator::VALIDATES_JSON_SCHEMA,
target: DatadogAPIClient::V1::SyntheticsAssertionJSONSchemaTargetTarget.new({
meta_schema: DatadogAPIClient::V1::SyntheticsAssertionJSONSchemaMetaSchema::DRAFT_07,
json_schema: '{"type": "object", "properties":{"slideshow":{"type":"object"}}}',
}),
type: DatadogAPIClient::V1::SyntheticsAssertionType::BODY,
}),
],
config_variables: [
DatadogAPIClient::V1::SyntheticsConfigVariable.new({
example: "content-type",
name: "PROPERTY",
pattern: "content-type",
type: DatadogAPIClient::V1::SyntheticsConfigVariableType::TEXT,
}),
],
request: DatadogAPIClient::V1::SyntheticsTestRequest.new({
certificate: DatadogAPIClient::V1::SyntheticsTestRequestCertificate.new({
cert: DatadogAPIClient::V1::SyntheticsTestRequestCertificateItem.new({
filename: "cert-filename",
updated_at: "2020-10-16T09:23:24.857Z",
}),
key: DatadogAPIClient::V1::SyntheticsTestRequestCertificateItem.new({
filename: "key-filename",
updated_at: "2020-10-16T09:23:24.857Z",
}),
}),
headers: {
unique: "examplesynthetic",
},
method: "GET",
timeout: 10,
url: "https://datadoghq.com",
}),
}),
locations: [
"aws:us-east-2",
],
message: "BDD test payload: synthetics_api_test_payload.json",
name: "Example-Synthetic-updated",
options: DatadogAPIClient::V1::SyntheticsTestOptions.new({
accept_self_signed: false,
allow_insecure: true,
follow_redirects: true,
min_failure_duration: 10,
min_location_failed: 1,
monitor_name: "Test-TestSyntheticsAPITestLifecycle-1623076664",
monitor_priority: 5,
_retry: DatadogAPIClient::V1::SyntheticsTestOptionsRetry.new({
count: 3,
interval: 10,
}),
tick_every: 60,
}),
status: DatadogAPIClient::V1::SyntheticsTestPauseStatus::LIVE,
subtype: DatadogAPIClient::V1::SyntheticsTestDetailsSubType::HTTP,
tags: [
"testing:api",
],
type: DatadogAPIClient::V1::SyntheticsAPITestType::API,
})
p api_instance.update_api_test(SYNTHETICS_API_TEST_PUBLIC_ID, body)
Instructions
First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"// Edit an API test returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_synthetics::SyntheticsAPI;
use datadog_api_client::datadogV1::model::SyntheticsAPITest;
use datadog_api_client::datadogV1::model::SyntheticsAPITestConfig;
use datadog_api_client::datadogV1::model::SyntheticsAPITestType;
use datadog_api_client::datadogV1::model::SyntheticsAssertion;
use datadog_api_client::datadogV1::model::SyntheticsAssertionJSONPathOperator;
use datadog_api_client::datadogV1::model::SyntheticsAssertionJSONPathTarget;
use datadog_api_client::datadogV1::model::SyntheticsAssertionJSONPathTargetTarget;
use datadog_api_client::datadogV1::model::SyntheticsAssertionJSONSchemaMetaSchema;
use datadog_api_client::datadogV1::model::SyntheticsAssertionJSONSchemaOperator;
use datadog_api_client::datadogV1::model::SyntheticsAssertionJSONSchemaTarget;
use datadog_api_client::datadogV1::model::SyntheticsAssertionJSONSchemaTargetTarget;
use datadog_api_client::datadogV1::model::SyntheticsAssertionOperator;
use datadog_api_client::datadogV1::model::SyntheticsAssertionTarget;
use datadog_api_client::datadogV1::model::SyntheticsAssertionTargetValue;
use datadog_api_client::datadogV1::model::SyntheticsAssertionType;
use datadog_api_client::datadogV1::model::SyntheticsConfigVariable;
use datadog_api_client::datadogV1::model::SyntheticsConfigVariableType;
use datadog_api_client::datadogV1::model::SyntheticsTestDetailsSubType;
use datadog_api_client::datadogV1::model::SyntheticsTestOptions;
use datadog_api_client::datadogV1::model::SyntheticsTestOptionsRetry;
use datadog_api_client::datadogV1::model::SyntheticsTestPauseStatus;
use datadog_api_client::datadogV1::model::SyntheticsTestRequest;
use datadog_api_client::datadogV1::model::SyntheticsTestRequestCertificate;
use datadog_api_client::datadogV1::model::SyntheticsTestRequestCertificateItem;
use std::collections::BTreeMap;
#[tokio::main]
async fn main() {
// there is a valid "synthetics_api_test" in the system
let synthetics_api_test_public_id = std::env::var("SYNTHETICS_API_TEST_PUBLIC_ID").unwrap();
let body =
SyntheticsAPITest::new(
SyntheticsAPITestConfig::new()
.assertions(
vec![
SyntheticsAssertion::SyntheticsAssertionTarget(
Box::new(
SyntheticsAssertionTarget::new(
SyntheticsAssertionOperator::IS,
SyntheticsAssertionTargetValue::SyntheticsAssertionTargetValueString(
"text/html".to_string(),
),
SyntheticsAssertionType::HEADER,
).property("{{ PROPERTY }}".to_string()),
),
),
SyntheticsAssertion::SyntheticsAssertionTarget(
Box::new(
SyntheticsAssertionTarget::new(
SyntheticsAssertionOperator::LESS_THAN,
SyntheticsAssertionTargetValue::SyntheticsAssertionTargetValueNumber(
2000.0 as f64,
),
SyntheticsAssertionType::RESPONSE_TIME,
),
),
),
SyntheticsAssertion::SyntheticsAssertionJSONPathTarget(
Box::new(
SyntheticsAssertionJSONPathTarget::new(
SyntheticsAssertionJSONPathOperator::VALIDATES_JSON_PATH,
SyntheticsAssertionType::BODY,
).target(
SyntheticsAssertionJSONPathTargetTarget::new()
.json_path("topKey".to_string())
.operator("isNot".to_string())
.target_value(
SyntheticsAssertionTargetValue::SyntheticsAssertionTargetValueString(
"0".to_string(),
),
),
),
),
),
SyntheticsAssertion::SyntheticsAssertionJSONSchemaTarget(
Box::new(
SyntheticsAssertionJSONSchemaTarget::new(
SyntheticsAssertionJSONSchemaOperator::VALIDATES_JSON_SCHEMA,
SyntheticsAssertionType::BODY,
).target(
SyntheticsAssertionJSONSchemaTargetTarget::new()
.json_schema(
r#"{"type": "object", "properties":{"slideshow":{"type":"object"}}}"#.to_string(),
)
.meta_schema(SyntheticsAssertionJSONSchemaMetaSchema::DRAFT_07),
),
),
)
],
)
.config_variables(
vec![
SyntheticsConfigVariable::new("PROPERTY".to_string(), SyntheticsConfigVariableType::TEXT)
.example("content-type".to_string())
.pattern("content-type".to_string())
],
)
.request(
SyntheticsTestRequest::new()
.certificate(
SyntheticsTestRequestCertificate::new()
.cert(
SyntheticsTestRequestCertificateItem::new()
.filename("cert-filename".to_string())
.updated_at("2020-10-16T09:23:24.857Z".to_string()),
)
.key(
SyntheticsTestRequestCertificateItem::new()
.filename("key-filename".to_string())
.updated_at("2020-10-16T09:23:24.857Z".to_string()),
),
)
.headers(BTreeMap::from([("unique".to_string(), "examplesynthetic".to_string())]))
.method("GET".to_string())
.timeout(10.0 as f64)
.url("https://datadoghq.com".to_string()),
),
vec!["aws:us-east-2".to_string()],
"BDD test payload: synthetics_api_test_payload.json".to_string(),
"Example-Synthetic-updated".to_string(),
SyntheticsTestOptions::new()
.accept_self_signed(false)
.allow_insecure(true)
.follow_redirects(true)
.min_failure_duration(10)
.min_location_failed(1)
.monitor_name("Test-TestSyntheticsAPITestLifecycle-1623076664".to_string())
.monitor_priority(5)
.retry(SyntheticsTestOptionsRetry::new().count(3).interval(10.0 as f64))
.tick_every(60),
SyntheticsAPITestType::API,
)
.status(SyntheticsTestPauseStatus::LIVE)
.subtype(SyntheticsTestDetailsSubType::HTTP)
.tags(vec!["testing:api".to_string()]);
let configuration = datadog::Configuration::new();
let api = SyntheticsAPI::with_config(configuration);
let resp = api
.update_api_test(synthetics_api_test_public_id.clone(), body)
.await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
Instructions
First install the library and its dependencies and then save the example to src/main.rs and run following commands:
DD_SITE="datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us3.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us5.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="datadoghq.eu" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap2.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="uk1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run/**
* Edit an API test returns "OK" response
*/
import { client, v1 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration({
authMethods: {
AuthZ: {
accessToken: process.env.DD_BEARER_TOKEN as string,
},
},
});
const apiInstance = new v1.SyntheticsApi(configuration);
// there is a valid "synthetics_api_test" in the system
const SYNTHETICS_API_TEST_PUBLIC_ID = process.env
.SYNTHETICS_API_TEST_PUBLIC_ID as string;
const params: v1.SyntheticsApiUpdateAPITestRequest = {
body: {
config: {
assertions: [
{
operator: "is",
property: "{{ PROPERTY }}",
target: "text/html",
type: "header",
},
{
operator: "lessThan",
target: 2000,
type: "responseTime",
},
{
operator: "validatesJSONPath",
target: {
jsonPath: "topKey",
operator: "isNot",
targetValue: "0",
},
type: "body",
},
{
operator: "validatesJSONSchema",
target: {
metaSchema: "draft-07",
jsonSchema: `{"type": "object", "properties":{"slideshow":{"type":"object"}}}`,
},
type: "body",
},
],
configVariables: [
{
example: "content-type",
name: "PROPERTY",
pattern: "content-type",
type: "text",
},
],
request: {
certificate: {
cert: {
filename: "cert-filename",
updatedAt: "2020-10-16T09:23:24.857Z",
},
key: {
filename: "key-filename",
updatedAt: "2020-10-16T09:23:24.857Z",
},
},
headers: {
unique: "examplesynthetic",
},
method: "GET",
timeout: 10,
url: "https://datadoghq.com",
},
},
locations: ["aws:us-east-2"],
message: "BDD test payload: synthetics_api_test_payload.json",
name: "Example-Synthetic-updated",
options: {
acceptSelfSigned: false,
allowInsecure: true,
followRedirects: true,
minFailureDuration: 10,
minLocationFailed: 1,
monitorName: "Test-TestSyntheticsAPITestLifecycle-1623076664",
monitorPriority: 5,
retry: {
count: 3,
interval: 10,
},
tickEvery: 60,
},
status: "live",
subtype: "http",
tags: ["testing:api"],
type: "api",
},
publicId: SYNTHETICS_API_TEST_PUBLIC_ID,
};
apiInstance
.updateAPITest(params)
.then((data: v1.SyntheticsAPITest) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
Instructions
First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"