UiPath Documentation
apps
latest
false
  • Apps API
    • Base URL
    • Get deployed apps
    • Edit a deployed app
    • Deploy a published app version
    • Upgrade deployed apps to latest version
    • Publish a coded app
    • Check app name uniqueness
    • Get published apps
    • Get published app versions
important :
For documentation on app projects in Studio Web, refer to the App Projects chapter in the Studio Web documentation: https://docs.uipath.com/studio-web/automation-cloud/latest/user-guide/apps-in-studio-web.

Apps API guide

Publish a coded app

Publishes a coded app from a package available in the Orchestrator feed.

API endpoint

POST <BaseURL>/models/apps/codedapp/publish

See Base URL for the root endpoint path.

Request headers

HeaderValue
AuthorizationBearer <access_token>
Content-Typeapplication/json
X-UiPath-Internal-TenantId<tenant_id>
Note:

Replace all the values between the angle brackets <...> with their corresponding use-case values.

The <access_token> is the one you received when you authorized the external application with the Apps or Apps.Write scope. It is available for 1 hour, then you need to generate a new one, or request a refresh token.

Request body (required)

{
  "packageName": "MyCodedApp",
  "packageVersion": "1.0.0",
  "tenantName": "DefaultTenant"
}
{
  "packageName": "MyCodedApp",
  "packageVersion": "1.0.0",
  "tenantName": "DefaultTenant"
}
FieldData typeDescription
packageName (required)stringThe name of the coded app package in the Orchestrator feed.
packageVersion (required)stringThe version of the coded app package to publish.
tenantName (required)stringThe name of the tenant where the package is hosted.

Responses

200 OK

Returns the published app details.

{
  "systemName": "string",
  "deployVersion": 1
}
{
  "systemName": "string",
  "deployVersion": 1
}
FieldData typeDescription
systemNamestringThe system name of the published app.
deployVersionnumberThe published version number.

401 Unauthorized

You are not authenticated. Make sure you are using a valid access token with the Apps or Apps.Write scope.

403 Forbidden

You don't have permission to publish apps in the specified tenant.

  • API endpoint
  • Request headers
  • Request body (required)
  • Responses
  • 200 OK
  • 401 Unauthorized
  • 403 Forbidden

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated