RIPE Atlas Documentation

GET /measurements/my/ ​

Show measurements to the authenticated user This resource can be reached if a user is logged in, or if a key was passed with sufficient permissions.

GET /measurements/my/ — af ​

return only the fields containing either IPv4 or IPv6 measurements. (4 - IPv4, 6 - IPv6)

GET /measurements/my/ — after ​

Used to get the next page of results when the maximum page number has been reached.

GET /measurements/my/ — current_probes ​

filter by the ID of a probe currently participating in this measurement

GET /measurements/my/ — description ​

filter on the exact description

GET /measurements/my/ — description__contains ​

filter on the description containing the value.

GET /measurements/my/ — description__endswith ​

filter on the description ending with value.

GET /measurements/my/ — description__startswith ​

filter on the description starting with value.

GET /measurements/my/ — favourite ​

only return favourited measurements

GET /measurements/my/ — group ​

[deprecated, use group_id] Filter by group ID

GET /measurements/my/ — group_id ​

filter by group ID

GET /measurements/my/ — hidden ​

only return hidden measurements (by default they will be excluded)

GET /measurements/my/ — id ​

filter on ID being one of a comma-separated list

GET /measurements/my/ — id__gt ​

filter on id being greater than value.

GET /measurements/my/ — id__gte ​

filter on id being greater than or equal to value.

GET /measurements/my/ — id__in ​

filter on ID being one of a comma-separated list

GET /measurements/my/ — id__lt ​

filter on id being less than value

GET /measurements/my/ — id__lte ​

filter on id being less than or equal to value.

GET /measurements/my/ — interval ​

filter on the interval matching the value.

GET /measurements/my/ — interval__gt ​

filter on the interval being greater than value.

GET /measurements/my/ — interval__gte ​

filter on the interval being greater than or equal to value.

GET /measurements/my/ — interval__lt ​

filter on the interval being less than value.

GET /measurements/my/ — interval__lte ​

filter on the interval being less than or equal to value.

GET /measurements/my/ — is_oneoff ​

return only one-off measurements.

GET /measurements/my/ — is_public ​

return only publicly available measurements.

GET /measurements/my/ — page ​

Filter on page number. The maximum number of results is 10000, beyond which you must use 'after='

GET /measurements/my/ — page_size ​

Set the number of measurements returned on one page. Maximum size is 500, default is 50.

GET /measurements/my/ — participant_logs_probes ​

filter by the ID of the probes that were selected by participation requests for this measurement (100 probes max)

GET /measurements/my/ — probes_requested ​

filter on probes requested

GET /measurements/my/ — probes_requested__gt ​

filter on probes requested being greater than value

GET /measurements/my/ — probes_requested__gte ​

filter on probes requested being greater than or equal to value

GET /measurements/my/ — probes_requested__lt ​

filter on probes requested being less than value

GET /measurements/my/ — probes_requested__lte ​

filter on probes requested being less than or equal to value

GET /measurements/my/ — probes_scheduled ​

filter on probes_scheduled

GET /measurements/my/ — probes_scheduled__gt ​

filter on probes scheduled being greater than value

GET /measurements/my/ — probes_scheduled__gte ​

filter on probes scheduled being greater than or equal to value

GET /measurements/my/ — probes_scheduled__lt ​

filter on probes scheduled being less than value

GET /measurements/my/ — probes_scheduled__lte ​

filter on probes scheduled being less than or equal to value

GET /measurements/my/ — protocol ​

filter on the protocol for the measurement, works only it conjunction with dns|traceroute.

filter on description (for DNS measurements) or target (other measurements) for containing value.

GET /measurements/my/ — sort ​

Sort the results based on certain field values. Sort directives beginning with '-' imply a descending/reversed sort order.

GET /measurements/my/ — start_time ​

filter on start time (as a unixtime timestamp) of scheduled measurement.

GET /measurements/my/ — start_time__gt ​

filter on start time being greater than the value (after).

GET /measurements/my/ — start_time__gte ​

filter on start time being greater than or equal to the value (after).

GET /measurements/my/ — start_time__lt ​

filter on start time being less than the value (before).

GET /measurements/my/ — start_time__lte ​

filter on start time being less than or equal to the value (before).

GET /measurements/my/ — status ​

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)

GET /measurements/my/ — status__in ​

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)

GET /measurements/my/ — stop_time ​

filter on stop time (as a unixtime timestamp) of scheduled measurement.

GET /measurements/my/ — stop_time__gt ​

filter on stop time being greater than (after) the value. If the given value is in the past then ongoing measurements will be included.

GET /measurements/my/ — stop_time__gte ​

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.

