API Keys

Last updated 9 days ago

Programmatic access to your Timber account

API keys grant access to all resources within your organization. They should be used for programmatic access to your Timber account.

Timber's API keys grant admin level access to your organization's resources. Please treat your API keys with care!

Getting Started

Each organization comes with a default API key. This API key is used during setup of your sources. See this FAQ for more information.

  1. Navigate to the Settings section using the main navigation.

  2. Click on the "API keys" tab.

Usage

You must have admin level privileges to access or modify API keys

Obtaining An API

You can obtain an API key by accessing the "API keys" section within your organization settings. Once there you have 2 choices:

  1. Create a new API key by clicking "Create Key"

  2. Copying the key of an existing API key.

Please read this FAQ on when to create or reuse an API key.

Deleting / Revoking / Rotating An API Key

You can delete an API key by navigating to the "API K

Using An API Key

You can use the API key to interface with Timber's API, Timber's CLI, or any of our language, platform, log forwarder, or operating system integrations.

How It Works

Timber's API keys are JSON web tokens. They are used within the Authorization header when making requests to the Timber API. They are scoped to all resources beneath the organization they belong.

FAQs

When should I create a new API key or reuse an existing one?

We recommend creating an API for each operator (machine or person). This gives you the ability to revoke access for an individual operator if necessary.

For example, let's say you need an API key to send logs to Timber from your application, and you also need an API key for a developer on your team to use the Timber CLI. You should create 2 separate API keys for both of these operators, this way if your developer leaves the company you can simply delete their API key without disrupting your app.

Can I grant custom access for each API key?

Not at this time. Timber's API keys grant the holder admin level privileges to your organization's resources. Treat your API keys with care!

Do API keys expire?

No, not at this time. As long as the API key lives in your account it is active. Timber currently does not implement a token / exchange access system with expiring keys.