Master
Versions: Euwe / Fine / Latest /

SOAP to REST Mapping guide

Insight Web Services

SOAP API HTTP Method REST API URLs Actions Examples

ClusterGetTags

GET

/api/cluster/:id/tags

DatastoreGetTags

GET

/api/data_stores/:id/tags

EmsGetTags

GET

/api/providers/:id/tags

EVMDeleteVmByName

DELETE

/api/vms/:id

Delete VM

POST

/api/vms/:id

delete

Delete VMs

EVMClusterList

GET

/api/clusters

EVMDatastoreList

GET

/api/data_stores

EVMHostList

GET

/api/hosts

EVMResourcePoolList

GET

/api/resource_pools

EVMPing

GET

/api

EVMVmAccounts

GET

/api/vms/:id/accounts

EVMVmList

GET

/api/vms

GET

/api/hosts/:id?attributes=vms

GET

/api/hosts?filter[]=guid='…​.'&expand=resources&attributes=vms

EVMVmSoftware

GET

/api/vms:id/software

FindClusterById

GET

/api/clusters/:id

FindClustersById

GET

/api/clusters/:id

FindDatastoreById

GET

/api/data_stores/:id

FindDatastoresById

GET

/api/data_stores/:id

FindEmsByGuid

GET

/api/providers?filter[]=guid='…​.'

FindHostByGuid

GET

/api/hosts?filter[]='guid='…​.'"

FindHostsByGuid

GET

/api/hosts?filter[]='guid='…​.'"

FindResourcePoolById

GET

/api/resource_pools/:id

FindResourcePoolsById

GET

/api/resource_pools

GET

/api/resource_pools?filter[]=id=:id&filter[]=or id=:id&…​

FindVmByGuid

GET

/api/vms?filter[]=guid='…​.'

FindVmsByGuid

GET

/api/vms?filter[]=guid='…​.'&filter[]=or guid='…​.'&…​

GetClusterList

GET

/api/clusters

GET

/api/clusters?filter[]=ems_id=:id

GET

/api/providers/:id?attributes=ems_clusters

GetClustersByList

GET

/api/clusters/:id

GET

/api/clusters?filter[]=id=:id&filter[]=or id=:id&…​

GetClustersByTag

GET

/api/clusters?by_tag=:tag_path

GetDatastoreByList

GET

/api/data_stores

GetDatastoreByTag

GET

/api/data_stores?by_tag=:tag_path

GetEmsByList

GET

/api/providers

GET

/api/providers/:id

GET

/api/providers?filter[]=…​.&expand=resources

GetEmsList

GET

/api/providers

GetHostsByList

GET

/api/hosts

GET

/api/hosts?filter[]=…​.&expand=resources

GetHostList

GET

/api/hosts

GET

/api/providers/:id?attributes=hosts

GET

/api/providers?filter[]=guid='…​.'&expand=resources&attributes=hosts

GetResourcePoolList

GET

/api/providers/:id?attributes=resource_pools

GET

/api/providers?filter[]=guid='…​.'&expand=resources&attributes=resource_pools

GetResourcePoolsByList

GET

/api/resource_pools

GET

/api/resource_pools/:id

GET

/api/resource_pools?filter[]=…​.&expand=resources

GetResourcePoolsByTag

GET

/api/resource_pools?by_tag=:tag_path

GetTemplatesByTag

GET

/api/templates?by_path=:tag_path

GetVmList

GET

/api/hosts/:id?attributes=vms

GET

/api/hosts?filter[]=guid='…​.'&expand=resources&attributes=vms

GetVmsByList

GET

/api/vms

GET

/api/vms/:id

GET

/api/vms?filter[]=…​.&expand=resources

GetVmsByTag

GET

/api/vms?by_path=:tag_path

HostGetTags

GET

/api/hosts/:id/tags

GET

/api/hosts/:id?expand=tags

GET

/api/hosts?filter[]=guid='…​.'&expand=resources,tags

ResourcePoolGetTags

GET

/api/resource_pools/:id/tags

