---
schema_version: "1"
id: 2a771775c65672fbc6c584d573f1fdecaa160e862701392bb4d1ccce908d26f6
title: Deploy the Canvas External Client App to an Org
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/platform/canvas-framework/guides/platform-connect/quick-start/quick-start-deploy-canvas-app.md
canonical_url: https://developer.salesforce.com/docs/platform/canvas-framework/guide/quick-start-deploy-canvas-app.html
source_site: developer.salesforce.com
content_type: documentation
content_hash: 796652cf080da5ba3288a2e271d1e5cb911d43beddd60056f5c36e88badd4774
products:
  - Canvas Developer Guide
  - Platform Developer Content
---

# Deploy the Canvas External Client App to an Org

Deploy and retrieve your Canvas integration for the external client app with Metadata API. The Canvas plugin has its own settings files and policies file.

Before you can deploy or retrieve an external client app, [set up an SFDX project](https://help.salesforce.com/s/articleView?id=xcloud.configure_sfdx_for_external_client_apps.htm).

If you [created the Canvas external client app](https://developer.salesforce.com/docs/platform/canvas-framework/guide/quick-start-create-canvas-app-eca.md) in Salesforce Setup, you can retrieve the app using Metadata API to configure the policies and then deploy your changes to your org.

1.  Retrieve your Canvas plugin files:

    ```html
    sf project retrieve start --manifest package.xml --target-org user@example.com
    
    ```

2.  Make your changes in the .js-meta.xml file for the Canvas plugin. For example, to update the Canvas URL and location options, update the `canvasUrl` and `canvasLocationOptions` fields in the .ecaCanvas-meta.xml file that's located in the force-app/main/default/extlClntAppCanvasSettings folder of your SFDX project.

3.  Save the metadata files with your changes.

4.  Deploy your Canvas plugin files:

    ```html
    sf project deploy start --manifest package.xml --target-org user@example.com
    
    ```

5.  Verify your changes in the External Client App Manager page in Setup.


    1.  In External Client App Manager, click the name of your external client app.

    2.  Go to the Settings tab and then expand the **Canvas App Settings** section.

    3.  Check that the **Canvas App URL** and **Locations** fields show your changes.


The Canvas plugin files include the metadata for the external client app, the Canvas settings, policies, and OAuth settings. This table lists the name of the source file with its type and path, where `API_Name` corresponds to the API Name for the external client app.

|Name|Metadata Type|Sample Path|
|----|-------------|-----------|
|API_Name|[ExternalClientApplication](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_externalclientapplication.htm)|force-app/main/default/externalClientApps/API_Name.eca-meta.xml|
|API_Name_canvasSettings|[ExtlClntAppCanvasSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_extlclntappcanvassettings.htm)|force-app/main/default/extlClntAppCanvasSettings/API_Name_canvasSettings.ecaCanvas-meta.xml|
|API_Name_plcy|[ExtlClntAppConfigurablePolicies](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_extlclntappconfigurablepolicies.htm)|force-app/main/default/extlClntAppPolicies/API_Name_plcy.ecaPlcy-meta.xml|
|API_Name_glbloauth|[ExtlClntAppGlobalOauthSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_extlclntappglobaloauthsettings.htm)|force-app/main/default/extlClntAppGlobalOauthSets/API_Name_glbloauth.ecaGlblOauth-meta.xml|
|API_Name_oauth|[ExtlClntAppOauthSettings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_externalclientapplication.htm)|force-app/main/default/extlClntAppOauthSettings/API_Name_oauth.ecaOauth-meta.xml|

**See Also**  


-   [External Client Apps Creation with Metadata API](https://help.salesforce.com/s/articleView?id=xcloud.meta_external_client_apps_creation.htm)