GET /probes/

List all RIPE Atlas probes. It is possible to get basic information on probes that are not marked 'public', but operational details will be obscured.

GET /probes/ — asn

Only include probes with an IPv4 or IPv6 address announced by this ASN.

GET /probes/ — asn46diff

Only include probes where the announced ASN of the IPv4 and IPv6 addresses differ.

GET /probes/ — asn_v4

Only include probes with an IPv4 address announced by this ASN.

GET /probes/ — asn_v4__in

Only include probes with an IPv4 address announced by an ASN in this comma-separated list.

GET /probes/ — asn_v6

Only include probes with an IPv6 address announced by this ASN.

GET /probes/ — asn_v6__in

Only include probes with an IPv4 address announced by an ASN in this comma-separatedd list.

GET /probes/ — country_code

Only include probes in this country (ISO 3166-1 alpha-2 code).

GET /probes/ — country_code__in

Only include probes in any of the countries in this comma-separated list of ISO 3166-1 alpha-2 codes.

GET /probes/ — favourite

Filter by whether the probe is in the authenticated user's favourites.

GET /probes/ — 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/ — firmware_version

Only include probes running this firmware version.

GET /probes/ — format

GET /probes/ — format[datetime]

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

GET /probes/ — hidden

Filter by whether the probe is in the authenticated user's hidden/archived list.

GET /probes/ — id__gt

Only include probes with IDs greater than this value.

GET /probes/ — id__gte

Only include probes with IDs greater than or equal to this value.

GET /probes/ — id__in

Only include probes with IDs in this comma-separated list.

GET /probes/ — id__lt

Only include probes with IDs less than this value.

GET /probes/ — id__lte

Only include probes with IDs less than or equal to this value.

GET /probes/ — include

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

GET /probes/ — is_anchor

Only include anchors.

GET /probes/ — is_public

Only include probes marked as public.

GET /probes/ — latitude

Only include probes at exactly this latitude (in degrees).

GET /probes/ — latitude__gt

Only include probes with a latitude greater than this value (in degrees).

GET /probes/ — latitude__gte

Only include probes with a latitude greater than or equal to this value (in degrees).

GET /probes/ — latitude__lt

Only include probes with a latitude less than this value (in degrees).

GET /probes/ — latitude__lte

Only include probes with a latitude less than or equal to this value (in degrees).

GET /probes/ — longitude

Only include probes at exactly this longitude (in degrees).

GET /probes/ — longitude__gt

Only include probes with a longitude greater than this value (in degrees).

GET /probes/ — longitude__gte

Only include probes with a longitude greater than or equal to this value (in degrees).

GET /probes/ — longitude__lt

Only include probes with a longitude less than this value (in degrees).

GET /probes/ — longitude__lte

Only include probes with a longitude less than or equal to this value (in degrees).

GET /probes/ — optional_fields

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

GET /probes/ — page

A page number within the paginated result set.

GET /probes/ — page_size

Number of results to return per page.

GET /probes/ — prefix_v4

Only include probes whose IPv4 address falls within this prefix (e.g. 192.0.2.0/24).

GET /probes/ — prefix_v6

Only include probes whose IPv6 address falls within this prefix (e.g. 2001:db8::/32).

GET /probes/ — radius

Only include probes within a given radius, expressed as 'lat,lon:radius' where lat/lon are in degrees and radius is in kilometres.

GET /probes/ — search

Search probes by description, ID, or ASN.

GET /probes/ — sort

Which field to use when ordering the results.

GET /probes/ — status

Only include probes with this status (numeric value).

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

GET /probes/ — status__in

Only include probes whose status is in this comma-separated list of numeric values.

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

GET /probes/ — status_name

Only include probes with this status (human-readable name).

• Never Connected - Never Connected
• Connected - Connected
• Disconnected - Disconnected
• Abandoned - Abandoned
• Written Off - Written Off

GET /probes/ — tags

Only include probes matching all tags in this comma-separated list.

GET /api/v2/probes/

List all RIPE Atlas probes.

It is possible to get basic information on probes that are not marked "public",
but operational details will be obscured.

Try it out

Playground

Authorization

api-key

Variables

Key

Value

asn

asn46diff

asn_v4

asn_v4__in

asn_v6

asn_v6__in

country_code

