Sign in

v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB
appManagementV2

Start app install job

Schedule an asynchronous job to install the app with the given UUID and version from the App Catalog. The app will be installed in 'Installed Apps' folder in the Content Library.

You get back an identifier of asynchronous job in response to this endpoint. You can then use the app install status API to get the status of the installation request. See Asynchronous-Request section for more details on how to work with asynchronous request.

post/v2/apps/{uuid}/install

Path parameters

uuidstring required

UUID of the app to install.

Request body

versionstring

Version of the app to install. You can either specify a specific version of the app or use latest to install the latest version of the app. If version is not specified, the latest version of the app will be installed.

parametersobject

Map of additional parameters for the app installation.

Example request

{
  "version": "1.0.1",
  "parameters": {
    "db_system": "redis"
  }
}

Response

App installation job has been scheduled.

jobIdstring required

Identifier of the asynchronous job. Use it to get status of the job.

Example response

{
  "jobId": "C03E086C137F38B4"
}