GET

/api/resource_pools/:id?expand=tags

VmGetTags

GET

/api/vms/:id/tags

GET

/api/vms/:id?expand=tags

Control Web Services

SOAP API HTTP Method REST API URLs Actions Examples

ClusterSetTag

POST

/api/clusters/:id/tags

assign

Assigning Tags

DatastoreSetTag

POST

/api/data_stores/:id/tags

assign

Assigning Tags

EmsSetTag

POST

/api/providers/:id/tags

assign

Assigning Tags

EVMActionList

GET

/api/policies/:id/policy_actions

Policy Actions

GET

/api/policies/:id?expand=policy_actions

GET

/api/policies?filter[]=guid='…​.'&expand=resources,policy_actions

EVMAddLifecycleEvent

POST

/api/vms/:id

add_lifecycle_event

Add Lifecycle Event to VM

EVMAssignPolicy

POST

/api/hosts/:id/policies

assign

Assigning Policies

EVMConditionList

GET

/api/policies/:id/conditions

Policy Conditions

GET

/api/policies/:id?expand=conditions

GET

/api/policies?filter[]=guid='…​.'&expand=resources,conditions

EVMEventList

GET

/api/policies/:id/events

Policy Events

GET

/api/policies/:id?expand=events

GET

/api/policies?filter[]=guid='…​.'&expand=resources,events

EVMGetPolicy

GET

/api/policies

Querying Policies

GET

/api/policies/:id

GET

/api/policies?filter[]=name='…​.'

EVMPolicyList

GET

/api/hosts/:id/policies

Policy Management

GET

/api/hosts/:id?expand=policies

GET

/api/hosts?filter[]=guid='…​.'&expand=resources,policies

EVMVmEventByProperty

POST

/api/vms/:id

add_event

Add VM Event

EVMVmScanByProperty

POST

/api/vms/:id

scan

Scan VM

EVMSmartStart

POST

/api/vms/:id

start

Start VM

EVMSmartStop

POST

/api/vms/:id

stop

Stop VM

EVMSmartSuspend

POST

/api/vms/:id

suspend

Suspend VM

EVMUnassignPolicy

POST

/api/hosts/:id/policies

unassign

Unassigning Policies

EVMVmRsop

POST

/api/vms/:id/policies/:id

resolve

Resolving Policies

POST

/api/vms/:id/policy_profiles/:id

resolve

Resolving Policy Profiles

HostSetTag

POST

/api/hosts/:id/tags

assign

Assigning Tags

ResourcePoolSetTag

POST

/api/resource_pools/:id/tags

assign

Assigning Tags

VmAddCustomAttribute

POST

/api/vms/:id/custom_attributes

add

Adding Custom Attributes

VmAddCustomAttributes

POST

/api/vms/:id/custom_attributes

add

VmAddCustomAttributeByFields

POST

/api/vms/:id/custom_attributes

add

VmDeleteCustomAttribute

POST

/api/vms/:id/custom_attributes

delete

Deleting Custom Attributes

VmDeleteCustomAttributes

POST

/api/vms/:id/custom_attributes

delete

VmSetTag

POST

/api/vms/:id/tags

assign

Assigning Tags

VmSetOwner

POST

/api/vms/:id

set_owner

Set Owner of VM

Automate Web Services

SOAP API HTTP Method REST API URLs Actions Examples

CreateAutomationRequest

POST

/api/automation_requests

create

Create Automation Request, Create Automation Requests

EVMProvisionRequestEx

POST

/api/provision_requests

create

Create Provision Request, Create Provision Requests

GetAutomationRequest

GET

/api/automation_requests/:id

GetAutomationTask

GET

/api/automation_requests/:id?expand=request_tasks

GET

/api/automation_requests/:id/request_tasks/:id

GetVmProvisionRequest

GET

/api/provision_requests/:id

GET

/api/provision_requests/:id?expand=request_tasks

VmProvisionRequest

POST

/api/provision_requests

create

Create Provision Request, Create Provision Requests