country_code__in

favourite

fields

firmware_version

format

format[datetime]

hidden

id__gt

id__gte

id__in

id__lt

id__lte

include

is_anchor

is_public

latitude

latitude__gt

latitude__gte

latitude__lt

latitude__lte

longitude

longitude__gt

longitude__gte

longitude__lt

longitude__lte

optional_fields

page

page_size

prefix_v4

prefix_v6

radius

search

sort

status

status__in

status_name

tags

Authorizations

Authorizations

api-key

Type

API Key (header: Authorization)

or

ripe-access

Type

API Key (cookie: crowd.token_key)

or

anonymous

No authentication required — this endpoint can be accessed anonymously.

Parameters

Query Parameters

asn

Only include probes with an IPv4 or IPv6 address announced by this ASN.

Type

number

asn46diff

Only include probes where the announced ASN of the IPv4 and IPv6 addresses differ.

Type

boolean

asn_v4

Only include probes with an IPv4 address announced by this ASN.

Type

integer

asn_v4__in

Only include probes with an IPv4 address announced by an ASN in this comma-separated list.

Type

integer

Maximum

2147483647

Minimum

-2147483648

asn_v6

Only include probes with an IPv6 address announced by this ASN.

Type

integer

asn_v6__in

Only include probes with an IPv4 address announced by an ASN in this comma-separatedd list.

Type

integer

Maximum

2147483647

Minimum

-2147483648

country_code

Only include probes in this country (ISO 3166-1 alpha-2 code).

Type

string

Valid values

"""AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR""AS""AT""AU""AW""AX""AZ""BA""BB""BD""BE""BF""BG""BH""BI""BJ""BL""BM""BN""BO""BQ""BR""BS""BT""BV""BW""BY""BZ""CA""CC""CD""CF""CG""CH""CI""CK""CL""CM""CN""CO""CR""CU""CV""CW""CX""CY""CZ""DE""DJ""DK""DM""DO""DZ""EC""EE""EG""EH""ER""ES""ET""FI""FJ""FK""FM""FO""FR""GA""GB""GD""GE""GF""GG""GH""GI""GL""GM""GN""GP""GQ""GR""GS""GT""GU""GW""GY""HK""HM""HN""HR""HT""HU""ID""IE""IL""IM""IN""IO""IQ""IR""IS""IT""JE""JM""JO""JP""KE""KG""KH""KI""KM""KN""KP""KR""KW""KY""KZ""LA""LB""LC""LI""LK""LR""LS""LT""LU""LV""LY""MA""MC""MD""ME""MF""MG""MH""MK""ML""MM""MN""MO""MP""MQ""MR""MS""MT""MU""MV""MW""MX""MY""MZ""NA""NC""NE""NF""NG""NI""NL""NO""NP""NR""NU""NZ"null"OM""PA""PE""PF""PG""PH""PK""PL""PM""PN""PR""PS""PT""PW""PY""QA""RE""RO""RS""RU""RW""SA""SB""SC""SD""SE""SG""SH""SI""SJ""SK""SL""SM""SN""SO""SR""SS""ST""SV""SX""SY""SZ""TC""TD""TF""TG""TH""TJ""TK""TL""TM""TN""TO""TR""TT""TV""TW""TZ""UA""UG""UM""US""UY""UZ""VA""VC""VE""VG""VI""VN""VU""WF""WS""YE""YT""ZA""ZM""ZW"

country_code__in

Only include probes in any of the countries in this comma-separated list of ISO 3166-1 alpha-2 codes.

Type

string

Valid values

"""AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR""AS""AT""AU""AW""AX""AZ""BA""BB""BD""BE""BF""BG""BH""BI""BJ""BL""BM""BN""BO""BQ""BR""BS""BT""BV""BW""BY""BZ""CA""CC""CD""CF""CG""CH""CI""CK""CL""CM""CN""CO""CR""CU""CV""CW""CX""CY""CZ""DE""DJ""DK""DM""DO""DZ""EC""EE""EG""EH""ER""ES""ET""FI""FJ""FK""FM""FO""FR""GA""GB""GD""GE""GF""GG""GH""GI""GL""GM""GN""GP""GQ""GR""GS""GT""GU""GW""GY""HK""HM""HN""HR""HT""HU""ID""IE""IL""IM""IN""IO""IQ""IR""IS""IT""JE""JM""JO""JP""KE""KG""KH""KI""KM""KN""KP""KR""KW""KY""KZ""LA""LB""LC""LI""LK""LR""LS""LT""LU""LV""LY""MA""MC""MD""ME""MF""MG""MH""MK""ML""MM""MN""MO""MP""MQ""MR""MS""MT""MU""MV""MW""MX""MY""MZ""NA""NC""NE""NF""NG""NI""NL""NO""NP""NR""NU""NZ"null"OM""PA""PE""PF""PG""PH""PK""PL""PM""PN""PR""PS""PT""PW""PY""QA""RE""RO""RS""RU""RW""SA""SB""SC""SD""SE""SG""SH""SI""SJ""SK""SL""SM""SN""SO""SR""SS""ST""SV""SX""SY""SZ""TC""TD""TF""TG""TH""TJ""TK""TL""TM""TN""TO""TR""TT""TV""TW""TZ""UA""UG""UM""US""UY""UZ""VA""VC""VE""VG""VI""VN""VU""WF""WS""YE""YT""ZA""ZM""ZW"

