PATCH /probes/{prb}/private/

Update one or more fields of one of the authenticated user's probes.

PATCH /probes/{prb}/private/ — fields

Comma-separated list of fields to include in response, in addition to 'type' and 'id' which are always present. Optional fields can be listed here also.

PATCH /probes/{prb}/private/ — prb

The unique probe ID.

PATCH /api/v2/probes/{prb}/private/

Update one or more fields of one of the authenticated user's probes.

Try it out

Playground

Authorization

api-key

Variables

Key

Value

prb*

fields

Body

Authorizations

Authorizations

api-key

Type

API Key (header: Authorization)

or

session

Type

API Key (cookie: atlasess)

Parameters

Path Parameters

prb*

The unique probe ID.

Type

integer

Required

Query Parameters

fields

Comma-separated list of fields to include in response, in addition to 'type' and 'id' which are always present. Optional fields can be listed here also.

Type

string

Request Body

Request Body

object

User defined description of the probe

If a probe is not public then certain details, including exact IP addresses, are not returned.

Optional. If specified, it may be used to correlate probe behaviour to similarities accross router models.

Generate DNS record

The total bandwidth, in Kbit/s, that you allow your probe to consume. Must be a value greater or equal to 10. Leaving it blank (the default) effectively means 'unlimited', but rarely exceeds 12Kbit/s. For software probes this is only effective if you also enable bandwith use reporting in your configuration.