Skip to main content
GET
/
api
/
public
/
v1
/
networks
/
{id}
/
attachments
List VMs attached to a network
curl --request GET \
  --url https://api.vmarea.com/api/v1/api/public/v1/networks/{id}/attachments \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "vmId": "<string>",
      "networkId": "<string>",
      "privateIp": "<string>",
      "netInterface": "<string>",
      "attachedAt": "2023-11-07T05:31:56Z",
      "vm": {
        "id": "<string>",
        "name": "<string>",
        "hostname": "<string>",
        "status": "<string>"
      }
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Long-lived API token created at https://vmarea.com/dashboard/settings/api-keys. Tokens are scope-restricted; this spec lists the scope each endpoint requires.

Path Parameters

​
id
string
required

Response

Default Response

​
success
enum<boolean>
required
Available options:
true
​
data
object[]
required