CloudInstanceApi

getAllCloudImages

Get all cloud images.


Endpoint	/app/rest/cloud/images
Produces	`application/xml` `application/json`
Parameters	`locator: string` `fields: string`
Response	`CloudImages`

Get cloud image matching the locator.


Endpoint	/app/rest/cloud/images/{imageLocator}
Produces	`application/xml` `application/json`
Parameters	`imageLocator: string` `fields: string`
Response	`CloudImage`

Get all cloud instances.


Endpoint	/app/rest/cloud/instances
Produces	`application/xml` `application/json`
Parameters	`locator: string` `fields: string`
Response	`CloudInstances`

Start a new cloud instance.


Endpoint	/app/rest/cloud/instances
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`body: CloudInstance` `fields: string`

Stop cloud instance matching the locator.


Endpoint	/app/rest/cloud/instances/{instanceLocator}
Parameters	`instanceLocator: string`

Get cloud instance matching the locator.


Endpoint	/app/rest/cloud/instances/{instanceLocator}
Produces	`application/xml` `application/json`
Parameters	`instanceLocator: string` `fields: string`
Response	`CloudInstance`

Terminates existing cloud instance immediately


Endpoint	/app/rest/cloud/instances/{instanceLocator}/actions/forceStop
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`instanceLocator: string`

Schedules existing cloud instance for termination


Endpoint	/app/rest/cloud/instances/{instanceLocator}/actions/stop
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`instanceLocator: string`

Get all cloud profiles.


Endpoint	/app/rest/cloud/profiles
Produces	`application/xml` `application/json`
Parameters	`locator: string` `fields: string`
Response	`CloudProfiles`

Get cloud profile matching the locator.


Endpoint	/app/rest/cloud/profiles/{profileLocator}
Produces	`application/xml` `application/json`
Parameters	`profileLocator: string` `fields: string`
Response	`CloudProfile`

Last modified: 04 July 2024