RIPE Atlas Documentation

GET /probes/{probe_id}/ ​

Retrieve information on a single RIPE Atlas probe.

GET /probes/{probe_id}/ — fields ​

Comma-separated list of fields to include in response, in addition to 'type' and 'id' which are always present. Optional fields can be listed here also.

GET /probes/{probe_id}/ — format ​

GET /probes/{probe_id}/ — format[datetime] ​

Output datetimes in ISO-8601 format ('iso-8601' or 'json') or as seconds since the epoch ('unix' or 'timestamp')

GET /probes/{probe_id}/ — include ​

Include additional fields named in comma-separated values in response as nested JSON objects.

GET /probes/{probe_id}/ — optional_fields ​

Comma-separated list of optional fields named to include in response objects.

GET /probes/{probe_id}/ — probe_id ​

The unique probe ID.

GET /api/v2/probes/{probe_id}/​

Retrieve information on a single RIPE Atlas probe.

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

Path Parameters

probe_id*

The unique probe ID.

Type
integer
Required

Query Parameters

fields

Comma-separated list of fields to include in response, in addition to 'type' and 'id' which are always present. Optional fields can be listed here also.

Type
string
format
Type
string
Valid values
"json""txt"
format[datetime]

Output datetimes in ISO-8601 format ('iso-8601' or 'json') or as seconds since the epoch ('unix' or 'timestamp')

Type
string
Valid values
"iso-8601""json""timestamp""unix"
include

Include additional fields named in comma-separated values in response as nested JSON objects.

Type
string
Valid values
"measurements"
optional_fields

Comma-separated list of optional fields named to include in response objects.

Type
string
Valid values
"country_name""measurements""connection_af""connection_controller"
Responses

Responses​

object

help_text on the fields will be displayed in the swagger interface inside the ResponseClass table.

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

The last IPv6 address that was known to be held by this probe, or null if there is no known address.

The IPv4 ASN if any

The IPv6 ASN if any

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

User defined description of the probe

When the probe connected for the first time (UTC Time and date in ISO-8601/ECMA 262 format)

Format"date-time"

A GeoJSON point object containing the user-supplied location of this probe.
The longitude and latitude are contained within the coordinates array

Format"double"

The id of the probe

Whether or not this probe is a RIPE Atlas Anchor

If a probe is not public then certain details, including exact IP addresses, are not returned.

When the probe connected for the last time (UTC Time and date in ISO-8601/ECMA 262 format)

Format"date-time"

The IPv4 prefix if any

The IPv6 prefix if any

object
Required

An object describing the probe status.

Status ID.

  • 0 - Never Connected
  • 1 - Connected
  • 2 - Disconnected
  • 3 - Abandoned
  • 4 - Written Off
Valid values01234

Human-readable status name.

  • Never Connected - 0
  • Connected - 1
  • Disconnected - 2
  • Abandoned - 3
  • Written Off - 4
Valid values"Never Connected""Connected""Disconnected""Abandoned""Written Off"

Time the status last changed.

Format"date-time"

Time the status last changed.

Format"date-time"
object[]
Required

Human-readable tag name.

Lower-case, hyphenated tag slug.

Accumulated uptime for this probe in seconds

The type of the object

Samples