v1

latestOpenAPI 3.1.02026-07-261690320.7 KB

List virtual machines

Returns a list of all the virtual machines in your account

get/virtual-machines

Query parameters

cloud_idinteger

Filter to get all virtual machines for a single cloud

searchstring

Filter to search all virtual machines

filter_osstring

Filter to get all virtual machines for a specific operating system

filter_os_versionstring

Filter to get all virtual machines for a specific operating system version

include_os_infointeger

Includes the operating system and operating system version of the virtual machines. 1 means true, 0 means false.

Response

A list of virtual machines

idinteger required

The virtual machine's id in Aikido.

activeinteger required

0 or 1 representing if the virtual machine is active.

namestring required

The virtual machine's name.

regionstring required

The region where the virtual machine is located.

latest_snapshot_idstring required

The id of the virtual machine's latest snapshot.

external_idstring required

The id of the virtual machine as displayed in the related cloud.

created_atinteger required

The timestamp of when the virtual machine was created in Aikido.

count_open_issuesinteger required

The amount of open issues related to this virtual machine.

count_ignored_issuesinteger required

The amount of ignored issues related to this virtual machine.

purposestring required

The purpose of this virtual machine.

cloud_idinteger required

The cloud id in Aikido related to this virtual machine.

last_scanned_atinteger required

The timestamp of the last scan of this virtual machine.

instance_countinteger required

The amount of instances related to this virtual machine.

environmentstring required

The type of environment this virtual machine is used for. Can be 'production', 'staging' or 'development'.

cloud_kindstring required

The kind of cloud this virtual machine is located in.

osstring required

The operating system of the virtual machine. When unknown this will be null.

os_versionstring required

The operating system version of the virtual machine. When unknown this will be null.

Example response

[
  {
    "id": 1,
    "active": 1,
    "name": "vm1",
    "region": "eu-west-1",
    "latest_snapshot_id": "nevergonnagive-1",
    "external_id": "nevergonnagive",
    "created_at": 1725622868,
    "count_open_issues": 2,
    "count_ignored_issues": 6,
    "purpose": "",
    "cloud_id": 1,
    "last_scanned_at": 1725622868,
    "instance_count": 1,
    "environment": "production",
    "cloud_kind": "aws"
  }
]