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

Get published app versions

Retrieves all published versions of a specific app in a tenant.

API endpoint

GET <BaseURL>/models/{appSystemName}/tenants/{cloudTenantId}/publish/versions

See Base URL for the root endpoint path.

Request headers

HeaderValue
AuthorizationBearer <access_token>
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.Read scope. It is available for 1 hour, then you need to generate a new one, or request a refresh token.

Path variables

Path variableData typeDescription
appSystemName (required)stringThe system name of the app.
cloudTenantId (required)stringThe cloud tenant ID.

Query parameters

Query parameterData typeDescriptionDefault value
top (optional)int32The number of results to return.N/A
skip (optional)int32The number of results to skip.N/A
orderBy (optional)stringThe field to order results by.N/A

Responses

200 OK

{
  "@odata.context": "string",
  "@odata.count": 2,
  "value": [
    {
      "systemName": "string",
      "title": "string",
      "deployVersion": 1
    },
    {
      "systemName": "string",
      "title": "string",
      "deployVersion": 2
    }
  ]
}
{
  "@odata.context": "string",
  "@odata.count": 2,
  "value": [
    {
      "systemName": "string",
      "title": "string",
      "deployVersion": 1
    },
    {
      "systemName": "string",
      "title": "string",
      "deployVersion": 2
    }
  ]
}
FieldData typeDescription
@odata.contextstringThe OData context URL.
@odata.countnumberThe total number of published versions for the app.
valuearrayThe list of published app versions.
value[].systemNamestringThe system name of the version.
value[].titlestringThe display title of the app version.
value[].deployVersionnumberThe version number.

401 Unauthorized

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

403 Forbidden

You don't have permission to view app versions in the specified tenant.

  • API endpoint
  • Request headers
  • Path variables
  • Query parameters
  • 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