RIPE Atlas Documentation

POST /measurements/{measurement_id}/participation-requests/ ​

Make a request to change probes in a measurement.

POST /measurements/{measurement_id}/participation-requests/ — measurement_id ​

The unique measurement ID.

POST /api/v2/measurements/{measurement_id}/participation-requests/​

Make a request to change probes in a measurement.

Try it out

Playground​

Authorization
Variables
Key
Value
Body
Authorizations

Authorizations​

api-key
Type
API Key (header: Authorization)
or
ripe-access
Type
API Key (cookie: crowd.token_key)
Parameters

Path Parameters

measurement_id*

The unique measurement ID.

Type
integer
Required
Request Body

Request Body​

object

Used directly by the participation-requests endpoint.

Number of probes that have to be added or removed

Probe selector type.

  • area - Compass quarter of the world
  • country - ISO 3166-1 alpha-2 country code
  • probes - Comma-separated list of probe IDs
  • asn - Autonomous System Number
  • prefix - IPv4 or IPv6 Prefix
  • msm - Existing measurement ID
  • region - Pre-defined region name
  • countries - Comma-separated list of ISO 3166-1 alpha-2 country codes
Valid values"area""country""probes""asn""prefix""msm""region""countries"

Value for given selector type. area: 'WW', 'West', 'North-Central', 'South-Central', 'North-East', 'South-East'. asn: ASN (integer). country: two-letter country code according to ISO 3166-1 alpha-2, e.g. GR. msm: measurement ID (integer). prefix: prefix in CIDR notation, e.g. 193.0.0/16. probes: comma-separated list of probe IDs

Action to be applied, or that was applied to the measurement involved.'add': add probe to the measurement, 'remove': remove probe from the measurement

  • add - Add probes
  • remove - Remove probes
Valid values"add""remove"

Comma-separated list of probe tags. Only probes with all these tags attached will be selected from this participation request

Format"comma-separated tag list"

Comma-separated list of probe tags. Probes with any of these tags attached will be excluded from this participation request

Format"comma-separated tag list"

Additional information

Responses

Responses​

application/json
object

Used directly by the participation-requests endpoint.

Number of probes that have to be added or removed

Probe selector type.

  • area - Compass quarter of the world
  • country - ISO 3166-1 alpha-2 country code
  • probes - Comma-separated list of probe IDs
  • asn - Autonomous System Number
  • prefix - IPv4 or IPv6 Prefix
  • msm - Existing measurement ID
  • region - Pre-defined region name
  • countries - Comma-separated list of ISO 3166-1 alpha-2 country codes
Valid values"area""country""probes""asn""prefix""msm""region""countries"

Value for given selector type. area: 'WW', 'West', 'North-Central', 'South-Central', 'North-East', 'South-East'. asn: ASN (integer). country: two-letter country code according to ISO 3166-1 alpha-2, e.g. GR. msm: measurement ID (integer). prefix: prefix in CIDR notation, e.g. 193.0.0/16. probes: comma-separated list of probe IDs

Action to be applied, or that was applied to the measurement involved.'add': add probe to the measurement, 'remove': remove probe from the measurement

  • add - Add probes
  • remove - Remove probes
Valid values"add""remove"

Comma-separated list of probe tags. Only probes with all these tags attached will be selected from this participation request

Format"comma-separated tag list"

Comma-separated list of probe tags. Probes with any of these tags attached will be excluded from this participation request

Format"comma-separated tag list"

Additional information

The unique ID for this participation request

The creation date and time of the participations request (Defaults to unix timestamp format)

Format"date-time"

The (direct) URL of this participations request

Format"uri"
Samples