# CircleCI

## About the integration

The CircleCI integration provides Sleuth with the ability to track your CircleCI builds and associate them with your corresponding Sleuth deploys. Once configured, the Sleuth CircleCI integration silently monitors your deployment activity, and ties your CircleCI builds with associated deployments you make to your integrated change sources by matching the git SHAs from your code repos. Sleuth then shows you a snapshot of your build state at the time of deploy.

## Setting up the integration

To add the Sleuth CircleCI integration:

1. Click **Integrations** in the sidebar.
2. Click the\*\* CI/CD\*\* tab, then click **enable** in the CircleCI card.\
   ![](/files/-MFHfuRWPeXOtqe8dTvc)
3. Enter your CircleCI User API Token, then press **Save**. To quickly obtain your User API Token, make sure you're logged in to your CircleCI account, then click **generate**. You will be taken to the Personal API Tokens section of your CircleCI account.
4. On successful integration, you'll see **CircleCI enabled** displayed in the CircleCI tile. You'll configure the default build server later.\
   ![](/files/-MFHfyS5XH86pv5qwYgm)

[Read the CircleCI documentation](https://circleci.com/docs/2.0/managing-api-tokens/#creating-a-personal-api-token) for more information on generating Personal API Tokens.

![Sleuth CircleCI Personal API Token entry dialog](/files/-MATRY2k7goJ8Ov4dKdG)

![Generate a new CircleCI Personal API Token in your CircleCI User settings](/files/-MAYdLuKWoXWClUwfmfb)

## Configuring the integration

The Sleuth CircleCI integration configuration simply consists of pointing the CircleCI integration to your projects that you want Sleuth to collect build information for.

To configure the CircleCI integration, you will need to set a default build server:

1. Click **Integrations** in the sidebar, then click the **Builds** tab.
2. Click the **Set default build server** dropdown.\
   ![](/files/-MAYfwf1PuSXzSjiMfPh)
3. Select a project to set as the default build server. You'll need to add a code deployment to the selected project if you haven't already done so.

Now that the CircleCI integration is configured, you will begin seeing information displayed in the Builds tab of a [deploy](/sleuth-dora/modeling-your-deployments/deploy-cards.md), as shown below.

![](/files/-MSQCLExzMKdr58aKGsb)

## Removing the integration

#### If you wish to disconnect the CircleCI integration for the organization:

1. Click on **Integrations** in the left sidebar, then on **Builds**.
2. In the CircleCI integration card, click **disable**. The message **CircleCI disabled** is displayed in the CircleCI integration card once the integration is dissolved.

The CircleCI integration is disconnected and no longer available to any projects within that organization.


---

# Agent Instructions: 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://help.sleuth.io/sleuth-dora/integrations-1/builds/circleci.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.