> For the complete documentation index, see [llms.txt](https://docs.appear.sh/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.appear.sh/installation/connections.md).

# Connections

Once you've installed the SDK, connected to the API endpoint, or integrated with OTel, you can now connect your Appear account to your environments.

## Overview

{% hint style="info" %}
Precondition: you must have installed the Appear introspector agent SDK (or installed via other methods) first, before you can establish a connection successfully.
{% endhint %}

Connections represent the relationship between Appear's introspector agent and your service. Every time you deploy Appear's agent into your codebases, a connection will be created.

## Add a connection

To create a connection, follow these steps:

{% stepper %}
{% step %}

### Log into your Appear account

Visit <https://app.appear.sh/sign-in> and sign in to Appear with your credentials
{% endstep %}

{% step %}

### View the Connections page

<div align="left" data-full-width="true"><figure><img src="https://4271365556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLEIq2n49ebGjzhVFTmTm%2Fuploads%2F4MPst6m4YmCg9rm4hJ9A%2FCleanShot%202025-05-05%20at%2013.11.41.png?alt=media&amp;token=66a20ec1-ac34-40f4-9efa-9d85225b90aa" alt=""><figcaption><p>The Connections view link is in the side navigation</p></figcaption></figure></div>

Open the side menu to access the **Connections** page, or click **Add connection** when on an empty service.
{% endstep %}

{% step %}

### Add a new connection

Click on the 'Add connection' button, which will open the connection creation guide.

<figure><img src="https://4271365556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLEIq2n49ebGjzhVFTmTm%2Fuploads%2FFlIwwJ8Tg93WDsJBsCuH%2FCleanShot%202025-05-05%20at%2013.21.51.png?alt=media&amp;token=5f98d3b7-19c7-4390-a7a3-cd77a7451116" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Create or select an environment

The first step is to create a new environment or select an existing one. If you have already installed and deployed the Appear introspector agent, there will be environment options to select from.

If you're creating a new environment, type in the name and click **Create**, then click **Continue.**

<figure><img src="https://4271365556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLEIq2n49ebGjzhVFTmTm%2Fuploads%2F1eJxdArIGAeb9SUvdVel%2FCleanShot%202025-05-05%20at%2013.16.51.png?alt=media&amp;token=786b84ee-e20c-476a-93b6-c71ca95197d2" alt=""><figcaption><p>The first step in the connection creation guide is to select or create your environment.</p></figcaption></figure>

Read about branches and environments in our dedicated explainer page [here](/explanations/branches-and-environments.md).
{% endstep %}

{% step %}

### Choose a framework

Browse the supported languages and frameworks for Appear's introspector agent and click on the one relevant for the codebase you're installing into.

<figure><img src="https://4271365556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLEIq2n49ebGjzhVFTmTm%2Fuploads%2FVKYZOkZm4iGf2VXURJ68%2FCleanShot%202025-05-05%20at%2013.23.32.png?alt=media&amp;token=ca38d8d6-7cd9-4e6e-9bbf-be05e1ceca44" alt=""><figcaption><p>Click or search through Appear's introspector agent's supported languages and frameworks.</p></figcaption></figure>

Appear's [product-map](/resources/product-map.md) and [installation guides](/getting-started/installation.md) express what languages and frameworks supported both current and planned.
{% endstep %}

{% step %}

### Configure your installation: Naming your service

Now you can configure your installation script with a **Service name** which helps the introspector understand the traffic and networking relationships.

<figure><img src="https://4271365556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLEIq2n49ebGjzhVFTmTm%2Fuploads%2FgqqBHOsVNeWPNZlTabRJ%2FCleanShot%202025-05-05%20at%2013.28.07.png?alt=media&amp;token=09c2d969-e498-48fb-955b-12da963608a3" alt=""><figcaption><p>Add a relevant service name to your installation. This will help better relate traffic to your service.</p></figcaption></figure>
{% endstep %}

{% step %}

### Scope your API key

Give your API key a name, then scope it based on its use and expiry.

Scope it by choosing between:

* **Reporting only**, or
* **Everything**

Choose an expiry options:

* **30 days**
* **60 days**
* **90 days, or**
* **No expiration**

<figure><img src="https://4271365556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLEIq2n49ebGjzhVFTmTm%2Fuploads%2FpOVa6y2S9sE8fl8SyodW%2FCleanShot%202025-05-05%20at%2013.29.24.png?alt=media&amp;token=1bc7c576-d495-4a80-955d-c574c2ff71db" alt=""><figcaption><p>You can define your API scope's access and expiry.</p></figcaption></figure>

Once you're comfortable with the settings, click **Save Settings**, and then **Continue**.
{% endstep %}

{% step %}

### Invite your team&#x20;

The next step is designed primarily for new user onboarding and provides a simple user experience for adding team members.

This is skippable if not relevant for your use-case.
{% endstep %}

{% step %}

### Complete

The connection is now created. You can now view the connections or dive into your **Catalog** to watch the services appear once the introspector agent is [installed](/getting-started/installation.md) and deployed or run locally.
{% endstep %}
{% endstepper %}

## View connections

Once you've created a connection you can view them in the **Connections** view. This page lists out all your active and inactive connections, which are specific to your environment.

### Connection list

The connections you create through the **Add connection** process or from installing Appear's introspector agent will appear automatically in the **Connections** view.

<figure><img src="https://4271365556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLEIq2n49ebGjzhVFTmTm%2Fuploads%2FXIyGFs0PXsjVNXKOqPf1%2FCleanShot%202025-05-05%20at%2022.04.55.png?alt=media&amp;token=47ffb06d-c816-4b78-9d93-dd0c3e6cb39f" alt=""><figcaption><p>The connection list shows the state of your installed agents.</p></figcaption></figure>

### Connections panel

You can view each connection in your list to see some extra detail which can be useful for understanding if the Appear agent is reporting as expected.&#x20;

<figure><img src="https://4271365556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLEIq2n49ebGjzhVFTmTm%2Fuploads%2FNU5bSxGK4eYBTg7a8FbB%2FCleanShot%202025-05-05%20at%2022.00.55.png?alt=media&amp;token=d43ae211-dad7-48cb-9994-4b7f697e3755" alt=""><figcaption><p>Opening a connection shows connection metadata useful for debugging, in addition to a quick install guide reference.</p></figcaption></figure>

***

If you have any queries or require support with the above instructions, please [get in touch](/getting-started/get-in-touch.md) with us.