Optional
additionalA container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.
Optional
allowAllows loading insecure content for an HTTP request in a multistep test step.
Optional
basicObject to handle basic authentication when performing the test.
Optional
bodyBody to include in the test.
Optional
bodyType of the request body.
Optional
callThe type of gRPC call to perform.
Optional
certificateClient certificate to use when performing the test request.
Optional
certificateBy 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
.
Optional
compressedA protobuf JSON descriptor that needs to be gzipped first then base64 encoded.
Optional
compressedA protobuf file that needs to be gzipped first then base64 encoded.
Optional
dnsDNS server to use for DNS tests.
Optional
dnsDNS server port to use for DNS tests.
Optional
filesFiles to be used as part of the request in the test.
Optional
followSpecifies whether or not the request follows redirects.
Optional
headersHeaders to include when performing the test.
Optional
hostHost name to perform the test with.
Optional
httpHTTP version to use for a Synthetic test.
Optional
messageMessage to send for UDP or WebSocket tests.
Optional
metadataMetadata to include when performing the gRPC test.
Optional
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
.
Optional
noDetermines whether or not to save the response body.
Optional
numberNumber of pings to use per test.
Optional
persistPersist cookies across redirects.
Optional
portPort to use when performing the test.
Optional
proxyThe proxy to perform the test.
Optional
queryQuery to use for the test.
Optional
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.
Optional
serviceThe gRPC service on which you want to perform the gRPC call.
Optional
shouldTurns on a traceroute probe to discover all gateways along the path to the host destination.
Optional
timeoutTimeout in seconds for the test.
Optional
urlURL to perform the test with.
Generated using TypeDoc
Object describing the Synthetic test request.