RIPE Atlas Documentation

GET /anchors/ ​

Resource describing the list of all announced anchors (public and disabled).

GET /anchors/ — as_v4 ​

Return all anchors within the specified IPv4 AS.

GET /anchors/ — as_v6 ​

Return all anchors within the specified IPv6 AS..

GET /anchors/ — country ​

Return all anchors in specified country. Specified as ISO 3166-1 alpha-2 code.

GET /anchors/ — format[datetime] ​

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

GET /anchors/ — include ​

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

GET /anchors/ — is_active ​

Return only anchors that are (not) active.

GET /anchors/ — is_decommissioned ​

Return only anchors that are (not) retired for good: decommissioned and with no other anchor still carrying the same FQDN — including one that has not been deployed yet. A replaced anchor whose hostname was taken over by its replacement is therefore NOT returned by is_decommissioned=true, from the moment that replacement exists rather than from the moment it goes public, while plain is_disabled=true does return it.

GET /anchors/ — is_disabled ​

Return only anchors that are (not) decommissioned.

GET /anchors/ — is_public ​

Return only anchors that are (not) publicly listed.

GET /anchors/ — page ​

A page number within the paginated result set.

GET /anchors/ — page_size ​

Number of results to return per page.

GET /anchors/ — probe_status ​

Only include anchors whose probe has this status (numeric value).

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

GET /anchors/ — probe_status__in ​

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

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

GET /anchors/ — probe_status__not ​

Exclude anchors whose probe has this status (numeric value). Anchors that have no probe yet are still returned.

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

GET /anchors/ — probe_status__not__in ​

Exclude anchors whose probe status is in this comma-separated list of numeric values. Anchors that have no probe yet are still returned.

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

GET /anchors/ — probe_status_name ​

Only include anchors whose probe has this status (human-readable name).

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

A search term.

GET /api/v2/anchors/​

Resource describing the list of all announced anchors (public and disabled).

Try it out

Playground​

Authorization
Variables
Key
Value
Authorizations

Authorizations​

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

No authentication required — this endpoint can be accessed anonymously.

Parameters

Query Parameters

as_v4

Return all anchors within the specified IPv4 AS.

Type
integer
as_v6

Return all anchors within the specified IPv6 AS..

Type
integer
country

Return all anchors in specified country. Specified as ISO 3166-1 alpha-2 code.

Type
string
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
"probe"
is_active

Return only anchors that are (not) active.

Type
boolean
is_decommissioned

Return only anchors that are (not) retired for good: decommissioned and with no other anchor still carrying the same FQDN — including one that has not been deployed yet. A replaced anchor whose hostname was taken over by its replacement is therefore NOT returned by is_decommissioned=true, from the moment that replacement exists rather than from the moment it goes public, while plain is_disabled=true does return it.

Type
boolean
is_disabled

Return only anchors that are (not) decommissioned.

Type
boolean
is_public

Return only anchors that are (not) publicly listed.

Type
boolean
page

A page number within the paginated result set.

Type
integer
page_size

Number of results to return per page.

Type
integer
probe_status

Only include anchors whose probe has this status (numeric value).

  • 0 - Never Connected
  • 1 - Connected
  • 2 - Disconnected
  • 3 - Abandoned
  • 4 - Written Off
Type
integer
Valid values
01234"null"
probe_status__in

Only include anchors whose probe 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
probe_status__not

Exclude anchors whose probe has this status (numeric value). Anchors that have no probe yet are still returned.

  • 0 - Never Connected
  • 1 - Connected
  • 2 - Disconnected
  • 3 - Abandoned
  • 4 - Written Off
Type
integer
Valid values
01234"null"
probe_status__not__in

Exclude anchors whose probe status is in this comma-separated list of numeric values. Anchors that have no probe yet are still returned.

  • 0 - Never Connected
  • 1 - Connected
  • 2 - Disconnected
  • 3 - Abandoned
  • 4 - Written Off
Type
integer
Valid values
01234
probe_status_name

Only include anchors whose probe has 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"
search

A search term.

Type
string
Responses

Responses​

application/json
object
Format"uri"
Format"uri"
object[]
Required

The id of the anchor

The type of the object

The fully qualified domain name of the anchor

The id of the probe that is hosted on this anchor

The IPv4 address (if any) of this anchor

The IPv4 AS this anchor belongs to

Maximum2147483647
Minimum0

The IPv4 gateway address of this anchor

The IPv4 netmask for the IP address of this anchor

The IPv6 address (if any) of this anchor

The IPv6 AS this anchor belongs to

Maximum2147483647
Minimum0

The IPv6 gateway address of this anchor

The IPv6 prefix of this anchor

Maximum2147483647
Minimum-2147483648

The city this anchor is located in

Max Length64

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

Host company

Max Length40

A GeoJSON point object containing the location of this anchor.
The longitude and latitude are contained within the coordinates array

Format"double"

Installed TLSA DNS resource record on this anchor

Max Length255
Format"date-time"
Format"date-time"
  • 0 - V1 (Dell)
  • 1 - V2 (Soekris)
  • 2 - V3 PC Engines
  • 98 - Clients own hardware
  • 99 - VM anchor
Valid values0129899
Minimum-2147483648
Maximum2147483647
Samples