---
schema_version: "1"
id: d22f1bcf9f97e4a98cfa818c20c771f2d145d26adb163050ab09639c06ad30f1
title: Deploy API Catalog Data Using Change Sets
collection: admin
version: current
locale: en-us
portal_url: https://docs.salesforce.com/admin/current/en-us/platform/264-0-0/api_catalog_package_and_promote.md
canonical_url: https://help.salesforce.com/s/articleView?id=platform.api_catalog_package_and_promote.htm&release=264.0.0&type=5
source_site: help.salesforce.com
content_type: documentation
content_hash: e0115efcbaabec06b4232b94baa4a4130ec7c2e6720b36407292503a1babd365
description: After you create, test, and debug your API Catalog configuration in a sandbox, use a change set to send the catalog and its associated dependencies, such as external services entries and named credentials, to production when you’re ready to deploy.
products:
  - Salesforce Platform
  - Security
release: "264"
---
# Deploy API Catalog Data Using Change Sets

After you create, test, and debug your API Catalog configuration in a sandbox, use a change set to send the catalog and its associated dependencies, such as external services entries and named credentials, to production when you’re ready to deploy.

### Required Editions

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small edition"><colgroup><col></colgroup><tbody><tr class=""><td class="slds-cell-wrap" style="vertical-align:top;">Available in: Lightning Experience</td></tr><tr class=""><td class="slds-cell-wrap" style="vertical-align:top;">Available in: <strong>Developer</strong>, <strong>Enterprise</strong>, <strong>Performance</strong>, and <strong>Unlimited</strong> Editions</td></tr></tbody></table>

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small permission">
        <colgroup>
          <col style="width:50%">
          <col style="width:50%">
        </colgroup>
        <thead class="slds-text-title_caps ">
          <tr class="">
            <th scope="colgroup" class="slds-cell-wrap" colspan="2" style="text-align:center;vertical-align:top;" id="d128712e72">User Permissions
              Needed</th>
          </tr>
        </thead>
        <tbody>
          <tr class="">
            <td data-label="User Permissions Needed" class="slds-cell-wrap" style="vertical-align:top;" headers="d128712e72 ">To access API Catalog:</td>

            <td class="slds-cell-wrap" style="vertical-align:top;" headers="d128712e72 ">
              <p>Available to Salesforce admins by default.</p>
              <p style="margin-bottom:0;">For other users, View Setup</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="User Permissions Needed" class="slds-cell-wrap" style="vertical-align:top;" headers="d128712e72 ">To edit deployment connections:</td>

            <td class="slds-cell-wrap" style="vertical-align:top;" headers="d128712e72 ">
              <p>Deploy Change Sets</p>
              <p>AND</p>
              <p style="margin-bottom:0;">Modify Metadata Through Metadata API Functions</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="User Permissions Needed" class="slds-cell-wrap" style="vertical-align:top;" headers="d128712e72 ">To use outbound change sets:</td>

            <td class="slds-cell-wrap" style="vertical-align:top;" headers="d128712e72 ">Create and Upload Change Sets</td>

          </tr>
          <tr class="">
            <td data-label="User Permissions Needed" class="slds-cell-wrap" style="vertical-align:top;" headers="d128712e72 ">To use inbound change sets:</td>

            <td class="slds-cell-wrap" style="vertical-align:top;" headers="d128712e72 ">
              <p>Deploy Change Sets</p>
              <p>AND</p>
              <p style="margin-bottom:0;">Modify Metadata Through Metadata API Functions</p>
            </td>

          </tr>
        </tbody>
      </table>

![Important](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-platform-extend_click-264-0-0-production-enus/5f7d9219-b7b1-4552-8891-f1aba9b289fc/images/icon_important.png)

Important You can’t use managed packages to promote API Catalog data from org to org. The authentication data necessary for API Catalog can’t be retained and installed in a separate org, and you can’t edit the authentication information installed through a package in the target org.

1. Create an outbound change set in the source org for the API Catalog entries you want to deploy to another org. See [Outbound Change Sets](https://help.salesforce.com/s/articleView?id=platform.changesets_about_outbound.htm&language=en_US).
2. Add **Cataloged API** to the change set and then select the catalog entries to include in the change set.
    
    The dependencies are automatically selected for you.
3. Upload your outbound change set.
4. Deploy your inbound change set in your target org. See [Inbound Change Sets](https://help.salesforce.com/s/articleView?id=platform.changesets_about_inbound.htm&language=en_US).
5. Make sure MuleSoft API connections that are in Custom status have valid external credentials, because API Catalog can’t automatically verify or create those during the connection process. See [Create and Manage Connections for Your APIs](https://help.salesforce.com/s/articleView?id=platform.api_catalog_create_connections_for_apis.htm&release=264.0.0&type=5 "Create connections to authorize the use of actions you activate for MuleSoft APIs and HTTP callouts in Salesforce. You create connections for other external API sources from outside of API Catalog, and then you can view the connections from the catalog.").

## Deploy Change Sets Using Salesforce CLI

You can alternatively deploy change sets using Salesforce CLI commands.

1. Create an empty Salesforce DX project. See [Salesforce DX Developer Guide: Create a Salesforce DX Project](https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_ws_create_new.htm).
2. Create a package XML file that has these metadata API components as shown in the example.
    
    - CatalogedApi
    - CatalogedApiVersion
    - CatalogedApiArtifactVersionInfo
    - ExternalServiceRegistration
    - NamedCredential
    - ExternalCredential
    - PermissionSet
    - Flow
    
    ```
    <?xml version="1.0" encoding="UTF-8"?>
    <Package xmlns="http://soap.sforce.com/2006/04/metadata">
        <types>
            <members>*</members>
            <name>PermissionSet</name>
        </types>
        <types>
            <members>*</members>
            <name>ExternalCredential</name>
        </types>
        <types>
            <members>*</members>
            <name>NamedCredential</name>
        </types>
        <types>
            <members>*</members>
            <name>ExternalServiceRegistration</name>
        </types>
        <types>
            <members>*</members>
            <name>CatalogedApiArtifactVersionInfo</name>
        </types>
        <types>
            <members>*</members>
            <name>CatalogedApi</name>
        </types>
        <types>
            <members>*</members>
            <name>CatalogedApiVersion</name>
        </types>
        <types>
            <members>*</members>
            <name>Flow</name>
        </types>
        <version>65.0</version>
    </Package>
    ```
3. Pull the package into your local project to create a change set by using the `sf project retrieve start` command.
    
    This example creates a change set in a source org with the org ID mySandboxOrg.
    
    ```
    sf project retrieve start --manifest package.xml --api-version 65.0 --target-org mySandboxOrg
    ```
4. Deploy to the target org by using the `sf project deploy start` command.
    
    This example deploys the change set to a target org with the org ID myProdOrg.
    
    ```
    sf project deploy start -o myProdOrg
    ```

#### See Also

- [Change Sets](https://help.salesforce.com/s/articleView?id=platform.changesets.htm&language=en_US)
- [_Developer Documentation:_ Metadata API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_intro.htm)
- [_Developer Documentation:_ Salesforce CLI Command Reference](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_project_commands_unified.htm)