Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14125953.1 KB

Updates a monitor probe. This action requires both the monitorName and probeId parameters. Run ListMonitors to get a list of monitor names. Run GetMonitor to get a list of probes and probe IDs.

You can update the following para create a monitor with probes using this command. For each probe, you define the following:

  • state—The state of the probe.

  • destination— The target destination IP address for the probe.

  • destinationPort—Required only if the protocol is TCP.

  • protocol—The communication protocol between the source and destination. This will be either TCP or ICMP.

  • packetSize—The size of the packets. This must be a number between 56 and 8500.

  • (Optional) tags —Key-value pairs created and assigned to the probe.

patch/monitors/{monitorName}/probes/{probeId}

Path parameters

monitorNamestring required

The name of the monitor that the probe was updated for.

probeIdstring required

The ID of the probe to update.

Request body

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

The state of the probe update.

destinationstring

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

destinationPortinteger

The updated port for the probe destination. 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'

The updated network protocol for the destination. This can be either <code>TCP</code> or <code>ICMP</code>. If the protocol is <code>TCP</code>, then <code>port</code> is also required.

packetSizeinteger

he updated packets size for network traffic between the source and destination. This must be a number between <code>56</code> and <code>8500</code>.

Response

Success

probeIdstring

The updated ID of the probe.

probeArnstring

The updated ARN of the probe.

sourceArnstring required

The updated ARN of the source subnet.

destinationstring required

The updated destination IP address for the probe.

destinationPortinteger

The updated destination port. This must be a number between <code>1</code> and <code>65536</code>.

protocol'TCP' | 'ICMP' required

The updated protocol for the probe.

packetSizeinteger

The updated packet size for the probe.

addressFamily'IPV4' | 'IPV6'

The updated IP address family. This must be either <code>IPV4</code> or <code>IPV6</code>.

vpcIdstring

The updated ID of the source VPC subnet ID.

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

The state of the updated probe.

createdAtstring date-time

The time and date that the probe was created.

modifiedAtstring date-time

The time and date that the probe was last updated.

tagsobject

Update tags for a probe.