Class SyntheticsTestRequest

Object describing the Synthetic test request.

Hierarchy

  • SyntheticsTestRequest

Constructors

constructor

Properties

additionalProperties? allowInsecure? basicAuth? body? bodyType? callType? certificate? certificateDomains? checkCertificateRevocation? compressedJsonDescriptor? compressedProtoFile? disableAiaIntermediateFetching? dnsServer? dnsServerPort? files? followRedirects? form? headers? host? httpVersion? isMessageBase64Encoded? message? metadata? method? noSavingResponseBody? numberOfPackets? persistCookies? port? proxy? query? servername? service? shouldTrackHops? timeout? url?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional allowInsecure

allowInsecure?: boolean

Allows loading insecure content for an HTTP request in a multistep test step.

Optional basicAuth

basicAuth?: SyntheticsBasicAuth

Object to handle basic authentication when performing the test.

Optional body

body?: string

Body to include in the test.

Optional bodyType

bodyType?: SyntheticsTestRequestBodyType

Type of the request body.

Optional callType

callType?: SyntheticsTestCallType

The type of gRPC call to perform.

Optional certificate

certificate?: SyntheticsTestRequestCertificate

Client certificate to use when performing the test request.

Optional certificateDomains

certificateDomains?: string[]

By 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 checkCertificateRevocation

checkCertificateRevocation?: boolean

Check for certificate revocation.

Optional compressedJsonDescriptor

compressedJsonDescriptor?: string

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

Optional compressedProtoFile

compressedProtoFile?: string

A protobuf file that needs to be gzipped first then base64 encoded.

Optional disableAiaIntermediateFetching

disableAiaIntermediateFetching?: boolean

Disable fetching intermediate certificates from AIA.

Optional dnsServer

dnsServer?: string

DNS server to use for DNS tests.

Optional dnsServerPort

dnsServerPort?: SyntheticsTestRequestDNSServerPort

DNS server port to use for DNS tests.

Optional files

files?: SyntheticsTestRequestBodyFile[]

Files to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.

Optional followRedirects

followRedirects?: boolean

Specifies whether or not the request follows redirects.

Optional form

form?: {
    [key: string]: string;
}

Form to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.

Type declaration

  • [key: string]: string

Optional headers

headers?: {
    [key: string]: string;
}

Headers to include when performing the test.

Type declaration

  • [key: string]: string

Optional host

host?: string

Host name to perform the test with.

Optional httpVersion

httpVersion?: SyntheticsTestOptionsHTTPVersion

HTTP version to use for a Synthetic test.

Optional isMessageBase64Encoded

isMessageBase64Encoded?: boolean

Whether the message is base64 encoded.

Optional message

message?: string

Message to send for UDP or WebSocket tests.

Optional metadata

metadata?: {
    [key: string]: string;
}

Metadata to include when performing the gRPC test.

Type declaration

  • [key: string]: string

Optional method

method?: string

Either 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 noSavingResponseBody

noSavingResponseBody?: boolean

Determines whether or not to save the response body.

Optional numberOfPackets

numberOfPackets?: number

Number of pings to use per test.

Optional persistCookies

persistCookies?: boolean

Persist cookies across redirects.

Optional port

port?: SyntheticsTestRequestPort

Port to use when performing the test.

Optional proxy

proxy?: SyntheticsTestRequestProxy

The proxy to perform the test.

Optional query

query?: any

Query to use for the test.

Optional servername

servername?: string

For 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 service

service?: string

The gRPC service on which you want to perform the gRPC call.

Optional shouldTrackHops

shouldTrackHops?: boolean

Turns on a traceroute probe to discover all gateways along the path to the host destination.

Optional timeout

timeout?: number

Timeout in seconds for the test.

Optional url

url?: string

URL to perform the test with.

Settings

Member Visibility

Theme

Generated using TypeDoc