favourite

Filter by whether the probe is in the authenticated user's favourites.

Type

boolean

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

firmware_version

Only include probes running this firmware version.

Type

number

format

Type

string

Valid values

"geojson""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"

hidden

Filter by whether the probe is in the authenticated user's hidden/archived list.

Type

boolean

id__gt

Only include probes with IDs greater than this value.

Type

number

id__gte

Only include probes with IDs greater than or equal to this value.

Type

number

id__in

Only include probes with IDs in this comma-separated list.

Type

integer

id__lt

Only include probes with IDs less than this value.

Type

number

id__lte

Only include probes with IDs less than or equal to this value.

Type

number

include

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

Type

string

Valid values

"measurements"

is_anchor

Only include anchors.

Type

boolean

is_public

Only include probes marked as public.

Type

boolean

latitude

Only include probes at exactly this latitude (in degrees).

Type

number

Format

"float"

latitude__gt

Only include probes with a latitude greater than this value (in degrees).

Type

number

Format

"float"

latitude__gte

Only include probes with a latitude greater than or equal to this value (in degrees).

Type

number

Format

"float"

latitude__lt

Only include probes with a latitude less than this value (in degrees).

Type

number

Format

"float"

latitude__lte

Only include probes with a latitude less than or equal to this value (in degrees).

Type

number

Format

"float"

longitude

Only include probes at exactly this longitude (in degrees).

Type

number

Format

"float"

longitude__gt

Only include probes with a longitude greater than this value (in degrees).

Type

number

Format

"float"

longitude__gte

Only include probes with a longitude greater than or equal to this value (in degrees).

Type

number

Format

"float"

longitude__lt

Only include probes with a longitude less than this value (in degrees).

Type

number

Format

"float"

longitude__lte

Only include probes with a longitude less than or equal to this value (in degrees).

Type

number

Format

"float"

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"

page

A page number within the paginated result set.

Type

integer

page_size

Number of results to return per page.

Type

integer

prefix_v4

Only include probes whose IPv4 address falls within this prefix (e.g. 192.0.2.0/24).

Type

string

prefix_v6

Only include probes whose IPv6 address falls within this prefix (e.g. 2001:db8::/32).

Type

string

radius

Only include probes within a given radius, expressed as 'lat,lon:radius' where lat/lon are in degrees and radius is in kilometres.

Type

string

search

Search probes by description, ID, or ASN.

Type

string

sort

Which field to use when ordering the results.

Type

string

status

Only include probes with this status (numeric value).

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

Type

integer

Valid values

01234"null"

status__in

Only include probes whose status is in this comma-separated list of numeric values.

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

Type

integer

Valid values

01234

status_name

Only include probes with this status (human-readable name).

• Never Connected - Never Connected
• Connected - Connected
• Disconnected - Disconnected
• Abandoned - Abandoned
• Written Off - Written Off

Type

integer

Valid values

"Abandoned""Connected""Disconnected""Never Connected""Written Off"

tags

Only include probes matching all tags in this comma-separated list.

Type

string

Responses

Responses

Content-Type

object

Format"uri"

Format"uri"

object[]

Required

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