API Keys

Introduction

API keys are used to authenticate requests to the API. They identify the user and project making the request.

Include your API key in the Authorization header of every request:

curl https://api.ittybit.com/tasks \
-H "Authorization: Bearer ITTYBIT_API_KEY"

Or use the fetch API:

const response = await fetch('https://api.ittybit.com/tasks', {
  headers: { 'Authorization': 'Bearer ITTYBIT_API_KEY' }
})
const tasks = await response.json()

Keys give access to all the resources for the project so you should not share them with anyone.

Create an API Key

When you first create a project, you will be asked to create an API key.

Click 'Generate Key', then copy the key to your clipboard. This is the only time the full key is shown.

View your API keys

Project Dashboard

Whenever you need to grab your API key, you can do so from the 'Quick Start' section of the project dashboard.

Project Settings

You can also view and manage your keys from your project settings page. Settings is accessible from the sidebar menu.

Pause API Key

You can pause an API key to temporarily stop it from being used, while retaining the option to re-enable it.

This is useful if you need to test changes in your system without causing side effects, or to prevent runaway costs during an unexpected busy period.

Delete API Key

You can delete an API key to permanently remove it from the project. This will immediately stop all requests using the key.

Deleting a key is irreversible.

Roll API Keys

If you need to rotate a project's API key, you can do so without downtime by:

1. Creating a new key in project settings
2. Updating your code to use the new key
3. Deleting the old key