Resources and Objects
The RIPE Atlas API exposes two types of resources for each object: Object List resources and Object Detail resources.
Object List Resources
An Object List resource returns a paginated collection of objects. The URL follows this pattern:
/api/v2/<OBJECTNAME_PLURAL>/For example, /api/v2/probes/ returns a list of probes.
The response is a JSON object with the following top-level fields:
| Field | Description |
|---|---|
count | Total number of objects matching the query |
next | URL for the next page of results (or null if on the last page) |
previous | URL for the previous page of results (or null if on the first page) |
results | Array of objects for the current page |
Each object in the results array includes at minimum:
id— a unique numeric identifiertype— a string identifying the object type (e.g."probe","measurement")
Lists are always paginated, with a maximum of 500 objects per page. You can control pagination with the page and page_size query parameters.
Results can be filtered using query parameters and sorted using the sort parameter. See Query Parameters and Filtering for details.
GET /api/v2/probes/?page=10&sort=id
Object Detail Resources
An Object Detail resource returns exactly one object. The URL follows this pattern:
/api/v2/<OBJECTNAME_PLURAL>/<OBJECT_ID>For example, /api/v2/probes/143 returns the details for probe 143.
The response is a single JSON object. Like list items, it always includes type and id fields, along with all the default fields for that object type.
GET /api/v2/probes/143/