Class SyntheticsAPITest

Object containing details about a Synthetic API test.

Hierarchy

  • SyntheticsAPITest

Constructors

constructor

Properties

additionalProperties? config locations message monitorId? name options publicId? status? subtype? tags? type

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

config

config: SyntheticsAPITestConfig

Configuration object for a Synthetic API test.

locations

locations: string[]

Array of locations used to run the test.

message

message: string

Notification message associated with the test.

Optional monitorId

monitorId?: number

The associated monitor ID.

name

name: string

Name of the test.

options

options: SyntheticsTestOptions

Object describing the extra options for a Synthetic test.

Optional publicId

publicId?: string

The public ID for the test.

Optional status

status?: SyntheticsTestPauseStatus

Define whether you want to start (live) or pause (paused) a Synthetic test.

Optional subtype

subtype?: SyntheticsTestDetailsSubType

The subtype of the Synthetic API test, http, ssl, tcp, dns, icmp, udp, websocket, grpc or multi.

Optional tags

tags?: string[]

Array of tags attached to the test.

type

type: SyntheticsAPITestType

Type of the Synthetic test, api.

Settings

Member Visibility

Theme

Generated using TypeDoc