[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen

Trigger App Scan

Description

Start scan for applications on image. This is supported only for server and multi-session images.

Request

Request

URL

URL


post
https://cloud.vmwarehorizon.com/imagemgmt/v1/appinventory/images/{imageId}/versions/{versionId}
Copy

Path Parameters

Path Parameters

string
imageId Required

imageId


string
versionId Required

versionId


Query Parameters

Query Parameters

boolean
deleteTemplate Optional

deleteTemplate


Request Body

Request Body

AppInventoryRequest of mimetype application/json Required

appInventoryRequest

{
	"providerInstanceId": "string",
	"providerLabel": "AKKA"
}
string
providerInstanceId Required

string
providerLabel Required

Possible values are: AKKAAZUREVSPHEREZEROCLOUD


networks Optional

string
orgId Optional

OrgId is required for non-customer CSP token

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created returns AppInventoryRepresentation of type application/json

Successfully accepted Application Inventory request

{
	"createdAt": "string",
	"details": {},
	"errorCode": "ADMIN_TEMPLATE_CREATION_CALL_FAILED",
	"errorDetail": "string",
	"id": "string",
	"orgId": "string",
	"receivedIconSets": 0,
	"status": "AVAILABLE",
	"streamId": "string",
	"templateId": "string",
	"totalIconSets": 0,
	"updatedAt": "string",
	"versionId": "string"
}
string as date-time
createdAt Optional


string
errorCode Optional

Possible values are: ADMIN_TEMPLATE_CREATION_CALL_FAILEDADMIN_TEMPLATE_DELETION_CALL_FAILEDAPP_INVENTORY_ALREADY_EXISTSAPP_INVENTORY_CREATION_FAILEDAPP_INVENTORY_EDGE_DEPLOYMENT_NOT_FOUNDAPP_INVENTORY_INVALID_STATUSAPP_INVENTORY_IN_PROGRESSAPP_INVENTORY_MISSING_FIELDSAPP_INVENTORY_NETWORK_DETAILS_NOT_FOUNDAPP_INVENTORY_NOT_FOUNDAPP_INVENTORY_NOT_FOUND_FOR_TEMPLATEAPP_INVENTORY_SCAN_IN_PROGRESSAPP_INVENTORY_TIME_OUTAPP_INVENTORY_TIME_OUT_FOR_ICONSFORBIDDENINV_FAILED_TO_FETCH_VMINV_FETCH_VM_CALL_FAILEDINV_NO_VM_EXISTSNO_PUBLISHED_ASSET_FOUND_FOR_VERSIONTEMPLATE_ERROR_EVENTTEMPLATE_ID_NOT_FOUNDTEMPLATE_PROVIDER_LABEL_NOT_FOUNDUNSUPPORTED_PROVIDERVALIDATION_FAILED


string
errorDetail Optional

string
id Optional

string
orgId Optional

integer as int64
receivedIconSets Optional

string
status Optional

Possible values are: AVAILABLEFAILEDFAILED_PUBLISH_FAILUREGET_APPLICATIONS_IN_PROGRESSGET_APPLICATIONS_TIMED_OUTGET_ICONS_IN_PROGRESSGET_ICONS_SCHEDULEDGET_ICONS_TIMED_OUTIN_PROGRESSTEMPLATE_CREATION_IN_PROGRESSTEMPLATE_CREATION_TIMED_OUTWAITING_FOR_PUBLISH


string
streamId Optional

string
templateId Optional

integer as int64
totalIconSets Optional

string as date-time
updatedAt Optional

string
versionId Optional
Errors

Errors

400

Bad request


401

Unauthorized


403

Forbidden


424

Failed Dependency for App Scan


500

Failed to created Application Inventory

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"networks":[{"data":{},"id":"string","infrastructureLinks":{},"kind":"string"}],"orgId":"string","providerInstanceId":"string","providerLabel":"AKKA"}' https://cloud.vmwarehorizon.com/imagemgmt/v1/appinventory/images/{imageId}/versions/{versionId}
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-codegen-request-body-name: appInventoryRequest


Feedback

Was this page helpful?