GET /measurements/my/ — stop_time__lt ​

filter on stop time being less than the value (before).

GET /measurements/my/ — stop_time__lte ​

filter on stop time being less than or equal to the value (before).

GET /measurements/my/ — tags ​

filter on list of tags

GET /measurements/my/ — target ​

filter on the exact target FQDN (or target ip if fqdn is not available)

GET /measurements/my/ — target__contains ​

filter on the target containing the value.

GET /measurements/my/ — target__endswith ​

filter on the target hostname ending with value.

GET /measurements/my/ — target__startswith ​

filter on the target hostname starting with value.

GET /measurements/my/ — target_asn ​

filter on the ASN seen to be routing the target's IP address

GET /measurements/my/ — target_ip ​

filter on the exact or more specific target IP address

GET /measurements/my/ — type ​

return all measurements of type value

GET /api/v2/measurements/my/​

Show measurements to the authenticated user

This resource can be reached if
a user is logged in, or if a key was passed with sufficient permissions.

Try it out

Playground​

Authorization
Variables
Key
Value
Authorizations

Authorizations​

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

Query Parameters

af

return only the fields containing either IPv4 or IPv6 measurements. (4 - IPv4, 6 - IPv6)

Type
integer
after

Used to get the next page of results when the maximum page number has been reached.

Type
string
current_probes

filter by the ID of a probe currently participating in this measurement

Type
integer
description

filter on the exact description

Type
string
description__contains

filter on the description containing the value.

Type
string
description__endswith

filter on the description ending with value.

Type
string
description__startswith

filter on the description starting with value.

Type
string
favourite

only return favourited measurements

Type
boolean
group

[deprecated, use group_id] Filter by group ID

Type
integer
group_id

filter by group ID

Type
integer
hidden

only return hidden measurements (by default they will be excluded)

Type
boolean
id

filter on ID being one of a comma-separated list

Type
string
Format
"comma-separated integers"
id__gt

filter on id being greater than value.

Type
integer
id__gte

filter on id being greater than or equal to value.

Type
integer
id__in

filter on ID being one of a comma-separated list

Type
string
Format
"comma-separated integers"
id__lt

filter on id being less than value

Type
integer
id__lte

filter on id being less than or equal to value.

Type
integer
interval

filter on the interval matching the value.

Type
integer
interval__gt

filter on the interval being greater than value.

Type
integer
interval__gte

filter on the interval being greater than or equal to value.

Type
integer
interval__lt

filter on the interval being less than value.

Type
integer
interval__lte

filter on the interval being less than or equal to value.

Type
integer
is_oneoff

return only one-off measurements.

Type
boolean
is_public

return only publicly available measurements.

Type
boolean
page

Filter on page number. The maximum number of results is 10000, beyond which you must use 'after='

Type
integer
page_size

Set the number of measurements returned on one page. Maximum size is 500, default is 50.

Type
integer
participant_logs_probes

filter by the ID of the probes that were selected by participation requests for this measurement (100 probes max)

Type
string
Format
"comma-separated integers"
probes_requested

filter on probes requested

Type
integer
probes_requested__gt

filter on probes requested being greater than value

Type
integer
probes_requested__gte

filter on probes requested being greater than or equal to value

Type
integer
probes_requested__lt

filter on probes requested being less than value

Type
integer
probes_requested__lte

filter on probes requested being less than or equal to value

Type
integer
probes_scheduled

filter on probes_scheduled

Type
integer
probes_scheduled__gt

filter on probes scheduled being greater than value

Type
integer
probes_scheduled__gte

filter on probes scheduled being greater than or equal to value

Type
integer
probes_scheduled__lt

filter on probes scheduled being less than value

Type
integer
probes_scheduled__lte

filter on probes scheduled being less than or equal to value

Type
integer
protocol

filter on the protocol for the measurement, works only it conjunction with dns|traceroute.

Type
string
search

filter on description (for DNS measurements) or target (other measurements) for containing value.

Type
string
sort

Sort the results based on certain field values. Sort directives beginning with '-' imply a descending/reversed sort order.

Type
string
Valid values
"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""probes_requested""-probes_requested""probes_scheduled""-probes_scheduled"
start_time

filter on start time (as a unixtime timestamp) of scheduled measurement.

Type
integer
start_time__gt

filter on start time being greater than the value (after).

Type
integer
start_time__gte

filter on start time being greater than or equal to the value (after).

Type
integer
start_time__lt

filter on start time being less than the value (before).

Type
integer
start_time__lte

filter on start time being less than or equal to the value (before).

Type
integer
status

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)

