Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14125953.1 KB

Create a probe within a monitor. Once you create a probe, and it begins monitoring your network traffic, you'll incur billing charges for that probe. This action requires the <code>monitorName</code> parameter. Run <code>ListMonitors</code> to get a list of monitor names. Note the name of the <code>monitorName</code> you want to create the probe for.

post/monitors/{monitorName}/probes

Path parameters

monitorNamestring required

The name of the monitor to associated with the probe.

Request body

clientTokenstring

Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.

tagsobject

The list of key-value pairs created and assigned to the probe.

Response

Success

probeIdstring

The ID of the probe for which details are returned.

probeArnstring

The ARN of the probe.

sourceArnstring required

The ARN of the probe.

destinationstring required

The destination IP address for the monitor. This must be either an IPv4 or IPv6 address.

destinationPortinteger

The port associated with the <code>destination</code>. This is required only if the <code>protocol</code> is <code>TCP</code> and must be a number between <code>1</code> and <code>65536</code>.

protocol'TCP' | 'ICMP' required

The protocol used for the network traffic between the <code>source</code> and <code>destination</code>. This must be either <code>TCP</code> or <code>ICMP</code>.

packetSizeinteger

The size of the packets sent between the source and destination. This must be a number between <code>56</code> and <code>8500</code>.

addressFamily'IPV4' | 'IPV6'

Indicates whether the IP address is <code>IPV4</code> or <code>IPV6</code>.

vpcIdstring

The ID of the source VPC or subnet.

state'PENDING' | 'ACTIVE' | 'INACTIVE' | 'ERROR' | 'DELETING' | 'DELETED'

The state of the probe.

createdAtstring date-time

The time and date that the probe was created.

modifiedAtstring date-time

The time and date when the probe was last modified.

tagsobject

The list of key-value pairs assigned to the probe.