> For the complete documentation index, see [llms.txt](https://learn.doubletick.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://learn.doubletick.io/settings/how-to-create-and-manage-your-api-key-in-doubletick.md).

# How to Create and Manage Your API Key in DoubleTick

#### <mark style="color:$primary;">**What is an API Key and Why Do You Need One?**</mark>

An API key is like a special password that lets other tools and apps connect to your DoubleTick account. For example, if you want to link DoubleTick with your CRM, automation tool, or any custom software — you'll need an API key to make that connection work.

This article walks you through creating your first API key and understanding everything you can do with it.

***

#### <mark style="color:$primary;">**Step 1: Go to Your API Key Settings**</mark>

<figure><img src="/files/ou87OS1Pnkfs2YGAToZH" alt=""><figcaption></figcaption></figure>

1. Log in to your DoubleTick account.
2. Click on **Settings** in the left navigation bar.
3. Scroll down and click on **Developer Documentation**.

You'll land on the **Manage your API keys** page. This is where all your API keys are listed — you can see each key's name, status, and when it was last used.

***

#### <mark style="color:$primary;">**Step 2: Create a New API Key**</mark>

<figure><img src="/files/Nb27oLqHR7AgIhWZgdeM" alt=""><figcaption></figcaption></figure>

1. Click the **+ Create new key** button at the top right of the page.
2. A small pop-up will appear. In the **Key name** field, type a name that helps you remember what this key is for — for example, "CRM Integration" or "WhatsApp Automation".
3. Click **Generate key**.
4. Your new API key will appear on the screen. **Copy it right away and save it somewhere safe** — like a password manager or a secure notes app.
5. Click **Done** to close the pop-up.

**Important:** Once you click Done, the full key is hidden permanently and cannot be viewed again. If you lose it, you'll have to regenerate a new one.

***

#### <mark style="color:$primary;">**Step 3: Manage Your API Key**</mark>

Click on any key in the list to open it. You'll see three tabs — here's what each one does:

#### <mark style="color:$primary;">**Overview Tab**</mark>

<figure><img src="/files/oc9cUmK2YfxzcmIvmvzn" alt=""><figcaption></figcaption></figure>

This is the first thing you'll see when you open a key. It shows you:

* **Created date** — the date this key was generated.
* **Last used** — the last time this key was used to make a connection. If you've never used it, it will show "Never".
* **Status** — tells you if the key is active and working.
* **Regenerate Key** — clicking this creates a brand new key. Use this if you think your key has been exposed or compromised. Note: your old key will stop working immediately when you do this.
* **Delete Key** — permanently removes this key. Use this only if you no longer need it.

#### <mark style="color:$primary;">**Usage Tab**</mark>

<figure><img src="/files/GgifgBsFMVQOCDOgQKHQ" alt=""><figcaption></figcaption></figure>

This tab shows you how your API key is being used. You can filter the data by the last **24 hours**, **7 days**, or **30 days**.

You'll see:

* **Total API calls** — how many times the key has been used to connect with DoubleTick.
* **APIs being used** — which specific features or endpoints are being accessed.
* **IP addresses** — the IP addresses from which the connections are being made.

This is useful for keeping an eye on your account activity and catching anything unusual early.

#### <mark style="color:$primary;">**Whitelist Tab**</mark>

<figure><img src="/files/7uFXMfbTTF6PGswSBvWI" alt=""><figcaption></figcaption></figure>

This tab lets you add an extra layer of security to your API key by restricting which IP addresses can use it.

Think of it this way — even if someone gets hold of your API key, they won't be able to use it unless they're connecting from an IP address you've approved.

To set it up:

1. Toggle on **"Restrict this key to whitelisted IPs"**.
2. Enter your public IP address and give it a label (e.g., "Office Server").
3. Click **Add IP**.

That's it! Only connections from that IP will be allowed going forward.

***

#### <mark style="color:$primary;">**Quick Tips to Keep Your API Key Safe**</mark>

* Give each key a clear, descriptive name so you always know what it's connected to.
* Never share your API key publicly or paste it into emails or chats.
* Check the Usage tab regularly to spot any unexpected activity.
* Enable IP whitelisting whenever possible — it's one of the best ways to secure your key.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://learn.doubletick.io/settings/how-to-create-and-manage-your-api-key-in-doubletick.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.