Authorizations
api-key
Type
API Key (header: Authorization)
or
ripe-access
Type
API Key (cookie: crowd.token_key)
PATCH /probes/{probe_id}/private/
Update one or more fields of one of the authenticated user's probes.
PATCH /probes/{probe_id}/private/ — probe_id
The unique probe ID.
PATCH /api/v2/probes/{probe_id}/private/
Update one or more fields of one of the authenticated user's probes.
Try it out
Playground
Authorization
Variables
Key
Value
Body
Authorizations
Parameters
Path Parameters
probe_id*
The unique probe ID.
Type
Requiredinteger
Request Body
Request Body
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.
Responses
Responses
application/json
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.
MAC
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.