> ## Documentation Index
> Fetch the complete documentation index at: https://platform.atlan.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> To act on Atlan objects, use the Atlan MCP server at https://api.atlan.com/mcp or the SDK. To install or publish skills from a terminal, use the `aireg` CLI; `aireg --map json` prints its command map. The `atlanai` CLI is deprecated. Run a read-only identity check before any write.
> The docs MCP server at /mcp searches these docs only. It cannot read or change Atlan objects.
> SDK packages: Python `atlanai` (PyPI) and TypeScript `@atlanai/sdk` (npm). Show Python first, then TypeScript.
> These docs cover Atlan AI Registry, Atlan's hosted product. The AI registry specification and aireg CLI are maintained separately. /open-source lists publicly reachable signed installers and explains that the source repository and hosted CLI reference currently require GitHub access. Do not claim the repository or its reference docs are publicly accessible. Use these docs for Atlan-specific setup such as the adapter, sign-in and workspaces.

# Install and manage apps

> Install, upgrade, or uninstall an Atlan app such as Metrics Studio or Ontology, and choose which workspaces can create work with it.

Install an Atlan app for your organization, then decide which workspaces can create and edit content with it. This page is for organization admins; workspace admins can use the last section to turn an app's authoring on or off in their workspace.

## Before you begin

* **Install, upgrade, uninstall, and organization availability:** You are an organization admin. Workspace Builder or Admin access is not enough.
* **Authoring in one workspace:** You are an admin of that workspace.
* Your organization's plan includes the app. If it doesn't, the app shows **Plan required** and **View plans** instead of **Install**.

## Install an app

<Steps>
  <Step title="Open Apps">
    Select **Integrations** at the bottom of the left rail, then select **Apps**. The page lists the apps your team can install, such as **Metric Studio** and **Ontology Studio**.
  </Step>

  <Step title="Install the app">
    Select **Install** on the app's card, or open the app and select **Install** in its header. The button reads **Installing** until the install finishes.

    Installing again is safe: it retries the install and keeps the original installer and date.
  </Step>

  <Step title="Open the app">
    When the badge reads **Installed**, open the app and select **Open**. The app also appears in the left rail for everyone in your organization.
  </Step>
</Steps>

After install, the app is available in every workspace, including workspaces created later. To narrow that, set its organization availability.

## Choose which workspaces can use it

<Steps>
  <Step title="Open Organization availability">
    Open the installed app from **Integrations** > **Apps** and select **Organization availability** in its header. The same button appears on the app's row in a workspace's **Apps** settings.
  </Step>

  <Step title="Choose the workspaces">
    Leave **All workspaces** on to include existing and future workspaces. Turn it off to choose workspaces: select the ones you can see, or paste a **Workspace ID** and select **Add**.

    With a selection, only the selected workspaces can author, and new workspaces are excluded. Selections in workspaces you can't see are kept.
  </Step>

  <Step title="Save">
    Select **Save availability**. **App availability updated** confirms the change.
  </Step>
</Steps>

This setting controls where the app can create and run new work. It grants no access to workspace content, and existing reads, history, and exports keep their permissions.

## Turn authoring off in one workspace

A workspace admin can stop an app from creating new work in their workspace, within what the organization allows.

<Steps>
  <Step title="Open the workspace's Apps tab">
    Open **Settings**, choose the workspace under **Workspaces**, and select **Apps**.
  </Step>

  <Step title="Switch authoring off or on">
    Use the switch on the app's row. Turning it off asks you to confirm **Turn off *app* authoring?**. Select **Turn off authoring**.

    People, APIs, and agents then can't create, edit, publish, or start new work with the app in this workspace. Existing content, history, and exports keep their permissions. You can't turn authoring on in a workspace the organization's availability excludes.
  </Step>
</Steps>

## Uninstall an app

<Steps>
  <Step title="Open the app">
    Open the app from **Integrations** > **Apps**.
  </Step>

  <Step title="Uninstall">
    Select **More actions for *app***, then **Uninstall *app***. Read **Uninstall *app*?**, then select **Uninstall**.
  </Step>
</Steps>

The app leaves the left rail for everyone in your organization. Its records are not deleted: they stay readable, and installing the app again finds them.

## Upgrade an app

The app has no upgrade button. To move an installed app to the version your Atlan deployment currently offers, call `POST /registry/v1/apps/{app}/upgrade` as an organization admin. Send `{"is_pinned": true}` to keep the app on that version; omit it or send `false` to remove the pin. An upgrade changes the recorded version only and does not migrate data.

## Verify

* **Install:** The app's card shows **Installed**, and **Open** opens it.
* **Availability:** In a workspace outside the selection, the app's row in **Apps** says **Your organization has restricted this app in this workspace. Existing content remains available under workspace permissions.**
* **Authoring off:** The row says **Authoring is off in this workspace. Existing content, history and exports remain available under workspace permissions.**
* **Uninstall:** The app no longer appears in the left rail or in **Brain** > **Apps**.

## Troubleshooting

| What you see | What it means |
| - | - |
| **Plan required** or **Your organization's plan does not include this app. Your installation and data are kept.** | Your plan doesn't include the app. Choose a plan that does under **View plans**, or ask an organization admin. |
| **This app is not set up on this deployment yet. Your installation and data are kept.** | The app isn't configured for your Atlan deployment. Contact your Atlan admin. |
| **Install failed** and **This app could not be installed. Try again.** | Select **Install** again; a repeat install retries it. |
| **Couldn't update availability. Review the reloaded policy before saving again.** | Someone else changed the policy. Review the reloaded settings and save again. |
| **An organization administrator needs to install this app.** | The app isn't installed. Ask an organization admin to install it. |

## Related

* [Find your installed apps](/registry/apps/how-tos/find-installed-apps): Find and open the apps your organization has installed.
* [Manage workspaces](/administer/workspaces/index): Workspace roles and settings.
* [Public API](/api/references/api-reference): `registry.installApp`, `registry.upgradeApp`, `registry.uninstallApp`, and the workspace availability operations.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.