RIPE Atlas Documentation

Participation Requests ​

Participation requests let you add or remove probes from a running measurement. They have a similar structure to the probes object used in measurement creation, with an additional action field (add or remove).

Getting Participation Request Info ​

Include participation requests in a measurement response:

GET /api/v2/measurements/2000000/?optional_fields=participation_requests
Try it out

Each participation request has its own ID. You can also query it directly:

GET /api/v2/participation-requests/2340391/
Try it out

Creating a Participation Request ​

Add probes to a running measurement by POSTing to its participation-requests endpoint:

shell
curl \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -H "Authorization: Key YOUR-KEY" \
    -X POST \
    -d '[{"action": "add", "requested": 1, "type": "countries", "value": "NL"}]' \
    https://atlas.ripe.net/api/v2/measurements/10000076/participation-requests/

Successful response:

json
{"request_ids": [35878]}

WARNING

The POST goes to the measurement's participation-requests sub-path: /api/v2/measurements/{id}/participation-requests/

Multiple Changes ​

Submit multiple add/remove requests in a single call:

json
[
    {"action": "add", "requested": 1, "type": "countries", "value": "CA"},
    {"action": "remove", "requested": 1, "type": "probes", "value": "4,103"}
]

Important: Removal requests only work with type: "probes". The value must be a comma-separated list of probe IDs to remove.

You can also use tags_include and tags_exclude to further filter probes. See Probe Selection for details.