APIs Overview

Here are some resources that will help you get started with the RIPE Atlas APIs.

API Objects

There are three main "objects" that you will encounter in our APIs: Measurements, Probes and Measurement Results. Measurements and Probes are objects that are available from the metadata API. Measurement results are available from the Results Stream API.

Connecting to the APIs

The APIs are primarily designed to be used programmatically through the REST web interface, over HTTPS using well-known HTTP verbs like GET, POST, etc.

Querying the metadata web API directly in a browser will return a special API webpage that allows you to browse it.

We also have a number of libraries, most notably Sagan and Cousteau, that allow you to interface with the APIs from a Python program. We also have a set of command-line interface tools available that use the APIs under the hood.

Authenticating to the APIs

First of all, you don't have to authenticate to any of our APIs – you can use them as an anonymous user. You will be able to request all publicly available information, but some information is not visible.

To create measurements and to see information about your own probes, you will have to identify yourself to RIPE Atlas. There are two methods to authenticate.

The first and most useful method from a client program is to use authentication keys. These keys cannot be created using the API; they must be created using the web interface.

The second method is to log in with your RIPE NCC Access account credentials and use the session-based cookie in your API requests. This method is primarily used to authenticate AJAX requests from web browsers. You can create a RIPE NCC Access account here.

More Detailed Information About the APIs

This manual is only an introduction. If you need to look up detailed information, you can go to the API reference. The API reference lists all fields, query parameters and payload specifications for most objects.

api reference window

results matching ""

    No results matching ""