# REST API Reference
API Version: v2.5.0
#anchor-measurements
GET /api/v2/anchor-measurements/{pk}/ Resource describing a measurement targeted to an anchor
Resource describing a measurement targeted to an anchor
Parameters
form parameters
path parameters
query parameters
Response
GET /api/v2/anchor-measurements/ Resource describing a list of measurements targeted to an anchor
Resource describing a list of measurements targeted to an anchor
Parameters
form parameters
query parameters
Response
#anchors
GET /api/v2/anchors/{pk}/ Resource describing a publicly available anchor
Resource describing a publicly available anchor.
Parameters
path parameters
query parameters
Response
GET /api/v2/anchors/ Resource describing the list of all announced anchors (public and disabled)
Resource describing the list of all announced anchors (public and disabled).
Parameters
query parameters
Response
#credits
GET /api/v2/credits/ Get high-level information about credits
Get high-level information about credits.
Response
GET /api/v2/credits/income-items/ Get sources of ongoing income
Get sources of ongoing income.
Response
GET /api/v2/credits/expense-items/ Get sources of ongoing expenditure
Get sources of ongoing expenditure.
Response
POST /api/v2/credits/transfers/ Transfer credits to another user
Transfer credits to another user.
Parameters
form parameters
Response
GET /api/v2/credits/voucher/{code}
Parameters
path parameters
Response
POST /api/v2/credits/voucher/redeem/
Parameters
form parameters
Response
GET /api/v2/credits/standing-order/
Response
POST /api/v2/credits/standing-order/
Parameters
form parameters
Response
GET /api/v2/credits/standing-order/{pk}/
Parameters
path parameters
Response
PATCH /api/v2/credits/standing-order/{pk}/
Parameters
form parameters
path parameters
Response
DELETE /api/v2/credits/standing-order/{pk}/
Parameters
path parameters
Response
GET /api/v2/credits/bill-me/
Response
POST /api/v2/credits/bill-me/
Parameters
form parameters
Response
GET /api/v2/credits/bill-me/{pk}/
Parameters
path parameters
Response
PATCH /api/v2/credits/bill-me/{pk}/
Parameters
form parameters
path parameters
Response
DELETE /api/v2/credits/bill-me/{pk}/
Parameters
path parameters
Response
GET /api/v2/credits/transactions/ Get a historic income or expense transaction
Get a historic income or expense transaction
Parameters
query parameters
Response
GET /api/v2/credits/members/ Show eligibility for claiming bonus credits for associated RIPE NCC
Show eligibility for claiming bonus credits for associated RIPE NCC members.
Response
POST /api/v2/credits/members/claim/ Claim bonus credits on behalf of a RIPE NCC member
Claim bonus credits on behalf of a RIPE NCC member.
Parameters
form parameters
Response
#keys
GET /api/v2/keys/permissions/ Get a list of permissions that may be granted to API keys
Get a list of permissions that may be granted to API keys
Response
GET /api/v2/keys/permissions/{permission}/targets/ Get a list of targets for which permissions may be granted
Get a list of targets for which permissions may be granted
Parameters
path parameters
Response
GET /api/v2/keys/{api_key_prefix:uuid}/ Get a single API key
Get a single API key.
Parameters
path parameters
Response
PUT /api/v2/keys/{api_key_prefix:uuid}/ Redefine an API key, preserving the same UUID
Redefine an API key, preserving the same UUID.
Parameters
form parameters
path parameters
Response
DELETE /api/v2/keys/{api_key_prefix:uuid}/
Parameters
path parameters
Response
PATCH /api/v2/keys/{api_key_prefix:uuid}/ Update specific fields for an API key, optionally regenerating the UUID
Update specific fields for an API key, optionally regenerating the UUID.
Parameters
form parameters
path parameters
Response
GET /api/v2/keys/ Get a list of your API keys, with optional filtering and sorting
Get a list of your API keys, with optional filtering and sorting.
Response
POST /api/v2/keys/ Create a new API key
Create a new API key.
Parameters
body parameters
form parameters
Response
#measurements
GET /api/v2/measurements/ Show measurements of all types
Show measurements of all types.
This resource holds a list of measurements of all different measurement types (dns, http, etc.).
It allows for sorting and filtering based on properties of the measurements.
Note that the returned list is polymorphic, so that the fields returned will differ per measurement type. The fields are divided between [core] fields, and those that belong to particular types.
Parameters
query parameters
Response
POST /api/v2/measurements/ Create one or more measurements of any available type
Create one or more measurements of any available type.
See the Measurements section of the REST API Manual for detailed instructions on creating measurements.
Full descriptions of available measurement options are available in the reference for the GET /api/v2/measurements/ endpoint.
Parameters
body parameters
form parameters
Response
GET /api/v2/measurements/{pk}/ Show one measurement specified by ID
Show one measurement specified by ID
Parameters
path parameters
Response
PATCH /api/v2/measurements/{pk}/ Update an existing measurement
Update an existing measurement.
Parameters
form parameters
path parameters
Response
DELETE /api/v2/measurements/{pk}/ Stop a running measurement
Stop a running measurement.
Sending a DELETE http verb to the API will stop the measurement.
You can only stop measurements that belong to the current logged in user, or by passing in a key
query parameter with a key that has permissions to stop a measurement.
Parameters
path parameters
Response
GET /api/v2/measurements/{pk}/results/ Get results of a measurement
Get results of a measurement.
For details of the result structure, see the raw data structure documentation .
Parameters
path parameters
query parameters
Response
GET /api/v2/measurements/{pk}/latest/ Get the most recent results from one or more measurements
Get the most recent results from one or more measurements.
For details of the structure of individual results, see the raw data structure documentation .
Parameters
path parameters
query parameters
Response
GET /api/v2/measurements/my/ Show measurements to the authenticated user
Show measurements to the authenticated user
This resource can be reached if a user is logged in, or if a key
query parameter was passed
with sufficient permissions.
Parameters
query parameters
Response
POST /api/v2/measurements/my/ [DEPRECATED] measurement creation URL
[DEPRECATED] measurement creation URL
The POST method of this endpoint should no longer be used, and will be removed in the future.
A POST request to /api/v2/measurements/ works in exactly the same way, and should be used instead.
Parameters
form parameters
query parameters
Response
GET /api/v2/measurements/ping/ Retrieve a list of ping measurements
Retrieve a list of ping measurements
Parameters
query parameters
Response
POST /api/v2/measurements/ping/ [DEPRECATED] measurement creation URL
[DEPRECATED] measurement creation URL
The POST method of this endpoint should no longer be used, and will be removed in the future.
A POST request to /api/v2/measurements/ works in exactly the same way, and should be used instead.
Parameters
form parameters
query parameters
Response
GET /api/v2/measurements/traceroute/ Retrieve a list of traceroute measurements
Retrieve a list of traceroute measurements
Parameters
query parameters
Response
POST /api/v2/measurements/traceroute/ [DEPRECATED] measurement creation URL
[DEPRECATED] measurement creation URL
The POST method of this endpoint should no longer be used, and will be removed in the future.
A POST request to /api/v2/measurements/ works in exactly the same way, and should be used instead.
Parameters
form parameters
query parameters
Response
GET /api/v2/measurements/sslcert/ Retrieve a list of SSL certificate measurements
Retrieve a list of SSL certificate measurements
Parameters
query parameters
Response
POST /api/v2/measurements/sslcert/ [DEPRECATED] measurement creation URL
[DEPRECATED] measurement creation URL
The POST method of this endpoint should no longer be used, and will be removed in the future.
A POST request to /api/v2/measurements/ works in exactly the same way, and should be used instead.
Parameters
form parameters
query parameters
Response
GET /api/v2/measurements/ntp/ Retrieve a list of NTP measurements
Retrieve a list of NTP measurements
Parameters
query parameters
Response
POST /api/v2/measurements/ntp/ [DEPRECATED] measurement creation URL
[DEPRECATED] measurement creation URL
The POST method of this endpoint should no longer be used, and will be removed in the future.
A POST request to /api/v2/measurements/ works in exactly the same way, and should be used instead.
Parameters
form parameters
query parameters
Response
GET /api/v2/measurements/wifi/ Retrieve a list of WiFi measurements
Retrieve a list of WiFi measurements.
Parameters
query parameters
Response
POST /api/v2/measurements/wifi/ [DEPRECATED] measurement creation URL
[DEPRECATED] measurement creation URL
The POST method of this endpoint should no longer be used, and will be removed in the future.
A POST request to /api/v2/measurements/ works in exactly the same way, and should be used instead.
Parameters
form parameters
query parameters
Response
GET /api/v2/measurements/http/ Retrieve a list of HTTP measurements
Retrieve a list of HTTP measurements
Parameters
query parameters
Response
POST /api/v2/measurements/http/ [DEPRECATED] measurement creation URL
[DEPRECATED] measurement creation URL
The POST method of this endpoint should no longer be used, and will be removed in the future.
A POST request to /api/v2/measurements/ works in exactly the same way, and should be used instead.
Parameters
form parameters
query parameters
Response
GET /api/v2/measurements/dns/ Retrieve a list of DNS measurements
Retrieve a list of DNS measurements
Parameters
query parameters
Response
POST /api/v2/measurements/dns/ [DEPRECATED] measurement creation URL
[DEPRECATED] measurement creation URL
The POST method of this endpoint should no longer be used, and will be removed in the future.
A POST request to /api/v2/measurements/ works in exactly the same way, and should be used instead.
Parameters
form parameters
query parameters
Response
GET /api/v2/measurements/groups/ Show measurement groups with their group members
Show measurement groups with their group members
This resource holds a list of measurement groups. Measurements are grouped when they are created in one API or UI request.
Parameters
query parameters
Response
GET /api/v2/measurements/groups/{pk}/ Show one measurement group specified by ID
Show one measurement group specified by ID.
Parameters
path parameters
query parameters
Response
DELETE /api/v2/measurements/groups/{pk}/ Stop all running measurements belonging to a group
Show one measurement group specified by ID.
Stop all running measurements belonging to a group.
Sending a DELETE http verb to the API will stop the measurements of htis group.
You can only stop measurements that belong to the current logged in user, or by passing in a key
query parameter with a key that has permissions to stop a measurement.
Parameters
path parameters
query parameters
Response
GET /api/v2/measurements/tags/ List all RIPE Atlas measurement tags
List all RIPE Atlas measurement tags
Parameters
query parameters
Response
GET /api/v2/measurements/tags/{tag}/results/ Resource describing the result set of a measurement tag
Resource describing the result set of a measurement tag.
For details of the result structure, see the raw data structure documentation .
Parameters
path parameters
query parameters
Response
GET /api/v2/measurements/my-tags/ List all of your own measurement tags, including private labels
List all of your own measurement tags, including private labels.
Parameters
query parameters
Response
GET /api/v2/measurements/my-tags/{tag}/ Get details of one of your own measurement tags, including private labels
Get details of one of your own measurement tags, including private labels.
Parameters
path parameters
query parameters
Response
POST /api/v2/measurements/my-tags/{tag}/stop/ Create a stop request for all measurements with a particular tag
Create a stop request for all measurements with a particular tag.
Parameters
path parameters
query parameters
Response
GET /api/v2/measurements/{pk}/tags/ List tags that are assigned to one of your measurements
List tags that are assigned to one of your measurements.
Parameters
path parameters
query parameters
Response
POST /api/v2/measurements/{pk}/tags/ Assign a tag to one of your measurements
Assign a tag to one of your measurements.
Parameters
form parameters
path parameters
query parameters
Response
GET /api/v2/measurements/{pk}/tags/{tag}/ Get details on a tag that is assigned to one of your measurements
Get details on a tag that is assigned to one of your measurements.
Parameters
path parameters
query parameters
Response
DELETE /api/v2/measurements/{pk}/tags/{tag}/ Remove a tag from one of your measurements
Remove a tag from one of your measurements.
Parameters
path parameters
query parameters
Response
GET /api/v2/measurements/{msm_id}/participation-requests/ Retrieve all participation requests for a measurement
Retrieve all participation requests for a measurement
Parameters
path parameters
query parameters
Response
POST /api/v2/measurements/{msm_id}/participation-requests/ Make a request to change probes in a measurement
Make a request to change probes in a measurement.
Parameters
form parameters
path parameters
query parameters
Response
GET /api/v2/measurements/{msm_id}/participation-requests/{source_id}/ Retrieve all participation requests for a measurement
Retrieve the details of a participation request
Retrieve all participation requests for a measurement
Parameters
path parameters
query parameters
Response
GET /api/v2/measurements/{pk}/private/ Get measurement information only available to the owner
Get measurement information only available to the owner.
Parameters
path parameters
query parameters
Response
#participation-requests
GET /api/v2/participation-requests/{source_id}/ Retrieve all participation requests for a measurement
Retrieve the details of a participation request
Retrieve all participation requests for a measurement
Parameters
path parameters
query parameters
Response
#probes
GET /api/v2/probes/ Resource containing lists of RIPE Atlas Probes
Resource containing lists of RIPE Atlas Probes.
It is possible to get basic information on probes that are not marked "public", but operational details will be obscured.
Parameters
query parameters
Response
GET /api/v2/probes/my/ List of all RIPE Atlas probes managed by the authenticated user
List of all RIPE Atlas probes managed by the authenticated user.
Parameters
query parameters
Response
GET /api/v2/probes/{pk}/ Resource describing a probe
Resource describing a probe
Parameters
path parameters
query parameters
Response
PUT /api/v2/probes/{pk}/ Resource describing a probe
Resource describing a probe
Parameters
form parameters
path parameters
Response
PATCH /api/v2/probes/{pk}/ Resource describing a probe
Resource describing a probe
Parameters
form parameters
path parameters
Response
GET /api/v2/probes/{prb_id}/measurements/ Retrieve the user-defined measurements currently running on this probe
Retrieve the user-defined measurements currently running on this probe
Parameters
path parameters
Response
GET /api/v2/probes/archive/ Resource describing historical probe status data
Resource describing historical probe status data.
Note that this resource can be queried by date as well as by probe. Also note that this resource does not paginate
Parameters
form parameters
query parameters
Response
GET /api/v2/probes/rankings/ Resource that returns a number of rankings ordered by ASN, prefix and country
Resource that returns a number of rankings ordered by ASN, prefix and country
This resource returns a JSON object with asn4
, asn6
, prefix4
, prefix6
and country
objects
that contain the number of probes in that category ordered by quantity.
Response
GET /api/v2/probes/tags/ Resource describing a list of tags used for tagging probes
Resource describing a list of tags used for tagging probes
Parameters
query parameters
Response
GET /api/v2/probes/tags/{slug}/ Resource describing a tag used for tagging probes
Resource describing a tag used for tagging probes