Cycle Logo
Platform
Internal
Scheduler
IAL

Virtual Machines

​

Endpoints for managing virtual machines.

Virtual Machines Operations

List Virtual Machines

​

Requires the virtual-machines-view capability.

Query Parameters
  • meta
    Type:array string[] enum

    A comma-separated list of meta values. Meta values will show up under a resource's meta field. In the case of applying a meta to a collection of resources, each resource will have its own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.

    • domains
    • ips
  • include
    Type:array string[] enum

    A comma-separated list of include values. Included resources will show up under the root document's include field. In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return.

    • creators
    • environments
    • clusters
    • containers
  • filter
    Type:object
  • sort
    Type:array string[]

    An array of sort values. To sort descending, put a - in front of the value, e.g. -id.

  • page
    Type:object
    • Responses
    Request Example forGET/v1/virtual-machines
    curl https://api.cycle.io/v1/virtual-machines \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'X-Hub-Id: YOUR_SECRET_TOKEN'

    {
  "data": [
    {
      "id": "651586fca6078e98982dbd90",
      "name": "…",
      "identifier": "…",
      "creator": {
        "id": "651586fca6078e98982dbd90",
        "type": "account"
      },
      "environment": {
        "id": "651586fca6078e98982dbd90",
        "cluster": "…"
      },
      "hub_id": "651586fca6078e98982dbd90",
      "config": {
        "network": {
          "public": "enable",
          "hostname": "…",
          "ports": [
            "…"
          ]
        },
        "deploy": {
          "constraints": {
            "node": {
              "tags": {
                "any": [
                  "…"
                ],
                "all": [
                  "…"
                ]
              }
            },
            "secrets": [
              "…"
            ],
            "containers": [
              "…"
            ]
          },
          "shutdown": {
            "graceful_timeout": "72h45m2s"
          },
          "startup": {
            "delay": "72h45m2s"
          },
          "telemetry": {
            "retention": "72h45m2s",
            "interval": "72h45m2s",
            "disable": true
          }
        },
        "resources": {
          "ram": {
            "limit": "1G",
            "allocate": null
          },
          "cpu": {
            "cores": {
              "number": 1,
              "allocate": null
            },
            "cpus": "1"
          }
        }
      },
      "image": {
        "type": "url",
        "details": {
          "url": "…"
        }
      },
      "container_id": "651586fca6078e98982dbd90",
      "volumes": [
        {
          "id": "651586fca6078e98982dbd90",
          "hash": "…",
          "config": {
            "local": {
              "max_size": "100G",
              "storage_pool": true
            },
            "identifier": "…",
            "read_only": true
          }
        }
      ],
      "annotations": null,
      "base_disk_size": "10G",
      "root_password": {
        "changed": "2021-01-30T08:30:00Z",
        "current": null
      },
      "ssh_keys": [
        "651586fca6078e98982dbd90"
      ],
      "state": {
        "current": "new",
        "changed": "2021-01-30T08:30:00Z",
        "error": {
          "message": "…",
          "time": "2021-01-30T08:30:00Z"
        }
      },
      "events": {
        "created": "2021-01-30T08:30:00Z",
        "updated": "2021-01-30T08:30:00Z",
        "deleted": "2021-01-30T08:30:00Z",
        "started": "2021-01-30T08:30:00Z"
      },
      "deprecate": true,
      "lock": true,
      "meta": {
        "domains": [
          {
            "fqdn": "…",
            "record": {
              "id": "651586fca6078e98982dbd90",
              "hub_id": "651586fca6078e98982dbd90",
              "creator": {
                "id": "651586fca6078e98982dbd90",
                "type": "account"
              },
              "zone_id": "…",
              "name": "…",
              "resolved_domain": "…",
              "type": {
                "a": {
                  "ip": "…"
                },
                "aaaa": {
                  "ip": "…"
                },
                "cname": {
                  "domain": "…"
                },
                "ns": {
                  "domain": "…"
                },
                "mx": {
                  "priority": 1,
                  "domain": "…"
                },
                "txt": {
                  "value": "…"
                },
                "alias": {
                  "domain": "…"
                },
                "srv": {
                  "weight": 1,
                  "priority": 1,
                  "port": 1,
                  "domain": "…"
                },
                "caa": {
                  "tag": "…",
                  "value": "…"
                },
                "linked": {
                  "features": {
                    "tls": {
                      "enable": true
                    },
                    "geodns": {
                      "enable": true
                    },
                    "wildcard": {
                      "resolve_sub_domains": false
                    }
                  },
                  "container_id": "…"
                }
              },
              "features": {
                "certificate": {
                  "id": "651586fca6078e98982dbd90",
                  "generated": "2021-01-30T08:30:00Z",
                  "wildcard_child": true,
                  "user_supplied": true,
                  "expires": "2021-01-30T08:30:00Z"
                }
              },
              "state": {
                "current": "pending",
                "changed": "2021-01-30T08:30:00Z",
                "error": {
                  "message": "…",
                  "time": "2021-01-30T08:30:00Z"
                }
              },
              "events": {
                "ANY_ADDITIONAL_PROPERTY": "2021-01-30T08:30:00Z"
              }
            }
          }
        ],
        "ips": [
          {
            "id": "651586fca6078e98982dbd90",
            "hub_id": "651586fca6078e98982dbd90",
            "kind": "ipv4",
            "assignment": {
              "container_id": "651586fca6078e98982dbd90",
              "instance_id": "651586fca6078e98982dbd90",
              "environment_id": "651586fca6078e98982dbd90",
              "virtual_machine": {
                "id": "651586fca6078e98982dbd90"
              }
            },
            "pool_id": "…",
            "address": "…",
            "gateway": "…",
            "cidr": "…",
            "state": {
              "current": "assigning",
              "changed": "2021-01-30T08:30:00Z",
              "error": {
                "message": "…",
                "time": "2021-01-30T08:30:00Z"
              }
            }
          }
        ],
        "server": {
          "id": "651586fca6078e98982dbd90",
          "hub_id": "651586fca6078e98982dbd90",
          "location_id": "…",
          "model_id": "…",
          "node_id": "…",
          "shared_file_systems": {
            "mounts": null,
            "directories": null
          },
          "hostname": "…",
          "creator": {
            "id": "651586fca6078e98982dbd90",
            "type": "account"
          },
          "provider": {
            "vendor": "…",
            "integration_id": "651586fca6078e98982dbd90",
            "model": "…",
            "zone": null,
            "location": "…",
            "server": "…",
            "init_ips": [
              "…"
            ],
            "mac_addr": "…",
            "extra": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "provision_options": {
              "encrypt_storage": true,
              "storage_size": 1,
              "reservation_id": "…"
            }
          },
          "cluster": "…",
          "features": {
            "sftp": true,
            "base_volume_gb": null,
            "gateway": {
              "type": "bgp"
            }
          },
          "constraints": {
            "tags": [
              "…"
            ],
            "allow": {
              "pool": true,
              "services": true,
              "overcommit": true
            }
          },
          "autoscale": {
            "group_id": "651586fca6078e98982dbd90"
          },
          "ephemeral": true,
          "evacuate": {
            "started": "2021-01-30T08:30:00Z"
          },
          "state": {
            "current": "new",
            "changed": "2021-01-30T08:30:00Z",
            "error": {
              "message": "…",
              "time": "2021-01-30T08:30:00Z"
            }
          },
          "events": {
            "created": "2021-01-30T08:30:00Z",
            "updated": "2021-01-30T08:30:00Z",
            "deleted": "2021-01-30T08:30:00Z",
            "latest_instance": "2021-01-30T08:30:00Z",
            "provisioning": {
              "started": "2021-01-30T08:30:00Z",
              "failed": "2021-01-30T08:30:00Z",
              "completed": "2021-01-30T08:30:00Z"
            }
          },
          "meta": {
            "node": {
              "last_checkin": "2021-01-30T08:30:00Z",
              "drivers": [
                "…"
              ],
              "state": {
                "current": "new",
                "changed": "2021-01-30T08:30:00Z",
                "error": {
                  "message": "…",
                  "time": "2021-01-30T08:30:00Z"
                }
              },
              "stats": {
                "network": {
                  "interfaces": {
                    "ANY_ADDITIONAL_PROPERTY": {
                      "interface": "…",
                      "flags": "…",
                      "mtu": 1,
                      "mac_addr": "…",
                      "addrs": [
                        "…"
                      ]
                    }
                  },
                  "external_ipv4": "…",
                  "external_ipv6": "…"
                },
                "uptime": {
                  "seconds": 1,
                  "cpu_idle": 1
                },
                "cpu": {
                  "cores": 1,
                  "processors": [
                    {
                      "model": "…",
                      "speed": 1
                    }
                  ],
                  "usage": {
                    "user": 1,
                    "nice": 1,
                    "system": 1,
                    "idle": 1,
                    "iowait": 1,
                    "irq": 1,
                    "soft_irq": 1,
                    "steal": 1,
                    "guest": 1,
                    "guest_nice": 1
                  }
                },
                "load": {
                  "avg1m": 1,
                  "avg5m": 1,
                  "avg15m": 1
                },
                "ram": {
                  "available": 1,
                  "free": 1,
                  "total": 1
                },
                "storage": {
                  "volume_groups": {
                    "ANY_ADDITIONAL_PROPERTY": {
                      "name": "…",
                      "size": 1,
                      "volumes": {
                        "ANY_ADDITIONAL_PROPERTY": {
                          "name": "…",
                          "size": 1,
                          "data_percent": 1,
                          "meta_percent": 1,
                          "pool": "…"
                        }
                      }
                    }
                  },
                  "mounts": {
                    "ANY_ADDITIONAL_PROPERTY": {
                      "device": "…",
                      "type": "…",
                      "mountpoint": "…",
                      "total": 1,
                      "free": 1,
                      "used": 1
                    }
                  }
                },
                "os": {
                  "release": "…",
                  "kernel": "…",
                  "hostname": "…"
                },
                "versions": {
                  "services": {
                    "ANY_ADDITIONAL_PROPERTY": "…"
                  }
                }
              },
              "healthy": true,
              "online": true
            },
            "instances_count": {
              "state": {
                "new": 0,
                "starting": 0,
                "running": 5,
                "stopping": 0,
                "deleting": 0,
                "deleted": 0
              },
              "total": 5,
              "available": 5
            },
            "allocations": {
              "cpu_shares": {
                "total": 1,
                "allocatable": 1,
                "allocated": 1
              },
              "ram": {
                "total_mb": 1,
                "allocatable_mb": 1,
                "allocated_mb": 1
              }
            }
          }
        }
      }
    }
  ],
  "includes": {
    "creators": {
      "accounts": {
        "ANY_ADDITIONAL_PROPERTY": {
          "name": {
            "first": "…",
            "last": "…"
          },
          "email": {
            "address": "…"
          },
          "id": "…",
          "events": {
            "ANY_ADDITIONAL_PROPERTY": "2021-01-30T08:30:00Z",
            "last_login": "2021-01-30T08:30:00Z"
          }
        }
      },
      "employees": {
        "ANY_ADDITIONAL_PROPERTY": {
          "name": {
            "first": "…",
            "last": "…"
          },
          "email": {
            "address": "…"
          },
          "id": "…",
          "events": {
            "ANY_ADDITIONAL_PROPERTY": "2021-01-30T08:30:00Z",
            "last_login": "2021-01-30T08:30:00Z"
          }
        }
      },
      "visitors": {
        "ANY_ADDITIONAL_PROPERTY": {
          "name": {
            "first": "…",
            "last": "…"
          },
          "email": {
            "address": "…"
          },
          "id": "…",
          "events": {
            "ANY_ADDITIONAL_PROPERTY": "2021-01-30T08:30:00Z",
            "last_login": "2021-01-30T08:30:00Z"
          }
        }
      },
      "environments": {
        "ANY_ADDITIONAL_PROPERTY": {
          "id": "651586fca6078e98982dbd90",
          "identifier": "…",
          "name": "…",
          "cluster": "…",
          "about": {
            "description": "…",
            "favorite": true
          },
          "creator": {
            "id": "651586fca6078e98982dbd90",
            "type": "account"
          },
          "hub_id": "651586fca6078e98982dbd90",
          "state": {
            "current": "new",
            "changed": "2021-01-30T08:30:00Z",
            "error": {
              "message": "…",
              "time": "2021-01-30T08:30:00Z"
            }
          },
          "events": {
            "created": "2021-01-30T08:30:00Z",
            "updated": "2021-01-30T08:30:00Z",
            "deleted": "2021-01-30T08:30:00Z"
          },
          "features": {
            "legacy_networking": true,
            "monitoring": {
              "tier": "limited"
            }
          },
          "services": {
            "loadbalancer": {
              "enable": true,
              "container_id": null,
              "high_availability": true,
              "auto_update": true,
              "config": {
                "ipv4": true,
                "ipv6": true,
                "type": "v1",
                "details": {
                  "controllers": [
                    {
                      "identifier": "…",
                      "port": 1,
                      "waf": {
                        "rules": [
                          {
                            "description": "…",
                            "skip": true,
                            "type": "allow",
                            "match": "any",
                            "conditions": [
                              {
                                "type": "ip-match",
                                "operator": "==",
                                "value": "0.0.0.0/0"
                              }
                            ]
                          }
                        ]
                      },
                      "transport": null
                    }
                  ],
                  "controller_template": {
                    "identifier": "…",
                    "port": 1,
                    "waf": {
                      "rules": [
                        {
                          "description": "…",
                          "skip": true,
                          "type": "allow",
                          "match": "any",
                          "conditions": [
                            {
                              "type": "ip-match",
                              "operator": "==",
                              "value": "0.0.0.0/0"
                            }
                          ]
                        }
                      ]
                    },
                    "transport": null
                  },
                  "waf": {
                    "rules": [
                      {
                        "description": "…",
                        "skip": true,
                        "type": "allow",
                        "match": "any",
                        "conditions": [
                          {
                            "type": "ip-match",
                            "operator": "==",
                            "value": "0.0.0.0/0"
                          }
                        ]
                      }
                    ]
                  }
                },
                "bind_host": null
              }
            },
            "discovery": {
              "enable": true,
              "container_id": "…",
              "high_availability": true,
              "auto_update": true,
              "config": {
                "empty_set_delay": "72h45m2s",
                "hosts": null,
                "custom_resolvers": [
                  "…"
                ]
              }
            },
            "vpn": {
              "enable": true,
              "container_id": "…",
              "auto_update": true,
              "config": {
                "allow_internet": true,
                "auth": {
                  "webhook": null,
                  "cycle_accounts": true,
                  "vpn_accounts": true
                }
              }
            },
            "scheduler": {
              "enable": true,
              "container_id": null,
              "high_availability": true,
              "auto_update": true,
              "config": {
                "public": true,
                "access_keys": [
                  {
                    "name": "…",
                    "secret": "…",
                    "ips": [
                      "…"
                    ]
                  }
                ]
              }
            },
            "gateway": {
              "enable": true,
              "container_id": "…",
              "high_availability": true,
              "auto_update": true
            }
          },
          "acl": {
            "roles": {
              "ANY_ADDITIONAL_PROPERTY": {
                "view": true,
                "modify": true,
                "manage": true
              }
            }
          },
          "private_network": {
            "vxlan_tag": 1,
            "subnet": "…",
            "ipv6": {
              "ip": "fd00::21:0:0:0",
              "cidr": "fd00::21:0:0:0/96"
            },
            "legacy": {
              "subnet": 1,
              "ipv4": {
                "ip": "fd00::21:0:0:0",
                "cidr": "fd00::21:0:0:0/96"
              }
            }
          },
          "deployments": {
            "tags": {
              "ANY_ADDITIONAL_PROPERTY": "v1.2.3-dev"
            }
          },
          "meta": {
            "containers_count": {
              "state": {
                "new": 0,
                "starting": 0,
                "running": 5,
                "stopping": 0,
                "deleting": 0,
                "deleted": 0
              },
              "total": 5,
              "available": 5
            },
            "instances_count": {
              "state": {
                "new": 0,
                "starting": 0,
                "running": 5,
                "stopping": 0,
                "deleting": 0,
                "deleted": 0
              },
              "total": 5,
              "available": 5
            },
            "containers": [
              {
                "id": "651586fca6078e98982dbd90",
                "name": "…",
                "state": {
                  "current": "new",
                  "desired": "new",
                  "changed": "2021-01-30T08:30:00Z",
                  "error": {
                    "message": "…",
                    "time": "2021-01-30T08:30:00Z"
                  }
                },
                "image": {
                  "id": "651586fca6078e98982dbd90",
                  "service": "discovery"
                },
                "environment": {
                  "id": "651586fca6078e98982dbd90",
                  "cluster": "…",
                  "container_subnet": null,
                  "ipv6": {
                    "ip": "fd00::21:0:0:0",
                    "cidr": "fd00::21:0:0:0/96"
                  },
                  "legacy": {
                    "subnet": 1,
                    "ipv4": {
                      "ip": "fd00::21:0:0:0",
                      "cidr": "fd00::21:0:0:0/96"
                    }
                  }
                }
              }
            ]
          }
        }
      },
      "api_keys": {
        "ANY_ADDITIONAL_PROPERTY": {
          "id": "651586fca6078e98982dbd90",
          "name": "…",
          "hub_id": "651586fca6078e98982dbd90",
          "secret": "…",
          "permissions": {
            "all_environments": true,
            "environments": [
              {
                "id": "651586fca6078e98982dbd90",
                "manage": true
              }
            ]
          },
          "capabilities": {
            "all": true,
            "specific": [
              "…"
            ]
          },
          "ips": [
            "…"
          ],
          "state": {
            "current": "live",
            "changed": "2021-01-30T08:30:00Z",
            "error": {
              "message": "…",
              "time": "2021-01-30T08:30:00Z"
            }
          },
          "events": {
            "ANY_ADDITIONAL_PROPERTY": "2021-01-30T08:30:00Z"
          }
        }
      }
    },
    "environments": {
      "ANY_ADDITIONAL_PROPERTY": {
        "id": "651586fca6078e98982dbd90",
        "identifier": "…",
        "name": "…",
        "cluster": "…",
        "about": {
          "description": "…",
          "favorite": true
        },
        "creator": {
          "id": "651586fca6078e98982dbd90",
          "type": "account"
        },
        "hub_id": "651586fca6078e98982dbd90",
        "state": {
          "current": "new",
          "changed": "2021-01-30T08:30:00Z",
          "error": {
            "message": "…",
            "time": "2021-01-30T08:30:00Z"
          }
        },
        "events": {
          "created": "2021-01-30T08:30:00Z",
          "updated": "2021-01-30T08:30:00Z",
          "deleted": "2021-01-30T08:30:00Z"
        },
        "features": {
          "legacy_networking": true,
          "monitoring": {
            "tier": "limited"
          }
        },
        "services": {
          "loadbalancer": {
            "enable": true,
            "container_id": null,
            "high_availability": true,
            "auto_update": true,
            "config": {
              "ipv4": true,
              "ipv6": true,
              "type": "v1",
              "details": {
                "controllers": [
                  {
                    "identifier": "…",
                    "port": 1,
                    "waf": {
                      "rules": [
                        {
                          "description": "…",
                          "skip": true,
                          "type": "allow",
                          "match": "any",
                          "conditions": [
                            {
                              "type": "ip-match",
                              "operator": "==",
                              "value": "0.0.0.0/0"
                            }
                          ]
                        }
                      ]
                    },
                    "transport": null
                  }
                ],
                "controller_template": {
                  "identifier": "…",
                  "port": 1,
                  "waf": {
                    "rules": [
                      {
                        "description": "…",
                        "skip": true,
                        "type": "allow",
                        "match": "any",
                        "conditions": [
                          {
                            "type": "ip-match",
                            "operator": "==",
                            "value": "0.0.0.0/0"
                          }
                        ]
                      }
                    ]
                  },
                  "transport": null
                },
                "waf": {
                  "rules": [
                    {
                      "description": "…",
                      "skip": true,
                      "type": "allow",
                      "match": "any",
                      "conditions": [
                        {
                          "type": "ip-match",
                          "operator": "==",
                          "value": "0.0.0.0/0"
                        }
                      ]
                    }
                  ]
                }
              },
              "bind_host": null
            }
          },
          "discovery": {
            "enable": true,
            "container_id": "…",
            "high_availability": true,
            "auto_update": true,
            "config": {
              "empty_set_delay": "72h45m2s",
              "hosts": null,
              "custom_resolvers": [
                "…"
              ]
            }
          },
          "vpn": {
            "enable": true,
            "container_id": "…",
            "auto_update": true,
            "config": {
              "allow_internet": true,
              "auth": {
                "webhook": null,
                "cycle_accounts": true,
                "vpn_accounts": true
              }
            }
          },
          "scheduler": {
            "enable": true,
            "container_id": null,
            "high_availability": true,
            "auto_update": true,
            "config": {
              "public": true,
              "access_keys": [
                {
                  "name": "…",
                  "secret": "…",
                  "ips": [
                    "…"
                  ]
                }
              ]
            }
          },
          "gateway": {
            "enable": true,
            "container_id": "…",
            "high_availability": true,
            "auto_update": true
          }
        },
        "acl": {
          "roles": {
            "ANY_ADDITIONAL_PROPERTY": {
              "view": true,
              "modify": true,
              "manage": true
            }
          }
        },
        "private_network": {
          "vxlan_tag": 1,
          "subnet": "…",
          "ipv6": {
            "ip": "fd00::21:0:0:0",
            "cidr": "fd00::21:0:0:0/96"
          },
          "legacy": {
            "subnet": 1,
            "ipv4": {
              "ip": "fd00::21:0:0:0",
              "cidr": "fd00::21:0:0:0/96"
            }
          }
        },
        "deployments": {
          "tags": {
            "ANY_ADDITIONAL_PROPERTY": "v1.2.3-dev"
          }
        },
        "meta": {
          "containers_count": {
            "state": {
              "new": 0,
              "starting": 0,
              "running": 5,
              "stopping": 0,
              "deleting": 0,
              "deleted": 0
            },
            "total": 5,
            "available": 5
          },
          "instances_count": {
            "state": {
              "new": 0,
              "starting": 0,
              "running": 5,
              "stopping": 0,
              "deleting": 0,
              "deleted": 0
            },
            "total": 5,
            "available": 5
          },
          "containers": [
            {
              "id": "651586fca6078e98982dbd90",
              "name": "…",
              "state": {
                "current": "new",
                "desired": "new",
                "changed": "2021-01-30T08:30:00Z",
                "error": {
                  "message": "…",
                  "time": "2021-01-30T08:30:00Z"
                }
              },
              "image": {
                "id": "651586fca6078e98982dbd90",
                "service": "discovery"
              },
              "environment": {
                "id": "651586fca6078e98982dbd90",
                "cluster": "…",
                "container_subnet": null,
                "ipv6": {
                  "ip": "fd00::21:0:0:0",
                  "cidr": "fd00::21:0:0:0/96"
                },
                "legacy": {
                  "subnet": 1,
                  "ipv4": {
                    "ip": "fd00::21:0:0:0",
                    "cidr": "fd00::21:0:0:0/96"
                  }
                }
              }
            }
          ]
        }
      }
    },
    "environments:identifiers": {
      "ANY_ADDITIONAL_PROPERTY": "651586fca6078e98982dbd90"
    },
    "clusters": {
      "ANY_ADDITIONAL_PROPERTY": {
        "id": "…",
        "identifier": "…",
        "creator": {
          "id": "651586fca6078e98982dbd90",
          "type": "account"
        },
        "hub_id": "651586fca6078e98982dbd90",
        "acl": {
          "roles": {
            "ANY_ADDITIONAL_PROPERTY": {
              "view": true,
              "modify": true,
              "manage": true
            }
          }
        },
        "state": {
          "current": "live",
          "changed": "2021-01-30T08:30:00Z",
          "error": {
            "message": "…",
            "time": "2021-01-30T08:30:00Z"
          }
        },
        "events": {
          "created": "2021-01-30T08:30:00Z",
          "updated": "2021-01-30T08:30:00Z",
          "deleted": "2021-01-30T08:30:00Z"
        }
      }
    },
    "containers": {
      "ANY_ADDITIONAL_PROPERTY": {
        "id": "651586fca6078e98982dbd90",
        "identifier": "…",
        "name": "…",
        "creator": {
          "id": "651586fca6078e98982dbd90",
          "type": "account"
        },
        "environment": {
          "id": "651586fca6078e98982dbd90",
          "cluster": "…",
          "container_subnet": null,
          "ipv6": {
            "ip": "fd00::21:0:0:0",
            "cidr": "fd00::21:0:0:0/96"
          },
          "legacy": {
            "subnet": 1,
            "ipv4": {
              "ip": "fd00::21:0:0:0",
              "cidr": "fd00::21:0:0:0/96"
            }
          }
        },
        "hub_id": "651586fca6078e98982dbd90",
        "image": {
          "id": "651586fca6078e98982dbd90",
          "extension": {
            "identifier": "virtual-machine-v1",
            "id": "651586fca6078e98982dbd90"
          },
          "service": "discovery"
        },
        "stack": {
          "id": "651586fca6078e98982dbd90",
          "build_id": "…",
          "identifier": "…"
        },
        "config": {
          "network": {
            "public": "enable",
            "hostname": "…",
            "ports": [
              "…"
            ]
          },
          "deploy": {
            "instances": 1,
            "strategy": "resource-density",
            "function": {
              "max_pool_size": null,
              "max_shard_concurrency": null,
              "max_runtime": "72h45m2s",
              "max_queue_time": "72h45m2s"
            },
            "stateful": {
              "options": {
                "use_base_hostname": null
              }
            },
            "constraints": {
              "node": {
                "tags": {
                  "any": [
                    "…"
                  ],
                  "all": [
                    "…"
                  ]
                }
              },
              "secrets": [
                "…"
              ]
            },
            "shutdown": {
              "graceful_timeout": "72h45m2s",
              "signals": [
                "SIGTERM"
              ]
            },
            "startup": {
              "delay": "72h45m2s"
            },
            "update": {
              "stagger": "72h45m2s"
            },
            "restart": {
              "condition": "always",
              "delay": "72h45m2s",
              "max_attempts": 1
            },
            "health_check": {
              "command": "…",
              "retries": 1,
              "delay": "72h45m2s",
              "interval": "72h45m2s",
              "timeout": "72h45m2s",
              "restart": true
            },
            "telemetry": {
              "retention": "72h45m2s",
              "interval": "72h45m2s",
              "disable": true
            }
          },
          "scale": {
            "autoscale_group": null,
            "instances": {
              "max": 1,
              "max_server": 1,
              "min_ttl": "72h45m2s"
            },
            "window": "72h45m2s",
            "thresholds": [
              {
                "type": "ram",
                "details": {
                  "usage": "2G"
                }
              }
            ]
          },
          "runtime": {
            "command": {
              "path": null,
              "args": null
            },
            "namespaces": [
              "ipc"
            ],
            "environment_vars": {
              "ANY_ADDITIONAL_PROPERTY": "…"
            },
            "privileged": true,
            "capabilities": [
              "CAP_CHOWN"
            ],
            "workdir": "…",
            "sysctl": {
              "ANY_ADDITIONAL_PROPERTY": "…"
            },
            "rlimits": {
              "ANY_ADDITIONAL_PROPERTY": {
                "hard": 1,
                "soft": 1
              }
            },
            "seccomp": {
              "disable": true,
              "rules": [
                {
                  "capabilities": {
                    "includes": "…",
                    "excludes": "…"
                  },
                  "syscall": {
                    "names": [
                      "…"
                    ],
                    "action": "…",
                    "errnoRet": 1,
                    "args": [
                      {
                        "index": 1,
                        "value": 1,
                        "valueTwo": 1,
                        "op": "…"
                      }
                    ]
                  }
                }
              ]
            },
            "host": {
              "expose_proc": null
            },
            "rootfs": {
              "readonly": true
            },
            "devices": {
              "shm_size": "64M"
            }
          },
          "resources": {
            "cpu": {
              "shares": {
                "limit": 1,
                "reserve": 1
              },
              "cpus": "…"
            },
            "ram": {
              "limit": "1G",
              "reserve": "…"
            }
          },
          "integrations": {
            "webhooks": {
              "events": {
                "deploy": "…",
                "start": "…",
                "stop": "…"
              },
              "config": "…"
            },
            "files": [
              {
                "source": "…",
                "destination": "…"
              }
            ],
            "lets_encrypt": {
              "certificate_path": "…",
              "chain_path": "…",
              "key_path": "…",
              "bundle_path": "…",
              "additional_certs_path": "…"
            },
            "backups": {
              "integration_id": "my-image-source",
              "backup": {
                "command": "…",
                "timeout": "72h45m2s",
                "cron_string": "…"
              },
              "restore": {
                "command": "…",
                "timeout": "…"
              },
              "retention": "365d"
            },
            "shared_file_systems": null,
            "logs": {
              "drain": {
                "url": "…"
              }
            }
          }
        },
        "deployment": {
          "version": "v1.2.3-dev"
        },
        "instances": 1,
        "volumes": [
          {
            "id": "651586fca6078e98982dbd90",
            "hash": "…",
            "config": {
              "read_only": true,
              "block_device": true,
              "local": {
                "max_size": "10G",
                "storage_pool": true
              },
              "destination": "…",
              "remote_access": {
                "enable": true,
                "ips": [
                  "…"
                ],
                "webhook": "…",
                "password": {
                  "algorithm": "raw",
                  "data": "…"
                }
              }
            }
          }
        ],
        "annotations": null,
        "role": "orchestrator",
        "stateful": true,
        "deprecate": true,
        "lock": true,
        "state": {
          "current": "new",
          "desired": "new",
          "changed": "2021-01-30T08:30:00Z",
          "error": {
            "message": "…",
            "time": "2021-01-30T08:30:00Z"
          }
        },
        "events": {
          "created": "2021-01-30T08:30:00Z",
          "updated": "2021-01-30T08:30:00Z",
          "deleted": "2021-01-30T08:30:00Z",
          "started": "2021-01-30T08:30:00Z"
        },
        "meta": {
          "instances_count": {
            "state": {
              "new": 0,
              "starting": 0,
              "running": 5,
              "stopping": 0,
              "deleting": 0,
              "deleted": 0
            },
            "total": 5,
            "available": 5
          },
          "domains": [
            {
              "fqdn": "…",
              "record": {
                "id": "651586fca6078e98982dbd90",
                "hub_id": "651586fca6078e98982dbd90",
                "creator": {
                  "id": "651586fca6078e98982dbd90",
                  "type": "account"
                },
                "zone_id": "…",
                "name": "…",
                "resolved_domain": "…",
                "type": {
                  "a": {
                    "ip": "…"
                  },
                  "aaaa": {
                    "ip": "…"
                  },
                  "cname": {
                    "domain": "…"
                  },
                  "ns": {
                    "domain": "…"
                  },
                  "mx": {
                    "priority": 1,
                    "domain": "…"
                  },
                  "txt": {
                    "value": "…"
                  },
                  "alias": {
                    "domain": "…"
                  },
                  "srv": {
                    "weight": 1,
                    "priority": 1,
                    "port": 1,
                    "domain": "…"
                  },
                  "caa": {
                    "tag": "…",
                    "value": "…"
                  },
                  "linked": {
                    "features": {
                      "tls": {
                        "enable": true
                      },
                      "geodns": {
                        "enable": true
                      },
                      "wildcard": {
                        "resolve_sub_domains": false
                      }
                    },
                    "container_id": "…"
                  }
                },
                "features": {
                  "certificate": {
                    "id": "651586fca6078e98982dbd90",
                    "generated": "2021-01-30T08:30:00Z",
                    "wildcard_child": true,
                    "user_supplied": true,
                    "expires": "2021-01-30T08:30:00Z"
                  }
                },
                "state": {
                  "current": "pending",
                  "changed": "2021-01-30T08:30:00Z",
                  "error": {
                    "message": "…",
                    "time": "2021-01-30T08:30:00Z"
                  }
                },
                "events": {
                  "ANY_ADDITIONAL_PROPERTY": "2021-01-30T08:30:00Z"
                }
              }
            }
          ],
          "ips": [
            {
              "id": "651586fca6078e98982dbd90",
              "hub_id": "651586fca6078e98982dbd90",
              "kind": "ipv4",
              "assignment": {
                "container_id": "651586fca6078e98982dbd90",
                "instance_id": "651586fca6078e98982dbd90",
                "environment_id": "651586fca6078e98982dbd90",
                "virtual_machine": {
                  "id": "651586fca6078e98982dbd90"
                }
              },
              "pool_id": "…",
              "address": "…",
              "gateway": "…",
              "cidr": "…",
              "state": {
                "current": "assigning",
                "changed": "2021-01-30T08:30:00Z",
                "error": {
                  "message": "…",
                  "time": "2021-01-30T08:30:00Z"
                }
              }
            }
          ]
        }
      }
    }
  }
}

    Returns a list of virtual machines.

    Create Virtual Machine

    ​

    Requires the virtual-machines-deploy capability.

    Query Parameters
    • meta
      Type:array string[] enum

      A comma-separated list of meta values. Meta values will show up under a resource's meta field. In the case of applying a meta to a collection of resources, each resource will have its own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.

      • domains
      • ips
      • server
  • include
    Type:array string[] enum

    A comma-separated list of include values. Included resources will show up under the root document's include field. In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return.

    • creators
    • environments
    • clusters
    • Body
    • identifier
      Type:string

      A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient. The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will have the identifier of my-container and is automatically created by the platform.

      The identifier does not have to be unique.

    • name
      Type:string
      required

      A user-defined name for the virtual machine.

    • environment_id
      Type:string
      required

      The ID of the environment this virtual machine will be deployed to.

    • image
      Type:object
      oneOf
      required

      Represents the image used by a virtual machine. It can either reference a URL where the image is located or specify a base image provided by Cycle. The base field allows users to specify the name of a desired Cycle-hosted base image, removing the need for a custom image URL.

      A virtual machine image sourced from a URL.

      A virtual machine image sourced from an IPXE script.

      A virtual machine image sourced from a Cycle base image.

    • config
      Type:object
      required

      Defines the network and deployment configurations for a virtual machine.

    • lock
      Type:boolean
      required

      Prevents this virtual machine from being deleted when true.

    • volumes
      Type:array object[]

      Represents the configuration for a volume attached to a virtual machine.

    • base_disk_size
      Type:string

      The size of the base disk. Must be between 10G and 100G.

      Example10G
    • annotations
      Type:object | null
    • ssh_keys
      Type:array string[]

      An array of SSH key IDs that should be applied to this virtual machine.

    Responses
    Request Example forPOST/v1/virtual-machines
    curl https://api.cycle.io/v1/virtual-machines \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'X-Hub-Id: YOUR_SECRET_TOKEN' \
  --data '{
  "identifier": "",
  "name": "",
  "environment_id": "",
  "image": {
    "type": "url",
    "details": {
      "url": ""
    }
  },
  "config": {
    "network": {
      "public": "enable",
      "hostname": "",
      "ports": [
        ""
      ]
    },
    "deploy": {
      "constraints": {
        "node": {
          "tags": {
            "any": [
              ""
            ],
            "all": [
              ""
            ]
          }
        },
        "secrets": [
          ""
        ],
        "containers": [
          ""
        ]
      },
      "shutdown": {
        "graceful_timeout": "72h45m2s"
      },
      "startup": {
        "delay": "72h45m2s"
      },
      "telemetry": {
        "retention": "72h45m2s",
        "interval": "72h45m2s",
        "disable": true
      }
    },
    "resources": {
      "ram": {
        "limit": "1G",
        "allocate": null
      },
      "cpu": {
        "cores": {
          "number": 1,
          "allocate": null
        },
        "cpus": "1"
      }
    }
  },
  "lock": true,
  "volumes": [
    {
      "local": {
        "max_size": "100G",
        "storage_pool": true
      },
      "identifier": "",
      "read_only": true
    }
  ],
  "base_disk_size": "10G",
  "annotations": null,
  "ssh_keys": [
    "651586fca6078e98982dbd90"
  ]
}'

    {
  "data": {
    "id": "651586fca6078e98982dbd90",
    "name": "…",
    "identifier": "…",
    "creator": {
      "id": "651586fca6078e98982dbd90",
      "type": "account"
    },
    "environment": {
      "id": "651586fca6078e98982dbd90",
      "cluster": "…"
    },
    "hub_id": "651586fca6078e98982dbd90",
    "config": {
      "network": {
        "public": "enable",
        "hostname": "…",
        "ports": [
          "…"
        ]
      },
      "deploy": {
        "constraints": {
          "node": {
            "tags": {
              "any": [
                "…"
              ],
              "all": [
                "…"
              ]
            }
          },
          "secrets": [
            "…"
          ],
          "containers": [
            "…"
          ]
        },
        "shutdown": {
          "graceful_timeout": "72h45m2s"
        },
        "startup": {
          "delay": "72h45m2s"
        },
        "telemetry": {
          "retention": "72h45m2s",
          "interval": "72h45m2s",
          "disable": true
        }
      },
      "resources": {
        "ram": {
          "limit": "1G",
          "allocate": null
        },
        "cpu": {
          "cores": {
            "number": 1,
            "allocate": null
          },
          "cpus": "1"
        }
      }
    },
    "image": {
      "type": "url",
      "details": {
        "url": "…"
      }
    },
    "container_id": "651586fca6078e98982dbd90",
    "volumes": [
      {
        "id": "651586fca6078e98982dbd90",
        "hash": "…",
        "config": {
          "local": {
            "max_size": "100G",
            "storage_pool": true
          },
          "identifier": "…",
          "read_only": true
        }
      }
    ],
    "annotations": null,
    "base_disk_size": "10G",
    "root_password": {
      "changed": "2021-01-30T08:30:00Z",
      "current": null
    },
    "ssh_keys": [
      "651586fca6078e98982dbd90"
    ],
    "state": {
      "current": "new",
      "changed": "2021-01-30T08:30:00Z",
      "error": {
        "message": "…",
        "time": "2021-01-30T08:30:00Z"
      }
    },
    "events": {
      "created": "2021-01-30T08:30:00Z",
      "updated": "2021-01-30T08:30:00Z",
      "deleted": "2021-01-30T08:30:00Z",
      "started": "2021-01-30T08:30:00Z"
    },
    "deprecate": true,
    "lock": true,
    "meta": {
      "domains": [
        {
          "fqdn": "…",
          "record": {
            "id": "651586fca6078e98982dbd90",
            "hub_id": "651586fca6078e98982dbd90",
            "creator": {
              "id": "651586fca6078e98982dbd90",
              "type": "account"
            },
            "zone_id": "…",
            "name": "…",
            "resolved_domain": "…",
            "type": {
              "a": {
                "ip": "…"
              },
              "aaaa": {
                "ip": "…"
              },
              "cname": {
                "domain": "…"
              },
              "ns": {
                "domain": "…"
              },
              "mx": {
                "priority": 1,
                "domain": "…"
              },
              "txt": {
                "value": "…"
              },
              "alias": {
                "domain": "…"
              },
              "srv": {
                "weight": 1,
                "priority": 1,
                "port": 1,
                "domain": "…"
              },
              "caa": {
                "tag": "…",
                "value": "…"
              },
              "linked": {
                "features": {
                  "tls": {
                    "enable": true
                  },
                  "geodns": {
                    "enable": true
                  },
                  "wildcard": {
                    "resolve_sub_domains": false
                  }
                },
                "container_id": "…"
              }
            },
            "features": {
              "certificate": {
                "id": "651586fca6078e98982dbd90",
                "generated": "2021-01-30T08:30:00Z",
                "wildcard_child": true,
                "user_supplied": true,
                "expires": "2021-01-30T08:30:00Z"
              }
            },
            "state": {
              "current": "pending",
              "changed": "2021-01-30T08:30:00Z",
              "error": {
                "message": "…",
                "time": "2021-01-30T08:30:00Z"
              }
            },
            "events": {
              "ANY_ADDITIONAL_PROPERTY": "2021-01-30T08:30:00Z"
            }
          }
        }
      ],
      "ips": [
        {
          "id": "651586fca6078e98982dbd90",
          "hub_id": "651586fca6078e98982dbd90",
          "kind": "ipv4",
          "assignment": {
            "container_id": "651586fca6078e98982dbd90",
            "instance_id": "651586fca6078e98982dbd90",
            "environment_id": "651586fca6078e98982dbd90",
            "virtual_machine": {
              "id": "651586fca6078e98982dbd90"
            }
          },
          "pool_id": "…",
          "address": "…",
          "gateway": "…",
          "cidr": "…",
          "state": {
            "current": "assigning",
            "changed": "2021-01-30T08:30:00Z",
            "error": {
              "message": "…",
              "time": "2021-01-30T08:30:00Z"
            }
          }
        }
      ],
      "server": {
        "id": "651586fca6078e98982dbd90",
        "hub_id": "651586fca6078e98982dbd90",
        "location_id": "…",
        "model_id": "…",
        "node_id": "…",
        "shared_file_systems": {
          "mounts": null,
          "directories": null
        },
        "hostname": "…",
        "creator": {
          "id": "651586fca6078e98982dbd90",
          "type": "account"
        },
        "provider": {
          "vendor": "…",
          "integration_id": "651586fca6078e98982dbd90",
          "model": "…",
          "zone": null,
          "location": "…",
          "server": "…",
          "init_ips": [
            "…"
          ],
          "mac_addr": "…",
          "extra": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "provision_options": {
            "encrypt_storage": true,
            "storage_size": 1,
            "reservation_id": "…"
          }
        },
        "cluster": "…",
        "features": {
          "sftp": true,
          "base_volume_gb": null,
          "gateway": {
            "type": "bgp"
          }
        },
        "constraints": {
          "tags": [
            "…"
          ],
          "allow": {
            "pool": true,
            "services": true,
            "overcommit": true
          }
        },
        "autoscale": {
          "group_id": "651586fca6078e98982dbd90"
        },
        "ephemeral": true,
        "evacuate": {
          "started": "2021-01-30T08:30:00Z"
        },
        "state": {
          "current": "new",
          "changed": "2021-01-30T08:30:00Z",
          "error": {
            "message": "…",
            "time": "2021-01-30T08:30:00Z"
          }
        },
        "events": {
          "created": "2021-01-30T08:30:00Z",
          "updated": "2021-01-30T08:30:00Z",
          "deleted": "2021-01-30T08:30:00Z",
          "latest_instance": "2021-01-30T08:30:00Z",
          "provisioning": {
            "started": "2021-01-30T08:30:00Z",
            "failed": "2021-01-30T08:30:00Z",
            "completed": "2021-01-30T08:30:00Z"
          }
        },
        "meta": {
          "node": {
            "last_checkin": "2021-01-30T08:30:00Z",
            "drivers": [
              "…"
            ],
            "state": {
              "current": "new",
              "changed": "2021-01-30T08:30:00Z",
              "error": {
                "message": "…",
                "time": "2021-01-30T08:30:00Z"
              }
            },
            "stats": {
              "network": {
                "interfaces": {
                  "ANY_ADDITIONAL_PROPERTY": {
                    "interface": "…",
                    "flags": "…",
                    "mtu": 1,
                    "mac_addr": "…",
                    "addrs": [
                      "…"
                    ]
                  }
                },
                "external_ipv4": "…",
                "external_ipv6": "…"
              },
              "uptime": {
                "seconds": 1,
                "cpu_idle": 1
              },
              "cpu": {
                "cores": 1,
                "processors": [
                  {
                    "model": "…",
                    "speed": 1
                  }
                ],
                "usage": {
                  "user": 1,
                  "nice": 1,
                  "system": 1,
                  "idle": 1,
                  "iowait": 1,
                  "irq": 1,
                  "soft_irq": 1,
                  "steal": 1,
                  "guest": 1,
                  "guest_nice": 1
                }
              },
              "load": {
                "avg1m": 1,
                "avg5m": 1,
                "avg15m": 1
              },
              "ram": {
                "available": 1,
                "free": 1,
                "total": 1
              },
              "storage": {
                "volume_groups": {
                  "ANY_ADDITIONAL_PROPERTY": {
                    "name": "…",
                    "size": 1,
                    "volumes": {
                      "ANY_ADDITIONAL_PROPERTY": {
                        "name": "…",
                        "size": 1,
                        "data_percent": 1,
                        "meta_percent": 1,
                        "pool": "…"
                      }
                    }
                  }
                },
                "mounts": {
                  "ANY_ADDITIONAL_PROPERTY": {
                    "device": "…",
                    "type": "…",
                    "mountpoint": "…",
                    "total": 1,
                    "free": 1,
                    "used": 1
                  }
                }
              },
              "os": {
                "release": "…",
                "kernel": "…",
                "hostname": "…"
              },
              "versions": {
                "services": {
                  "ANY_ADDITIONAL_PROPERTY": "…"
                }
              }
            },
            "healthy": true,
            "online": true
          },
          "instances_count": {
            "state": {
              "new": 0,
              "starting": 0,
              "running": 5,
              "stopping": 0,
              "deleting": 0,
              "deleted": 0
            },
            "total": 5,
            "available": 5
          },
          "allocations": {
            "cpu_shares": {
              "total": 1,
              "allocatable": 1,
              "allocated": 1
            },
            "ram": {
              "total_mb": 1,
              "allocatable_mb": 1,
              "allocated_mb": 1
            }
          }
        }
      }
    }
  },
  "includes": {
    "creators": {
      "accounts": {
        "ANY_ADDITIONAL_PROPERTY": {
          "name": {
            "first": "…",
            "last": "…"
          },
          "email": {
            "address": "…"
          },
          "id": "…",
          "events": {
            "ANY_ADDITIONAL_PROPERTY": "2021-01-30T08:30:00Z",
            "last_login": "2021-01-30T08:30:00Z"
          }
        }
      },
      "employees": {
        "ANY_ADDITIONAL_PROPERTY": {
          "name": {
            "first": "…",
            "last": "…"
          },
          "email": {
            "address": "…"
          },
          "id": "…",
          "events": {
            "ANY_ADDITIONAL_PROPERTY": "2021-01-30T08:30:00Z",
            "last_login": "2021-01-30T08:30:00Z"
          }
        }
      },
      "visitors": {
        "ANY_ADDITIONAL_PROPERTY": {
          "name": {
            "first": "…",
            "last": "…"
          },
          "email": {
            "address": "…"
          },
          "id": "…",
          "events": {
            "ANY_ADDITIONAL_PROPERTY": "2021-01-30T08:30:00Z",
            "last_login": "2021-01-30T08:30:00Z"
          }
        }
      },
      "environments": {
        "ANY_ADDITIONAL_PROPERTY": {
          "id": "651586fca6078e98982dbd90",
          "identifier": "…",
          "name": "…",
          "cluster": "…",
          "about": {
            "description": "…",
            "favorite": true
          },
          "creator": {
            "id": "651586fca6078e98982dbd90",
            "type": "account"
          },
          "hub_id": "651586fca6078e98982dbd90",
          "state": {
            "current": "new",
            "changed": "2021-01-30T08:30:00Z",
            "error": {
              "message": "…",
              "time": "2021-01-30T08:30:00Z"
            }
          },
          "events": {
            "created": "2021-01-30T08:30:00Z",
            "updated": "2021-01-30T08:30:00Z",
            "deleted": "2021-01-30T08:30:00Z"
          },
          "features": {
            "legacy_networking": true,
            "monitoring": {
              "tier": "limited"
            }
          },
          "services": {
            "loadbalancer": {
              "enable": true,
              "container_id": null,
              "high_availability": true,
              "auto_update": true,
              "config": {
                "ipv4": true,
                "ipv6": true,
                "type": "v1",
                "details": {
                  "controllers": [
                    {
                      "identifier": "…",
                      "port": 1,
                      "waf": {
                        "rules": [
                          {
                            "description": "…",
                            "skip": true,
                            "type": "allow",
                            "match": "any",
                            "conditions": [
                              {
                                "type": "ip-match",
                                "operator": "==",
                                "value": "0.0.0.0/0"
                              }
                            ]
                          }
                        ]
                      },
                      "transport": null
                    }
                  ],
                  "controller_template": {
                    "identifier": "…",
                    "port": 1,
                    "waf": {
                      "rules": [
                        {
                          "description": "…",
                          "skip": true,
                          "type": "allow",
                          "match": "any",
                          "conditions": [
                            {
                              "type": "ip-match",
                              "operator": "==",
                              "value": "0.0.0.0/0"
                            }
                          ]
                        }
                      ]
                    },
                    "transport": null
                  },
                  "waf": {
                    "rules": [
                      {
                        "description": "…",
                        "skip": true,
                        "type": "allow",
                        "match": "any",
                        "conditions": [
                          {
                            "type": "ip-match",
                            "operator": "==",
                            "value": "0.0.0.0/0"
                          }
                        ]
                      }
                    ]
                  }
                },
                "bind_host": null
              }
            },
            "discovery": {
              "enable": true,
              "container_id": "…",
              "high_availability": true,
              "auto_update": true,
              "config": {
                "empty_set_delay": "72h45m2s",
                "hosts": null,
                "custom_resolvers": [
                  "…"
                ]
              }
            },
            "vpn": {
              "enable": true,
              "container_id": "…",
              "auto_update": true,
              "config": {
                "allow_internet": true,
                "auth": {
                  "webhook": null,
                  "cycle_accounts": true,
                  "vpn_accounts": true
                }
              }
            },
            "scheduler": {
              "enable": true,
              "container_id": null,
              "high_availability": true,
              "auto_update": true,
              "config": {
                "public": true,
                "access_keys": [
                  {
                    "name": "…",
                    "secret": "…",
                    "ips": [
                      "…"
                    ]
                  }
                ]
              }
            },
            "gateway": {
              "enable": true,
              "container_id": "…",
              "high_availability": true,
              "auto_update": true
            }
          },
          "acl": {
            "roles": {
              "ANY_ADDITIONAL_PROPERTY": {
                "view": true,
                "modify": true,
                "manage": true
              }
            }
          },
          "private_network": {
            "vxlan_tag": 1,
            "subnet": "…",
            "ipv6": {
              "ip": "fd00::21:0:0:0",
              "cidr": "fd00::21:0:0:0/96"
            },
            "legacy": {
              "subnet": 1,
              "ipv4": {
                "ip": "fd00::21:0:0:0",
                "cidr": "fd00::21:0:0:0/96"
              }
            }
          },
          "deployments": {
            "tags": {
              "ANY_ADDITIONAL_PROPERTY": "v1.2.3-dev"
            }
          },
          "meta": {
            "containers_count": {
              "state": {
                "new": 0,
                "starting": 0,
                "running": 5,
                "stopping": 0,
                "deleting": 0,
                "deleted": 0
              },
              "total": 5,
              "available": 5
            },
            "instances_count": {
              "state": {
                "new": 0,
                "starting": 0,
                "running": 5,
                "stopping": 0,
                "deleting": 0,
                "deleted": 0
              },
              "total": 5,
              "available": 5
            },
            "containers": [
              {
                "id": "651586fca6078e98982dbd90",
                "name": "…",
                "state": {
                  "current": "new",
                  "desired": "new",
                  "changed": "2021-01-30T08:30:00Z",
                  "error": {
                    "message": "…",
                    "time": "2021-01-30T08:30:00Z"
                  }
                },
                "image": {
                  "id": "651586fca6078e98982dbd90",
                  "service": "discovery"
                },
                "environment": {
                  "id": "651586fca6078e98982dbd90",
                  "cluster": "…",
                  "container_subnet": null,
                  "ipv6": {
                    "ip": "fd00::21:0:0:0",
                    "cidr": "fd00::21:0:0:0/96"
                  },
                  "legacy": {
                    "subnet": 1,
                    "ipv4": {
                      "ip": "fd00::21:0:0:0",
                      "cidr": "fd00::21:0:0:0/96"
                    }
                  }
                }
              }
            ]
          }
        }
      },
      "api_keys": {
        "ANY_ADDITIONAL_PROPERTY": {
          "id": "651586fca6078e98982dbd90",
          "name": "…",
          "hub_id": "651586fca6078e98982dbd90",
          "secret": "…",
          "permissions": {
            "all_environments": true,
            "environments": [
              {
                "id": "651586fca6078e98982dbd90",
                "manage": true
              }
            ]
          },
          "capabilities": {
            "all": true,
            "specific": [
              "…"
            ]
          },
          "ips": [
            "…"
          ],
          "state": {
            "current": "live",
            "changed": "2021-01-30T08:30:00Z",
            "error": {
              "message": "…",
              "time": "2021-01-30T08:30:00Z"
            }
          },
          "events": {
            "ANY_ADDITIONAL_PROPERTY": "2021-01-30T08:30:00Z"
          }
        }
      }
    },
    "environments": {
      "ANY_ADDITIONAL_PROPERTY": {
        "id": "651586fca6078e98982dbd90",
        "identifier": "…",
        "name": "…",
        "cluster": "…",
        "about": {
          "description": "…",
          "favorite": true
        },
        "creator": {
          "id": "651586fca6078e98982dbd90",
          "type": "account"
        },
        "hub_id": "651586fca6078e98982dbd90",
        "state": {
          "current": "new",
          "changed": "2021-01-30T08:30:00Z",
          "error": {
            "message": "…",
            "time": "2021-01-30T08:30:00Z"
          }
        },
        "events": {
          "created": "2021-01-30T08:30:00Z",
          "updated": "2021-01-30T08:30:00Z",
          "deleted": "2021-01-30T08:30:00Z"
        },
        "features": {
          "legacy_networking": true,
          "monitoring": {
            "tier": "limited"
          }
        },
        "services": {
          "loadbalancer": {
            "enable": true,
            "container_id": null,
            "high_availability": true,
            "auto_update": true,
            "config": {
              "ipv4": true,
              "ipv6": true,
              "type": "v1",
              "details": {
                "controllers": [
                  {
                    "identifier": "…",
                    "port": 1,
                    "waf": {
                      "rules": [
                        {
                          "description": "…",
                          "skip": true,
                          "type": "allow",
                          "match": "any",
                          "conditions": [
                            {
                              "type": "ip-match",
                              "operator": "==",
                              "value": "0.0.0.0/0"
                            }
                          ]
                        }
                      ]
                    },
                    "transport": null
                  }
                ],
                "controller_template": {
                  "identifier": "…",
                  "port": 1,
                  "waf": {
                    "rules": [
                      {
                        "description": "…",
                        "skip": true,
                        "type": "allow",
                        "match": "any",
                        "conditions": [
                          {
                            "type": "ip-match",
                            "operator": "==",
                            "value": "0.0.0.0/0"
                          }
                        ]
                      }
                    ]
                  },
                  "transport": null
                },
                "waf": {
                  "rules": [
                    {
                      "description": "…",
                      "skip": true,
                      "type": "allow",
                      "match": "any",
                      "conditions": [
                        {
                          "type": "ip-match",
                          "operator": "==",
                          "value": "0.0.0.0/0"
                        }
                      ]
                    }
                  ]
                }
              },
              "bind_host": null
            }
          },
          "discovery": {
            "enable": true,
            "container_id": "…",
            "high_availability": true,
            "auto_update": true,
            "config": {
              "empty_set_delay": "72h45m2s",
              "hosts": null,
              "custom_resolvers": [
                "…"
              ]
            }
          },
          "vpn": {
            "enable": true,
            "container_id": "…",
            "auto_update": true,
            "config": {
              "allow_internet": true,
              "auth": {
                "webhook": null,
                "cycle_accounts": true,
                "vpn_accounts": true
              }
            }
          },
          "scheduler": {
            "enable": true,
            "container_id": null,
            "high_availability": true,
            "auto_update": true,
            "config": {
              "public": true,
              "access_keys": [
                {
                  "name": "…",
                  "secret": "…",
                  "ips": [
                    "…"
                  ]
                }
              ]
            }
          },
          "gateway": {
            "enable": true,
            "container_id": "…",
            "high_availability": true,
            "auto_update": true
          }
        },
        "acl": {
          "roles": {
            "ANY_ADDITIONAL_PROPERTY": {
              "view": true,
              "modify": true,
              "manage": true
            }
          }
        },
        "private_network": {
          "vxlan_tag": 1,
          "subnet": "…",
          "ipv6": {
            "ip": "fd00::21:0:0:0",
            "cidr": "fd00::21:0:0:0/96"
          },
          "legacy": {
            "subnet": 1,
            "ipv4": {
              "ip": "fd00::21:0:0:0",
              "cidr": "fd00::21:0:0:0/96"
            }
          }
        },
        "deployments": {
          "tags": {
            "ANY_ADDITIONAL_PROPERTY": "v1.2.3-dev"
          }
        },
        "meta": {
          "containers_count": {
            "state": {
              "new": 0,
              "starting": 0,
              "running": 5,
              "stopping": 0,
              "deleting": 0,
              "deleted": 0
            },
            "total": 5,
            "available": 5
          },
          "instances_count": {
            "state": {
              "new": 0,
              "starting": 0,
              "running": 5,
              "stopping": 0,
              "deleting": 0,
              "deleted": 0
            },
            "total": 5,
            "available": 5
          },
          "containers": [
            {
              "id": "651586fca6078e98982dbd90",
              "name": "…",
              "state": {
                "current": "new",
                "desired": "new",
                "changed": "2021-01-30T08:30:00Z",
                "error": {
                  "message": "…",
                  "time": "2021-01-30T08:30:00Z"
                }
              },
              "image": {
                "id": "651586fca6078e98982dbd90",
                "service": "discovery"
              },
              "environment": {
                "id": "651586fca6078e98982dbd90",
                "cluster": "…",
                "container_subnet": null,
                "ipv6": {
                  "ip": "fd00::21:0:0:0",
                  "cidr": "fd00::21:0:0:0/96"
                },
                "legacy": {
                  "subnet": 1,
                  "ipv4": {
                    "ip": "fd00::21:0:0:0",
                    "cidr": "fd00::21:0:0:0/96"
                  }
                }
              }
            }
          ]
        }
      }
    },
    "environments:identifiers": {
      "ANY_ADDITIONAL_PROPERTY": "651586fca6078e98982dbd90"
    },
    "clusters": {
      "ANY_ADDITIONAL_PROPERTY": {
        "id": "…",
        "identifier": "…",
        "creator": {
          "id": "651586fca6078e98982dbd90",
          "type": "account"
        },
        "hub_id": "651586fca6078e98982dbd90",
        "acl": {
          "roles": {
            "ANY_ADDITIONAL_PROPERTY": {
              "view": true,
              "modify": true,
              "manage": true
            }
          }
        },
        "state": {
          "current": "live",
          "changed": "2021-01-30T08:30:00Z",
          "error": {
            "message": "…",
            "time": "2021-01-30T08:30:00Z"
          }
        },
        "events": {
          "created": "2021-01-30T08:30:00Z",
          "updated": "2021-01-30T08:30:00Z",
          "deleted": "2021-01-30T08:30:00Z"
        }
      }
    },
    "containers": {
      "ANY_ADDITIONAL_PROPERTY": {
        "id": "651586fca6078e98982dbd90",
        "identifier": "…",
        "name": "…",
        "creator": {
          "id": "651586fca6078e98982dbd90",
          "type": "account"
        },
        "environment": {
          "id": "651586fca6078e98982dbd90",
          "cluster": "…",
          "container_subnet": null,
          "ipv6": {
            "ip": "fd00::21:0:0:0",
            "cidr": "fd00::21:0:0:0/96"
          },
          "legacy": {
            "subnet": 1,
            "ipv4": {
              "ip": "fd00::21:0:0:0",
              "cidr": "fd00::21:0:0:0/96"
            }
          }
        },
        "hub_id": "651586fca6078e98982dbd90",
        "image": {
          "id": "651586fca6078e98982dbd90",
          "extension": {
            "identifier": "virtual-machine-v1",
            "id": "651586fca6078e98982dbd90"
          },
          "service": "discovery"
        },
        "stack": {
          "id": "651586fca6078e98982dbd90",
          "build_id": "…",
          "identifier": "…"
        },
        "config": {
          "network": {
            "public": "enable",
            "hostname": "…",
            "ports": [
              "…"
            ]
          },
          "deploy": {
            "instances": 1,
            "strategy": "resource-density",
            "function": {
              "max_pool_size": null,
              "max_shard_concurrency": null,
              "max_runtime": "72h45m2s",
              "max_queue_time": "72h45m2s"
            },
            "stateful": {
              "options": {
                "use_base_hostname": null
              }
            },
            "constraints": {
              "node": {
                "tags": {
                  "any": [
                    "…"
                  ],
                  "all": [
                    "…"
                  ]
                }
              },
              "secrets": [
                "…"
              ]
            },
            "shutdown": {
              "graceful_timeout": "72h45m2s",
              "signals": [
                "SIGTERM"
              ]
            },
            "startup": {
              "delay": "72h45m2s"
            },
            "update": {
              "stagger": "72h45m2s"
            },
            "restart": {
              "condition": "always",
              "delay": "72h45m2s",
              "max_attempts": 1
            },
            "health_check": {
              "command": "…",
              "retries": 1,
              "delay": "72h45m2s",
              "interval": "72h45m2s",
              "timeout": "72h45m2s",
              "restart": true
            },
            "telemetry": {
              "retention": "72h45m2s",
              "interval": "72h45m2s",
              "disable": true
            }
          },
          "scale": {
            "autoscale_group": null,
            "instances": {
              "max": 1,
              "max_server": 1,
              "min_ttl": "72h45m2s"
            },
            "window": "72h45m2s",
            "thresholds": [
              {
                "type": "ram",
                "details": {
                  "usage": "2G"
                }
              }
            ]
          },
          "runtime": {
            "command": {
              "path": null,
              "args": null
            },
            "namespaces": [
              "ipc"
            ],
            "environment_vars": {
              "ANY_ADDITIONAL_PROPERTY": "…"
            },
            "privileged": true,
            "capabilities": [
              "CAP_CHOWN"
            ],
            "workdir": "…",
            "sysctl": {
              "ANY_ADDITIONAL_PROPERTY": "…"
            },
            "rlimits": {
              "ANY_ADDITIONAL_PROPERTY": {
                "hard": 1,
                "soft": 1
              }
            },
            "seccomp": {
              "disable": true,
              "rules": [
                {
                  "capabilities": {
                    "includes": "…",
                    "excludes": "…"
                  },
                  "syscall": {
                    "names": [
                      "…"
                    ],
                    "action": "…",
                    "errnoRet": 1,
                    "args": [
                      {
                        "index": 1,
                        "value": 1,
                        "valueTwo": 1,
                        "op": "…"
                      }
                    ]
                  }
                }
              ]
            },
            "host": {
              "expose_proc": null
            },
            "rootfs": {
              "readonly": true
            },
            "devices": {
              "shm_size": "64M"
            }
          },
          "resources": {
            "cpu": {
              "shares": {
                "limit": 1,
                "reserve": 1
              },
              "cpus": "…"
            },
            "ram": {
              "limit": "1G",
              "reserve": "…"
            }
          },
          "integrations": {
            "webhooks": {
              "events": {
                "deploy": "…",
                "start": "…",
                "stop": "…"
              },
              "config": "…"
            },
            "files": [
              {
                "source": "…",
                "destination": "…"
              }
            ],
            "lets_encrypt": {
              "certificate_path": "…",
              "chain_path": "…",
              "key_path": "…",
              "bundle_path": "…",
              "additional_certs_path": "…"
            },
            "backups": {
              "integration_id": "my-image-source",
              "backup": {
                "command": "…",
                "timeout": "72h45m2s",
                "cron_string": "…"
              },
              "restore": {
                "command": "…",
                "timeout": "…"
              },
              "retention": "365d"
            },
            "shared_file_systems": null,
            "logs": {
              "drain": {
                "url": "…"
              }
            }
          }
        },
        "deployment": {
          "version": "v1.2.3-dev"
        },
        "instances": 1,
        "volumes": [
          {
            "id": "651586fca6078e98982dbd90",
            "hash": "…",
            "config": {
              "read_only": true,
              "block_device": true,
              "local": {
                "max_size": "10G",
                "storage_pool": true
              },
              "destination": "…",
              "remote_access": {
                "enable": true,
                "ips": [
                  "…"
                ],
                "webhook": "…",
                "password": {
                  "algorithm": "raw",
                  "data": "…"
                }
              }
            }
          }
        ],
        "annotations": null,
        "role": "orchestrator",
        "stateful": true,
        "deprecate": true,
        "lock": true,
        "state": {
          "current": "new",
          "desired": "new",
          "changed": "2021-01-30T08:30:00Z",
          "error": {
            "message": "…",
            "time": "2021-01-30T08:30:00Z"
          }
        },
        "events": {
          "created": "2021-01-30T08:30:00Z",
          "updated": "2021-01-30T08:30:00Z",
          "deleted": "2021-01-30T08:30:00Z",
          "started": "2021-01-30T08:30:00Z"
        },
        "meta": {
          "instances_count": {
            "state": {
              "new": 0,
              "starting": 0,
              "running": 5,
              "stopping": 0,
              "deleting": 0,
              "deleted": 0
            },
            "total": 5,
            "available": 5
          },
          "domains": [
            {
              "fqdn": "…",
              "record": {
                "id": "651586fca6078e98982dbd90",
                "hub_id": "651586fca6078e98982dbd90",
                "creator": {
                  "id": "651586fca6078e98982dbd90",
                  "type": "account"
                },
                "zone_id": "…",
                "name": "…",
                "resolved_domain": "…",
                "type": {
                  "a": {
                    "ip": "…"
                  },
                  "aaaa": {
                    "ip": "…"
                  },
                  "cname": {
                    "domain": "…"
                  },
                  "ns": {
                    "domain": "…"
                  },
                  "mx": {
                    "priority": 1,
                    "domain": "…"
                  },
                  "txt": {
                    "value": "…"
                  },
                  "alias": {
                    "domain": "…"
                  },
                  "srv": {
                    "weight": 1,
                    "priority": 1,
                    "port": 1,
                    "domain": "…"
                  },
                  "caa": {
                    "tag": "…",
                    "value": "…"
                  },
                  "linked": {
                    "features": {
                      "tls": {
                        "enable": true
                      },
                      "geodns": {
                        "enable": true
                      },
                      "wildcard": {
                        "resolve_sub_domains": false
                      }
                    },
                    "container_id": "…"
                  }
                },
                "features": {
                  "certificate": {
                    "id": "651586fca6078e98982dbd90",
                    "generated": "2021-01-30T08:30:00Z",
                    "wildcard_child": true,
                    "user_supplied": true,
                    "expires": "2021-01-30T08:30:00Z"
                  }
                },
                "state": {
                  "current": "pending",
                  "changed": "2021-01-30T08:30:00Z",
                  "error": {
                    "message": "…",
                    "time": "2021-01-30T08:30:00Z"
                  }
                },
                "events": {
                  "ANY_ADDITIONAL_PROPERTY": "2021-01-30T08:30:00Z"
                }
              }
            }
          ],
          "ips": [
            {
              "id": "651586fca6078e98982dbd90",
              "hub_id": "651586fca6078e98982dbd90",
              "kind": "ipv4",
              "assignment": {
                "container_id": "651586fca6078e98982dbd90",
                "instance_id": "651586fca6078e98982dbd90",
                "environment_id": "651586fca6078e98982dbd90",
                "virtual_machine": {
                  "id": "651586fca6078e98982dbd90"
                }
              },
              "pool_id": "…",
              "address": "…",
              "gateway": "…",
              "cidr": "…",
              "state": {
                "current": "assigning",
                "changed": "2021-01-30T08:30:00Z",
                "error": {
                  "message": "…",
                  "time": "2021-01-30T08:30:00Z"
                }
              }
            }
          ]
        }
      }
    }
  }
}

    Returns the newly created virtual machine.

    v1.0.0
    OAS 3.1.0

    Cycle Platform API

    The Cycle Platform API is a REST-based, resource-oriented API designed to be easy to use and understand. Using this API, you are able to fully interact with the Cycle Platform.

    All API responses return JSON, including errors. There is also support for cross-origin resource sharing, so this API can be used in a client-side web application as well.

    Auth Basics

    Every API request much have an accompanying API key in the Authorization header. For more information on generating an API key head over to the Portal Docs.

    Your API key should never be made publicly available, published to a public repository, or used on a client side web app. If you would like to use the API from a web app, you should create a thin-client service that acts as a passthrough for your API requests.

    The Root Document

    Every response follows the same structure, known as the root document. The main data structure, known as a resource, is nested under a data field. If you request a collection of resources, the data field will be an array of those resources. If you request a single resource, the data field will be equal to that resource.

    If there is an error, the error field will be present, and the data field will be present and null.

    The root resource. If fetching a collection, this will be an array of resource objects.

    Includes fields - the key will be the name of the included item passed. All values of include fields will be a full resource structure. (i.e. including environments will embed full environment objects by ID)

    Meta Fields - the key will be equal to the name of the meta field provided. Values of meta fields will vary based on the resource. These values are injected into the data object(s).

    Scope

    In order to fetch resources that are part of a hub (containers, environments, etc.), you will need to pass an X-Hub-ID header. When fetching collections of resources, this will limit the response to contain only resources from the specified hub. Most requests require this header.

    Queries

    When trying to gather more complete or specific data you can use query parameters to supplement the normal return (metas, includes) and you can also add specificity to the format and the order (sort, filter). It's worth understanding that sort & filter should only be used on collections.

    Sort - An array of sort values. To sort descending, put a -n front of the value, i.e. -id.

    Include - An array of include values. Included resources will show up under the root document's include field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.

    Meta - An array of meta values. Meta values will show up under a resource's meta field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.

    Filter - The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.

    Server: https://api.cycle.io

    Cycle Platform API

    BearerAuth: bearer
    :
    HubAuth: header
    :
    X-Hub-Id
    :
    QUxMIFlPVVIgQkFTRSBBUkUgQkVMT05HIFRPIFVT
    Client Libraries
    Curl Shell

    Accounts (Collapsed)

    ​

    Endpoints related to managing your account on Cycle.

    Accounts Operations

    Memberships (Collapsed)

    ​

    Endpoints related to account hub memberships, such as sending invitations to hubs or listing the hubs your account is a member of.

    Memberships Operations

    Credits (Collapsed)

    ​

    Endpoints related to credits applied to a hub.

    Credits Operations

    Invoices (Collapsed)

    ​

    Endpoints related to hub invoices, including the ability to pay an invoice.

    Invoices Operations

    Containers (Collapsed)

    ​

    Endpoints related to managing containers, such as starting/stopping/reconfiguring and telemetry.

    Containers Operations

    Instances (Collapsed)

    ​

    Endpoints related to managing a container's instances, including connecting to the console and credentials for SSH.

    Instances Operations

    Zones (Collapsed)

    ​

    Endpoints related to DNS zones.

    Zones Operations

    Records (Collapsed)

    ​

    Endpoints related to managing DNS zone records.

    Records Operations

    Environments (Collapsed)

    ​

    Endpoints related to managing an environment.

    Environments Operations

    Deployments (Collapsed)

    ​

    Endpoints related to environment deployments.

    Deployments Operations

    Hubs (Collapsed)

    ​

    Endpoints related to managing hubs on Cycle.

    Hubs Operations

    API Keys (Collapsed)

    ​

    Endpoints related to managing a hub's API keys.

    API Keys Operations

    Images (Collapsed)

    ​

    Endpoints related to managing container images.

    Images Operations

    Image Sources (Collapsed)

    ​

    Endpoints related to managing image sources.

    Image Sources Operations

    Infrastructure (Collapsed)

    ​

    Endpoints related to managing physical/virtual infrastructure on Cycle.

    Infrastructure Operations

    Auto-Scale Groups (Collapsed)

    ​

    Endpoints for managing groups of infrastructure that can be used for auto-scaling.

    Auto-Scale Groups Operations

    Jobs (Collapsed)

    ​

    Endpoints related to managing long-running tasks, known as jobs, on Cycle.

    Jobs Operations

    Monitoring (Collapsed)

    ​

    Endpoints related to gathered metrics for building dashboards, charts, and graphs.

    Monitoring Operations

    Pipelines (Collapsed)

    ​

    Endpoints related to pipelines, used for integrating with CI/CD solutions and automating deployments or other tasks.

    Pipelines Operations

    Trigger Keys (Collapsed)

    ​

    Endpoints for managing the trigger keys used to kick off a pipeline run.

    Trigger Keys Operations

    Networks (Collapsed)

    ​

    Endpoints for managing software-defined networks, for linking multiple environments together.

    Networks Operations

    Search (Collapsed)

    ​

    Endpoints related to search functionality on a hub.

    Search Operations

    Stacks (Collapsed)

    ​

    Endpoints for managing Cycle stacks.

    Stacks Operations

    Stack Builds (Collapsed)

    ​

    Endpoints for managing builds of a Cycle stack, including deploying a stack build to an environment.

    Stack Builds Operations

    Virtual Machines

    ​

    Endpoints for managing virtual machines.

    Virtual Machines Operations

    List Virtual Machines

    ​

    Requires the virtual-machines-view capability.

    Query Parameters
    • meta
      Type:array string[] enum

      A comma-separated list of meta values. Meta values will show up under a resource's meta field. In the case of applying a meta to a collection of resources, each resource will have its own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.

      • domains
      • ips
  • include
    Type:array string[] enum

    A comma-separated list of include values. Included resources will show up under the root document's include field. In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return.

    • creators
    • environments
    • clusters
    • containers
  • filter
    Type:object
  • sort
    Type:array string[]

    An array of sort values. To sort descending, put a - in front of the value, e.g. -id.

  • page
    Type:object
    • Responses
    Request Example forGET/v1/virtual-machines
    curl https://api.cycle.io/v1/virtual-machines \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'X-Hub-Id: YOUR_SECRET_TOKEN'

    {
  "data": [
    {
      "id": "651586fca6078e98982dbd90",
      "name": "…",
      "identifier": "…",
      "creator": {
        "id": "651586fca6078e98982dbd90",
        "type": "account"
      },
      "environment": {
        "id": "651586fca6078e98982dbd90",
        "cluster": "…"
      },
      "hub_id": "651586fca6078e98982dbd90",
      "config": {
        "network": {
          "public": "enable",
          "hostname": "…",
          "ports": [
            "…"
          ]
        },
        "deploy": {
          "constraints": {
            "node": {
              "tags": {
                "any": [
                  "…"
                ],
                "all": [
                  "…"
                ]
              }
            },
            "secrets": [
              "…"
            ],
            "containers": [
              "…"
            ]
          },
          "shutdown": {
            "graceful_timeout": "72h45m2s"
          },
          "startup": {
            "delay": "72h45m2s"
          },
          "telemetry": {
            "retention": "72h45m2s",
            "interval": "72h45m2s",
            "disable": true
          }
        },
        "resources": {
          "ram": {
            "limit": "1G",
            "allocate": null
          },
          "cpu": {
            "cores": {
              "number": 1,
              "allocate": null
            },
            "cpus": "1"
          }
        }
      },
      "image": {
        "type": "url",
        "details": {
          "url": "…"
        }
      },
      "container_id": "651586fca6078e98982dbd90",
      "volumes": [
        {
          "id": "651586fca6078e98982dbd90",
          "hash": "…",
          "config": {
            "local": {
              "max_size": "100G",
              "storage_pool": true
            },
            "identifier": "…",
            "read_only": true
          }
        }
      ],
      "annotations": null,
      "base_disk_size": "10G",
      "root_password": {
        "changed": "2021-01-30T08:30:00Z",
        "current": null
      },
      "ssh_keys": [
        "651586fca6078e98982dbd90"
      ],
      "state": {
        "current": "new",
        "changed": "2021-01-30T08:30:00Z",
        "error": {
          "message": "…",
          "time": "2021-01-30T08:30:00Z"
        }
      },
      "events": {
        "created": "2021-01-30T08:30:00Z",
        "updated": "2021-01-30T08:30:00Z",
        "deleted": "2021-01-30T08:30:00Z",
        "started": "2021-01-30T08:30:00Z"
      },
      "deprecate": true,
      "lock": true,
      "meta": {
        "domains": [
          {
            "fqdn": "…",
            "record": {
              "id": "651586fca6078e98982dbd90",
              "hub_id": "651586fca6078e98982dbd90",
              "creator": {
                "id": "651586fca6078e98982dbd90",
                "type": "account"
              },
              "zone_id": "…",
              "name": "…",
              "resolved_domain": "…",
              "type": {
                "a": {
                  "ip": "…"
                },
                "aaaa": {
                  "ip": "…"
                },
                "cname": {
                  "domain": "…"
                },
                "ns": {
                  "domain": "…"
                },
                "mx": {
                  "priority": 1,
                  "domain": "…"
                },
                "txt": {
                  "value": "…"
                },
                "alias": {
                  "domain": "…"
                },
                "srv": {
                  "weight": 1,
                  "priority": 1,
                  "port": 1,
                  "domain": "…"
                },
                "caa": {
                  "tag": "…",
                  "value": "…"
                },
                "linked": {
                  "features": {
                    "tls": {
                      "enable": true
                    },
                    "geodns": {
                      "enable": true
                    },
                    "wildcard": {
                      "resolve_sub_domains": false
                    }
                  },
                  "container_id": "…"
                }
              },
              "features": {
                "certificate": {
                  "id": "651586fca6078e98982dbd90",
                  "generated": "2021-01-30T08:30:00Z",
                  "wildcard_child": true,
                  "user_supplied": true,
                  "expires": "2021-01-30T08:30:00Z"
                }
              },
              "state": {
                "current": "pending",
                "changed": "2021-01-30T08:30:00Z",
                "error": {
                  "message": "…",
                  "time": "2021-01-30T08:30:00Z"
                }
              },
              "events": {
                "ANY_ADDITIONAL_PROPERTY": "2021-01-30T08:30:00Z"
              }
            }
          }
        ],
        "ips": [
          {
            "id": "651586fca6078e98982dbd90",
            "hub_id": "651586fca6078e98982dbd90",
            "kind": "ipv4",
            "assignment": {
              "container_id": "651586fca6078e98982dbd90",
              "instance_id": "651586fca6078e98982dbd90",
              "environment_id": "651586fca6078e98982dbd90",
              "virtual_machine": {
                "id": "651586fca6078e98982dbd90"
              }
            },
            "pool_id": "…",
            "address": "…",
            "gateway": "…",
            "cidr": "…",
            "state": {
              "current": "assigning",
              "changed": "2021-01-30T08:30:00Z",
              "error": {
                "message": "…",
                "time": "2021-01-30T08:30:00Z"
              }
            }
          }
        ],
        "server": {
          "id": "651586fca6078e98982dbd90",
          "hub_id": "651586fca6078e98982dbd90",
          "location_id": "…",
          "model_id": "…",
          "node_id": "…",
          "shared_file_systems": {
            "mounts": null,
            "directories": null
          },
          "hostname": "…",
          "creator": {
            "id": "651586fca6078e98982dbd90",
            "type": "account"
          },
          "provider": {
            "vendor": "…",
            "integration_id": "651586fca6078e98982dbd90",
            "model": "…",
            "zone": null,
            "location": "…",
            "server": "…",
            "init_ips": [
              "…"
            ],
            "mac_addr": "…",
            "extra": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "provision_options": {
              "encrypt_storage": true,
              "storage_size": 1,
              "reservation_id": "…"
            }
          },
          "cluster": "…",
          "features": {
            "sftp": true,
            "base_volume_gb": null,
            "gateway": {
              "type": "bgp"
            }
          },
          "constraints": {
            "tags": [
              "…"
            ],
            "allow": {
              "pool": true,
              "services": true,
              "overcommit": true
            }
          },
          "autoscale": {
            "group_id": "651586fca6078e98982dbd90"
          },
          "ephemeral": true,
          "evacuate": {
            "started": "2021-01-30T08:30:00Z"
          },
          "state": {
            "current": "new",
            "changed": "2021-01-30T08:30:00Z",
            "error": {
              "message": "…",
              "time": "2021-01-30T08:30:00Z"
            }
          },
          "events": {
            "created": "2021-01-30T08:30:00Z",
            "updated": "2021-01-30T08:30:00Z",
            "deleted": "2021-01-30T08:30:00Z",
            "latest_instance": "2021-01-30T08:30:00Z",
            "provisioning": {
              "started": "2021-01-30T08:30:00Z",
              "failed": "2021-01-30T08:30:00Z",
              "completed": "2021-01-30T08:30:00Z"
            }
          },
          "meta": {
            "node": {
              "last_checkin": "2021-01-30T08:30:00Z",
              "drivers": [
                "…"
              ],
              "state": {
                "current": "new",
                "changed": "2021-01-30T08:30:00Z",
                "error": {
                  "message": "…",
                  "time": "2021-01-30T08:30:00Z"
                }
              },
              "stats": {
                "network": {
                  "interfaces": {
                    "ANY_ADDITIONAL_PROPERTY": {
                      "interface": "…",
                      "flags": "…",
                      "mtu": 1,
                      "mac_addr": "…",
                      "addrs": [
                        "…"
                      ]
                    }
                  },
                  "external_ipv4": "…",
                  "external_ipv6": "…"
                },
                "uptime": {
                  "seconds": 1,
                  "cpu_idle": 1
                },
                "cpu": {
                  "cores": 1,
                  "processors": [
                    {
                      "model": "…",
                      "speed": 1
                    }
                  ],
                  "usage": {
                    "user": 1,
                    "nice": 1,
                    "system": 1,
                    "idle": 1,
                    "iowait": 1,
                    "irq": 1,
                    "soft_irq": 1,
                    "steal": 1,
                    "guest": 1,
                    "guest_nice": 1
                  }
                },
                "load": {
                  "avg1m": 1,
                  "avg5m": 1,
                  "avg15m": 1
                },
                "ram": {
                  "available": 1,
                  "free": 1,
                  "total": 1
                },
                "storage": {
                  "volume_groups": {
                    "ANY_ADDITIONAL_PROPERTY": {
                      "name": "…",
                      "size": 1,
                      "volumes": {
                        "ANY_ADDITIONAL_PROPERTY": {
                          "name": "…",
                          "size": 1,
                          "data_percent": 1,
                          "meta_percent": 1,
                          "pool": "…"
                        }
                      }
                    }
                  },
                  "mounts": {
                    "ANY_ADDITIONAL_PROPERTY": {
                      "device": "…",
                      "type": "…",
                      "mountpoint": "…",
                      "total": 1,
                      "free": 1,
                      "used": 1
                    }
                  }
                },
                "os": {
                  "release": "…",
                  "kernel": "…",
                  "hostname": "…"
                },
                "versions": {
                  "services": {
                    "ANY_ADDITIONAL_PROPERTY": "…"
                  }
                }
              },
              "healthy": true,
              "online": true
            },
            "instances_count": {
              "state": {
                "new": 0,
                "starting": 0,
                "running": 5,
                "stopping": 0,
                "deleting": 0,
                "deleted": 0
              },
              "total": 5,
              "available": 5
            },
            "allocations": {
              "cpu_shares": {
                "total": 1,
                "allocatable": 1,
                "allocated": 1
              },
              "ram": {
                "total_mb": 1,
                "allocatable_mb": 1,
                "allocated_mb": 1
              }
            }
          }
        }
      }
    }
  ],
  "includes": {
    "creators": {
      "accounts": {
        "ANY_ADDITIONAL_PROPERTY": {
          "name": {
            "first": "…",
            "last": "…"
          },
          "email": {
            "address": "…"
          },
          "id": "…",
          "events": {
            "ANY_ADDITIONAL_PROPERTY": "2021-01-30T08:30:00Z",
            "last_login": "2021-01-30T08:30:00Z"
          }
        }
      },
      "employees": {
        "ANY_ADDITIONAL_PROPERTY": {
          "name": {
            "first": "…",
            "last": "…"
          },
          "email": {
            "address": "…"
          },
          "id": "…",
          "events": {
            "ANY_ADDITIONAL_PROPERTY": "2021-01-30T08:30:00Z",
            "last_login": "2021-01-30T08:30:00Z"
          }
        }
      },
      "visitors": {
        "ANY_ADDITIONAL_PROPERTY": {
          "name": {
            "first": "…",
            "last": "…"
          },
          "email": {
            "address": "…"
          },
          "id": "…",
          "events": {
            "ANY_ADDITIONAL_PROPERTY": "2021-01-30T08:30:00Z",
            "last_login": "2021-01-30T08:30:00Z"
          }
        }
      },
      "environments": {
        "ANY_ADDITIONAL_PROPERTY": {
          "id": "651586fca6078e98982dbd90",
          "identifier": "…",
          "name": "…",
          "cluster": "…",
          "about": {
            "description": "…",
            "favorite": true
          },
          "creator": {
            "id": "651586fca6078e98982dbd90",
            "type": "account"
          },
          "hub_id": "651586fca6078e98982dbd90",
          "state": {
            "current": "new",
            "changed": "2021-01-30T08:30:00Z",
            "error": {
              "message": "…",
              "time": "2021-01-30T08:30:00Z"
            }
          },
          "events": {
            "created": "2021-01-30T08:30:00Z",
            "updated": "2021-01-30T08:30:00Z",
            "deleted": "2021-01-30T08:30:00Z"
          },
          "features": {
            "legacy_networking": true,
            "monitoring": {
              "tier": "limited"
            }
          },
          "services": {
            "loadbalancer": {
              "enable": true,
              "container_id": null,
              "high_availability": true,
              "auto_update": true,
              "config": {
                "ipv4": true,
                "ipv6": true,
                "type": "v1",
                "details": {
                  "controllers": [
                    {
                      "identifier": "…",
                      "port": 1,
                      "waf": {
                        "rules": [
                          {
                            "description": "…",
                            "skip": true,
                            "type": "allow",
                            "match": "any",
                            "conditions": [
                              {
                                "type": "ip-match",
                                "operator": "==",
                                "value": "0.0.0.0/0"
                              }
                            ]
                          }
                        ]
                      },
                      "transport": null
                    }
                  ],
                  "controller_template": {
                    "identifier": "…",
                    "port": 1,
                    "waf": {
                      "rules": [
                        {
                          "description": "…",
                          "skip": true,
                          "type": "allow",
                          "match": "any",
                          "conditions": [
                            {
                              "type": "ip-match",
                              "operator": "==",
                              "value": "0.0.0.0/0"
                            }
                          ]
                        }
                      ]
                    },
                    "transport": null
                  },
                  "waf": {
                    "rules": [
                      {
                        "description": "…",
                        "skip": true,
                        "type": "allow",
                        "match": "any",
                        "conditions": [
                          {
                            "type": "ip-match",
                            "operator": "==",
                            "value": "0.0.0.0/0"
                          }
                        ]
                      }
                    ]
                  }
                },
                "bind_host": null
              }
            },
            "discovery": {
              "enable": true,
              "container_id": "…",
              "high_availability": true,
              "auto_update": true,
              "config": {
                "empty_set_delay": "72h45m2s",
                "hosts": null,
                "custom_resolvers": [
                  "…"
                ]
              }
            },
            "vpn": {
              "enable": true,
              "container_id": "…",
              "auto_update": true,
              "config": {
                "allow_internet": true,
                "auth": {
                  "webhook": null,
                  "cycle_accounts": true,
                  "vpn_accounts": true
                }
              }
            },
            "scheduler": {
              "enable": true,
              "container_id": null,
              "high_availability": true,
              "auto_update": true,
              "config": {
                "public": true,
                "access_keys": [
                  {
                    "name": "…",
                    "secret": "…",
                    "ips": [
                      "…"
                    ]
                  }
                ]
              }
            },
            "gateway": {
              "enable": true,
              "container_id": "…",
              "high_availability": true,
              "auto_update": true
            }
          },
          "acl": {
            "roles": {
              "ANY_ADDITIONAL_PROPERTY": {
                "view": true,
                "modify": true,
                "manage": true
              }
            }
          },
          "private_network": {
            "vxlan_tag": 1,
            "subnet": "…",
            "ipv6": {
              "ip": "fd00::21:0:0:0",
              "cidr": "fd00::21:0:0:0/96"
            },
            "legacy": {
              "subnet": 1,
              "ipv4": {
                "ip": "fd00::21:0:0:0",
                "cidr": "fd00::21:0:0:0/96"
              }
            }
          },
          "deployments": {
            "tags": {
              "ANY_ADDITIONAL_PROPERTY": "v1.2.3-dev"
            }
          },
          "meta": {
            "containers_count": {
              "state": {
                "new": 0,
                "starting": 0,
                "running": 5,
                "stopping": 0,
                "deleting": 0,
                "deleted": 0
              },
              "total": 5,
              "available": 5
            },
            "instances_count": {
              "state": {
                "new": 0,
                "starting": 0,
                "running": 5,
                "stopping": 0,
                "deleting": 0,
                "deleted": 0
              },
              "total": 5,
              "available": 5
            },
            "containers": [
              {
                "id": "651586fca6078e98982dbd90",
                "name": "…",
                "state": {
                  "current": "new",
                  "desired": "new",
                  "changed": "2021-01-30T08:30:00Z",
                  "error": {
                    "message": "…",
                    "time": "2021-01-30T08:30:00Z"
                  }
                },
                "image": {
                  "id": "651586fca6078e98982dbd90",
                  "service": "discovery"
                },
                "environment": {
                  "id": "651586fca6078e98982dbd90",
                  "cluster": "…",
                  "container_subnet": null,
                  "ipv6": {
                    "ip": "fd00::21:0:0:0",
                    "cidr": "fd00::21:0:0:0/96"
                  },
                  "legacy": {
                    "subnet": 1,
                    "ipv4": {
                      "ip": "fd00::21:0:0:0",
                      "cidr": "fd00::21:0:0:0/96"
                    }
                  }
                }
              }
            ]
          }
        }
      },
      "api_keys": {
        "ANY_ADDITIONAL_PROPERTY": {
          "id": "651586fca6078e98982dbd90",
          "name": "…",
          "hub_id": "651586fca6078e98982dbd90",
          "secret": "…",
          "permissions": {
            "all_environments": true,
            "environments": [
              {
                "id": "651586fca6078e98982dbd90",
                "manage": true
              }
            ]
          },
          "capabilities": {
            "all": true,
            "specific": [
              "…"
            ]
          },
          "ips": [
            "…"
          ],
          "state": {
            "current": "live",
            "changed": "2021-01-30T08:30:00Z",
            "error": {
              "message": "…",
              "time": "2021-01-30T08:30:00Z"
            }
          },
          "events": {
            "ANY_ADDITIONAL_PROPERTY": "2021-01-30T08:30:00Z"
          }
        }
      }
    },
    "environments": {
      "ANY_ADDITIONAL_PROPERTY": {
        "id": "651586fca6078e98982dbd90",
        "identifier": "…",
        "name": "…",
        "cluster": "…",
        "about": {
          "description": "…",
          "favorite": true
        },
        "creator": {
          "id": "651586fca6078e98982dbd90",
          "type": "account"
        },
        "hub_id": "651586fca6078e98982dbd90",
        "state": {
          "current": "new",
          "changed": "2021-01-30T08:30:00Z",
          "error": {
            "message": "…",
            "time": "2021-01-30T08:30:00Z"
          }
        },
        "events": {
          "created": "2021-01-30T08:30:00Z",
          "updated": "2021-01-30T08:30:00Z",
          "deleted": "2021-01-30T08:30:00Z"
        },
        "features": {
          "legacy_networking": true,
          "monitoring": {
            "tier": "limited"
          }
        },
        "services": {
          "loadbalancer": {
            "enable": true,
            "container_id": null,
            "high_availability": true,
            "auto_update": true,
            "config": {
              "ipv4": true,
              "ipv6": true,
              "type": "v1",
              "details": {
                "controllers": [
                  {
                    "identifier": "…",
                    "port": 1,
                    "waf": {
                      "rules": [
                        {
                          "description": "…",
                          "skip": true,
                          "type": "allow",
                          "match": "any",
                          "conditions": [
                            {
                              "type": "ip-match",
                              "operator": "==",
                              "value": "0.0.0.0/0"
                            }
                          ]
                        }
                      ]
                    },
                    "transport": null
                  }
                ],
                "controller_template": {
                  "identifier": "…",
                  "port": 1,
                  "waf": {
                    "rules": [
                      {
                        "description": "…",
                        "skip": true,
                        "type": "allow",
                        "match": "any",
                        "conditions": [
                          {
                            "type": "ip-match",
                            "operator": "==",
                            "value": "0.0.0.0/0"
                          }
                        ]
                      }
                    ]
                  },
                  "transport": null
                },
                "waf": {
                  "rules": [
                    {
                      "description": "…",
                      "skip": true,
                      "type": "allow",
                      "match": "any",
                      "conditions": [
                        {
                          "type": "ip-match",
                          "operator": "==",
                          "value": "0.0.0.0/0"
                        }
                      ]
                    }
                  ]
                }
              },
              "bind_host": null
            }
          },
          "discovery": {
            "enable": true,
            "container_id": "…",
            "high_availability": true,
            "auto_update": true,
            "config": {
              "empty_set_delay": "72h45m2s",
              "hosts": null,
              "custom_resolvers": [
                "…"
              ]
            }
          },
          "vpn": {
            "enable": true,
            "container_id": "…",
            "auto_update": true,
            "config": {
              "allow_internet": true,
              "auth": {
                "webhook": null,
                "cycle_accounts": true,
                "vpn_accounts": true
              }
            }
          },
          "scheduler": {
            "enable": true,
            "container_id": null,
            "high_availability": true,
            "auto_update": true,
            "config": {
              "public": true,
              "access_keys": [
                {
                  "name": "…",
                  "secret": "…",
                  "ips": [
                    "…"
                  ]
                }
              ]
            }
          },
          "gateway": {
            "enable": true,
            "container_id": "…",
            "high_availability": true,
            "auto_update": true
          }
        },
        "acl": {
          "roles": {
            "ANY_ADDITIONAL_PROPERTY": {
              "view": true,
              "modify": true,
              "manage": true
            }
          }
        },
        "private_network": {
          "vxlan_tag": 1,
          "subnet": "…",
          "ipv6": {
            "ip": "fd00::21:0:0:0",
            "cidr": "fd00::21:0:0:0/96"
          },
          "legacy": {
            "subnet": 1,
            "ipv4": {
              "ip": "fd00::21:0:0:0",
              "cidr": "fd00::21:0:0:0/96"
            }
          }
        },
        "deployments": {
          "tags": {
            "ANY_ADDITIONAL_PROPERTY": "v1.2.3-dev"
          }
        },
        "meta": {
          "containers_count": {
            "state": {
              "new": 0,
              "starting": 0,
              "running": 5,
              "stopping": 0,
              "deleting": 0,
              "deleted": 0
            },
            "total": 5,
            "available": 5
          },
          "instances_count": {
            "state": {
              "new": 0,
              "starting": 0,
              "running": 5,
              "stopping": 0,
              "deleting": 0,
              "deleted": 0
            },
            "total": 5,
            "available": 5
          },
          "containers": [
            {
              "id": "651586fca6078e98982dbd90",
              "name": "…",
              "state": {
                "current": "new",
                "desired": "new",
                "changed": "2021-01-30T08:30:00Z",
                "error": {
                  "message": "…",
                  "time": "2021-01-30T08:30:00Z"
                }
              },
              "image": {
                "id": "651586fca6078e98982dbd90",
                "service": "discovery"
              },
              "environment": {
                "id": "651586fca6078e98982dbd90",
                "cluster": "…",
                "container_subnet": null,
                "ipv6": {
                  "ip": "fd00::21:0:0:0",
                  "cidr": "fd00::21:0:0:0/96"
                },
                "legacy": {
                  "subnet": 1,
                  "ipv4": {
                    "ip": "fd00::21:0:0:0",
                    "cidr": "fd00::21:0:0:0/96"
                  }
                }
              }
            }
          ]
        }
      }
    },
    "environments:identifiers": {
      "ANY_ADDITIONAL_PROPERTY": "651586fca6078e98982dbd90"
    },
    "clusters": {
      "ANY_ADDITIONAL_PROPERTY": {
        "id": "…",
        "identifier": "…",
        "creator": {
          "id": "651586fca6078e98982dbd90",
          "type": "account"
        },
        "hub_id": "651586fca6078e98982dbd90",
        "acl": {
          "roles": {
            "ANY_ADDITIONAL_PROPERTY": {
              "view": true,
              "modify": true,
              "manage": true
            }
          }
        },
        "state": {
          "current": "live",
          "changed": "2021-01-30T08:30:00Z",
          "error": {
            "message": "…",
            "time": "2021-01-30T08:30:00Z"
          }
        },
        "events": {
          "created": "2021-01-30T08:30:00Z",
          "updated": "2021-01-30T08:30:00Z",
          "deleted": "2021-01-30T08:30:00Z"
        }
      }
    },
    "containers": {
      "ANY_ADDITIONAL_PROPERTY": {
        "id": "651586fca6078e98982dbd90",
        "identifier": "…",
        "name": "…",
        "creator": {
          "id": "651586fca6078e98982dbd90",
          "type": "account"
        },
        "environment": {
          "id": "651586fca6078e98982dbd90",
          "cluster": "…",
          "container_subnet": null,
          "ipv6": {
            "ip": "fd00::21:0:0:0",
            "cidr": "fd00::21:0:0:0/96"
          },
          "legacy": {
            "subnet": 1,
            "ipv4": {
              "ip": "fd00::21:0:0:0",
              "cidr": "fd00::21:0:0:0/96"
            }
          }
        },
        "hub_id": "651586fca6078e98982dbd90",
        "image": {
          "id": "651586fca6078e98982dbd90",
          "extension": {
            "identifier": "virtual-machine-v1",
            "id": "651586fca6078e98982dbd90"
          },
          "service": "discovery"
        },
        "stack": {
          "id": "651586fca6078e98982dbd90",
          "build_id": "…",
          "identifier": "…"
        },
        "config": {
          "network": {
            "public": "enable",
            "hostname": "…",
            "ports": [
              "…"
            ]
          },
          "deploy": {
            "instances": 1,
            "strategy": "resource-density",
            "function": {
              "max_pool_size": null,
              "max_shard_concurrency": null,
              "max_runtime": "72h45m2s",
              "max_queue_time": "72h45m2s"
            },
            "stateful": {
              "options": {
                "use_base_hostname": null
              }
            },
            "constraints": {
              "node": {
                "tags": {
                  "any": [
                    "…"
                  ],
                  "all": [
                    "…"
                  ]
                }
              },
              "secrets": [
                "…"
              ]
            },
            "shutdown": {
              "graceful_timeout": "72h45m2s",
              "signals": [
                "SIGTERM"
              ]
            },
            "startup": {
              "delay": "72h45m2s"
            },
            "update": {
              "stagger": "72h45m2s"
            },
            "restart": {
              "condition": "always",
              "delay": "72h45m2s",
              "max_attempts": 1
            },
            "health_check": {
              "command": "…",
              "retries": 1,
              "delay": "72h45m2s",
              "interval": "72h45m2s",
              "timeout": "72h45m2s",
              "restart": true
            },
            "telemetry": {
              "retention": "72h45m2s",
              "interval": "72h45m2s",
              "disable": true
            }
          },
          "scale": {
            "autoscale_group": null,
            "instances": {
              "max": 1,
              "max_server": 1,
              "min_ttl": "72h45m2s"
            },
            "window": "72h45m2s",
            "thresholds": [
              {
                "type": "ram",
                "details": {
                  "usage": "2G"
                }
              }
            ]
          },
          "runtime": {
            "command": {
              "path": null,
              "args": null
            },
            "namespaces": [
              "ipc"
            ],
            "environment_vars": {
              "ANY_ADDITIONAL_PROPERTY": "…"
            },
            "privileged": true,
            "capabilities": [
              "CAP_CHOWN"
            ],
            "workdir": "…",
            "sysctl": {
              "ANY_ADDITIONAL_PROPERTY": "…"
            },
            "rlimits": {
              "ANY_ADDITIONAL_PROPERTY": {
                "hard": 1,
                "soft": 1
              }
            },
            "seccomp": {
              "disable": true,
              "rules": [
                {
                  "capabilities": {
                    "includes": "…",
                    "excludes": "…"
                  },
                  "syscall": {
                    "names": [
                      "…"
                    ],
                    "action": "…",
                    "errnoRet": 1,
                    "args": [
                      {
                        "index": 1,
                        "value": 1,
                        "valueTwo": 1,
                        "op": "…"
                      }
                    ]
                  }
                }
              ]
            },
            "host": {
              "expose_proc": null
            },
            "rootfs": {
              "readonly": true
            },
            "devices": {
              "shm_size": "64M"
            }
          },
          "resources": {
            "cpu": {
              "shares": {
                "limit": 1,
                "reserve": 1
              },
              "cpus": "…"
            },
            "ram": {
              "limit": "1G",
              "reserve": "…"
            }
          },
          "integrations": {
            "webhooks": {
              "events": {
                "deploy": "…",
                "start": "…",
                "stop": "…"
              },
              "config": "…"
            },
            "files": [
              {
                "source": "…",
                "destination": "…"
              }
            ],
            "lets_encrypt": {
              "certificate_path": "…",
              "chain_path": "…",
              "key_path": "…",
              "bundle_path": "…",
              "additional_certs_path": "…"
            },
            "backups": {
              "integration_id": "my-image-source",
              "backup": {
                "command": "…",
                "timeout": "72h45m2s",
                "cron_string": "…"
              },
              "restore": {
                "command": "…",
                "timeout": "…"
              },
              "retention": "365d"
            },
            "shared_file_systems": null,
            "logs": {
              "drain": {
                "url": "…"
              }
            }
          }
        },
        "deployment": {
          "version": "v1.2.3-dev"
        },
        "instances": 1,
        "volumes": [
          {
            "id": "651586fca6078e98982dbd90",
            "hash": "…",
            "config": {
              "read_only": true,
              "block_device": true,
              "local": {
                "max_size": "10G",
                "storage_pool": true
              },
              "destination": "…",
              "remote_access": {
                "enable": true,
                "ips": [
                  "…"
                ],
                "webhook": "…",
                "password": {
                  "algorithm": "raw",
                  "data": "…"
                }
              }
            }
          }
        ],
        "annotations": null,
        "role": "orchestrator",
        "stateful": true,
        "deprecate": true,
        "lock": true,
        "state": {
          "current": "new",
          "desired": "new",
          "changed": "2021-01-30T08:30:00Z",
          "error": {
            "message": "…",
            "time": "2021-01-30T08:30:00Z"
          }
        },
        "events": {
          "created": "2021-01-30T08:30:00Z",
          "updated": "2021-01-30T08:30:00Z",
          "deleted": "2021-01-30T08:30:00Z",
          "started": "2021-01-30T08:30:00Z"
        },
        "meta": {
          "instances_count": {
            "state": {
              "new": 0,
              "starting": 0,
              "running": 5,
              "stopping": 0,
              "deleting": 0,
              "deleted": 0
            },
            "total": 5,
            "available": 5
          },
          "domains": [
            {
              "fqdn": "…",
              "record": {
                "id": "651586fca6078e98982dbd90",
                "hub_id": "651586fca6078e98982dbd90",
                "creator": {
                  "id": "651586fca6078e98982dbd90",
                  "type": "account"
                },
                "zone_id": "…",
                "name": "…",
                "resolved_domain": "…",
                "type": {
                  "a": {
                    "ip": "…"
                  },
                  "aaaa": {
                    "ip": "…"
                  },
                  "cname": {
                    "domain": "…"
                  },
                  "ns": {
                    "domain": "…"
                  },
                  "mx": {
                    "priority": 1,
                    "domain": "…"
                  },
                  "txt": {
                    "value": "…"
                  },
                  "alias": {
                    "domain": "…"
                  },
                  "srv": {
                    "weight": 1,
                    "priority": 1,
                    "port": 1,
                    "domain": "…"
                  },
                  "caa": {
                    "tag": "…",
                    "value": "…"
                  },
                  "linked": {
                    "features": {
                      "tls": {
                        "enable": true
                      },
                      "geodns": {
                        "enable": true
                      },
                      "wildcard": {
                        "resolve_sub_domains": false
                      }
                    },
                    "container_id": "…"
                  }
                },
                "features": {
                  "certificate": {
                    "id": "651586fca6078e98982dbd90",
                    "generated": "2021-01-30T08:30:00Z",
                    "wildcard_child": true,
                    "user_supplied": true,
                    "expires": "2021-01-30T08:30:00Z"
                  }
                },
                "state": {
                  "current": "pending",
                  "changed": "2021-01-30T08:30:00Z",
                  "error": {
                    "message": "…",
                    "time": "2021-01-30T08:30:00Z"
                  }
                },
                "events": {
                  "ANY_ADDITIONAL_PROPERTY": "2021-01-30T08:30:00Z"
                }
              }
            }
          ],
          "ips": [
            {
              "id": "651586fca6078e98982dbd90",
              "hub_id": "651586fca6078e98982dbd90",
              "kind": "ipv4",
              "assignment": {
                "container_id": "651586fca6078e98982dbd90",
                "instance_id": "651586fca6078e98982dbd90",
                "environment_id": "651586fca6078e98982dbd90",
                "virtual_machine": {
                  "id": "651586fca6078e98982dbd90"
                }
              },
              "pool_id": "…",
              "address": "…",
              "gateway": "…",
              "cidr": "…",
              "state": {
                "current": "assigning",
                "changed": "2021-01-30T08:30:00Z",
                "error": {
                  "message": "…",
                  "time": "2021-01-30T08:30:00Z"
                }
              }
            }
          ]
        }
      }
    }
  }
}

    Returns a list of virtual machines.

    Utility (Collapsed)

    ​

    Extra utility endpoints that aren't related to a specific resource.

    Utility Operations

    Models