RIPE Atlas Documentation

GET /measurements/{msm}/ ​

Show one measurement specified by ID

GET /measurements/{msm}/ — msm ​

The unique measurement ID.

GET /api/v2/measurements/{msm}/​

Show one measurement specified by ID

Try it out

Playground​

Authorization
Variables
Key
Value
Authorizations

Authorizations​

api-key
Type
API Key (header: Authorization)
or
or
anonymous

No authentication required — this endpoint can be accessed anonymously.

Parameters

Path Parameters

msm*

The unique measurement ID.

Type
integer
Required
Responses

Responses​

application/json
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. This 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

The number of days after which disconnected probes should be replaced in a measurement

Maximum30
Minimum1
Default7

Minimum similarity level for replacement probes

Format"double"
Maximum1
Minimum0
Default0.5

The number of hours after which the DNS record of the target should be looked up again

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 refers to a measurement acting as group master

Address family of the measurement (IPv4 of IPv6)

  • 4 - 4
  • 6 - 6
Valid values46

Indicates this is a one-off measurement

Distribution of probes' measurements throughout the interval (default is half the interval)

Indicates that a name should be resolved (using DNS) on the probe. If set to false then the name will be resolved centrally, 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 Autonomous System Number of the target IP address

Enclosing prefix of the target IP address

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. [deprecated/historical]

The list of IP addresses returned for the FQDN in the target field

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