Object describing the Synthetic test request.

Hierarchy

  • SyntheticsTestRequest

Constructors

Properties

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
allowInsecure?: boolean

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

Object to handle basic authentication when performing the test.

body?: string

Body to include in the test.

Type of the request body.

The type of gRPC call to perform.

Client certificate to use when performing the test request.

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.

compressedJsonDescriptor?: string

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

compressedProtoFile?: string

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

dnsServer?: string

DNS server to use for DNS tests.

dnsServerPort?: string

DNS server port to use for DNS tests.

Files to be used as part of the request in the test.

followRedirects?: boolean

Specifies whether or not the request follows redirects.

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

Headers to include when performing the test.

Type declaration

  • [key: string]: string
host?: string

Host name to perform the test with.

HTTP version to use for a Synthetic test.

message?: string

Message to send for UDP or WebSocket tests.

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

Metadata to include when performing the gRPC test.

Type declaration

  • [key: string]: string
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.

noSavingResponseBody?: boolean

Determines whether or not to save the response body.

numberOfPackets?: number

Number of pings to use per test.

persistCookies?: boolean

Persist cookies across redirects.

Port to use when performing the test.

The proxy to perform the test.

query?: any

Query to use for the test.

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.

service?: string

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

shouldTrackHops?: boolean

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

timeout?: number

Timeout in seconds for the test.

url?: string

URL to perform the test with.

Generated using TypeDoc