Logo
Log in

Docs

Table of contents

  1. Generate a key
  2. Use a key
  3. Revoke a key

Generate a key

To generate a new key you need the following information:

If a key never expires it can be used to access the API forever, unless the key is revoked.

If a key has an expiry date (and time) it will not allow access to the API from that time. Revoking an expired key has no effect.

To begin, from the dashboard, click the big button:

Fill out the name and either enter a future expiry date or check the "Key never expires" checkbox:

Use an API key

Use HTTPS to send and receive data to/from the APIs.

To use a restricted API you must use an API key to authenticate your requests. This is done with the Authorization request header.

The standard header looks like:
Autorization: Apikey 76c94af1-7b3c-446f-b7e9-f8c291543293

To use your API key with curl:

  1. curl -H "Authorization: ApiKey 76c94af1-7b3c-446f-b7e9-f8c291543293" https://api.example.org

or wget:

  1. wget --header="Authorization: ApiKey 76c94af1-7b3c-446f-b7e9-f8c291543293" https://api.example.org

Revoke a key

You can stop a key from being used to access to API immediately at any time.

Revoking an expired key has no effect: the key stopped working when it expired.

To revoke a key:

  1. From the dashboard, click on the row in the table containing the key you wish to revoke.
  2. In the Revoke card, the Revoke button can be clicked if the key can be revoked.