[{"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

URL

post

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

Copy

Path Parameters

string

imageId Required

imageId

string

versionId Required

versionId

Query Parameters

boolean

deleteTemplate Optional

deleteTemplate

Request Body

AppInventoryRequest of mimetype application/json Required

appInventoryRequest

Show optional properties

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

{
	"networks": [
		{
			"data": {},
			"id": "string",
			"infrastructureLinks": {},
			"kind": "string"
		}
	],
	"orgId": "string",
	"providerInstanceId": "string",
	"providerLabel": "AKKA"
}

string

providerInstanceId Required

string

providerLabel Required

Possible values are: AKKA , AZURE , VSPHERE , ZEROCLOUD

array of InfrastructureResource

networks Optional

string

orgId Optional

OrgId is required for non-customer CSP token

Authentication

This operation uses the following authentication methods.

Bearer

Response

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

InlineAppInventoryRepresentationDetails

details Optional

string

errorCode Optional

Possible values are: ADMIN_TEMPLATE_CREATION_CALL_FAILED , ADMIN_TEMPLATE_DELETION_CALL_FAILED , APP_INVENTORY_ALREADY_EXISTS , APP_INVENTORY_CREATION_FAILED , APP_INVENTORY_EDGE_DEPLOYMENT_NOT_FOUND , APP_INVENTORY_INVALID_STATUS , APP_INVENTORY_IN_PROGRESS , APP_INVENTORY_MISSING_FIELDS , APP_INVENTORY_NETWORK_DETAILS_NOT_FOUND , APP_INVENTORY_NOT_FOUND , APP_INVENTORY_NOT_FOUND_FOR_TEMPLATE , APP_INVENTORY_SCAN_IN_PROGRESS , APP_INVENTORY_TIME_OUT , APP_INVENTORY_TIME_OUT_FOR_ICONS , FORBIDDEN , INV_FAILED_TO_FETCH_VM , INV_FETCH_VM_CALL_FAILED , INV_NO_VM_EXISTS , NO_PUBLISHED_ASSET_FOUND_FOR_VERSION , TEMPLATE_ERROR_EVENT , TEMPLATE_ID_NOT_FOUND , TEMPLATE_PROVIDER_LABEL_NOT_FOUND , UNSUPPORTED_PROVIDER , VALIDATION_FAILED

string

errorDetail Optional

string

id Optional

string

orgId Optional

integer as int64

receivedIconSets Optional

string

status Optional

Possible values are: AVAILABLE , FAILED , FAILED_PUBLISH_FAILURE , GET_APPLICATIONS_IN_PROGRESS , GET_APPLICATIONS_TIMED_OUT , GET_ICONS_IN_PROGRESS , GET_ICONS_SCHEDULED , GET_ICONS_TIMED_OUT , IN_PROGRESS , TEMPLATE_CREATION_IN_PROGRESS , TEMPLATE_CREATION_TIMED_OUT , WAITING_FOR_PUBLISH

string

streamId Optional

string

templateId Optional

integer as int64

totalIconSets Optional

string as date-time

updatedAt Optional

string

versionId Optional

Errors

ErrorResponse

400

Bad request

ErrorResponse

401

Unauthorized

ErrorResponse

403

Forbidden

ErrorResponse

424

Failed Dependency for App Scan

ErrorResponse

500

Failed to created Application Inventory

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

This operation contains the following vendor extensions defined in the spec:

x-codegen-request-body-name: appInventoryRequest

[{"label":"Latest (V1)","version":"latest"}]

horizon-cloud-nextgen

Images Operations

delete

Delete App Inventory

get

Fetch Apps By Image And Version

get

Get App Inventory By Image And Version

post

Trigger App Scan

Trigger App Scan

Request

URL

Path Parameters

Query Parameters

Request Body

Authentication

Bearer

Response

Response Body

201 Created

Errors

Code Samples

cURL Command

Vendor Extensions

On This Page

Images Operations

Was this page helpful?