---
schema_version: "1"
id: fe2ebadd4139cc23282ba55b01f0892506c8af9f443f5d1bed1d7f2d8e009c88
title: Set up API Visualizer
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/visualizer/setup.md
canonical_url: https://docs.mulesoft.com/visualizer/setup
source_site: docs.mulesoft.com
content_type: documentation
content_hash: d88da9da8ef600e92dbab712dae21310917ec26176c37f9af7286f90b68556c0
description: MuleSoft Documentation Site
latest: true
---
---
product: API Visualizer
---

# Set up API Visualizer

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Configure the roles and permissions required to use API Visualizer and understand what to consider
when deploying applications.

## Configure Permissions

To view content in API Visualizer, be assigned a role that has one of the following permissions:

- **Runtime Manager > Read Applications** Enables a user to view the graph of an app network, but
  does not allow them to make changes.

- **API Manager > View Policies or Manage Policies** Enables a user to view the APIs linked to their
  Mule applications and the policies applied to those APIs. Only relevant for the Policy
  Visualization.

- **Visualizer > Visualizer Editor** Enables a user to manage and customize certain aspects of the
  visualization of an application network. You can create a
  [custom role](https://docs.mulesoft.com/access-management/roles#custom-roles) and assign the Visualizer Editor permission
  to it.

  > [!NOTE] The **Visualizer Editor** permission can be assigned only within the root organization.

## Select a Deployment Type

API Visualizer supports the following deployment types:

- [CloudHub](https://docs.mulesoft.com/visualizer/cloudhub-setup)

- [Standalone Mule](https://docs.mulesoft.com/visualizer/standalone-mule-setup)

- [Runtime Fabric](https://docs.mulesoft.com/visualizer/runtime-fabric-setup)

The set up process and supported Mule runtimes differ depending on deployment type. Further details
are included in each section.

## Deploy an App

When you deploy an app you want to view in API Visualizer, make sure that you select a supported
version of Mule as the deployment target. See [Runtime Manager](https://docs.mulesoft.com/runtime-manager/) for more
information.

After redeploying an app, all metadata collected by API Visualizer is removed for that app. The
number of inbound connections for the app node is reset.

## Verify Supported Connectors

API Visualizer can monitor activity for outbound connections for these connectors:

- Salesforce

- HTTP/HTTPS

- Database

- Mule 4 Extension Connectors

### Manage Performance and Data Collection

The agent that API Visualizer uses to collect metadata sometimes has a performance impact.

For more information about data collection and performance, see
[Managing Performance and Data Collection](https://docs.mulesoft.com/visualizer/manage-performance).