Type
string
Format
"comma-separated status names or IDs"
status__in

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)

Type
string
Format
"comma-separated status names or IDs"
stop_time

filter on stop time (as a unixtime timestamp) of scheduled measurement.

Type
integer
stop_time__gt

filter on stop time being greater than (after) the value. If the given value is in the past then ongoing measurements will be included.

Type
integer
stop_time__gte

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.

Type
integer
stop_time__lt

filter on stop time being less than the value (before).

Type
integer
stop_time__lte

filter on stop time being less than or equal to the value (before).

Type
integer
tags

filter on list of tags

Type
string
Format
"comma-separated tags"
target

filter on the exact target FQDN (or target ip if fqdn is not available)

Type
string
target__contains

filter on the target containing the value.

Type
string
target__endswith

filter on the target hostname ending with value.

Type
string
target__startswith

filter on the target hostname starting with value.

Type
string
target_asn

filter on the ASN seen to be routing the target's IP address

Type
integer
target_ip

filter on the exact or more specific target IP address

Type
string
Format
"cidr prefix"
type

return all measurements of type value

Type
string
Format
"ping, traceroute, dns, http, sslcert, or ntp"
Responses

Responses​

application/json
object
Format"uri"
Format"uri"
object

Output serializer fields in lexically sorted order.

This shouldn't make a difference to machines since JSON object keys are
unordered, but it makes the output easier to read and compare for humans.

Indicates this measurement is publicly available; may be changed from false to true, but not from true to false

Defaulttrue

User-defined description of the measurement

Automatic top-up measurements probes

Defaultfalse

Threshold in days to replace a disconnected probe

Maximum30
Minimum1
Default7

Minimum similarity for replacement probes

Format"double"
Maximum1
Minimum0
Default0.5

Number of hours to re-lookup a target DNS record

Default0

The unique identifier that RIPE Atlas assigned to this measurement

The URL that contains the results of this measurement

Format"uri"

The ID of the measurement group. This ID references a measurement acting as group master

[Not for wifi] IPv4 of IPv6 Address family of the measurement

  • 4 - 4
  • 6 - 6
Valid values46

Indicates this is a one-off or a periodic measurement

Distribution of probes' measurements throughout the interval (default is half the interval, maximum 400 seconds)

Indicates that a name should be resolved (using DNS) on the probe. Otherwise it will be resolved on the RIPE Atlas servers

Defaultfalse

Configured start time (as a unix timestamp)

Format"date-time"

Actual end time of measurement (as a unix timestamp)

Format"date-time"
object
Required

Current status of the measurement. Status can be: Specified, Scheduled, Ongoing, Stopped, Requested to stop, Forced to stop, No suitable probes, Failed or Archived

Numeric ID of this status (0: Specified, 1: Scheduled, 2: Ongoing, 4: Stopped, 5: Forced to stop, 6: No suitable probes, 7: Failed, 8: Archived)

Human-readable description of this status

When the measurement entered this status (not available for every status)

Format"date-time"

Indicates if all probe requests have made it through the scheduling process

The number of the Autonomous System the IP address of the target belongs to

Enclosing prefix of the IP address of the target

The IP Address of the target of the measurement

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

Format"date-time"

Indicates this measurement belongs to a wifi measurement group

The list of IP addresses returned for the fqdn in the target field by the backend infra-structure resolvers

Number of probes requested, but not necessarily granted to this measurement

Number of probes actually scheduled for this measurement

Number of probes actually scheduled for this measurement (alias for probes_scheduled)

The API URL of the measurement group.

Format"uri"

estimated RIPE Atlas credits consumed by this measurement per day

Array of tags to apply to the measurement

Time of the last DNS lookup for the measurement target)

Format"date-time"

The type of the measurement

  • ping - Ping
  • traceroute - Traceroute
  • dns - DNS
  • sslcert - TLS
  • http - HTTP
  • ntp - NTP
  • wifi - Wi-Fi (discontinued)
Valid values"ping""traceroute""dns""sslcert""http""ntp""wifi"

The FQDN (if it was requested) or the ip address of the target of this measurement

Interval between samples from a single probe.

The number of packets send in a measurement execution. Value must be between 1 and 16. Default is 3

Maximum16
Minimum1
Default3

size of the data part of the packet, i.e. excluding any IP and ICMP headers. Value must be between 1 and 2048

Maximum2048
Minimum1
Default64

Time between packets in milliseconds. Value must be between 2 and 300000

Maximum30000
Minimum2
Default1000

Include the probe ID (encoded as ASCII digits) as part of the payload

Defaultfalse
Samples