RIPE Atlas Documentation

GET /ambassadors/probes/{id}/ ​

Retrieve or update a probe that the user is an ambassador of. Retrieval takes ambassadors.get_ambassador_probe_info; updating takes ambassadors.change_ambassador_probe. The two grants are independent, so a read-only key stays read-only. state is restricted on writes, for session and key alike — see AmbassadorProbeWriteSerializer. Every other field is as writable by a key as it is from the UI, including email, which triggers the host's initial email. PATCH is the verb to use: comment and state are both required, so a PUT missing either is a 400.

GET /ambassadors/probes/{id}/ — id ​

The unique ambassadorship ID. This identifies the record linking an ambassador to a probe they handed out -- it is not the probe ID.

GET /ambassadors/probes/{id}/ — include ​

Include additional fields named in comma-separated values in response as nested JSON objects.

GET /api/v2/ambassadors/probes/{id}/​

Retrieve or update a probe that the user is an ambassador of.

Retrieval takes ambassadors.get_ambassador_probe_info; updating takes ambassadors.change_ambassador_probe. The two grants are independent, so a read-only key stays read-only.

state is restricted on writes, for session and key alike — see AmbassadorProbeWriteSerializer. Every other field is as writable by a key as it is from the UI, including email, which triggers the host's initial email. PATCH is the verb to use: comment and state are both required, so a PUT missing either is a 400.

Try it out

Playground​

Authorization
Variables
Key
Value
Authorizations

Authorizations​

api-key
Type
API Key (header: Authorization)
or
session
Type
API Key (cookie: atlasess)
Parameters

Path Parameters

id*

The unique ambassadorship ID. This identifies the record linking an ambassador to a probe they handed out -- it is not the probe ID.

Type
integer
Required

Query Parameters

include

Include additional fields named in comma-separated values in response as nested JSON objects.

Type
string
Valid values
"probe"
Responses

Responses​

application/json
object

Serializer for AmbassadorProbe model.

Max Length64

The unique identifier of this probe.

Maximum2147483647
Minimum-2147483648
Max Length100
Max Length240
Format"email"
Max Length128
Max Length240
Format"date"
Format"date"
Format"date"
Format"date"
Format"date"
Format"date"
Format"date-time"
  • 0 - Reset
  • 1 - Given to ambassador
  • 2 - Handed out
  • 3 - Applied
  • 5 - Hosted
  • 4 - Online, not hosted
  • 6 - Written off
  • 10 - Returned
  • 7 - Refurbished
  • 8 - Lost in transit
  • 9 - Broken
Valid values012354610789
Minimum-2147483648
Maximum2147483647
Samples