v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB
appManagement

Install an app by UUID.

Installs the app with given UUID in the folder specified using destinationFolderId.

post/v1/apps/{uuid}/install

Path parameters

uuidstring uuid required

UUID of the app to install.

Request body

namestring required

Preferred name of the app to be installed. This will be the name of the app in the selected installation folder.

descriptionstring required

Preferred description of the app to be installed. This will be displayed as the app description in the selected installation folder.

destinationFolderIdstring required

Identifier of the folder in which the app will be installed in hexadecimal format.

dataSourceValuesobject

Dictionary of properties specifying log-source name and value.

Example request

{
  "name": "Sumo Logic Configuration App",
  "description": "Sumo Logic Configuration App to configure collectors and data sources",
  "destinationFolderId": "00000000000001C8",
  "dataSourceValues": {
    "logsrc": "_sourceCategory = api"
  }
}

Response

App install job has been scheduled.

idstring required

Identifier to get the status of an asynchronous job.

Example response

{
  "id": "C03E086C137F38B4"
}