API Keys

The preferred and most convenient method to authenticate to RIPE Atlas is to use API keys. API keys can be created via the web interface and there is documentation on how to do this. Note that you need a RIPE NCC Access account, which you can create here if you don't already have one.

You can assign permissions to API keys and you can share them with other people. Please keep in mind, though, that the RIPE Atlas keys are intended as secret keys. This means that an API key is the only thing needed to elevate the permissions of an arbitrary program or user to the level given by that particular API key.

The user who created the API key is referred to by RIPE Atlas as the creator of the key. Key permissions can never be greater than those of the creator. This also means that key permissions can be lowered when the creator's permissions are lowered.

API keys can be used used in the RIPE Atlas APIs in one of two ways:

  1. by passing them in as query parameters in a web request:

    • https://atlas.ripe.net/api/v2/measurements/?key=1233-3434-4556-565
  2. by including the key in the Authorization header, e.g. with curl:

    • curl -H "Authorization: Key 1233-3434-4556-565" "https://atlas.ripe.net/api/v2/measurements/"

Notes

  • A 403 Forbidden error will response will be returned if:

    • the API key does not provide the required permission;
    • the API key does not exist;
    • the API key is either not enabled or is outside of the defined valid from to valid to time range;
    • multiple API keys are presented using either multiple "key=" parameters, or a combination of "key=" parameters and the "Authorization" header.
  • Providing an empty "key" value is currently equivalent to not presenting a key at all. It is not recommended for you to to do this and the behaviour may change in future releases.

results matching ""

    No results matching ""