# 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
optional_fields (enum)
Include additional fields named in comma-separated values in response as nested JSON objects.
[date_created,date_modified]
path parameters
pk (string)
query parameters
include (enum)
include the fields as nested JSON objects.
[target,measurement]
Response
date_created (string: date-time)
date_modified (string: date-time)
id (integer: int64)
id of this target measurement
is_mesh (boolean)
measurement (string)
URL of the actual measurement
target (string)
URL of the anchor to which the measurement is targeted
type (string)
Measurement type of the involved measurement
GET /api/v2/anchor-measurements/{pk}/
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
optional_fields (enum)
Include additional fields named in comma-separated values in response.
[date_created,date_modified]
query parameters
include (enum)
include the fields as nested JSON objects.
[target,measurement]
Response
date_created (string: date-time)
date_modified (string: date-time)
id (integer: int64)
id of this target measurement
is_mesh (boolean)
measurement (string)
URL of the actual measurement
target (string)
URL of the anchor to which the measurement is targeted
type (string)
Measurement type of the involved measurement
GET /api/v2/anchor-measurements/
#anchors
GET /api/v2/anchors/{pk}/ Resource describing a publicly available anchor
Resource describing a publicly available anchor.
Parameters
path parameters
pk (string)
query parameters
include (enum)
Include the complete object for the specified field in the response.
[probe]
Response
id (integer: int64)
The id of the anchor
type (string)
The type of the object
hostname (string)
fqdn (string)
The fully qualified domain name of the anchor
probe (integer: int64)
The id of the probe that is hosted on this anchor
is_ipv4_only (boolean)
ip_v4 (string)
The IPv4 address (if any) of this anchor
as_v4 (integer: int64)
The IPv4 AS this anchor belongs to
ip_v4_gateway (string)
The IPv4 gateway address of this anchor
ip_v4_netmask (string)
The IPv4 netmask for the IP address of this anchor
ip_v6 (string)
The IPv6 address (if any) of this anchor
as_v6 (integer: int64)
The IPv6 AS this anchor belongs to
ip_v6_gateway (string)
The IPv6 gateway address of this anchor
ip_v6_prefix (integer: int64)
The IPv6 prefix of this anchor
city (string)
The city this anchor is located in
country (string)
An ISO-3166-1 alpha-2 code indicating the country that this probe is located in, as derived from the user supplied longitude and latitude
company (string)
Host company
nic_handle (string)
geometry (number: float)
A GeoJSON point object containing the location of this anchor.
The longitude and latitude are contained within the `coordinates` array
tlsa_record (string)
Installed TLSA DNS resource record on this anchor
is_disabled (boolean)
date_live (string: date-time)
date_decommissioned (string: date-time)
hardware_version (integer: int32)
[
0,
1,
2,
98,
99
]
GET /api/v2/anchors/{pk}/
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
country (string)
Return all anchors in specified country. Specified as ISO 3166-1 alpha-2 code, e.g. DE,US
as_v4 (number)
Return all anchors within the specified IPv4 AS. Specified as an integer number.
as_v6 (number)
Return all anchors within the specified IPv6 AS. Specified as an integer number.
search (string)
Search for a string within the fields `city`, `fqdn` and `company`
include (enum)
Include the complete object for the specified field in the response.
[probe]
Response
id (integer: int64)
The id of the anchor
type (string)
The type of the object
hostname (string)
fqdn (string)
The fully qualified domain name of the anchor
probe (integer: int64)
The id of the probe that is hosted on this anchor
is_ipv4_only (boolean)
ip_v4 (string)
The IPv4 address (if any) of this anchor
as_v4 (integer: int64)
The IPv4 AS this anchor belongs to
ip_v4_gateway (string)
The IPv4 gateway address of this anchor
ip_v4_netmask (string)
The IPv4 netmask for the IP address of this anchor
ip_v6 (string)
The IPv6 address (if any) of this anchor
as_v6 (integer: int64)
The IPv6 AS this anchor belongs to
ip_v6_gateway (string)
The IPv6 gateway address of this anchor
ip_v6_prefix (integer: int64)
The IPv6 prefix of this anchor
city (string)
The city this anchor is located in
country (string)
An ISO-3166-1 alpha-2 code indicating the country that this probe is located in, as derived from the user supplied longitude and latitude
company (string)
Host company
nic_handle (string)
geometry (number: float)
A GeoJSON point object containing the location of this anchor.
The longitude and latitude are contained within the `coordinates` array
tlsa_record (string)
Installed TLSA DNS resource record on this anchor
is_disabled (boolean)
date_live (string: date-time)
date_decommissioned (string: date-time)
hardware_version (integer: int32)
[
0,
1,
2,
98,
99
]
GET /api/v2/anchors/
#credits
GET /api/v2/credits/ Get high-level information about credits
Get high-level information about credits.
Response
current_balance (integer: int64)
Current number of available credits
credit_checked (boolean)
Do we perform a credit check before creating the measurement
max_daily_credits (integer: int64)
Maximum number of credits that can be spend in a day
estimated_daily_income (integer: int64)
Total estimated daily income from all income items
estimated_daily_expenditure (integer: int64)
Total estimated daily expenditure from all expense items
estimated_daily_balance (integer: int64)
Estimated daily income minus estimated daily expenditure
calculation_time (string: date-time)
Time that the estimates were produced
estimated_runout_seconds (integer: int64)
Estimated elapsed time from `calculation_time` until total credit balance will drop to zero
past_day_measurement_results (integer: int64)
Number of results from user-defined measurements in the past 24 hours
past_day_credits_spent (integer: int64)
Number of credits spent in the past 24 hours
last_date_debited (string: date-time)
Last time the account was debited
last_date_credited (string: date-time)
Last time the account was credited
income_items (string)
URL of the income-items list (include directly using ?include=income_items)
expense_items (string)
URL of the expense-items list (include directly using ?include=expense_items)
transactions (string)
URL of the transactions list
GET /api/v2/credits/
GET /api/v2/credits/income-items/ Get sources of ongoing income
Get sources of ongoing income.
Response
groups (income groups)
Grouped list of income items
total_estimated_daily_income (integer: int64)
Total estimated daily income from all income items
GET /api/v2/credits/income-items/
GET /api/v2/credits/expense-items/ Get sources of ongoing expenditure
Get sources of ongoing expenditure.
Response
groups (expense groups)
Grouped list of expense items
total_estimated_daily_expenditure (integer: int64)
Total estimated daily expenditure from all expense items
GET /api/v2/credits/expense-items/
POST /api/v2/credits/transfers/ Transfer credits to another user
Transfer credits to another user.
Parameters
form parameters
amount (integer)
How many credits to transfer
recipient (string)
Email address of a RIPE Access user
Response
transaction (string)
URL of the created transaction
GET /api/v2/credits/voucher/{code}
Parameters
path parameters
code (string)
Response
value (integer: int64)
The value that will be transfered to redeeemer
redemptions_allowed (integer: int64)
Total number of times this voucher can be redeemed. Either by multiple users and/or periodically
periodic (string)
active_from (string: date-time)
The time the voucher can be redeemed from
active_till (string: date-time)
The time the voucher can be redeemed till. Periodic vouchers will stop at this time
campaign (string)
can_redeem (boolean)
redemptions_left (integer: int64)
GET /api/v2/credits/voucher/{code}
POST /api/v2/credits/voucher/redeem/
Parameters
form parameters
code (string)
Voucher code
Response
code (string)
Voucher code
GET /api/v2/credits/standing-order/
Response
id (integer: int64)
threshold (integer: int64)
The threshold above which you will start automatically sharing your credits
amount (integer: int64)
The amount of credits that will be evenly distributed among the recipients
is_active (boolean)
Starts or stops the transfer
recipients (array)
The list of users that will be receiving credits from you
GET /api/v2/credits/standing-order/
POST /api/v2/credits/standing-order/
Parameters
form parameters
threshold (integer)
The threshold above which you will start automatically sharing your credits
amount (integer)
The amount of credits that will be evenly distributed among the recipients
is_active (boolean)
Starts or stops the transfer
recipients (string)
The list of users that will be receiving credits from you
Response
id (integer: int64)
threshold (integer: int64)
The threshold above which you will start automatically sharing your credits
amount (integer: int64)
The amount of credits that will be evenly distributed among the recipients
is_active (boolean)
Starts or stops the transfer
recipients (array)
The list of users that will be receiving credits from you
GET /api/v2/credits/standing-order/{pk}/
Parameters
path parameters
pk (string)
Response
id (integer: int64)
threshold (integer: int64)
The threshold above which you will start automatically sharing your credits
amount (integer: int64)
The amount of credits that will be evenly distributed among the recipients
is_active (boolean)
Starts or stops the transfer
recipients (array)
The list of users that will be receiving credits from you
GET /api/v2/credits/standing-order/{pk}/
PATCH /api/v2/credits/standing-order/{pk}/
Parameters
form parameters
threshold (integer)
The threshold above which you will start automatically sharing your credits
amount (integer)
The amount of credits that will be evenly distributed among the recipients
is_active (boolean)
Starts or stops the transfer
recipients (string)
The list of users that will be receiving credits from you
path parameters
pk (string)
Response
id (integer: int64)
threshold (integer: int64)
The threshold above which you will start automatically sharing your credits
amount (integer: int64)
The amount of credits that will be evenly distributed among the recipients
is_active (boolean)
Starts or stops the transfer
recipients (array)
The list of users that will be receiving credits from you
DELETE /api/v2/credits/standing-order/{pk}/
Parameters
path parameters
pk (string)
Response
id (integer: int64)
threshold (integer: int64)
The threshold above which you will start automatically sharing your credits
amount (integer: int64)
The amount of credits that will be evenly distributed among the recipients
is_active (boolean)
Starts or stops the transfer
recipients (array)
The list of users that will be receiving credits from you
GET /api/v2/credits/bill-me/
Response
id (integer: int64)
recipients (array)
The list of users that will be able to set you as bill_to_user_id
GET /api/v2/credits/bill-me/
POST /api/v2/credits/bill-me/
Parameters
form parameters
recipients (string)
The list of users that will be able to set you as bill_to_user_id
Response
id (integer: int64)
recipients (array)
The list of users that will be able to set you as bill_to_user_id
GET /api/v2/credits/bill-me/{pk}/
Parameters
path parameters
pk (string)
Response
id (integer: int64)
recipients (array)
The list of users that will be able to set you as bill_to_user_id
GET /api/v2/credits/bill-me/{pk}/
PATCH /api/v2/credits/bill-me/{pk}/
Parameters
form parameters
recipients (string)
The list of users that will be able to set you as bill_to_user_id
path parameters
pk (string)
Response
id (integer: int64)
recipients (array)
The list of users that will be able to set you as bill_to_user_id
DELETE /api/v2/credits/bill-me/{pk}/
Parameters
path parameters
pk (string)
Response
id (integer: int64)
recipients (array)
The list of users that will be able to set you as bill_to_user_id
GET /api/v2/credits/transactions/ Get a historic income or expense transaction
Get a historic income or expense transaction
Parameters
query parameters
date (string)
filter the transactions on the specified date, can be specified in the seconds since the epoch or in iso-8601 format
date__lt (integer)
filter on date being less than value.
date__lte (integer)
filter on date being less than or equal to value.
date__gte (integer)
filter on date being greater than or equal to value.
date__gt (integer)
filter on date being greater than value.
sort (enum)
sorting transaction (only by date)
[date,-date]
type (enum)
filter transactions by type
[admin,measurement,probe]
page_size (integer)
Set responce size
Response
id (integer)
type (enum)
[
"admin",
"measurement",
"probe"
] Transaction type
reason (string)
description (string)
amount (integer)
balance_before (float)
balance_after (float)
date (date-time)
measurement_id (integer)
measurement (url)
samples (integer)
probe_id (integer)
probe (url)
GET /api/v2/credits/transactions/
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
members (array)
GET /api/v2/credits/members/
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
members (array)
Array of RegIDs to claim credits for
Response
members (array)
Array of RegIDs to claim credits for
#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
id (string)
The name of this permission, in the format 'permission_group.permission_name'
type (string)
The string 'permission'
description (string)
Human-readable explanation of the allowed action
target_types (array)
Array of names of valid target types
GET /api/v2/keys/permissions/
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
permission (string)
Response
id (string)
Type-unique identifier for this target
label (string)
Human-readable label for this target
type (string)
Type of target
GET /api/v2/keys/permissions/{permission}/targets/
GET /api/v2/keys/{api_key_prefix:uuid}/ Get a single API key
Get a single API key.
Parameters
path parameters
api_key_prefix:uuid (string)
Response
uuid (string)
String to be provided when making authenticated requests to the API, masked in the keys API output after first creation/regeneration.
url (string)
label (string)
A human-readable identifier to help you organise and manage your keys
created_at (string: date-time)
The time when this key was created or regenerated
valid_from (string: date-time)
The key will start to be usable at this time, or immediately if is omitted or null
valid_to (string: date-time)
The key will stop being usable at this time, or never if is omitted or null
last_used (string: date-time)
The last time this key was used to authenticate with the API
enabled (boolean)
Can be manually set to true or false to control whether this key is active, regardless of the `valid_from` and `valid_to` values
is_active (boolean)
Whether this key is currently enabled and within its defined usability time range
is_frozen (boolean)
Whether this key is frozen after a long period of inactivity (unfreeze with a new secret using the regenerate flag)
grants (array)
Grants are the permissions that are granted by this key, possibly relating to specific objects such as measurements, probes or other API keys
GET /api/v2/keys/{api_key_prefix:uuid}/
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
label (string)
A human-readable identifier to help you organise and manage your keys
valid_from (string)
The key will start to be usable at this time, or immediately if is omitted or null
valid_to (string)
The key will stop being usable at this time, or never if is omitted or null
enabled (boolean)
Can be manually set to true or false to control whether this key is active, regardless of the `valid_from` and `valid_to` values
grants (string)
Grants are the permissions that are granted by this key, possibly relating to specific objects such as measurements, probes or other API keys
regenerate (boolean)
(PATCH only) Give the key a new secret UUID, and unfreeze the key if frozen
path parameters
api_key_prefix:uuid (string)
Response
uuid (string)
String to be provided when making authenticated requests to the API, masked in the keys API output after first creation/regeneration.
url (string)
label (string)
A human-readable identifier to help you organise and manage your keys
created_at (string: date-time)
The time when this key was created or regenerated
valid_from (string: date-time)
The key will start to be usable at this time, or immediately if is omitted or null
valid_to (string: date-time)
The key will stop being usable at this time, or never if is omitted or null
last_used (string: date-time)
The last time this key was used to authenticate with the API
enabled (boolean)
Can be manually set to true or false to control whether this key is active, regardless of the `valid_from` and `valid_to` values
is_active (boolean)
Whether this key is currently enabled and within its defined usability time range
is_frozen (boolean)
Whether this key is frozen after a long period of inactivity (unfreeze with a new secret using the regenerate flag)
grants (array)
Grants are the permissions that are granted by this key, possibly relating to specific objects such as measurements, probes or other API keys
DELETE /api/v2/keys/{api_key_prefix:uuid}/
Parameters
path parameters
api_key_prefix:uuid (string)
Response
uuid (string)
String to be provided when making authenticated requests to the API, masked in the keys API output after first creation/regeneration.
url (string)
label (string)
A human-readable identifier to help you organise and manage your keys
created_at (string: date-time)
The time when this key was created or regenerated
valid_from (string: date-time)
The key will start to be usable at this time, or immediately if is omitted or null
valid_to (string: date-time)
The key will stop being usable at this time, or never if is omitted or null
last_used (string: date-time)
The last time this key was used to authenticate with the API
enabled (boolean)
Can be manually set to true or false to control whether this key is active, regardless of the `valid_from` and `valid_to` values
is_active (boolean)
Whether this key is currently enabled and within its defined usability time range
is_frozen (boolean)
Whether this key is frozen after a long period of inactivity (unfreeze with a new secret using the regenerate flag)
grants (array)
Grants are the permissions that are granted by this key, possibly relating to specific objects such as measurements, probes or other API keys
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
label (string)
A human-readable identifier to help you organise and manage your keys
valid_from (string)
The key will start to be usable at this time, or immediately if is omitted or null
valid_to (string)
The key will stop being usable at this time, or never if is omitted or null
enabled (boolean)
Can be manually set to true or false to control whether this key is active, regardless of the `valid_from` and `valid_to` values
grants (string)
Grants are the permissions that are granted by this key, possibly relating to specific objects such as measurements, probes or other API keys
regenerate (boolean)
(PATCH only) Give the key a new secret UUID, and unfreeze the key if frozen
path parameters
api_key_prefix:uuid (string)
Response
uuid (string)
String to be provided when making authenticated requests to the API, masked in the keys API output after first creation/regeneration.
url (string)
label (string)
A human-readable identifier to help you organise and manage your keys
created_at (string: date-time)
The time when this key was created or regenerated
valid_from (string: date-time)
The key will start to be usable at this time, or immediately if is omitted or null
valid_to (string: date-time)
The key will stop being usable at this time, or never if is omitted or null
last_used (string: date-time)
The last time this key was used to authenticate with the API
enabled (boolean)
Can be manually set to true or false to control whether this key is active, regardless of the `valid_from` and `valid_to` values
is_active (boolean)
Whether this key is currently enabled and within its defined usability time range
is_frozen (boolean)
Whether this key is frozen after a long period of inactivity (unfreeze with a new secret using the regenerate flag)
grants (array)
Grants are the permissions that are granted by this key, possibly relating to specific objects such as measurements, probes or other API keys
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
uuid (string)
String to be provided when making authenticated requests to the API, masked in the keys API output after first creation/regeneration.
url (string)
label (string)
A human-readable identifier to help you organise and manage your keys
created_at (string: date-time)
The time when this key was created or regenerated
valid_from (string: date-time)
The key will start to be usable at this time, or immediately if is omitted or null
valid_to (string: date-time)
The key will stop being usable at this time, or never if is omitted or null
last_used (string: date-time)
The last time this key was used to authenticate with the API
enabled (boolean)
Can be manually set to true or false to control whether this key is active, regardless of the `valid_from` and `valid_to` values
is_active (boolean)
Whether this key is currently enabled and within its defined usability time range
is_frozen (boolean)
Whether this key is frozen after a long period of inactivity (unfreeze with a new secret using the regenerate flag)
grants (array)
Grants are the permissions that are granted by this key, possibly relating to specific objects such as measurements, probes or other API keys
GET /api/v2/keys/
POST /api/v2/keys/ Create a new API key
Create a new API key.
Parameters
body parameters
grants (string)
Array of grant definitions.Each grant is a JSON object with the same structure defined in the response above.
form parameters
label (string)
A human-readable identifier to help you organise and manage your keys
valid_from (string)
The key will start to be usable at this time, or immediately if is omitted or null
valid_to (string)
The key will stop being usable at this time, or never if is omitted or null
enabled (boolean)
Can be manually set to true or false to control whether this key is active, regardless of the `valid_from` and `valid_to` values
regenerate (boolean)
(PATCH only) Give the key a new secret UUID, and unfreeze the key if frozen
Response
uuid (string)
String to be provided when making authenticated requests to the API, masked in the keys API output after first creation/regeneration.
url (string)
label (string)
A human-readable identifier to help you organise and manage your keys
created_at (string: date-time)
The time when this key was created or regenerated
valid_from (string: date-time)
The key will start to be usable at this time, or immediately if is omitted or null
valid_to (string: date-time)
The key will stop being usable at this time, or never if is omitted or null
last_used (string: date-time)
The last time this key was used to authenticate with the API
enabled (boolean)
Can be manually set to true or false to control whether this key is active, regardless of the `valid_from` and `valid_to` values
is_active (boolean)
Whether this key is currently enabled and within its defined usability time range
is_frozen (boolean)
Whether this key is frozen after a long period of inactivity (unfreeze with a new secret using the regenerate flag)
grants (array)
Grants are the permissions that are granted by this key, possibly relating to specific objects such as measurements, probes or other API keys
#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
sort (enum)
Sort the results based on certain field values. Sort directives beginning with '-' imply a descending/reversed sort order.
[id,-id,start_time,-start_time,stop_time,-stop_time,is_oneoff,-is_oneoff,interval,-interval,type,-type,af,-af,status.name,-status.name,status.id,-status.id]
id__lt (string)
filter on id being less than value
id__lte (string)
filter on id being less than or equal to value.
id__gt (string)
filter on id being greater than value.
id__gte (string)
filter on id being greater than or equal to value.
id__in (string)
filter on ID being one of a comma-separated list
id (string)
filter on ID being one of a comma-separated list
start_time (number)
filter on start time (as a unixtime timestamp) of scheduled measurement.
start_time__lt (number)
filter on start time being less than the value (before).
start_time__lte (number)
filter on start time being less than or equal to the value (before).
start_time__gt (number)
filter on start time being greater than the value (after).
start_time__gte (number)
filter on start time being greater than or equal to the value (after).
stop_time (number)
filter on stop time (as a unixtime timestamp) of scheduled measurement.
stop_time__lt (number)
filter on stop time being less than the value (before).
stop_time__lte (number)
filter on stop time being less than or equal to the value (before).
stop_time__gt (number)
filter on stop time being greater than (after) the value. If the given value is in the past then ongoing measurements will be included.
stop_time__gte (number)
filter on stop time being greater than (after) or equal to the value. If the given value is in the past then ongoing measurements will be included.
is_public (boolean)
return only publicly available measurements.
is_oneoff (boolean)
return only one-off measurements.
interval (string)
filter on the interval matching the value.
interval__lt (string)
filter on the interval being less than value.
interval__lte (string)
filter on the interval being less than or equal to value.
interval__gt (string)
filter on the interval being greater than value.
interval__gte (string)
filter on the interval being greater than or equal to value.
status (string)
filter on the status of the measurement. Multiple statuses are specified as comma-separated values. (0: Specified, 1: Scheduled, 2: Ongoing, 4: Stopped, 5: Forced to stop, 6: No suitable probes, 7: Failed, 8: Archived)
status__in (string)
filter on the status of the measurement. Multiple statuses are specified as comma-separated values. (0: Specified, 1: Scheduled, 2: Ongoing, 4: Stopped, 5: Forced to stop, 6: No suitable probes, 7: Failed, 8: Archived)
tags (string)
filter on list of tags
type (string)
return all measurements of type value, one of `ping`,'traceroute`, 'dns`, `http`, `sslcert`, `ntp`
target_ip (string)
filter on the exact or more specific target IP address
current_probes (string)
filter by the ID of a probe currently participating in this measurement
participant_logs_probes (string)
filter by the ID of the probes that were selected by participation requests for this measurement (100 probes max)
target_asn (string)
filter on the ASN seen to be routing the target's IP address
target (string)
filter on the exact target FQDN (or target ip if fqdn is not available)
target__contains (string)
filter on the target URL containing the value.
target__startswith (string)
filter on the target hostname starting with value.
target__endswith (string)
filter on the target hostname ending with value.
description (string)
filter on the exact description
description__contains (string)
filter on the description containing the value.
description__startswith (string)
filter on the description starting with value.
description__endswith (string)
filter on the description ending with value.
af (string)
return only the fields containing either IPv4 or IPv6 measurements. (4 - IPv4, 6 - IPv6)
search (string)
filter on description (for DNS measurements) or target (other measurements) for containing value.
protocol (string)
filter on the protocol for the measurement, works only it conjunction with type=dns|traceroute.
group_id (string)
Filter by group ID
group (string)
[deprecated, use group_id] Filter by group ID
favourite (boolean)
only return favourited measurements
hidden (boolean)
only return hidden measurements (by default they will be excluded)
page (number)
Filter on page number. The maximum number of results returned is 10000.
page_size (number)
Set the number of measurements returned on one page. Maximum size is 500, default is 50.
after (string)
Used to get the next page of results when the maximum page number has been reached
format (enum)
Choose between available output formats (api, json, jsonp, txt)
[api,json,jsonp,txt]
callback (string)
Specifies a callback function name for a 'JSONP' response
optional_fields (enum)
Include additional fields named in comma-separated values in response.
[participation_requests,participant_logs,current_probes,is_active,probe_sources,probes]
fields (string)
Return fields named in comma-separated values in response, in addition to 'type' and 'id' which are always present. Optional fields can be listed here also.
format[datetime] (string)
Output datetimes in ISO-8601 format ('iso-8601' or 'json') or as seconds since the epoch ('unix')
key (string)
An API key to be used to authorize this request
mine (boolean)
passing in mine=true will return only the measurements of the logged in user
Response
[core] is_public (boolean)
Indicates this measurement is publicly available; may be changed from false to true, but not from true to false
[core] description (string)
User-defined description of the measurement
[core] id (integer: int64)
The unique identifier that RIPE Atlas assigned to this measurement
[core] result (string)
The URL that contains the results of this measurement
[core] group_id (integer: int64)
The ID of the measurement group. This ID references a measurement acting as group master
[core] af (integer: int32)
[
4,
6
] [Not for wifi] IPv4 of IPv6 Address family of the measurement
[core] is_oneoff (boolean)
Indicates this is a one-off or a recurring measurement
[core] spread (integer: int64)
Distribution of probes' measurements throughout the interval (default is half the interval, maximum 400 seconds)
[core] resolve_on_probe (boolean)
Indicates that a name should be resolved (using DNS) on the probe. Otherwise it will be resolved on the RIPE Atlas servers
[core] start_time (string: date-time)
Configured start time (as a unix timestamp)
[core] stop_time (string: date-time)
Actual end time of measurement (as a unix timestamp)
[core] type (string)
[
"ping",
"traceroute",
"dns",
"sslcert",
"http",
"ntp",
"wifi"
] The type of the measurement
[core] status (measurement status)
Current status of the measurement. Status can be: Specified, Scheduled, Ongoing, Stopped, Requested to stop, Forced to stop, No suitable probes, Failed or Archived
[core] is_all_scheduled (boolean)
Indicates if all probe requests have made it through the scheduling process
[core] is_reachability_test (boolean)
Indicates this measurement is a reachability test
[core] participant_count (integer: int64)
Number of participating probes
[core] target_asn (integer: int64)
The number of the Autonomous System the IP address of the target belongs to
[core] target_prefix (string)
Enclosing prefix of the IP address of the target
[core] target_ip (string)
The IP Address of the target of the measurement
[core] creation_time (string: date-time)
The creation date and time of the measurement (Defaults to unix timestamp format)
[core] in_wifi_group (boolean)
Indicates this measurement belongs to a wifi measurement group
[core] resolved_ips (string)
The list of IP addresses returned for the fqdn in the `target` field by the backend infra-structure resolvers
[core] probes_requested (integer: int64)
Number of probes requested, but not necessarily granted to this measurement
[core] probes_scheduled (integer: int64)
Number of probes actually scheduled for this measurement
[core] group (string)
The API URL of the measurement group.
[core] probes (array)
probes involved in this measurement
[core] estimated_results_per_day (string)
estimated RIPE Atlas credits consumed by this measurement per day
[core] credits_per_result (integer: int64)
[core] probe_sources (array)
[core] participation_requests (array)
[core] user_id (integer: int64)
The user ID of the owner of this measurement
[core] bill_to_user_id (integer: int64)
The ID of the user who will be billed for this measurement
[core] tags (string)
Array of tags to apply to the measurement
[core] scheduled_via (string)
[ping] packets (integer: int64)
The number of packets send in a measurement execution. Value must be between 1 and 16. Default is 3
[ping] size (integer: int64)
size of the data part of the packet, i.e. excluding any IP and ICMP headers. Value must be between 1 and 2048
[ping] packet_interval (integer: int64)
Time between packets in milliseconds. Value must be between 2 and 300000
[ping] include_probe_id (boolean)
Include the probe ID (encoded as ASCII digits) as part of the payload
[traceroute] port (integer: int64)
The target port number (TCP only). Defaults to 80
[traceroute] packets (integer: int64)
The number of packets send in a measurement execution. Value must be between 1 and 16. Default is 3
[traceroute] first_hop (integer: int64)
TTL (time to live) of the first hop
[traceroute] max_hops (integer: int64)
Traceroute measurement stops after the hop at which the TTL reaches this value
[traceroute] paris (integer: int64)
The number of paris traceroute variations to try. Zero disables paris traceroute. Value must be between 0 and 64
[traceroute] size (integer: int64)
size of the data part of the packet, i.e. excluding any IP, ICMP, UDP or TCP headers. Value must be between 0 and 2048
[traceroute] protocol (string)
[
"ICMP",
"UDP",
"TCP"
] Protocol used in measurement
[traceroute] response_timeout (integer: int64)
Response timeout for one packet
[traceroute] duplicate_timeout (integer: int64)
Time to wait (in milliseconds) for a duplicate response after receiving the first response
[traceroute] hop_by_hop_option_size (integer: int64)
Size of an IPv6 hop-by-hop option header filled with NOPs
[traceroute] destination_option_size (integer: int64)
Size of an IPv6 destination option header filled with NOPs
[traceroute] dont_fragment (boolean)
Do not fragment outgoing packets
[traceroute] traffic_class (integer: int64)
The traffic class (IPv6) or type of service and precedence (IPv4) value
[traceroute] gap_limit (integer: int64)
Number of unresponsive hops before the traceroute measurement is stopped
[dns] udp_payload_size (integer: int64)
Set the EDNS0 option for UDP payload size to this value, between 512 and 4096.Defaults to 512)
[dns] use_probe_resolver (boolean)
Send the DNS query to the probe's local resolvers (instead of an explicitly specified target)
[dns] set_rd_bit (boolean)
Indicates Recursion Desired bit was set
[dns] prepend_probe_id (boolean)
Each probe prepends its probe number and a timestamp to the DNS query argument to make it unique
[dns] protocol (string)
[
"UDP",
"TCP"
] Protocol used in measurement. Defaults to UDP
[dns] retry (integer: int64)
Number of times to retry
[dns] include_qbuf (boolean)
include the raw DNS query data in the result. Defaults to false
[dns] set_nsid_bit (boolean)
Indicates Name Server Identifier (RFC5001) was set
[dns] include_abuf (boolean)
include the raw DNS answer data in the result. Defaults to true
[dns] query_class (string)
[
"IN",
"CHAOS"
] The `class` part of the query used in the measurement
[dns] query_argument (string)
The `argument` part of the query used in the measurement
[dns] query_type (string)
[
"A",
"AAAA",
"ANY",
"CNAME",
"DNSKEY",
"DS",
"MX",
"NS",
"NSEC",
"PTR",
"RRSIG",
"SOA",
"TXT",
"SRV",
"NAPTR",
"TLSA"
] The `type` part of the query used in the measurement
[dns] set_cd_bit (boolean)
Indicates DNSSEC Checking Disabled (RFC4035) was set
[dns] set_do_bit (boolean)
Indicates DNSSEC OK (RFC3225) was set
[dns] use_macros (boolean)
Allow the use of $p (probe ID), $r (random 16-digit hex string) and $t (timestamp) in the query_argument
[dns] timeout (integer: int64)
Timeout in milliseconds (default: 5000)
[dns] tls (boolean)
Enable DNS over Transport Layer Security (RFC7858)
[dns] port (integer: int64)
UDP or TCP port, if not specified defaults to port 53 or to port 853 for DNS-over-TLS
[dns] default_client_subnet (boolean)
Enable an EDNS Client Subnet (RFC7871) of 0.0.0.0/0 0 or ::/0
[dns] cookies (boolean)
Insert client cookie in requests and process server cookies
[dns] ttl (boolean)
Report the IP time-to-live field (hop limit for IPv6) of DNS reply packets received (only for UDP)
[dns] set_ad_bit (boolean)
Indicates Authenticated Data (RFC3655) was set
[http] extended_timing (boolean)
Enable time-to-resolve, time-to-connect and time-to-first-byte measurements
[http] more_extended_timing (boolean)
Include fields added by extended_timing and adds readtiming which reports for each read system call when it happened and how much data was delivered
[http] header_bytes (integer: int64)
Maximum number of bytes in the reponse header, defaults to 0
[http] method (string)
[
"GET",
"POST",
"HEAD"
] http verb of the measurement request
[http] path (string)
Path of the requested URL
[http] query_string (string)
Optional query parameters of the requested URL
[http] user_agent (string)
[
"RIPE Atlas: https://atlas.ripe.net/"
] user agent header field sent in the http request. Always set to 'RIPE Atlas: https//atlas.ripe.net'
[http] max_bytes_read (integer: int64)
[http] version (string)
[
"1.0",
"1.1"
] http version of measurement request
[http] port (integer: int64)
The target port number Defaults to 80 (HTTP) or 443 (HTTPS)
[http] host (string)
Value for the Host header if different than the target
[http] https (boolean)
Use HTTPS instead of plaintext HTTP
[ntp] packets (integer: int64)
The number of packets send in a measurement execution. Value must be between 1 and 16. Default is 3
[ntp] timeout (integer: int64)
Per packet timeout in milliseconds
[ntp] size (integer: int64)
size of the data part of the packet, i.e. excluding any headers. Value must be between 28 and 1184, and a multiple of 4
[sslcert] port (integer: int64)
The target port number. Defaults to 443
[sslcert] hostname (string)
Server Name Indication (SNI) hostname
[wifi] ipv4 (boolean)
Indicates IPv4 measurements are attempted in this group
[wifi] ipv6 (boolean)
Indicates IPv6 measurements are attempted in this group
[wifi] cert (string)
Certificate in PEM format
[wifi] extra_wait (integer: int64)
Wait this amount of time before executing measurement commands.
[wifi] ssid (string)
[
"eduroam",
"guestnet",
"ripemtg-2.4-74",
"ripemtg-nat64-2.4-74",
"phicoh-test-2.4"
] Wifi SSID to connect to. Max. 32 characters
[wifi] key_mgmt (string)
[
"WPA-PSK",
"WPA-EAP"
] Authentication mechanism used for the wifi connection. For WPA-PSK `psk` field is also required,for WPA-EAP `eap` and `password` fields are required
[wifi] eap (string)
[
"TTLS",
"PEAP"
] Extensible Authentication Protocol type. Currently only `TTLS` is available
[wifi] identity (string)
Username used for wifi connection. Used for both outer and inner connection if anonymous_identity is omitted
[wifi] anonymous_identity (string)
Username used for outer connection. If omitted the `identity` field is used for the outer connection
[wifi] phase2 (string)
[
"auth=EAP-MSCHAPV2",
"auth=MSCHAPV2",
"auth=PAP"
] Connection and Authentication directives for the inner connection. Only used for WPA-EAP. Currently only EAP-MSCHAPv2 is available
[wifi] rssi (boolean)
Indicates that BSSID radio signal strength will be measured and stored
GET /api/v2/measurements/
POST /api/v2/measurements/ Create one or more measurements of any available type
Create one or more measurements of any available type
Parameters
body parameters
definitions (new measurement)
Array of measurement definitions. Each measurement definition is a JSON object.
probes (probe source)
Properties of requested probes.
form parameters
measurements (array)
ids of the created measurements
Response
measurements (array)
ids of the created measurements
GET /api/v2/measurements/{pk}/ Show one measurement specified by ID
Show one measurement specified by ID
Parameters
path parameters
pk (string)
Response
[core] is_public (boolean)
Indicates this measurement is publicly available; may be changed from false to true, but not from true to false
[core] description (string)
User-defined description of the measurement
[core] id (integer: int64)
The unique identifier that RIPE Atlas assigned to this measurement
[core] result (string)
The URL that contains the results of this measurement
[core] group_id (integer: int64)
The ID of the measurement group. This ID references a measurement acting as group master
[core] af (integer: int32)
[
4,
6
] [Not for wifi] IPv4 of IPv6 Address family of the measurement
[core] is_oneoff (boolean)
Indicates this is a one-off or a recurring measurement
[core] spread (integer: int64)
Distribution of probes' measurements throughout the interval (default is half the interval, maximum 400 seconds)
[core] resolve_on_probe (boolean)
Indicates that a name should be resolved (using DNS) on the probe. Otherwise it will be resolved on the RIPE Atlas servers
[core] start_time (string: date-time)
Configured start time (as a unix timestamp)
[core] stop_time (string: date-time)
Actual end time of measurement (as a unix timestamp)
[core] type (string)
[
"ping",
"traceroute",
"dns",
"sslcert",
"http",
"ntp",
"wifi"
] The type of the measurement
[core] status (measurement status)
Current status of the measurement. Status can be: Specified, Scheduled, Ongoing, Stopped, Requested to stop, Forced to stop, No suitable probes, Failed or Archived
[core] is_all_scheduled (boolean)
Indicates if all probe requests have made it through the scheduling process
[core] is_reachability_test (boolean)
Indicates this measurement is a reachability test
[core] participant_count (integer: int64)
Number of participating probes
[core] target_asn (integer: int64)
The number of the Autonomous System the IP address of the target belongs to
[core] target_prefix (string)
Enclosing prefix of the IP address of the target
[core] target_ip (string)
The IP Address of the target of the measurement
[core] creation_time (string: date-time)
The creation date and time of the measurement (Defaults to unix timestamp format)
[core] in_wifi_group (boolean)
Indicates this measurement belongs to a wifi measurement group
[core] resolved_ips (string)
The list of IP addresses returned for the fqdn in the `target` field by the backend infra-structure resolvers
[core] probes_requested (integer: int64)
Number of probes requested, but not necessarily granted to this measurement
[core] probes_scheduled (integer: int64)
Number of probes actually scheduled for this measurement
[core] group (string)
The API URL of the measurement group.
[core] probes (array)
probes involved in this measurement
[core] estimated_results_per_day (string)
estimated RIPE Atlas credits consumed by this measurement per day
[core] credits_per_result (integer: int64)
[core] probe_sources (array)
[core] participation_requests (array)
[core] user_id (integer: int64)
The user ID of the owner of this measurement
[core] bill_to_user_id (integer: int64)
The ID of the user who will be billed for this measurement
[core] tags (string)
Array of tags to apply to the measurement
[core] scheduled_via (string)
[ping] packets (integer: int64)
The number of packets send in a measurement execution. Value must be between 1 and 16. Default is 3
[ping] size (integer: int64)
size of the data part of the packet, i.e. excluding any IP and ICMP headers. Value must be between 1 and 2048
[ping] packet_interval (integer: int64)
Time between packets in milliseconds. Value must be between 2 and 300000
[ping] include_probe_id (boolean)
Include the probe ID (encoded as ASCII digits) as part of the payload
[traceroute] port (integer: int64)
The target port number (TCP only). Defaults to 80
[traceroute] packets (integer: int64)
The number of packets send in a measurement execution. Value must be between 1 and 16. Default is 3
[traceroute] first_hop (integer: int64)
TTL (time to live) of the first hop
[traceroute] max_hops (integer: int64)
Traceroute measurement stops after the hop at which the TTL reaches this value
[traceroute] paris (integer: int64)
The number of paris traceroute variations to try. Zero disables paris traceroute. Value must be between 0 and 64
[traceroute] size (integer: int64)
size of the data part of the packet, i.e. excluding any IP, ICMP, UDP or TCP headers. Value must be between 0 and 2048
[traceroute] protocol (string)
[
"ICMP",
"UDP",
"TCP"
] Protocol used in measurement
[traceroute] response_timeout (integer: int64)
Response timeout for one packet
[traceroute] duplicate_timeout (integer: int64)
Time to wait (in milliseconds) for a duplicate response after receiving the first response
[traceroute] hop_by_hop_option_size (integer: int64)
Size of an IPv6 hop-by-hop option header filled with NOPs
[traceroute] destination_option_size (integer: int64)
Size of an IPv6 destination option header filled with NOPs
[traceroute] dont_fragment (boolean)
Do not fragment outgoing packets
[traceroute] traffic_class (integer: int64)
The traffic class (IPv6) or type of service and precedence (IPv4) value
[traceroute] gap_limit (integer: int64)
Number of unresponsive hops before the traceroute measurement is stopped
[dns] udp_payload_size (integer: int64)
Set the EDNS0 option for UDP payload size to this value, between 512 and 4096.Defaults to 512)
[dns] use_probe_resolver (boolean)
Send the DNS query to the probe's local resolvers (instead of an explicitly specified target)
[dns] set_rd_bit (boolean)
Indicates Recursion Desired bit was set
[dns] prepend_probe_id (boolean)
Each probe prepends its probe number and a timestamp to the DNS query argument to make it unique
[dns] protocol (string)
[
"UDP",
"TCP"
] Protocol used in measurement. Defaults to UDP
[dns] retry (integer: int64)
Number of times to retry
[dns] include_qbuf (boolean)
include the raw DNS query data in the result. Defaults to false
[dns] set_nsid_bit (boolean)
Indicates Name Server Identifier (RFC5001) was set
[dns] include_abuf (boolean)
include the raw DNS answer data in the result. Defaults to true
[dns] query_class (string)
[
"IN",
"CHAOS"
] The `class` part of the query used in the measurement
[dns] query_argument (string)
The `argument` part of the query used in the measurement
[dns] query_type (string)
[
"A",
"AAAA",
"ANY",
"CNAME",
"DNSKEY",
"DS",
"MX",
"NS",
"NSEC",
"PTR",
"RRSIG",
"SOA",
"TXT",
"SRV",
"NAPTR",
"TLSA"
] The `type` part of the query used in the measurement
[dns] set_cd_bit (boolean)
Indicates DNSSEC Checking Disabled (RFC4035) was set
[dns] set_do_bit (boolean)
Indicates DNSSEC OK (RFC3225) was set
[dns] use_macros (boolean)
Allow the use of $p (probe ID), $r (random 16-digit hex string) and $t (timestamp) in the query_argument
[dns] timeout (integer: int64)
Timeout in milliseconds (default: 5000)
[dns] tls (boolean)
Enable DNS over Transport Layer Security (RFC7858)
[dns] port (integer: int64)
UDP or TCP port, if not specified defaults to port 53 or to port 853 for DNS-over-TLS
[dns] default_client_subnet (boolean)
Enable an EDNS Client Subnet (RFC7871) of 0.0.0.0/0 0 or ::/0
[dns] cookies (boolean)
Insert client cookie in requests and process server cookies
[dns] ttl (boolean)
Report the IP time-to-live field (hop limit for IPv6) of DNS reply packets received (only for UDP)
[dns] set_ad_bit (boolean)
Indicates Authenticated Data (RFC3655) was set
[http] extended_timing (boolean)
Enable time-to-resolve, time-to-connect and time-to-first-byte measurements
[http] more_extended_timing (boolean)
Include fields added by extended_timing and adds readtiming which reports for each read system call when it happened and how much data was delivered
[http] header_bytes (integer: int64)
Maximum number of bytes in the reponse header, defaults to 0
[http] method (string)
[
"GET",
"POST",
"HEAD"
] http verb of the measurement request
[http] path (string)
Path of the requested URL
[http] query_string (string)
Optional query parameters of the requested URL
[http] user_agent (string)
[
"RIPE Atlas: https://atlas.ripe.net/"
] user agent header field sent in the http request. Always set to 'RIPE Atlas: https//atlas.ripe.net'
[http] max_bytes_read (integer: int64)
[http] version (string)
[
"1.0",
"1.1"
] http version of measurement request
[http] port (integer: int64)
The target port number Defaults to 80 (HTTP) or 443 (HTTPS)
[http] host (string)
Value for the Host header if different than the target
[http] https (boolean)
Use HTTPS instead of plaintext HTTP
[ntp] packets (integer: int64)
The number of packets send in a measurement execution. Value must be between 1 and 16. Default is 3
[ntp] timeout (integer: int64)
Per packet timeout in milliseconds
[ntp] size (integer: int64)
size of the data part of the packet, i.e. excluding any headers. Value must be between 28 and 1184, and a multiple of 4
[sslcert] port (integer: int64)
The target port number. Defaults to 443
[sslcert] hostname (string)
Server Name Indication (SNI) hostname
[wifi] ipv4 (boolean)
Indicates IPv4 measurements are attempted in this group
[wifi] ipv6 (boolean)
Indicates IPv6 measurements are attempted in this group
[wifi] cert (string)
Certificate in PEM format
[wifi] extra_wait (integer: int64)
Wait this amount of time before executing measurement commands.
[wifi] ssid (string)
[
"eduroam",
"guestnet",
"ripemtg-2.4-74",
"ripemtg-nat64-2.4-74",
"phicoh-test-2.4"
] Wifi SSID to connect to. Max. 32 characters
[wifi] key_mgmt (string)
[
"WPA-PSK",
"WPA-EAP"
] Authentication mechanism used for the wifi connection. For WPA-PSK `psk` field is also required,for WPA-EAP `eap` and `password` fields are required
[wifi] eap (string)
[
"TTLS",
"PEAP"
] Extensible Authentication Protocol type. Currently only `TTLS` is available
[wifi] identity (string)
Username used for wifi connection. Used for both outer and inner connection if anonymous_identity is omitted
[wifi] anonymous_identity (string)
Username used for outer connection. If omitted the `identity` field is used for the outer connection
[wifi] phase2 (string)
[
"auth=EAP-MSCHAPV2",
"auth=MSCHAPV2",
"auth=PAP"
] Connection and Authentication directives for the inner connection. Only used for WPA-EAP. Currently only EAP-MSCHAPv2 is available
[wifi] rssi (boolean)
Indicates that BSSID radio signal strength will be measured and stored
GET /api/v2/measurements/{pk}/
PATCH /api/v2/measurements/{pk}/ Update an existing measurement
Update an existing measurement.
Parameters
form parameters
is_public (boolean)
Indicates this measurement is publicly available; may be changed from false to true, but not from true to false
description (string)
User-defined description of the measurement
path parameters
pk (string)
Response
is_public (boolean)
Indicates this measurement is publicly available; may be changed from false to true, but not from true to false
description (string)
User-defined description of the measurement
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
pk (string)
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
pk (string)
query parameters
format (enum)
Choose between available output formats (json, jsonp, txt)
[json,jsonp,txt]
callback (string)
Specifies a callback function name for a 'JSONP' response
key (string)
An API key to be used to authorize this request
start (integer)
filter on start time (as a unixtime timestamp) of result events.
stop (integer)
filter on stop time (as a unixtime timestamp) of result events.
probe_ids (string)
filter the results on probes as a comma-separated list.
anchors_only (boolean)
only return results from anchors.
public_only (boolean)
only return results from public probes.
Response
GET /api/v2/measurements/{pk}/results/
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
pk (string)
query parameters
format (enum)
Choose between available output formats (api, json, jsonp, txt)
[api,json,jsonp,txt]
callback (string)
Specifies a callback function name for a 'JSONP' response
key (string)
An API key to be used to authorize this request
versions (integer)
number of versions to return, between 1 and 10
probe_ids (string)
probe IDs as a comma-separated list
anchors_only (boolean)
only return results from anchors
public_only (boolean)
only return results from public probes
Response
GET /api/v2/measurements/{pk}/latest/
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
sort (enum)
Sort the results based on certain field values. Sort directives beginning with '-' imply a descending/reversed sort order.
[id,-id,start_time,-start_time,stop_time,-stop_time,is_oneoff,-is_oneoff,interval,-interval,type,-type,af,-af,status.name,-status.name,status.id,-status.id]
id__lt (string)
filter on id being less than value
id__lte (string)
filter on id being less than or equal to value.
id__gt (string)
filter on id being greater than value.
id__gte (string)
filter on id being greater than or equal to value.
id__in (string)
filter on ID being one of a comma-separated list
id (string)
filter on ID being one of a comma-separated list
start_time (number)
filter on start time (as a unixtime timestamp) of scheduled measurement.
start_time__lt (number)
filter on start time being less than the value (before).
start_time__lte (number)
filter on start time being less than or equal to the value (before).
start_time__gt (number)
filter on start time being greater than the value (after).
start_time__gte (number)
filter on start time being greater than or equal to the value (after).
stop_time (number)
filter on stop time (as a unixtime timestamp) of scheduled measurement.
stop_time__lt (number)
filter on stop time being less than the value (before).
stop_time__lte (number)
filter on stop time being less than or equal to the value (before).
stop_time__gt (number)
filter on stop time being greater than (after) the value. If the given value is in the past then ongoing measurements will be included.
stop_time__gte (number)
filter on stop time being greater than (after) or equal to the value. If the given value is in the past then ongoing measurements will be included.
is_public (boolean)
return only publicly available measurements.
is_oneoff (boolean)
return only one-off measurements.
interval (string)
filter on the interval matching the value.
interval__lt (string)
filter on the interval being less than value.
interval__lte (string)
filter on the interval being less than or equal to value.
interval__gt (string)
filter on the interval being greater than value.
interval__gte (string)
filter on the interval being greater than or equal to value.
status (string)
filter on the status of the measurement. Multiple statuses are specified as comma-separated values. (0: Specified, 1: Scheduled, 2: Ongoing, 4: Stopped, 5: Forced to stop, 6: No suitable probes, 7: Failed, 8: Archived)
status__in (string)
filter on the status of the measurement. Multiple statuses are specified as comma-separated values. (0: Specified, 1: Scheduled, 2: Ongoing, 4: Stopped, 5: Forced to stop, 6: No suitable probes, 7: Failed, 8: Archived)
tags (string)
filter on list of tags
type (string)
return all measurements of type value, one of `ping`,'traceroute`, 'dns`, `http`, `sslcert`, `ntp`
target_ip (string)
filter on the exact or more specific target IP address
current_probes (string)
filter by the ID of a probe currently participating in this measurement
participant_logs_probes (string)
filter by the ID of the probes that were selected by participation requests for this measurement (100 probes max)
target_asn (string)
filter on the ASN seen to be routing the target's IP address
target (string)
filter on the exact target FQDN (or target ip if fqdn is not available)
target__contains (string)
filter on the target URL containing the value.
target__startswith (string)
filter on the target hostname starting with value.
target__endswith (string)
filter on the target hostname ending with value.
description (string)
filter on the exact description
description__contains (string)
filter on the description containing the value.
description__startswith (string)
filter on the description starting with value.
description__endswith (string)
filter on the description ending with value.
af (string)
return only the fields containing either IPv4 or IPv6 measurements. (4 - IPv4, 6 - IPv6)
search (string)
filter on description (for DNS measurements) or target (other measurements) for containing value.
protocol (string)
filter on the protocol for the measurement, works only it conjunction with type=dns|traceroute.
group_id (string)
Filter by group ID
group (string)
[deprecated, use group_id] Filter by group ID
favourite (boolean)
only return favourited measurements
hidden (boolean)
only return hidden measurements (by default they will be excluded)
page (number)
Filter on page number. The maximum number of results returned is 10000.
page_size (number)
Set the number of measurements returned on one page. Maximum size is 500, default is 50.
after (string)
Used to get the next page of results when the maximum page number has been reached
format (enum)
Choose between available output formats (api, json, jsonp, txt)
[api,json,jsonp,txt]
callback (string)
Specifies a callback function name for a 'JSONP' response
optional_fields (enum)
Include additional fields named in comma-separated values in response.
[participation_requests,participant_logs,current_probes,is_active,probe_sources,probes]
fields (string)
Return fields named in comma-separated values in response, in addition to 'type' and 'id' which are always present. Optional fields can be listed here also.
format[datetime] (string)
Output datetimes in ISO-8601 format ('iso-8601' or 'json') or as seconds since the epoch ('unix')
key (string)
An API key to be used to authorize this request
mine (boolean)
passing in mine=true will return only the measurements of the logged in user
Response
[core] is_public (boolean)
Indicates this measurement is publicly available; may be changed from false to true, but not from true to false
[core] description (string)
User-defined description of the measurement
[core] id (integer: int64)
The unique identifier that RIPE Atlas assigned to this measurement
[core] result (string)
The URL that contains the results of this measurement
[core] group_id (integer: int64)
The ID of the measurement group. This ID references a measurement acting as group master
[core] af (integer: int32)
[
4,
6
] [Not for wifi] IPv4 of IPv6 Address family of the measurement
[core] is_oneoff (boolean)
Indicates this is a one-off or a recurring measurement
[core] spread (integer: int64)
Distribution of probes' measurements throughout the interval (default is half the interval, maximum 400 seconds)
[core] resolve_on_probe (boolean)
Indicates that a name should be resolved (using DNS) on the probe. Otherwise it will be resolved on the RIPE Atlas servers
[core] start_time (string: date-time)
Configured start time (as a unix timestamp)
[core] stop_time (string: date-time)
Actual end time of measurement (as a unix timestamp)
[core] type (string)
[
"ping",
"traceroute",
"dns",
"sslcert",
"http",
"ntp",
"wifi"
] The type of the measurement
[core] status (measurement status)
Current status of the measurement. Status can be: Specified, Scheduled, Ongoing, Stopped, Requested to stop, Forced to stop, No suitable probes, Failed or Archived
[core] is_all_scheduled (boolean)
Indicates if all probe requests have made it through the scheduling process
[core] is_reachability_test (boolean)
Indicates this measurement is a reachability test
[core] participant_count (integer: int64)
Number of participating probes
[core] target_asn (integer: int64)
The number of the Autonomous System the IP address of the target belongs to
[core] target_prefix (string)
Enclosing prefix of the IP address of the target
[core] target_ip (string)
The IP Address of the target of the measurement
[core] creation_time (string: date-time)
The creation date and time of the measurement (Defaults to unix timestamp format)
[core] in_wifi_group (boolean)
Indicates this measurement belongs to a wifi measurement group
[core] resolved_ips (string)
The list of IP addresses returned for the fqdn in the `target` field by the backend infra-structure resolvers
[core] probes_requested (integer: int64)
Number of probes requested, but not necessarily granted to this measurement
[core] probes_scheduled (integer: int64)
Number of probes actually scheduled for this measurement
[core] group (string)
The API URL of the measurement group.
[core] probes (array)
probes involved in this measurement
[core] estimated_results_per_day (string)
estimated RIPE Atlas credits consumed by this measurement per day
[core] credits_per_result (integer: int64)
[core] probe_sources (array)
[core] participation_requests (array)
[core] user_id (integer: int64)
The user ID of the owner of this measurement
[core] bill_to_user_id (integer: int64)
The ID of the user who will be billed for this measurement
[core] tags (string)
Array of tags to apply to the measurement
[core] scheduled_via (string)
[ping] packets (integer: int64)
The number of packets send in a measurement execution. Value must be between 1 and 16. Default is 3
[ping] size (integer: int64)
size of the data part of the packet, i.e. excluding any IP and ICMP headers. Value must be between 1 and 2048
[ping] packet_interval (integer: int64)
Time between packets in milliseconds. Value must be between 2 and 300000
[ping] include_probe_id (boolean)
Include the probe ID (encoded as ASCII digits) as part of the payload
[traceroute] port (integer: int64)
The target port number (TCP only). Defaults to 80
[traceroute] packets (integer: int64)
The number of packets send in a measurement execution. Value must be between 1 and 16. Default is 3
[traceroute] first_hop (integer: int64)
TTL (time to live) of the first hop
[traceroute] max_hops (integer: int64)
Traceroute measurement stops after the hop at which the TTL reaches this value
[traceroute] paris (integer: int64)
The number of paris traceroute variations to try. Zero disables paris traceroute. Value must be between 0 and 64
[traceroute] size (integer: int64)
size of the data part of the packet, i.e. excluding any IP, ICMP, UDP or TCP headers. Value must be between 0 and 2048
[traceroute] protocol (string)
[
"ICMP",
"UDP",
"TCP"
] Protocol used in measurement
[traceroute] response_timeout (integer: int64)
Response timeout for one packet
[traceroute] duplicate_timeout (integer: int64)
Time to wait (in milliseconds) for a duplicate response after receiving the first response
[traceroute] hop_by_hop_option_size (integer: int64)
Size of an IPv6 hop-by-hop option header filled with NOPs
[traceroute] destination_option_size (integer: int64)
Size of an IPv6 destination option header filled with NOPs
[traceroute] dont_fragment (boolean)
Do not fragment outgoing packets
[traceroute] traffic_class (integer: int64)
The traffic class (IPv6) or type of service and precedence (IPv4) value
[traceroute] gap_limit (integer: int64)
Number of unresponsive hops before the traceroute measurement is stopped
[dns] udp_payload_size (integer: int64)
Set the EDNS0 option for UDP payload size to this value, between 512 and 4096.Defaults to 512)
[dns] use_probe_resolver (boolean)
Send the DNS query to the probe's local resolvers (instead of an explicitly specified target)
[dns] set_rd_bit (boolean)
Indicates Recursion Desired bit was set
[dns] prepend_probe_id (boolean)
Each probe prepends its probe number and a timestamp to the DNS query argument to make it unique
[dns] protocol (string)
[
"UDP",
"TCP"
] Protocol used in measurement. Defaults to UDP
[dns] retry (integer: int64)
Number of times to retry
[dns] include_qbuf (boolean)
include the raw DNS query data in the result. Defaults to false
[dns] set_nsid_bit (boolean)
Indicates Name Server Identifier (RFC5001) was set
[dns] include_abuf (boolean)
include the raw DNS answer data in the result. Defaults to true
[dns] query_class (string)
[
"IN",
"CHAOS"
] The `class` part of the query used in the measurement
[dns] query_argument (string)
The `argument` part of the query used in the measurement
[dns] query_type (string)
[
"A",
"AAAA",
"ANY",
"CNAME",
"DNSKEY",
"DS",
"MX",
"NS",
"NSEC",
"PTR",
"RRSIG",
"SOA",
"TXT",
"SRV",
"NAPTR",
"TLSA"
] The `type` part of the query used in the measurement
[dns] set_cd_bit (boolean)
Indicates DNSSEC Checking Disabled (RFC4035) was set
[dns] set_do_bit (boolean)
Indicates DNSSEC OK (RFC3225) was set
[dns] use_macros (boolean)
Allow the use of $p (probe ID), $r (random 16-digit hex string) and $t (timestamp) in the query_argument
[dns] timeout (integer: int64)
Timeout in milliseconds (default: 5000)
[dns] tls (boolean)
Enable DNS over Transport Layer Security (RFC7858)
[dns] port (integer: int64)
UDP or TCP port, if not specified defaults to port 53 or to port 853 for DNS-over-TLS
[dns] default_client_subnet (boolean)
Enable an EDNS Client Subnet (RFC7871) of 0.0.0.0/0 0 or ::/0
[dns] cookies (boolean)
Insert client cookie in requests and process server cookies
[dns] ttl (boolean)
Report the IP time-to-live field (hop limit for IPv6) of DNS reply packets received (only for UDP)
[dns] set_ad_bit (boolean)
Indicates Authenticated Data (RFC3655) was set
[http] extended_timing (boolean)
Enable time-to-resolve, time-to-connect and time-to-first-byte measurements
[http] more_extended_timing (boolean)
Include fields added by extended_timing and adds readtiming which reports for each read system call when it happened and how much data was delivered
[http] header_bytes (integer: int64)
Maximum number of bytes in the reponse header, defaults to 0
[http] method (string)
[
"GET",
"POST",
"HEAD"
] http verb of the measurement request
[http] path (string)
Path of the requested URL
[http] query_string (string)
Optional query parameters of the requested URL
[http] user_agent (string)
[
"RIPE Atlas: https://atlas.ripe.net/"
] user agent header field sent in the http request. Always set to 'RIPE Atlas: https//atlas.ripe.net'
[http] max_bytes_read (integer: int64)
[http] version (string)
[
"1.0",
"1.1"
] http version of measurement request
[http] port (integer: int64)
The target port number Defaults to 80 (HTTP) or 443 (HTTPS)
[http] host (string)
Value for the Host header if different than the target
[http] https (boolean)
Use HTTPS instead of plaintext HTTP
[ntp] packets (integer: int64)
The number of packets send in a measurement execution. Value must be between 1 and 16. Default is 3
[ntp] timeout (integer: int64)
Per packet timeout in milliseconds
[ntp] size (integer: int64)
size of the data part of the packet, i.e. excluding any headers. Value must be between 28 and 1184, and a multiple of 4
[sslcert] port (integer: int64)
The target port number. Defaults to 443
[sslcert] hostname (string)
Server Name Indication (SNI) hostname
[wifi] ipv4 (boolean)
Indicates IPv4 measurements are attempted in this group
[wifi] ipv6 (boolean)
Indicates IPv6 measurements are attempted in this group
[wifi] cert (string)
Certificate in PEM format
[wifi] extra_wait (integer: int64)
Wait this amount of time before executing measurement commands.
[wifi] ssid (string)
[
"eduroam",
"guestnet",
"ripemtg-2.4-74",
"ripemtg-nat64-2.4-74",
"phicoh-test-2.4"
] Wifi SSID to connect to. Max. 32 characters
[wifi] key_mgmt (string)
[
"WPA-PSK",
"WPA-EAP"
] Authentication mechanism used for the wifi connection. For WPA-PSK `psk` field is also required,for WPA-EAP `eap` and `password` fields are required
[wifi] eap (string)
[
"TTLS",
"PEAP"
] Extensible Authentication Protocol type. Currently only `TTLS` is available
[wifi] identity (string)
Username used for wifi connection. Used for both outer and inner connection if anonymous_identity is omitted
[wifi] anonymous_identity (string)
Username used for outer connection. If omitted the `identity` field is used for the outer connection
[wifi] phase2 (string)
[
"auth=EAP-MSCHAPV2",
"auth=MSCHAPV2",
"auth=PAP"
] Connection and Authentication directives for the inner connection. Only used for WPA-EAP. Currently only EAP-MSCHAPv2 is available
[wifi] rssi (boolean)
Indicates that BSSID radio signal strength will be measured and stored
GET /api/v2/measurements/my/
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
measurements (array)
ids of the created measurements
Response
measurements (array)
ids of the created measurements
GET /api/v2/measurements/ping/ Retrieve a list of ping measurements
Retrieve a list of ping measurements
Parameters
query parameters
sort (enum)
Sort the results based on certain field values. Sort directives beginning with '-' imply a descending/reversed sort order.
[id,-id,start_time,-start_time,stop_time,-stop_time,is_oneoff,-is_oneoff,interval,-interval,type,-type,af,-af,status.name,-status.name,status.id,-status.id]
id__lt (string)
filter on id being less than value
id__lte (string)
filter on id being less than or equal to value.
id__gt (string)
filter on id being greater than value.
id__gte (string)
filter on id being greater than or equal to value.
id__in (string)
filter on ID being one of a comma-separated list
id (string)
filter on ID being one of a comma-separated list
start_time (number)
filter on start time (as a unixtime timestamp) of scheduled measurement.
start_time__lt (number)
filter on start time being less than the value (before).
start_time__lte (number)
filter on start time being less than or equal to the value (before).
start_time__gt (number)
filter on start time being greater than the value (after).
start_time__gte (number)
filter on start time being greater than or equal to the value (after).
stop_time (number)
filter on stop time (as a unixtime timestamp) of scheduled measurement.
stop_time__lt (number)
filter on stop time being less than the value (before).
stop_time__lte (number)
filter on stop time being less than or equal to the value (before).
stop_time__gt (number)
filter on stop time being greater than (after) the value. If the given value is in the past then ongoing measurements will be included.
stop_time__gte (number)
filter on stop time being greater than (after) or equal to the value. If the given value is in the past then ongoing measurements will be included.
is_public (boolean)
return only publicly available measurements.
is_oneoff (boolean)
return only one-off measurements.
interval (string)
filter on the interval matching the value.
interval__lt (string)
filter on the interval being less than value.
interval__lte (string)
filter on the interval being less than or equal to value.
interval__gt (string)
filter on the interval being greater than value.
interval__gte (string)
filter on the interval being greater than or equal to value.
status (string)
filter on the status of the measurement. Multiple statuses are specified as comma-separated values. (0: Specified, 1: Scheduled, 2: Ongoing, 4: Stopped, 5: Forced to stop, 6: No suitable probes, 7: Failed, 8: Archived)
status__in (string)
filter on the status of the measurement. Multiple statuses are specified as comma-separated values. (0: Specified, 1: Scheduled, 2: Ongoing, 4: Stopped, 5: Forced to stop, 6: No suitable probes, 7: Failed, 8: Archived)
tags (string)
filter on list of tags
type (string)
return all measurements of type value, one of `ping`,'traceroute`, 'dns`, `http`, `sslcert`, `ntp`
target_ip (string)
filter on the exact or more specific target IP address
current_probes (string)
filter by the ID of a probe currently participating in this measurement
participant_logs_probes (string)
filter by the ID of the probes that were selected by participation requests for this measurement (100 probes max)
target_asn (string)
filter on the ASN seen to be routing the target's IP address
target (string)
filter on the exact target FQDN (or target ip if fqdn is not available)
target__contains (string)
filter on the target URL containing the value.
target__startswith (string)
filter on the target hostname starting with value.
target__endswith (string)
filter on the target hostname ending with value.
description (string)
filter on the exact description
description__contains (string)
filter on the description containing the value.
description__startswith (string)
filter on the description starting with value.
description__endswith (string)
filter on the description ending with value.
af (string)
return only the fields containing either IPv4 or IPv6 measurements. (4 - IPv4, 6 - IPv6)
search (string)
filter on description (for DNS measurements) or target (other measurements) for containing value.
protocol (string)
filter on the protocol for the measurement, works only it conjunction with type=dns|traceroute.
group_id (string)
Filter by group ID
group (string)
[deprecated, use group_id] Filter by group ID
favourite (boolean)
only return favourited measurements
hidden (boolean)
only return hidden measurements (by default they will be excluded)
page (number)
Filter on page number. The maximum number of results returned is 10000.
page_size (number)
Set the number of measurements returned on one page. Maximum size is 500, default is 50.
after (string)
Used to get the next page of results when the maximum page number has been reached
format (enum)
Choose between available output formats (api, json, jsonp, txt)
[api,json,jsonp,txt]
callback (string)
Specifies a callback function name for a 'JSONP' response
optional_fields (enum)
Include additional fields named in comma-separated values in response.
[participation_requests,participant_logs,current_probes,is_active,probe_sources,probes]
fields (string)
Return fields named in comma-separated values in response, in addition to 'type' and 'id' which are always present. Optional fields can be listed here also.
format[datetime] (string)
Output datetimes in ISO-8601 format ('iso-8601' or 'json') or as seconds since the epoch ('unix')
key (string)
An API key to be used to authorize this request
mine (boolean)
passing in mine=true will return only the measurements of the logged in user
Response
is_public (boolean)
Indicates this measurement is publicly available; may be changed from false to true, but not from true to false
description (string)
User-defined description of the measurement
id (integer: int64)
The unique identifier that RIPE Atlas assigned to this measurement
result (string)
The URL that contains the results of this measurement
group_id (integer: int64)
The ID of the measurement group. This ID references a measurement acting as group master
af (integer: int32)
[
4,
6
] [Not for wifi] IPv4 of IPv6 Address family of the measurement
is_oneoff (boolean)
Indicates this is a one-off or a recurring measurement
spread (integer: int64)
Distribution of probes' measurements throughout the interval (default is half the interval, maximum 400 seconds)
resolve_on_probe (boolean)
Indicates that a name should be resolved (using DNS) on the probe. Otherwise it will be resolved on the RIPE Atlas servers
start_time (string: date-time)
Configured start time (as a unix timestamp)
stop_time (string: date-time)
Actual end time of measurement (as a unix timestamp)
type (string)
[
"ping",
"traceroute",
"dns",
"sslcert",
"http",
"ntp",
"wifi"
] The type of the measurement
status (measurement status)
Current status of the measurement. Status can be: Specified, Scheduled, Ongoing, Stopped, Requested to stop, Forced to stop, No suitable probes, Failed or Archived
is_all_scheduled (boolean)
Indicates if all probe requests have made it through the scheduling process
participant_count (integer: int64)
Number of participating probes
target_asn (integer: int64)
The number of the Autonomous System the IP address of the target belongs to
target_prefix (string)
Enclosing prefix of the IP address of the target
target_ip (string)
The IP Address of the target of the measurement
creation_time (string: date-time)
The creation date and time of the measurement (Defaults to unix timestamp format)
in_wifi_group (boolean)
Indicates this measurement belongs to a wifi measurement group
resolved_ips (string)
The list of IP addresses returned for the fqdn in the `target` field by the backend infra-structure resolvers
probes_requested (integer: int64)
Number of probes requested, but not necessarily granted to this measurement
probes_scheduled (integer: int64)
Number of probes actually scheduled for this measurement
group (string)
The API URL of the measurement group.
probes (array)
probes involved in this measurement
estimated_results_per_day (string)
estimated RIPE Atlas credits consumed by this measurement per day
credits_per_result (integer: int64)
probe_sources (array)
participation_requests (array)
tags (string)
Array of tags to apply to the measurement
packets (integer: int64)
The number of packets send in a measurement execution. Value must be between 1 and 16. Default is 3
size (integer: int64)
size of the data part of the packet, i.e. excluding any IP and ICMP headers. Value must be between 1 and 2048
packet_interval (integer: int64)
Time between packets in milliseconds. Value must be between 2 and 300000
include_probe_id (boolean)
Include the probe ID (encoded as ASCII digits) as part of the payload
target (string)
The FQDN (if it was requested) or the ip address of the target of this measurement
interval (integer: int64)
Interval between samples from a single probe. Defaults to 240 seconds.
GET /api/v2/measurements/ping/
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
measurements (array)
ids of the created measurements
Response
measurements (array)
ids of the created measurements
GET /api/v2/measurements/traceroute/ Retrieve a list of traceroute measurements
Retrieve a list of traceroute measurements
Parameters
query parameters
sort (enum)
Sort the results based on certain field values. Sort directives beginning with '-' imply a descending/reversed sort order.
[id,-id,start_time,-start_time,stop_time,-stop_time,is_oneoff,-is_oneoff,interval,-interval,type,-type,af,-af,status.name,-status.name,status.id,-status.id]
id__lt (string)
filter on id being less than value
id__lte (string)
filter on id being less than or equal to value.
id__gt (string)
filter on id being greater than value.
id__gte (string)
filter on id being greater than or equal to value.
id__in (string)
filter on ID being one of a comma-separated list
id (string)
filter on ID being one of a comma-separated list
start_time (number)
filter on start time (as a unixtime timestamp) of scheduled measurement.
start_time__lt (number)
filter on start time being less than the value (before).
start_time__lte (number)
filter on start time being less than or equal to the value (before).
start_time__gt (number)
filter on start time being greater than the value (after).
start_time__gte (number)
filter on start time being greater than or equal to the value (after).
stop_time (number)
filter on stop time (as a unixtime timestamp) of scheduled measurement.
stop_time__lt (number)
filter on stop time being less than the value (before).
stop_time__lte (number)
filter on stop time being less than or equal to the value (before).
stop_time__gt (number)
filter on stop time being greater than (after) the value. If the given value is in the past then ongoing measurements will be included.
stop_time__gte (number)
filter on stop time being greater than (after) or equal to the value. If the given value is in the past then ongoing measurements will be included.
is_public (boolean)
return only publicly available measurements.
is_oneoff (boolean)
return only one-off measurements.
interval (string)
filter on the interval matching the value.
interval__lt (string)
filter on the interval being less than value.
interval__lte (string)
filter on the interval being less than or equal to value.
interval__gt (string)
filter on the interval being greater than value.
interval__gte (string)
filter on the interval being greater than or equal to value.
status (string)
filter on the status of the measurement. Multiple statuses are specified as comma-separated values. (0: Specified, 1: Scheduled, 2: Ongoing, 4: Stopped, 5: Forced to stop, 6: No suitable probes, 7: Failed, 8: Archived)
status__in (string)
filter on the status of the measurement. Multiple statuses are specified as comma-separated values. (0: Specified, 1: Scheduled, 2: Ongoing, 4: Stopped, 5: Forced to stop, 6: No suitable probes, 7: Failed, 8: Archived)
tags (string)
filter on list of tags
type (string)
return all measurements of type value, one of `ping`,'traceroute`, 'dns`, `http`, `sslcert`, `ntp`
target_ip (string)
filter on the exact or more specific target IP address
current_probes (string)
filter by the ID of a probe currently participating in this measurement
participant_logs_probes (string)
filter by the ID of the probes that were selected by participation requests for this measurement (100 probes max)
target_asn (string)
filter on the ASN seen to be routing the target's IP address
target (string)
filter on the exact target FQDN (or target ip if fqdn is not available)
target__contains (string)
filter on the target URL containing the value.
target__startswith (string)
filter on the target hostname starting with value.
target__endswith (string)
filter on the target hostname ending with value.
description (string)
filter on the exact description
description__contains (string)
filter on the description containing the value.
description__startswith (string)
filter on the description starting with value.
description__endswith (string)
filter on the description ending with value.
af (string)
return only the fields containing either IPv4 or IPv6 measurements. (4 - IPv4, 6 - IPv6)
search (string)
filter on description (for DNS measurements) or target (other measurements) for containing value.
protocol (string)
filter on the protocol for the measurement, works only it conjunction with type=dns|traceroute.
group_id (string)
Filter by group ID
group (string)
[deprecated, use group_id] Filter by group ID
favourite (boolean)
only return favourited measurements
hidden (boolean)
only return hidden measurements (by default they will be excluded)
page (number)
Filter on page number. The maximum number of results returned is 10000.
page_size (number)
Set the number of measurements returned on one page. Maximum size is 500, default is 50.
after (string)
Used to get the next page of results when the maximum page number has been reached
format (enum)
Choose between available output formats (api, json, jsonp, txt)
[api,json,jsonp,txt]
callback (string)
Specifies a callback function name for a 'JSONP' response
optional_fields (enum)
Include additional fields named in comma-separated values in response.
[participation_requests,participant_logs,current_probes,is_active,probe_sources,probes]
fields (string)
Return fields named in comma-separated values in response, in addition to 'type' and 'id' which are always present. Optional fields can be listed here also.
format[datetime] (string)
Output datetimes in ISO-8601 format ('iso-8601' or 'json') or as seconds since the epoch ('unix')
key (string)
An API key to be used to authorize this request
mine (boolean)
passing in mine=true will return only the measurements of the logged in user
Response
is_public (boolean)
Indicates this measurement is publicly available; may be changed from false to true, but not from true to false
description (string)
User-defined description of the measurement
id (integer: int64)
The unique identifier that RIPE Atlas assigned to this measurement
result (string)
The URL that contains the results of this measurement
group_id (integer: int64)
The ID of the measurement group. This ID references a measurement acting as group master
af (integer: int32)
[
4,
6
] [Not for wifi] IPv4 of IPv6 Address family of the measurement
is_oneoff (boolean)
Indicates this is a one-off or a recurring measurement
spread (integer: int64)
Distribution of probes' measurements throughout the interval (default is half the interval, maximum 400 seconds)
resolve_on_probe (boolean)
Indicates that a name should be resolved (using DNS) on the probe. Otherwise it will be resolved on the RIPE Atlas servers
start_time (string: date-time)
Configured start time (as a unix timestamp)
stop_time (string: date-time)
Actual end time of measurement (as a unix timestamp)
type (string)
[
"ping",
"traceroute",
"dns",
"sslcert",
"http",
"ntp",
"wifi"
] The type of the measurement
status (measurement status)
Current status of the measurement. Status can be: Specified, Scheduled, Ongoing, Stopped, Requested to stop, Forced to stop, No suitable probes, Failed or Archived
is_all_scheduled (boolean)
Indicates if all probe requests have made it through the scheduling process
participant_count (integer: int64)
Number of participating probes
target_asn (integer: int64)
The number of the Autonomous System the IP address of the target belongs to
target_prefix (string)
Enclosing prefix of the IP address of the target
target_ip (string)
The IP Address of the target of the measurement
creation_time (string: date-time)
The creation date and time of the measurement (Defaults to unix timestamp format)
in_wifi_group (boolean)
Indicates this measurement belongs to a wifi measurement group
resolved_ips (string)
The list of IP addresses returned for the fqdn in the `target` field by the backend infra-structure resolvers
probes_requested (integer: int64)
Number of probes requested, but not necessarily granted to this measurement
probes_scheduled (integer: int64)
Number of probes actually scheduled for this measurement
group (string)
The API URL of the measurement group.
probes (array)
probes involved in this measurement
estimated_results_per_day (string)
estimated RIPE Atlas credits consumed by this measurement per day
credits_per_result (integer: int64)
probe_sources (array)
participation_requests (array)
tags (string)
Array of tags to apply to the measurement
port (integer: int64)
The target port number (TCP only). Defaults to 80
packets (integer: int64)
The number of packets send in a measurement execution. Value must be between 1 and 16. Default is 3
first_hop (integer: int64)
TTL (time to live) of the first hop
max_hops (integer: int64)
Traceroute measurement stops after the hop at which the TTL reaches this value
paris (integer: int64)
The number of paris traceroute variations to try. Zero disables paris traceroute. Value must be between 0 and 64
size (integer: int64)
size of the data part of the packet, i.e. excluding any IP, ICMP, UDP or TCP headers. Value must be between 0 and 2048
protocol (string)
[
"ICMP",
"UDP",
"TCP"
] Protocol used in measurement
response_timeout (integer: int64)
Response timeout for one packet
duplicate_timeout (integer: int64)
Time to wait (in milliseconds) for a duplicate response after receiving the first response
hop_by_hop_option_size (integer: int64)
Size of an IPv6 hop-by-hop option header filled with NOPs
destination_option_size (integer: int64)
Size of an IPv6 destination option header filled with NOPs
dont_fragment (boolean)
Do not fragment outgoing packets
traffic_class (integer: int64)
The traffic class (IPv6) or type of service and precedence (IPv4) value
gap_limit (integer: int64)
Number of unresponsive hops before the traceroute measurement is stopped
target (string)
The FQDN (if it was requested) or the ip address of the target of this measurement
interval (integer: int64)
Interval between samples from a single probe. Defaults to 900 seconds.
GET /api/v2/measurements/traceroute/
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
measurements (array)
ids of the created measurements
Response
measurements (array)
ids of the created measurements
GET /api/v2/measurements/sslcert/ Retrieve a list of SSL certificate measurements
Retrieve a list of SSL certificate measurements
Parameters
query parameters
sort (enum)
Sort the results based on certain field values. Sort directives beginning with '-' imply a descending/reversed sort order.
[id,-id,start_time,-start_time,stop_time,-stop_time,is_oneoff,-is_oneoff,interval,-interval,type,-type,af,-af,status.name,-status.name,status.id,-status.id]
id__lt (string)
filter on id being less than value
id__lte (string)
filter on id being less than or equal to value.
id__gt (string)
filter on id being greater than value.
id__gte (string)
filter on id being greater than or equal to value.
id__in (string)
filter on ID being one of a comma-separated list
id (string)
filter on ID being one of a comma-separated list
start_time (number)
filter on start time (as a unixtime timestamp) of scheduled measurement.
start_time__lt (number)
filter on start time being less than the value (before).
start_time__lte (number)
filter on start time being less than or equal to the value (before).
start_time__gt (number)
filter on start time being greater than the value (after).
start_time__gte (number)
filter on start time being greater than or equal to the value (after).
stop_time (number)
filter on stop time (as a unixtime timestamp) of scheduled measurement.
stop_time__lt (number)
filter on stop time being less than the value (before).
stop_time__lte (number)
filter on stop time being less than or equal to the value (before).
stop_time__gt (number)
filter on stop time being greater than (after) the value. If the given value is in the past then ongoing measurements will be included.
stop_time__gte (number)
filter on stop time being greater than (after) or equal to the value. If the given value is in the past then ongoing measurements will be included.
is_public (boolean)
return only publicly available measurements.
is_oneoff (boolean)
return only one-off measurements.
interval (string)
filter on the interval matching the value.
interval__lt (string)
filter on the interval being less than value.
interval__lte (string)
filter on the interval being less than or equal to value.
interval__gt (string)
filter on the interval being greater than value.
interval__gte (string)
filter on the interval being greater than or equal to value.
status (string)
filter on the status of the measurement. Multiple statuses are specified as comma-separated values. (0: Specified, 1: Scheduled, 2: Ongoing, 4: Stopped, 5: Forced to stop, 6: No suitable probes, 7: Failed, 8: Archived)
status__in (string)
filter on the status of the measurement. Multiple statuses are specified as comma-separated values. (0: Specified, 1: Scheduled, 2: Ongoing, 4: Stopped, 5: Forced to stop, 6: No suitable probes, 7: Failed, 8: Archived)
tags (string)
filter on list of tags
type (string)
return all measurements of type value, one of `ping`,'traceroute`, 'dns`, `http`, `sslcert`, `ntp`
target_ip (string)
filter on the exact or more specific target IP address
current_probes (string)
filter by the ID of a probe currently participating in this measurement
participant_logs_probes (string)
filter by the ID of the probes that were selected by participation requests for this measurement (100 probes max)
target_asn (string)
filter on the ASN seen to be routing the target's IP address
target (string)
filter on the exact target FQDN (or target ip if fqdn is not available)
target__contains (string)
filter on the target URL containing the value.
target__startswith (string)
filter on the target hostname starting with value.
target__endswith (string)
filter on the target hostname ending with value.
description (string)
filter on the exact description
description__contains (string)
filter on the description containing the value.
description__startswith (string)
filter on the description starting with value.
description__endswith (string)
filter on the description ending with value.
af (string)
return only the fields containing either IPv4 or IPv6 measurements. (4 - IPv4, 6 - IPv6)
search (string)
filter on description (for DNS measurements) or target (other measurements) for containing value.
protocol (string)
filter on the protocol for the measurement, works only it conjunction with type=dns|traceroute.
group_id (string)
Filter by group ID
group (string)
[deprecated, use group_id] Filter by group ID
favourite (boolean)
only return favourited measurements
hidden (boolean)
only return hidden measurements (by default they will be excluded)
page (number)
Filter on page number. The maximum number of results returned is 10000.
page_size (number)
Set the number of measurements returned on one page. Maximum size is 500, default is 50.
after (string)
Used to get the next page of results when the maximum page number has been reached
format (enum)
Choose between available output formats (api, json, jsonp, txt)
[api,json,jsonp,txt]
callback (string)
Specifies a callback function name for a 'JSONP' response
optional_fields (enum)
Include additional fields named in comma-separated values in response.
[participation_requests,participant_logs,current_probes,is_active,probe_sources,probes]
fields (string)
Return fields named in comma-separated values in response, in addition to 'type' and 'id' which are always present. Optional fields can be listed here also.
format[datetime] (string)
Output datetimes in ISO-8601 format ('iso-8601' or 'json') or as seconds since the epoch ('unix')
key (string)
An API key to be used to authorize this request
mine (boolean)
passing in mine=true will return only the measurements of the logged in user
Response
is_public (boolean)
Indicates this measurement is publicly available; may be changed from false to true, but not from true to false
description (string)
User-defined description of the measurement
id (integer: int64)
The unique identifier that RIPE Atlas assigned to this measurement
result (string)
The URL that contains the results of this measurement
group_id (integer: int64)
The ID of the measurement group. This ID references a measurement acting as group master
af (integer: int32)
[
4,
6
] [Not for wifi] IPv4 of IPv6 Address family of the measurement
is_oneoff (boolean)
Indicates this is a one-off or a recurring measurement
spread (integer: int64)
Distribution of probes' measurements throughout the interval (default is half the interval, maximum 400 seconds)
resolve_on_probe (boolean)
Indicates that a name should be resolved (using DNS) on the probe. Otherwise it will be resolved on the RIPE Atlas servers
start_time (string: date-time)
Configured start time (as a unix timestamp)
stop_time (string: date-time)
Actual end time of measurement (as a unix timestamp)
type (string)
[
"ping",
"traceroute",
"dns",
"sslcert",
"http",
"ntp",
"wifi"
] The type of the measurement
status (measurement status)
Current status of the measurement. Status can be: Specified, Scheduled, Ongoing, Stopped, Requested to stop, Forced to stop, No suitable probes, Failed or Archived
is_all_scheduled (boolean)
Indicates if all probe requests have made it through the scheduling process
participant_count (integer: int64)
Number of participating probes
target_asn (integer: int64)
The number of the Autonomous System the IP address of the target belongs to
target_prefix (string)
Enclosing prefix of the IP address of the target
target_ip (string)
The IP Address of the target of the measurement
creation_time (string: date-time)
The creation date and time of the measurement (Defaults to unix timestamp format)
in_wifi_group (boolean)
Indicates this measurement belongs to a wifi measurement group
resolved_ips (string)
The list of IP addresses returned for the fqdn in the `target` field by the backend infra-structure resolvers
probes_requested (integer: int64)
Number of probes requested, but not necessarily granted to this measurement
probes_scheduled (integer: int64)
Number of probes actually scheduled for this measurement
group (string)
The API URL of the measurement group.
probes (array)
probes involved in this measurement
estimated_results_per_day (string)
estimated RIPE Atlas credits consumed by this measurement per day
credits_per_result (integer: int64)
probe_sources (array)
participation_requests (array)
tags (string)
Array of tags to apply to the measurement
port (integer: int64)
The target port number. Defaults to 443
hostname (string)
Server Name Indication (SNI) hostname
target (string)
The FQDN (if it was requested) or the ip address of the target of this measurement
interval (integer: int64)
Interval between samples from a single probe. Defaults to 900 seconds.
GET /api/v2/measurements/sslcert/
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
measurements (array)
ids of the created measurements
Response
measurements (array)
ids of the created measurements
GET /api/v2/measurements/ntp/ Retrieve a list of NTP measurements
Retrieve a list of NTP measurements
Parameters
query parameters
sort (enum)
Sort the results based on certain field values. Sort directives beginning with '-' imply a descending/reversed sort order.
[id,-id,start_time,-start_time,stop_time,-stop_time,is_oneoff,-is_oneoff,interval,-interval,type,-type,af,-af,status.name,-status.name,status.id,-status.id]
id__lt (string)
filter on id being less than value
id__lte (string)
filter on id being less than or equal to value.
id__gt (string)
filter on id being greater than value.
id__gte (string)
filter on id being greater than or equal to value.
id__in (string)
filter on ID being one of a comma-separated list
id (string)
filter on ID being one of a comma-separated list
start_time (number)
filter on start time (as a unixtime timestamp) of scheduled measurement.
start_time__lt (number)
filter on start time being less than the value (before).
start_time__lte (number)
filter on start time being less than or equal to the value (before).
start_time__gt (number)
filter on start time being greater than the value (after).
start_time__gte (number)
filter on start time being greater than or equal to the value (after).
stop_time (number)
filter on stop time (as a unixtime timestamp) of scheduled measurement.
stop_time__lt (number)
filter on stop time being less than the value (before).
stop_time__lte (number)
filter on stop time being less than or equal to the value (before).
stop_time__gt (number)
filter on stop time being greater than (after) the value. If the given value is in the past then ongoing measurements will be included.
stop_time__gte (number)
filter on stop time being greater than (after) or equal to the value. If the given value is in the past then ongoing measurements will be included.
is_public (boolean)
return only publicly available measurements.
is_oneoff (boolean)
return only one-off measurements.
interval (string)
filter on the interval matching the value.
interval__lt (string)
filter on the interval being less than value.
interval__lte (string)
filter on the interval being less than or equal to value.
interval__gt (string)
filter on the interval being greater than value.
interval__gte (string)
filter on the interval being greater than or equal to value.
status (string)
filter on the status of the measurement. Multiple statuses are specified as comma-separated values. (0: Specified, 1: Scheduled, 2: Ongoing, 4: Stopped, 5: Forced to stop, 6: No suitable probes, 7: Failed, 8: Archived)
status__in (string)
filter on the status of the measurement. Multiple statuses are specified as comma-separated values. (0: Specified, 1: Scheduled, 2: Ongoing, 4: Stopped, 5: Forced to stop, 6: No suitable probes, 7: Failed, 8: Archived)
tags (string)
filter on list of tags
type (string)
return all measurements of type value, one of `ping`,'traceroute`, 'dns`, `http`, `sslcert`, `ntp`
target_ip (string)
filter on the exact or more specific target IP address
current_probes (string)
filter by the ID of a probe currently participating in this measurement
participant_logs_probes (string)
filter by the ID of the probes that were selected by participation requests for this measurement (100 probes max)
target_asn (string)
filter on the ASN seen to be routing the target's IP address
target (string)
filter on the exact target FQDN (or target ip if fqdn is not available)
target__contains (string)
filter on the target URL containing the value.
target__startswith (string)
filter on the target hostname starting with value.
target__endswith (string)
filter on the target hostname ending with value.
description (string)
filter on the exact description
description__contains (string)
filter on the description containing the value.
description__startswith (string)
filter on the description starting with value.
description__endswith (string)
filter on the description ending with value.
af (string)
return only the fields containing either IPv4 or IPv6 measurements. (4 - IPv4, 6 - IPv6)
search (string)
filter on description (for DNS measurements) or target (other measurements) for containing value.
protocol (string)
filter on the protocol for the measurement, works only it conjunction with type=dns|traceroute.
group_id (string)
Filter by group ID
group (string)
[deprecated, use group_id] Filter by group ID
favourite (boolean)
only return favourited measurements
hidden (boolean)
only return hidden measurements (by default they will be excluded)
page (number)
Filter on page number. The maximum number of results returned is 10000.
page_size (number)
Set the number of measurements returned on one page. Maximum size is 500, default is 50.
after (string)
Used to get the next page of results when the maximum page number has been reached
format (enum)
Choose between available output formats (api, json, jsonp, txt)
[api,json,jsonp,txt]
callback (string)
Specifies a callback function name for a 'JSONP' response
optional_fields (enum)
Include additional fields named in comma-separated values in response.
[participation_requests,participant_logs,current_probes,is_active,probe_sources,probes]
fields (string)
Return fields named in comma-separated values in response, in addition to 'type' and 'id' which are always present. Optional fields can be listed here also.
format[datetime] (string)
Output datetimes in ISO-8601 format ('iso-8601' or 'json') or as seconds since the epoch ('unix')
key (string)
An API key to be used to authorize this request
mine (boolean)
passing in mine=true will return only the measurements of the logged in user
Response
is_public (boolean)
Indicates this measurement is publicly available; may be changed from false to true, but not from true to false
description (string)
User-defined description of the measurement
id (integer: int64)
The unique identifier that RIPE Atlas assigned to this measurement
result (string)
The URL that contains the results of this measurement
group_id (integer: int64)
The ID of the measurement group. This ID references a measurement acting as group master
af (integer: int32)
[
4,
6
] [Not for wifi] IPv4 of IPv6 Address family of the measurement
is_oneoff (boolean)
Indicates this is a one-off or a recurring measurement
spread (integer: int64)
Distribution of probes' measurements throughout the interval (default is half the interval, maximum 400 seconds)
resolve_on_probe (boolean)
Indicates that a name should be resolved (using DNS) on the probe. Otherwise it will be resolved on the RIPE Atlas servers
start_time (string: date-time)
Configured start time (as a unix timestamp)
stop_time (string: date-time)
Actual end time of measurement (as a unix timestamp)
type (string)
[
"ping",
"traceroute",
"dns",
"sslcert",
"http",
"ntp",
"wifi"
] The type of the measurement
status (measurement status)
Current status of the measurement. Status can be: Specified, Scheduled, Ongoing, Stopped, Requested to stop, Forced to stop, No suitable probes, Failed or Archived
is_all_scheduled (boolean)
Indicates if all probe requests have made it through the scheduling process
participant_count (integer: int64)
Number of participating probes
target_asn (integer: int64)
The number of the Autonomous System the IP address of the target belongs to
target_prefix (string)
Enclosing prefix of the IP address of the target
target_ip (string)
The IP Address of the target of the measurement
creation_time (string: date-time)
The creation date and time of the measurement (Defaults to unix timestamp format)
in_wifi_group (boolean)
Indicates this measurement belongs to a wifi measurement group
resolved_ips (string)
The list of IP addresses returned for the fqdn in the `target` field by the backend infra-structure resolvers
probes_requested (integer: int64)
Number of probes requested, but not necessarily granted to this measurement
probes_scheduled (integer: int64)
Number of probes actually scheduled for this measurement
group (string)
The API URL of the measurement group.
probes (array)
probes involved in this measurement
estimated_results_per_day (string)
estimated RIPE Atlas credits consumed by this measurement per day
credits_per_result (integer: int64)
probe_sources (array)
participation_requests (array)
tags (string)
Array of tags to apply to the measurement
packets (integer: int64)
The number of packets send in a measurement execution. Value must be between 1 and 16. Default is 3
timeout (integer: int64)
Per packet timeout in milliseconds
size (integer: int64)
size of the data part of the packet, i.e. excluding any headers. Value must be between 28 and 1184, and a multiple of 4
target (string)
The FQDN (if it was requested) or the ip address of the target of this measurement
interval (integer: int64)
Interval between samples from a single probe. Defaults to 1800 seconds.
GET /api/v2/measurements/ntp/
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
measurements (array)
ids of the created measurements
Response
measurements (array)
ids of the created measurements
GET /api/v2/measurements/wifi/ Retrieve a list of WiFi measurements
Retrieve a list of WiFi measurements.
Parameters
query parameters
sort (enum)
Sort the results based on certain field values. Sort directives beginning with '-' imply a descending/reversed sort order.
[id,-id,start_time,-start_time,stop_time,-stop_time,is_oneoff,-is_oneoff,interval,-interval,type,-type,af,-af,status.name,-status.name,status.id,-status.id]
id__lt (string)
filter on id being less than value
id__lte (string)
filter on id being less than or equal to value.
id__gt (string)
filter on id being greater than value.
id__gte (string)
filter on id being greater than or equal to value.
id__in (string)
filter on ID being one of a comma-separated list
id (string)
filter on ID being one of a comma-separated list
start_time (number)
filter on start time (as a unixtime timestamp) of scheduled measurement.
start_time__lt (number)
filter on start time being less than the value (before).
start_time__lte (number)
filter on start time being less than or equal to the value (before).
start_time__gt (number)
filter on start time being greater than the value (after).
start_time__gte (number)
filter on start time being greater than or equal to the value (after).
stop_time (number)
filter on stop time (as a unixtime timestamp) of scheduled measurement.
stop_time__lt (number)
filter on stop time being less than the value (before).
stop_time__lte (number)
filter on stop time being less than or equal to the value (before).
stop_time__gt (number)
filter on stop time being greater than (after) the value. If the given value is in the past then ongoing measurements will be included.
stop_time__gte (number)
filter on stop time being greater than (after) or equal to the value. If the given value is in the past then ongoing measurements will be included.
is_public (boolean)
return only publicly available measurements.
is_oneoff (boolean)
return only one-off measurements.
interval (string)
filter on the interval matching the value.
interval__lt (string)
filter on the interval being less than value.
interval__lte (string)
filter on the interval being less than or equal to value.
interval__gt (string)
filter on the interval being greater than value.
interval__gte (string)
filter on the interval being greater than or equal to value.
status (string)
filter on the status of the measurement. Multiple statuses are specified as comma-separated values. (0: Specified, 1: Scheduled, 2: Ongoing, 4: Stopped, 5: Forced to stop, 6: No suitable probes, 7: Failed, 8: Archived)
status__in (string)
filter on the status of the measurement. Multiple statuses are specified as comma-separated values. (0: Specified, 1: Scheduled, 2: Ongoing, 4: Stopped, 5: Forced to stop, 6: No suitable probes, 7: Failed, 8: Archived)
tags (string)
filter on list of tags
type (string)
return all measurements of type value, one of `ping`,'traceroute`, 'dns`, `http`, `sslcert`, `ntp`
target_ip (string)
filter on the exact or more specific target IP address
current_probes (string)
filter by the ID of a probe currently participating in this measurement
participant_logs_probes (string)
filter by the ID of the probes that were selected by participation requests for this measurement (100 probes max)
target_asn (string)
filter on the ASN seen to be routing the target's IP address
target (string)
filter on the exact target FQDN (or target ip if fqdn is not available)
target__contains (string)
filter on the target URL containing the value.
target__startswith (string)
filter on the target hostname starting with value.
target__endswith (string)
filter on the target hostname ending with value.
description (string)
filter on the exact description
description__contains (string)
filter on the description containing the value.
description__startswith (string)
filter on the description starting with value.
description__endswith (string)
filter on the description ending with value.
af (string)
return only the fields containing either IPv4 or IPv6 measurements. (4 - IPv4, 6 - IPv6)
search (string)
filter on description (for DNS measurements) or target (other measurements) for containing value.
protocol (string)
filter on the protocol for the measurement, works only it conjunction with type=dns|traceroute.
group_id (string)
Filter by group ID
group (string)
[deprecated, use group_id] Filter by group ID
favourite (boolean)
only return favourited measurements
hidden (boolean)
only return hidden measurements (by default they will be excluded)
page (number)
Filter on page number. The maximum number of results returned is 10000.
page_size (number)
Set the number of measurements returned on one page. Maximum size is 500, default is 50.
after (string)
Used to get the next page of results when the maximum page number has been reached
format (enum)
Choose between available output formats (api, json, jsonp, txt)
[api,json,jsonp,txt]
callback (string)
Specifies a callback function name for a 'JSONP' response
optional_fields (enum)
Include additional fields named in comma-separated values in response.
[participation_requests,participant_logs,current_probes,is_active,probe_sources,probes]
fields (string)
Return fields named in comma-separated values in response, in addition to 'type' and 'id' which are always present. Optional fields can be listed here also.
format[datetime] (string)
Output datetimes in ISO-8601 format ('iso-8601' or 'json') or as seconds since the epoch ('unix')
key (string)
An API key to be used to authorize this request
mine (boolean)
passing in mine=true will return only the measurements of the logged in user
Response
is_public (boolean)
Indicates this measurement is publicly available; may be changed from false to true, but not from true to false
description (string)
User-defined description of the measurement
id (integer: int64)
The unique identifier that RIPE Atlas assigned to this measurement
result (string)
The URL that contains the results of this measurement
group_id (integer: int64)
The ID of the measurement group. This ID references a measurement acting as group master
af (integer: int32)
[
4
] IPv4 of IPv6 Address family of the measurement
is_oneoff (boolean)
Indicates this is a one-off or a recurring measurement
spread (integer: int64)
Distribution of probes' measurements throughout the interval (default is half the interval, maximum 400 seconds)
resolve_on_probe (boolean)
Indicates that a name should be resolved (using DNS) on the probe. Otherwise it will be resolved on the RIPE Atlas servers
start_time (string: date-time)
Configured start time (as a unix timestamp)
stop_time (string: date-time)
Actual end time of measurement (as a unix timestamp)
type (string)
[
"ping",
"traceroute",
"dns",
"sslcert",
"http",
"ntp",
"wifi"
] The type of the measurement
status (measurement status)
Current status of the measurement. Status can be: Specified, Scheduled, Ongoing, Stopped, Requested to stop, Forced to stop, No suitable probes, Failed or Archived
is_all_scheduled (boolean)
Indicates if all probe requests have made it through the scheduling process
participant_count (integer: int64)
Number of participating probes
target_asn (integer: int64)
The number of the Autonomous System the IP address of the target belongs to
target_prefix (string)
Enclosing prefix of the IP address of the target
target_ip (string)
The IP Address of the target of the measurement
creation_time (string: date-time)
The creation date and time of the measurement (Defaults to unix timestamp format)
in_wifi_group (boolean)
Indicates this measurement belongs to a wifi measurement group
resolved_ips (string)
The list of IP addresses returned for the fqdn in the `target` field by the backend infra-structure resolvers
probes_requested (integer: int64)
Number of probes requested, but not necessarily granted to this measurement
probes_scheduled (integer: int64)
Number of probes actually scheduled for this measurement
group (string)
The API URL of the measurement group.
probes (array)
probes involved in this measurement
estimated_results_per_day (string)
estimated RIPE Atlas credits consumed by this measurement per day
credits_per_result (integer: int64)
probe_sources (array)
participation_requests (array)
tags (string)
Array of tags to apply to the measurement
ipv4 (boolean)
Indicates IPv4 measurements are attempted in this group
ipv6 (boolean)
Indicates IPv6 measurements are attempted in this group
cert (string)
Certificate in PEM format
extra_wait (integer: int64)
Wait this amount of time before executing measurement commands.
ssid (string)
[
"eduroam",
"guestnet",
"ripemtg-2.4-74",
"ripemtg-nat64-2.4-74",
"phicoh-test-2.4"
] Wifi SSID to connect to. Max. 32 characters
key_mgmt (string)
[
"WPA-PSK",
"WPA-EAP"
] Authentication mechanism used for the wifi connection. For WPA-PSK `psk` field is also required,for WPA-EAP `eap` and `password` fields are required
eap (string)
[
"TTLS",
"PEAP"
] Extensible Authentication Protocol type. Currently only `TTLS` is available
identity (string)
Username used for wifi connection. Used for both outer and inner connection if anonymous_identity is omitted
anonymous_identity (string)
Username used for outer connection. If omitted the `identity` field is used for the outer connection
phase2 (string)
[
"auth=EAP-MSCHAPV2",
"auth=MSCHAPV2",
"auth=PAP"
] Connection and Authentication directives for the inner connection. Only used for WPA-EAP. Currently only EAP-MSCHAPv2 is available
rssi (boolean)
Indicates that BSSID radio signal strength will be measured and stored
interval (integer: int64)
Interval between samples from a single probe. Defaults to 900 seconds.
GET /api/v2/measurements/wifi/
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
measurements (array)
ids of the created measurements
Response
measurements (array)
ids of the created measurements
GET /api/v2/measurements/http/ Retrieve a list of HTTP measurements
Retrieve a list of HTTP measurements
Parameters
query parameters
sort (enum)
Sort the results based on certain field values. Sort directives beginning with '-' imply a descending/reversed sort order.
[id,-id,start_time,-start_time,stop_time,-stop_time,is_oneoff,-is_oneoff,interval,-interval,type,-type,af,-af,status.name,-status.name,status.id,-status.id]
id__lt (string)
filter on id being less than value
id__lte (string)
filter on id being less than or equal to value.
id__gt (string)
filter on id being greater than value.
id__gte (string)
filter on id being greater than or equal to value.
id__in (string)
filter on ID being one of a comma-separated list
id (string)
filter on ID being one of a comma-separated list
start_time (number)
filter on start time (as a unixtime timestamp) of scheduled measurement.
start_time__lt (number)
filter on start time being less than the value (before).
start_time__lte (number)
filter on start time being less than or equal to the value (before).
start_time__gt (number)
filter on start time being greater than the value (after).
start_time__gte (number)
filter on start time being greater than or equal to the value (after).
stop_time (number)
filter on stop time (as a unixtime timestamp) of scheduled measurement.
stop_time__lt (number)
filter on stop time being less than the value (before).
stop_time__lte (number)
filter on stop time being less than or equal to the value (before).
stop_time__gt (number)
filter on stop time being greater than (after) the value. If the given value is in the past then ongoing measurements will be included.
stop_time__gte (number)
filter on stop time being greater than (after) or equal to the value. If the given value is in the past then ongoing measurements will be included.
is_public (boolean)
return only publicly available measurements.
is_oneoff (boolean)
return only one-off measurements.
interval (string)
filter on the interval matching the value.
interval__lt (string)
filter on the interval being less than value.
interval__lte (string)
filter on the interval being less than or equal to value.
interval__gt (string)
filter on the interval being greater than value.
interval__gte (string)
filter on the interval being greater than or equal to value.
status (string)
filter on the status of the measurement. Multiple statuses are specified as comma-separated values. (0: Specified, 1: Scheduled, 2: Ongoing, 4: Stopped, 5: Forced to stop, 6: No suitable probes, 7: Failed, 8: Archived)
status__in (string)
filter on the status of the measurement. Multiple statuses are specified as comma-separated values. (0: Specified, 1: Scheduled, 2: Ongoing, 4: Stopped, 5: Forced to stop, 6: No suitable probes, 7: Failed, 8: Archived)
tags (string)
filter on list of tags
type (string)
return all measurements of type value, one of `ping`,'traceroute`, 'dns`, `http`, `sslcert`, `ntp`
target_ip (string)
filter on the exact or more specific target IP address
current_probes (string)
filter by the ID of a probe currently participating in this measurement
participant_logs_probes (string)
filter by the ID of the probes that were selected by participation requests for this measurement (100 probes max)
target_asn (string)
filter on the ASN seen to be routing the target's IP address
target (string)
filter on the exact target FQDN (or target ip if fqdn is not available)
target__contains (string)
filter on the target URL containing the value.
target__startswith (string)
filter on the target hostname starting with value.
target__endswith (string)
filter on the target hostname ending with value.
description (string)
filter on the exact description
description__contains (string)
filter on the description containing the value.
description__startswith (string)
filter on the description starting with value.
description__endswith (string)
filter on the description ending with value.
af (string)
return only the fields containing either IPv4 or IPv6 measurements. (4 - IPv4, 6 - IPv6)
search (string)
filter on description (for DNS measurements) or target (other measurements) for containing value.
protocol (string)
filter on the protocol for the measurement, works only it conjunction with type=dns|traceroute.
group_id (string)
Filter by group ID
group (string)
[deprecated, use group_id] Filter by group ID
favourite (boolean)
only return favourited measurements
hidden (boolean)
only return hidden measurements (by default they will be excluded)
page (number)
Filter on page number. The maximum number of results returned is 10000.
page_size (number)
Set the number of measurements returned on one page. Maximum size is 500, default is 50.
after (string)
Used to get the next page of results when the maximum page number has been reached
format (enum)
Choose between available output formats (api, json, jsonp, txt)
[api,json,jsonp,txt]
callback (string)
Specifies a callback function name for a 'JSONP' response
optional_fields (enum)
Include additional fields named in comma-separated values in response.
[participation_requests,participant_logs,current_probes,is_active,probe_sources,probes]
fields (string)
Return fields named in comma-separated values in response, in addition to 'type' and 'id' which are always present. Optional fields can be listed here also.
format[datetime] (string)
Output datetimes in ISO-8601 format ('iso-8601' or 'json') or as seconds since the epoch ('unix')
key (string)
An API key to be used to authorize this request
mine (boolean)
passing in mine=true will return only the measurements of the logged in user
Response
is_public (boolean)
Indicates this measurement is publicly available; may be changed from false to true, but not from true to false
description (string)
User-defined description of the measurement
id (integer: int64)
The unique identifier that RIPE Atlas assigned to this measurement
result (string)
The URL that contains the results of this measurement
group_id (integer: int64)
The ID of the measurement group. This ID references a measurement acting as group master
af (integer: int32)
[
4,
6
] [Not for wifi] IPv4 of IPv6 Address family of the measurement
is_oneoff (boolean)
Indicates this is a one-off or a recurring measurement
spread (integer: int64)
Distribution of probes' measurements throughout the interval (default is half the interval, maximum 400 seconds)
resolve_on_probe (boolean)
Indicates that a name should be resolved (using DNS) on the probe. Otherwise it will be resolved on the RIPE Atlas servers
start_time (string: date-time)
Configured start time (as a unix timestamp)
stop_time (string: date-time)
Actual end time of measurement (as a unix timestamp)
type (string)
[
"ping",
"traceroute",
"dns",
"sslcert",
"http",
"ntp",
"wifi"
] The type of the measurement
status (measurement status)
Current status of the measurement. Status can be: Specified, Scheduled, Ongoing, Stopped, Requested to stop, Forced to stop, No suitable probes, Failed or Archived
is_all_scheduled (boolean)
Indicates if all probe requests have made it through the scheduling process
participant_count (integer: int64)
Number of participating probes
target_asn (integer: int64)
The number of the Autonomous System the IP address of the target belongs to
target_prefix (string)
Enclosing prefix of the IP address of the target
target_ip (string)
The IP Address of the target of the measurement
creation_time (string: date-time)
The creation date and time of the measurement (Defaults to unix timestamp format)
in_wifi_group (boolean)
Indicates this measurement belongs to a wifi measurement group
resolved_ips (string)
The list of IP addresses returned for the fqdn in the `target` field by the backend infra-structure resolvers
probes_requested (integer: int64)
Number of probes requested, but not necessarily granted to this measurement
probes_scheduled (integer: int64)
Number of probes actually scheduled for this measurement
group (string)
The API URL of the measurement group.
probes (array)
probes involved in this measurement
estimated_results_per_day (string)
estimated RIPE Atlas credits consumed by this measurement per day
credits_per_result (integer: int64)
probe_sources (array)
participation_requests (array)
tags (string)
Array of tags to apply to the measurement
extended_timing (boolean)
Enable time-to-resolve, time-to-connect and time-to-first-byte measurements
more_extended_timing (boolean)
Include fields added by extended_timing and adds readtiming which reports for each read system call when it happened and how much data was delivered
header_bytes (integer: int64)
Maximum number of bytes in the reponse header, defaults to 0
method (string)
[
"GET",
"POST",
"HEAD"
] http verb of the measurement request
path (string)
Path of the requested URL
query_string (string)
Optional query parameters of the requested URL
user_agent (string)
[
"RIPE Atlas: https://atlas.ripe.net/"
] user agent header field sent in the http request. Always set to 'RIPE Atlas: https//atlas.ripe.net'
max_bytes_read (integer: int64)
version (string)
[
"1.0",
"1.1"
] http version of measurement request
port (integer: int64)
The target port number Defaults to 80 (HTTP) or 443 (HTTPS)
host (string)
Value for the Host header if different than the target
https (boolean)
Use HTTPS instead of plaintext HTTP
target (string)
The FQDN (if it was requested) or the ip address of the target of this measurement
interval (integer: int64)
Interval between samples from a single probe. Defaults to 1800 seconds.
GET /api/v2/measurements/http/
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
measurements (array)
ids of the created measurements
Response
measurements (array)
ids of the created measurements
GET /api/v2/measurements/dns/ Retrieve a list of DNS measurements
Retrieve a list of DNS measurements
Parameters
query parameters
sort (enum)
Sort the results based on certain field values. Sort directives beginning with '-' imply a descending/reversed sort order.
[id,-id,start_time,-start_time,stop_time,-stop_time,is_oneoff,-is_oneoff,interval,-interval,type,-type,af,-af,status.name,-status.name,status.id,-status.id]
id__lt (string)
filter on id being less than value
id__lte (string)
filter on id being less than or equal to value.
id__gt (string)
filter on id being greater than value.
id__gte (string)
filter on id being greater than or equal to value.
id__in (string)
filter on ID being one of a comma-separated list
id (string)
filter on ID being one of a comma-separated list
start_time (number)
filter on start time (as a unixtime timestamp) of scheduled measurement.
start_time__lt (number)
filter on start time being less than the value (before).
start_time__lte (number)
filter on start time being less than or equal to the value (before).
start_time__gt (number)
filter on start time being greater than the value (after).
start_time__gte (number)
filter on start time being greater than or equal to the value (after).
stop_time (number)
filter on stop time (as a unixtime timestamp) of scheduled measurement.
stop_time__lt (number)
filter on stop time being less than the value (before).
stop_time__lte (number)
filter on stop time being less than or equal to the value (before).
stop_time__gt (number)
filter on stop time being greater than (after) the value. If the given value is in the past then ongoing measurements will be included.
stop_time__gte (number)
filter on stop time being greater than (after) or equal to the value. If the given value is in the past then ongoing measurements will be included.
is_public (boolean)
return only publicly available measurements.
is_oneoff (boolean)
return only one-off measurements.
interval (string)
filter on the interval matching the value.
interval__lt (string)
filter on the interval being less than value.
interval__lte (string)
filter on the interval being less than or equal to value.
interval__gt (string)
filter on the interval being greater than value.
interval__gte (string)
filter on the interval being greater than or equal to value.
status (string)
filter on the status of the measurement. Multiple statuses are specified as comma-separated values. (0: Specified, 1: Scheduled, 2: Ongoing, 4: Stopped, 5: Forced to stop, 6: No suitable probes, 7: Failed, 8: Archived)
status__in (string)
filter on the status of the measurement. Multiple statuses are specified as comma-separated values. (0: Specified, 1: Scheduled, 2: Ongoing, 4: Stopped, 5: Forced to stop, 6: No suitable probes, 7: Failed, 8: Archived)
tags (string)
filter on list of tags
type (string)
return all measurements of type value, one of `ping`,'traceroute`, 'dns`, `http`, `sslcert`, `ntp`
target_ip (string)
filter on the exact or more specific target IP address
current_probes (string)
filter by the ID of a probe currently participating in this measurement
participant_logs_probes (string)
filter by the ID of the probes that were selected by participation requests for this measurement (100 probes max)
target_asn (string)
filter on the ASN seen to be routing the target's IP address
target (string)
filter on the exact target FQDN (or target ip if fqdn is not available)
target__contains (string)
filter on the target URL containing the value.
target__startswith (string)
filter on the target hostname starting with value.
target__endswith (string)
filter on the target hostname ending with value.
description (string)
filter on the exact description
description__contains (string)
filter on the description containing the value.
description__startswith (string)
filter on the description starting with value.
description__endswith (string)
filter on the description ending with value.
af (string)
return only the fields containing either IPv4 or IPv6 measurements. (4 - IPv4, 6 - IPv6)
search (string)
filter on description (for DNS measurements) or target (other measurements) for containing value.
protocol (string)
filter on the protocol for the measurement, works only it conjunction with type=dns|traceroute.
group_id (string)
Filter by group ID
group (string)
[deprecated, use group_id] Filter by group ID
favourite (boolean)
only return favourited measurements
hidden (boolean)
only return hidden measurements (by default they will be excluded)
page (number)
Filter on page number. The maximum number of results returned is 10000.
page_size (number)
Set the number of measurements returned on one page. Maximum size is 500, default is 50.
after (string)
Used to get the next page of results when the maximum page number has been reached
format (enum)
Choose between available output formats (api, json, jsonp, txt)
[api,json,jsonp,txt]
callback (string)
Specifies a callback function name for a 'JSONP' response
optional_fields (enum)
Include additional fields named in comma-separated values in response.
[participation_requests,participant_logs,current_probes,is_active,probe_sources,probes]
fields (string)
Return fields named in comma-separated values in response, in addition to 'type' and 'id' which are always present. Optional fields can be listed here also.
format[datetime] (string)
Output datetimes in ISO-8601 format ('iso-8601' or 'json') or as seconds since the epoch ('unix')
key (string)
An API key to be used to authorize this request
mine (boolean)
passing in mine=true will return only the measurements of the logged in user
Response
is_public (boolean)
Indicates this measurement is publicly available; may be changed from false to true, but not from true to false
description (string)
User-defined description of the measurement
id (integer: int64)
The unique identifier that RIPE Atlas assigned to this measurement
result (string)
The URL that contains the results of this measurement
group_id (integer: int64)
The ID of the measurement group. This ID references a measurement acting as group master
af (integer: int32)
[
4,
6
] [Not for wifi] IPv4 of IPv6 Address family of the measurement
is_oneoff (boolean)
Indicates this is a one-off or a recurring measurement
spread (integer: int64)
Distribution of probes' measurements throughout the interval (default is half the interval, maximum 400 seconds)
resolve_on_probe (boolean)
Indicates that a name should be resolved (using DNS) on the probe. Otherwise it will be resolved on the RIPE Atlas servers
start_time (string: date-time)
Configured start time (as a unix timestamp)
stop_time (string: date-time)
Actual end time of measurement (as a unix timestamp)
type (string)
[
"ping",
"traceroute",
"dns",
"sslcert",
"http",
"ntp",
"wifi"
] The type of the measurement
status (measurement status)
Current status of the measurement. Status can be: Specified, Scheduled, Ongoing, Stopped, Requested to stop, Forced to stop, No suitable probes, Failed or Archived
is_all_scheduled (boolean)
Indicates if all probe requests have made it through the scheduling process
participant_count (integer: int64)
Number of participating probes
target_asn (integer: int64)
The number of the Autonomous System the IP address of the target belongs to
target_prefix (string)
Enclosing prefix of the IP address of the target
target_ip (string)
The IP Address of the target of the measurement
creation_time (string: date-time)
The creation date and time of the measurement (Defaults to unix timestamp format)
in_wifi_group (boolean)
Indicates this measurement belongs to a wifi measurement group
resolved_ips (string)
The list of IP addresses returned for the fqdn in the `target` field by the backend infra-structure resolvers
probes_requested (integer: int64)
Number of probes requested, but not necessarily granted to this measurement
probes_scheduled (integer: int64)
Number of probes actually scheduled for this measurement
group (string)
The API URL of the measurement group.
probes (array)
probes involved in this measurement
estimated_results_per_day (string)
estimated RIPE Atlas credits consumed by this measurement per day
credits_per_result (integer: int64)
probe_sources (array)
participation_requests (array)
tags (string)
Array of tags to apply to the measurement
udp_payload_size (integer: int64)
Set the EDNS0 option for UDP payload size to this value, between 512 and 4096.Defaults to 512)
use_probe_resolver (boolean)
Send the DNS query to the probe's local resolvers (instead of an explicitly specified target)
set_rd_bit (boolean)
Indicates Recursion Desired bit was set
prepend_probe_id (boolean)
Each probe prepends its probe number and a timestamp to the DNS query argument to make it unique
protocol (string)
[
"UDP",
"TCP"
] Protocol used in measurement. Defaults to UDP
retry (integer: int64)
Number of times to retry
include_qbuf (boolean)
include the raw DNS query data in the result. Defaults to false
set_nsid_bit (boolean)
Indicates Name Server Identifier (RFC5001) was set
include_abuf (boolean)
include the raw DNS answer data in the result. Defaults to true
query_class (string)
[
"IN",
"CHAOS"
] The `class` part of the query used in the measurement
query_argument (string)
The `argument` part of the query used in the measurement
query_type (string)
[
"A",
"AAAA",
"ANY",
"CNAME",
"DNSKEY",
"DS",
"MX",
"NS",
"NSEC",
"PTR",
"RRSIG",
"SOA",
"TXT",
"SRV",
"NAPTR",
"TLSA"
] The `type` part of the query used in the measurement
set_cd_bit (boolean)
Indicates DNSSEC Checking Disabled (RFC4035) was set
set_do_bit (boolean)
Indicates DNSSEC OK (RFC3225) was set
use_macros (boolean)
Allow the use of $p (probe ID), $r (random 16-digit hex string) and $t (timestamp) in the query_argument
timeout (integer: int64)
Timeout in milliseconds (default: 5000)
tls (boolean)
Enable DNS over Transport Layer Security (RFC7858)
port (integer: int64)
UDP or TCP port, if not specified defaults to port 53 or to port 853 for DNS-over-TLS
default_client_subnet (boolean)
Enable an EDNS Client Subnet (RFC7871) of 0.0.0.0/0 0 or ::/0
cookies (boolean)
Insert client cookie in requests and process server cookies
ttl (boolean)
Report the IP time-to-live field (hop limit for IPv6) of DNS reply packets received (only for UDP)
set_ad_bit (boolean)
Indicates Authenticated Data (RFC3655) was set
target (string)
The FQDN (if it was requested) or the ip address of the target of this measurement
interval (integer: int64)
Interval between samples from a single probe. Defaults to 240 seconds.
GET /api/v2/measurements/dns/
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
measurements (array)
ids of the created measurements
Response
measurements (array)
ids of the created measurements
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
sort (enum)
Sort the results based on certain field values. Sort directives beginning with '-' imply a descending/reversed sort order.
[id,-id]
page_size (number)
Set the number of measurements returned on one page. Maximum size is 500, default is 50.
after (string)
Used to get the next page of results when the maximum page number has been reached
format (enum)
Choose between available output formats (api, json, jsonp, txt)
[api,json,jsonp,txt]
callback (string)
Specifies a callback function name for a 'JSONP' response
key (string)
An API key to be used to authorize this request
Response
id (integer: int64)
Measurement group ID
is_wifi_group (string)
Whether this group is a set of WiFi measurements
group_members (array)
The members of this group. This array may be incomplete in the case of large groups, in which case `total_members` can be used to get the group size and the group= parameter of the /measurements/ API can be used to get the full list of members
total_members (integer: int64)
Total number of members in this group
GET /api/v2/measurements/groups/
GET /api/v2/measurements/groups/{pk}/ Show one measurement group specified by ID
Show one measurement group specified by ID.
Parameters
path parameters
pk (string)
query parameters
format (enum)
Choose between available output formats (api, json, jsonp)
[api,json,jsonp]
callback (string)
Specifies a callback function name for a 'JSONP' response
key (string)
An API key to be used to authorize this request
Response
id (integer: int64)
Measurement group ID
is_wifi_group (string)
Whether this group is a set of WiFi measurements
group_members (array)
The members of this group. This array may be incomplete in the case of large groups, in which case `total_members` can be used to get the group size and the group= parameter of the /measurements/ API can be used to get the full list of members
total_members (integer: int64)
Total number of members in this group
GET /api/v2/measurements/groups/{pk}/
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
pk (string)
query parameters
format (enum)
Choose between available output formats (api, json, jsonp)
[api,json,jsonp]
callback (string)
Specifies a callback function name for a 'JSONP' response
key (string)
An API key to be used to authorize this request
Response
GET /api/v2/measurements/tags/ List all RIPE Atlas measurement tags
List all RIPE Atlas measurement tags
Parameters
query parameters
format (enum)
Choose between available output formats (api, json)
[api,json]
key (string)
An API key to be used to authorize this request
Response
tag (string)
A publicly visible and human-readable tag
GET /api/v2/measurements/tags/
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
tag (string)
query parameters
format (enum)
Choose between available output formats (json, jsonp, txt)
[json,jsonp,txt]
callback (string)
Specifies a callback function name for a 'JSONP' response
key (string)
An API key to be used to authorize this request
sort (string)
sort by 'timestamp' (default for tags with <= 10 measurements), or by 'msm_id' (default for tags with > 10 measurements)
Response
GET /api/v2/measurements/tags/{tag}/results/
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
format (enum)
Choose between available output formats (api, json)
[api,json]
key (string)
An API key to be used to authorize this request
Response
tag (string)
A publicly visible and human-readable tag
label (string)
A personal, unique label
GET /api/v2/measurements/my-tags/
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
tag (string)
query parameters
format (enum)
Choose between available output formats (api, json)
[api,json]
key (string)
An API key to be used to authorize this request
Response
tag (string)
A publicly visible and human-readable tag
label (string)
A personal, unique label
GET /api/v2/measurements/my-tags/{tag}/
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
tag (string)
query parameters
format (enum)
Choose between available output formats (api, json)
[api,json]
key (string)
An API key to be used to authorize this request
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
pk (string)
query parameters
format (enum)
Choose between available output formats (api, json)
[api,json]
key (string)
An API key to be used to authorize this request
Response
tag (string)
A publicly visible and human-readable tag
label (string)
A personal, unique label
GET /api/v2/measurements/{pk}/tags/
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
tag (string)
A publicly visible and human-readable tag
path parameters
pk (string)
query parameters
format (enum)
Choose between available output formats (api, json)
[api,json]
key (string)
An API key to be used to authorize this request
Response
tag (string)
A publicly visible and human-readable tag
label (string)
A personal, unique label
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
pk (string)
tag (string)
query parameters
format (enum)
Choose between available output formats (api, json)
[api,json]
key (string)
An API key to be used to authorize this request
Response
tag (string)
A publicly visible and human-readable tag
label (string)
A personal, unique label
GET /api/v2/measurements/{pk}/tags/{tag}/
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
pk (string)
tag (string)
query parameters
format (enum)
Choose between available output formats (api, json)
[api,json]
key (string)
An API key to be used to authorize this request
Response
tag (string)
A publicly visible and human-readable tag
label (string)
A personal, unique label
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
msm_id (string)
query parameters
page_size (number)
Set the number of measurements returned on one page. Maximum size is 500, default is 50.
after (string)
Used to get the next page of results when the maximum page number has been reached
format (enum)
Choose between available output formats (api, json)
[api,json]
optional_fields (enum)
Include additional fields named in comma-separated values in response.
[]
fields (string)
Return fields named in comma-separated values in response, in addition to 'type' and 'id' which are always present. Optional fields can be listed here also.
format[datetime] (string)
Output datetimes in ISO-8601 format ('iso-8601' or 'json') or as seconds since the epoch ('unix')
key (string)
An API key to be used to authorize this request
Response
requested (integer: int64)
Number of probes that have to be added or removed
type (string)
[
"area",
"country",
"probes",
"asn",
"prefix",
"msm",
1,
2,
3,
4,
5,
6
] Probe selector. Options are: `area` allows a compass quarter of the world, `asn` selects an Autonomous System, `country` selects a country, `msm` selects the probes used in another measurement, `prefix` selects probes based on prefix, `probes` selects probes directly
value (string)
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 (string)
[
"add",
"remove",
1,
2
] Action to be applied, or that was applied to the measurement involved.'add': add probe to the measurement, 'remove': remove probe from the measurement
tags_include (string)
Comma-separated list of probe tags. Only probes with all these tags attached will be selected from this participation request
tags_exclude (string)
Comma-separated list of probe tags. Probes with any of these tags attached will be excluded from this participation request
id (integer: int64)
The unique ID for this participation request
created_at (string: date-time)
The creation date and time of the participations request (Defaults to unix timestamp format)
self (string)
The (direct) URL of this participations request
GET /api/v2/measurements/{msm_id}/participation-requests/
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
requested (integer)
Number of probes that have to be added or removed
type (enum)
Probe selector. Options are: `area` allows a compass quarter of the world, `asn` selects an Autonomous System, `country` selects a country, `msm` selects the probes used in another measurement, `prefix` selects probes based on prefix, `probes` selects probes directly
[area,country,probes,asn,prefix,msm,1,2,3,4,5,6]
value (string)
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 (enum)
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,remove,1,2]
tags_include (string)
Comma-separated list of probe tags. Only probes with all these tags attached will be selected from this participation request
tags_exclude (string)
Comma-separated list of probe tags. Probes with any of these tags attached will be excluded from this participation request
path parameters
msm_id (string)
query parameters
page_size (number)
Set the number of measurements returned on one page. Maximum size is 500, default is 50.
after (string)
Used to get the next page of results when the maximum page number has been reached
format (enum)
Choose between available output formats (api, json)
[api,json]
optional_fields (enum)
Include additional fields named in comma-separated values in response.
[measurement]
fields (string)
Return fields named in comma-separated values in response, in addition to 'type' and 'id' which are always present. Optional fields can be listed here also.
format[datetime] (string)
Output datetimes in ISO-8601 format ('iso-8601' or 'json') or as seconds since the epoch ('unix')
key (string)
An API key to be used to authorize this request
Response
requested (integer: int64)
Number of probes that have to be added or removed
type (string)
[
"area",
"country",
"probes",
"asn",
"prefix",
"msm",
1,
2,
3,
4,
5,
6
] Probe selector. Options are: `area` allows a compass quarter of the world, `asn` selects an Autonomous System, `country` selects a country, `msm` selects the probes used in another measurement, `prefix` selects probes based on prefix, `probes` selects probes directly
value (string)
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 (string)
[
"add",
"remove",
1,
2
] Action to be applied, or that was applied to the measurement involved.'add': add probe to the measurement, 'remove': remove probe from the measurement
tags_include (string)
Comma-separated list of probe tags. Only probes with all these tags attached will be selected from this participation request
tags_exclude (string)
Comma-separated list of probe tags. Probes with any of these tags attached will be excluded from this participation request
id (integer: int64)
The unique ID for this participation request
created_at (string: date-time)
The creation date and time of the participations request (Defaults to unix timestamp format)
self (string)
The (direct) URL of this participations request
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
msm_id (string)
source_id (string)
query parameters
format (enum)
Choose between available output formats (api, json)
[api,json]
key (string)
An API key to be used to authorize this request
Response
GET /api/v2/measurements/{msm_id}/participation-requests/{source_id}/
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
pk (string)
query parameters
format (enum)
Choose between available output formats (api, json)
[api,json]
key (string)
An API key to be used to authorize this request
Response
id (integer: int64)
Measurement ID
user_email (string)
Email address of the measurement owner
bill_to (string)
Email address of the bill to user
GET /api/v2/measurements/{pk}/private/
#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
source_id (string)
query parameters
format (enum)
Choose between available output formats (api, json)
[api,json]
key (string)
An API key to be used to authorize this request
Response
GET /api/v2/participation-requests/{source_id}/
#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
country_code (string)
id__lt (integer)
filter on id being less than value.
id__lte (integer)
filter on id being less than or equal to value.
id__gte (integer)
filter on id being greater than or equal to value.
id__gt (integer)
filter on id being greater than value.
id__in (string)
filter on id being one of comma-separated values.
latitude (string)
filter on the latitude equaling the exact supplied float value.
latitude__lt (string)
filter on the latitude being less than values (south to).
latitude__lte (string)
filter on the latitude being less than or equal to value (south of).
latitude__gte (string)
filter on the latitude being greater than or equal to value (north of).
latitude__gt (string)
filter on the latitude being greater than value.
longitude (string)
filter on the longitude equaling the exact supplied float value.
longitude__lt (string)
filter on the longitude being less than the value.
longitude__lte (string)
filter on the longitude being less than or equal to value (to the west of).
longitude__gte (string)
filter on the longitude being greater than or equal to value (to the east of).
longitude__gt (string)
filter on the longitude being greater than to value (to the east of).
asn (string)
filter on probes announced by the autonomous system with the name of value. This field is useful for filtering when you don't care about IP version.
asn_v4 (string)
filter on probes with an IPv4 address announced by an autonomous system with a particular number.
asn_v4__in (string)
filter on probes with an IPv4 address announced by one of the autonomous systems in a comma-separated list.
asn_v6 (string)
filter on probes with an IPv6 address announced by an autonomous system with a particular number.
asn_v6__in (string)
filter on probes with an IPv6 address announced by one of the autonomous systems in a comma-separated list.
prefix_v4 (string)
filter on IPv4 prefix supplied by value. Paramater value should be supplied in CIDR notation. Irrelevant octets can be omitted.
prefix_v6 (string)
filter on IPv6 prefix supplied by value. Irrelevant hextets can be omitted.
status (enum)
The connection status [0 - Never Connected, 1 - Connected, 2 - Disconnected, 3 - Abandoned]
[0,1,2,3]
status_name (enum)
[Never Connected,Connected,Disconnected,Abandoned,Written Off]
is_anchor (boolean)
return probes that are anchors.
is_public (boolean)
return probes that are public.
tags (string)
filter on tags inside a list of comma-separated values. The returned probes have all tags set.
radius (string)
filter on probes being within supplied radius of supplied latitude and longitude. Parameter value should be supplied as radius=lat(deg),lon(deg):radius(km).
country_code__in (string)
search (string)
Search 'id', 'asn_v4', 'asn_v6' and 'description' fields
favourite (boolean)
return probes that you have added to your favourites.
hidden (boolean)
return only probes that you have hidden (default is to show no hidden probes).
include (enum)
Include additional fields named in comma-separated values in response as nested JSON objects.
[measurements]
optional_fields (enum)
Include additional fields named in comma-separated values in response.
[country_name,measurements]
format (enum)
Choose between available output formats (json,txt).
[json,txt]
sort (enum)
Sort on a supported field, can be prefixed with a hyphen for descending order.
[id,-id,description,-description,status,-status,country,-country,asn_v4,-asn_v4,asn_v6,-asn_v6]
Response
address_v4 (string)
The last IPv4 address that was known to be held by this probe, or null if there is no known address. Note: a probe that connects over IPv6 may fail to report its IPv4 address, meaning that this field can sometimes be null even though the probe may have working IPv4
address_v6 (string)
The last IPv6 address that was known to be held by this probe, or null if there is no known address.
asn_v4 (integer: int64)
The IPv4 ASN if any
asn_v6 (integer: int64)
The IPv6 ASN if any
country_code (string)
An ISO-3166-1 alpha-2 code indicating the country that this probe is located in,
as derived from the user supplied longitude and latitude
description (string)
User defined description of the probe
firmware_version (string)
first_connected (string: date-time)
When the probe connected for the first time (UTC Time and date in ISO-8601/ECMA 262 format)
geometry (number: float)
A GeoJSON point object containing the user-supplied location of this probe.
The longitude and latitude are contained within the `coordinates` array
id (integer: int64)
The id of the probe
is_anchor (boolean)
Whether or not this probe is a RIPE Atlas Anchor
is_public (boolean)
If a probe is not public then certain details, including exact IP addresses, are not returned.
last_connected (string: date-time)
When the probe connected for the last time (UTC Time and date in ISO-8601/ECMA 262 format)
prefix_v4 (string)
The IPv4 prefix if any
prefix_v6 (string)
The IPv6 prefix if any
status (string)
A JSON object containing id: The connection status ID for this probe (integer [0-3]), name: The connection status (string [Never Connected, Connected, Disconnected, Abandoned]), since: The datetime of the last change in connection status
status_since (string: date-time)
A datetime field that can hold a datetime both as a timestamp and as a JSON datetime
tags (array)
total_uptime (integer: int64)
Accumulated uptime for this probe in seconds
type (string)
The type of the object
GET /api/v2/probes/
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
country_code (string)
id__lt (integer)
filter on id being less than value.
id__lte (integer)
filter on id being less than or equal to value.
id__gte (integer)
filter on id being greater than or equal to value.
id__gt (integer)
filter on id being greater than value.
id__in (string)
filter on id being one of comma-separated values.
latitude (string)
filter on the latitude equaling the exact supplied float value.
latitude__lt (string)
filter on the latitude being less than values (south to).
latitude__lte (string)
filter on the latitude being less than or equal to value (south of).
latitude__gte (string)
filter on the latitude being greater than or equal to value (north of).
latitude__gt (string)
filter on the latitude being greater than value.
longitude (string)
filter on the longitude equaling the exact supplied float value.
longitude__lt (string)
filter on the longitude being less than the value.
longitude__lte (string)
filter on the longitude being less than or equal to value (to the west of).
longitude__gte (string)
filter on the longitude being greater than or equal to value (to the east of).
longitude__gt (string)
filter on the longitude being greater than to value (to the east of).
asn (string)
filter on probes announced by the autonomous system with the name of value. This field is useful for filtering when you don't care about IP version.
asn_v4 (string)
filter on probes with an IPv4 address announced by an autonomous system with a particular number.
asn_v4__in (string)
filter on probes with an IPv4 address announced by one of the autonomous systems in a comma-separated list.
asn_v6 (string)
filter on probes with an IPv6 address announced by an autonomous system with a particular number.
asn_v6__in (string)
filter on probes with an IPv6 address announced by one of the autonomous systems in a comma-separated list.
prefix_v4 (string)
filter on IPv4 prefix supplied by value. Paramater value should be supplied in CIDR notation. Irrelevant octets can be omitted.
prefix_v6 (string)
filter on IPv6 prefix supplied by value. Irrelevant hextets can be omitted.
status (enum)
The connection status [0 - Never Connected, 1 - Connected, 2 - Disconnected, 3 - Abandoned]
[0,1,2,3]
status_name (enum)
[Never Connected,Connected,Disconnected,Abandoned,Written Off]
is_anchor (boolean)
return probes that are anchors.
is_public (boolean)
return probes that are public.
tags (string)
filter on tags inside a list of comma-separated values. The returned probes have all tags set.
radius (string)
filter on probes being within supplied radius of supplied latitude and longitude. Parameter value should be supplied as radius=lat(deg),lon(deg):radius(km).
country_code__in (string)
search (string)
Search 'id', 'asn_v4', 'asn_v6' and 'description' fields
favourite (boolean)
return probes that you have added to your favourites.
hidden (boolean)
return only probes that you have hidden (default is to show no hidden probes).
include (enum)
Include additional fields named in comma-separated values in response as nested JSON objects.
[measurements]
optional_fields (enum)
Include additional fields named in comma-separated values in response.
[country_name,measurements]
format (enum)
Choose between available output formats (json,txt).
[json,txt]
sort (enum)
Sort on a supported field, can be prefixed with a hyphen for descending order.
[id,-id,description,-description,status,-status,country,-country,asn_v4,-asn_v4,asn_v6,-asn_v6]
Response
address_v4 (string)
The last IPv4 address that was known to be held by this probe, or null if there is no known address. Note: a probe that connects over IPv6 may fail to report its IPv4 address, meaning that this field can sometimes be null even though the probe may have working IPv4
address_v6 (string)
The last IPv6 address that was known to be held by this probe, or null if there is no known address.
asn_v4 (integer: int64)
The IPv4 ASN if any
asn_v6 (integer: int64)
The IPv6 ASN if any
country_code (string)
An ISO-3166-1 alpha-2 code indicating the country that this probe is located in,
as derived from the user supplied longitude and latitude
description (string)
User defined description of the probe
firmware_version (string)
first_connected (string: date-time)
When the probe connected for the first time (UTC Time and date in ISO-8601/ECMA 262 format)
geometry (number: float)
A GeoJSON point object containing the user-supplied location of this probe.
The longitude and latitude are contained within the `coordinates` array
id (integer: int64)
The id of the probe
is_anchor (boolean)
Whether or not this probe is a RIPE Atlas Anchor
is_public (boolean)
If a probe is not public then certain details, including exact IP addresses, are not returned.
last_connected (string: date-time)
When the probe connected for the last time (UTC Time and date in ISO-8601/ECMA 262 format)
prefix_v4 (string)
The IPv4 prefix if any
prefix_v6 (string)
The IPv6 prefix if any
status (string)
A JSON object containing id: The connection status ID for this probe (integer [0-3]), name: The connection status (string [Never Connected, Connected, Disconnected, Abandoned]), since: The datetime of the last change in connection status
status_since (string: date-time)
A datetime field that can hold a datetime both as a timestamp and as a JSON datetime
tags (array)
total_uptime (integer: int64)
Accumulated uptime for this probe in seconds
type (string)
The type of the object
GET /api/v2/probes/my/
GET /api/v2/probes/{pk}/ Resource describing a probe
Resource describing a probe
Parameters
path parameters
pk (string)
query parameters
include (enum)
include the fields as nested JSON objects.
[measurements]
optional_fields (enum)
Include additional fields named in comma-separated values in response as nested JSON objects.
[country_name,measurements]
Response
address_v4 (string)
The last IPv4 address that was known to be held by this probe, or null if there is no known address. Note: a probe that connects over IPv6 may fail to report its IPv4 address, meaning that this field can sometimes be null even though the probe may have working IPv4
address_v6 (string)
The last IPv6 address that was known to be held by this probe, or null if there is no known address.
asn_v4 (integer: int64)
The IPv4 ASN if any
asn_v6 (integer: int64)
The IPv6 ASN if any
country_code (string)
An ISO-3166-1 alpha-2 code indicating the country that this probe is located in,
as derived from the user supplied longitude and latitude
description (string)
User defined description of the probe
firmware_version (string)
first_connected (string: date-time)
When the probe connected for the first time (UTC Time and date in ISO-8601/ECMA 262 format)
geometry (number: float)
A GeoJSON point object containing the user-supplied location of this probe.
The longitude and latitude are contained within the `coordinates` array
id (integer: int64)
The id of the probe
is_anchor (boolean)
Whether or not this probe is a RIPE Atlas Anchor
is_public (boolean)
If a probe is not public then certain details, including exact IP addresses, are not returned.
last_connected (string: date-time)
When the probe connected for the last time (UTC Time and date in ISO-8601/ECMA 262 format)
prefix_v4 (string)
The IPv4 prefix if any
prefix_v6 (string)
The IPv6 prefix if any
status (string)
A JSON object containing id: The connection status ID for this probe (integer [0-3]), name: The connection status (string [Never Connected, Connected, Disconnected, Abandoned]), since: The datetime of the last change in connection status
status_since (string: date-time)
A datetime field that can hold a datetime both as a timestamp and as a JSON datetime
tags (array)
total_uptime (integer: int64)
Accumulated uptime for this probe in seconds
type (string)
The type of the object
GET /api/v2/probes/{pk}/
PUT /api/v2/probes/{pk}/ Resource describing a probe
Resource describing a probe
Parameters
form parameters
is_wifi_requested (boolean)
Opt-in participating in WiFi measurements
path parameters
pk (string)
Response
address_v4 (string)
The last IPv4 address that was known to be held by this probe, or null if there is no known address. Note: a probe that connects over IPv6 may fail to report its IPv4 address, meaning that this field can sometimes be null even though the probe may have working IPv4
address_v6 (string)
The last IPv6 address that was known to be held by this probe, or null if there is no known address.
asn_v4 (integer: int64)
The IPv4 ASN if any
asn_v6 (integer: int64)
The IPv6 ASN if any
country_code (string)
An ISO-3166-1 alpha-2 code indicating the country that this probe is located in,
as derived from the user supplied longitude and latitude
description (string)
User defined description of the probe
firmware_version (string)
first_connected (string: date-time)
When the probe connected for the first time (UTC Time and date in ISO-8601/ECMA 262 format)
geometry (number: float)
A GeoJSON point object containing the user-supplied location of this probe.
The longitude and latitude are contained within the `coordinates` array
id (integer: int64)
The id of the probe
is_anchor (boolean)
Whether or not this probe is a RIPE Atlas Anchor
is_public (boolean)
If a probe is not public then certain details, including exact IP addresses, are not returned.
last_connected (string: date-time)
When the probe connected for the last time (UTC Time and date in ISO-8601/ECMA 262 format)
prefix_v4 (string)
The IPv4 prefix if any
prefix_v6 (string)
The IPv6 prefix if any
status (string)
A JSON object containing id: The connection status ID for this probe (integer [0-3]), name: The connection status (string [Never Connected, Connected, Disconnected, Abandoned]), since: The datetime of the last change in connection status
status_since (string: date-time)
A datetime field that can hold a datetime both as a timestamp and as a JSON datetime
tags (array)
total_uptime (integer: int64)
Accumulated uptime for this probe in seconds
type (string)
The type of the object
PATCH /api/v2/probes/{pk}/ Resource describing a probe
Resource describing a probe
Parameters
form parameters
is_wifi_requested (boolean)
Opt-in participating in WiFi measurements
path parameters
pk (string)
Response
address_v4 (string)
The last IPv4 address that was known to be held by this probe, or null if there is no known address. Note: a probe that connects over IPv6 may fail to report its IPv4 address, meaning that this field can sometimes be null even though the probe may have working IPv4
address_v6 (string)
The last IPv6 address that was known to be held by this probe, or null if there is no known address.
asn_v4 (integer: int64)
The IPv4 ASN if any
asn_v6 (integer: int64)
The IPv6 ASN if any
country_code (string)
An ISO-3166-1 alpha-2 code indicating the country that this probe is located in,
as derived from the user supplied longitude and latitude
description (string)
User defined description of the probe
firmware_version (string)
first_connected (string: date-time)
When the probe connected for the first time (UTC Time and date in ISO-8601/ECMA 262 format)
geometry (number: float)
A GeoJSON point object containing the user-supplied location of this probe.
The longitude and latitude are contained within the `coordinates` array
id (integer: int64)
The id of the probe
is_anchor (boolean)
Whether or not this probe is a RIPE Atlas Anchor
is_public (boolean)
If a probe is not public then certain details, including exact IP addresses, are not returned.
last_connected (string: date-time)
When the probe connected for the last time (UTC Time and date in ISO-8601/ECMA 262 format)
prefix_v4 (string)
The IPv4 prefix if any
prefix_v6 (string)
The IPv6 prefix if any
status (string)
A JSON object containing id: The connection status ID for this probe (integer [0-3]), name: The connection status (string [Never Connected, Connected, Disconnected, Abandoned]), since: The datetime of the last change in connection status
status_since (string: date-time)
A datetime field that can hold a datetime both as a timestamp and as a JSON datetime
tags (array)
total_uptime (integer: int64)
Accumulated uptime for this probe in seconds
type (string)
The type of the object
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
prb_id (string)
Response
id (string)
type (string)
The type of the Object
measurement (string)
GET /api/v2/probes/{prb_id}/measurements/
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
probe (string)
filter on the probes in format of list and/or ranges like probe_id,[probe_id[,probe_id-probe_id]].
query parameters
date (string)
filter the probes on the specified date, in format YYYY-MM-DD.
date__lt (string)
filter on date being less than the specified date, in format YYYY-MM-DD.
date__lte (string)
filter on date being less than or equal to the specified date, in format YYYY-MM-DD.
date__gte (string)
filter on date being greater than or equal to the specified date, in format YYYY-MM-DD.
date__gt (string)
filter on date being greater than the specified date, in format YYYY-MM-DD.
status (string)
filter on the probe statuses in format of list and/or ranges like status_id,[status_id[,status_id-status_id]].
format (enum)
Choose between available output formats (json,geojson,txt).
[json,geojson,txt]
Response
GET /api/v2/probes/archive/
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
asn4 (string)
An array containing array [ASN_ID,NUMBER OF PROBES USING IPv4]
asn6 (string)
An array containing array [ASN_ID, NUMBER OF PROBES USING IPv6]
prefix4 (string)
An array containing array [IPv4 PREFIX, NUMBER OF PROBES HAVING IPv4 PREFIX]
prefix6 (string)
An array containing array [IPv6 PREFIX, NUMBER OF PROBES HAVING IPv6 PREFIX]
country (string)
An array containing array [COUNTRY CODE, NUMBER OF PROBES IN COUNTRY]
GET /api/v2/probes/rankings/
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
name (string)
slug (string)
test for existence of slug
name__startswith (string)
name__contains (string)
slug__startswith (string)
slug__contains (string)
Response
name (string)
tagname
slug (string)
tag as a slug, the tagname in lowercase and hyphenated (for use in URLs).
GET /api/v2/probes/tags/
GET /api/v2/probes/tags/{slug}/ Resource describing a tag used for tagging probes
Resource describing a tag used for tagging probes
Parameters
query parameters
slug (string)
test for existence of slug
Response
name (string)
tagname
slug (string)
tag as a slug, the tagname in lowercase and hyphenated (for use in URLs).
GET /api/v2/probes/tags/{slug}/