Class SyntheticsCITest

Configuration for Continuous Testing.

Hierarchy

  • SyntheticsCITest

Constructors

constructor

Properties

additionalProperties? allowInsecureCertificates? basicAuth? body? bodyType? cookies? deviceIds? followRedirects? headers? locations? metadata? publicId retry? startUrl? variables? version?

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 allowInsecureCertificates

allowInsecureCertificates?: boolean

Disable certificate checks in API tests.

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?: string

Type of the data sent in a Synthetic API test.

Optional cookies

cookies?: string

Cookies for the request.

Optional deviceIds

deviceIds?: string[]

For browser test, array with the different device IDs used to run the test.

Optional followRedirects

followRedirects?: boolean

For API HTTP test, whether or not the test should follow redirects.

Optional headers

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

Headers to include when performing the test.

Type declaration

  • [key: string]: string

Optional locations

locations?: string[]

Array of locations used to run the test.

Optional metadata

metadata?: SyntheticsCIBatchMetadata

Metadata for the Synthetic tests run.

publicId

publicId: string

The public ID of the Synthetic test to trigger.

Optional retry

retry?: SyntheticsTestOptionsRetry

Object describing the retry strategy to apply to a Synthetic test.

Optional startUrl

startUrl?: string

Starting URL for the browser test.

Optional variables

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

Variables to replace in the test.

Type declaration

  • [key: string]: string

Optional version

version?: number

The version number of the Synthetic test version to trigger.

Settings

Member Visibility

Theme

Generated using TypeDoc