Cloud Service Manager > Virtual Machines

Returns the list of all virtual machines created or imported under a particular account id. Supports optional query parameters like region id, vpc id, public_ip, is_gateway.

Request:

Method:
GET
URI Path(s):
/api/v1/csm/virtual-machines
Request Headers:
n/a
Query Parameters:
CloudVirtualMachinesListRequestParameters+
Request Body:
n/a

Example Request:

GET https://<nsx-csm>/api/v1/csm/virtual-machines

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
CloudVirtualMachinesListResult+

Example Response:

{ "cursor": "0003348", "sort_ascending": true, "result_count": 348, "results": [ { "description": "t2.micro", "id": "i-027c0b32cbe631ec9", "display_name": "vm-2", "is_gateway": false, "private_ip": "13.14.41.253", "cloud_tags": [], "os_type": "AMAZON_LINUX", "agent_status": "NO_AGENT", "os_details": "", "availability_zone": "us-west-2c", "vpc": "vpc-f4ddaf93", "vm_config_status": { "whitelist": { "whitelisted": "YES" } }, "nsx_successful_rules_count" : 1, "nsx_failed_rules_count" : 0 }, { "description": "c4.xlarge", "id": "i-0b62834659a30fc21", "display_name": "nsx-gw-vpc-c35dbaa4-preferred-active", "public_ip": "52.89.33.233", "is_gateway": true, "private_ip": "10.0.1.97", "is_gateway_active": true, "cloud_tags": [], "gateway_status": "UP", "os_type": "UBUNTU", "os_details": "LTS 14.04", "availability_zone": "us-west-2a", "vpc": "vpc-c35dbaa4", "vm_config_status": { "whitelist": { "whitelisted": "NO" } }, "nsx_successful_rules_count" : 1, "nsx_failed_rules_count" : 0 } ] }

Required Permissions:

read

Feature:

cloud_resources

Additional Errors: