Retrieve Private Network details

GET /private-network/{id}

Path parameters

  • id string(uuid) Required

Responses

  • 200 application/json

    200

    Hide response attributes Show response attributes object
    • description string

      Private Network description

      Maximum length is 255.

    • labels object

      Resource labels

      Hide labels attribute Show labels attribute object
      • * string Additional properties
    • name string

      Private Network name

      Minimum length is 1, maximum length is 255.

    • start-ip string(ipv4)

      Private Network start IP address

    • leases array[object]

      Private Network leased IP addresses

      Hide leases attributes Show leases attributes object
      • ip string(ipv4)

        Private Network IP address

      • instance-id string(uuid)

        Attached instance ID

    • id string(uuid)

      Private Network ID

    • vni integer(int64)

      Private Network VXLAN ID

      Minimum value is 0.

    • netmask string(ipv4)

      Private Network netmask

    • options object

      DHCP options

      Additional properties are allowed.

      Hide options attributes Show options attributes object
    • end-ip string(ipv4)

      Private Network end IP address
GET /private-network/{id} 
curl \
 -X GET https://api-ch-gva-2.exoscale.com/v2/private-network/{id}
Response examples (200) 
{
  "description": "string",
  "labels": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  },
  "name": "string",
  "start-ip": "string",
  "leases": [
    {
      "ip": "string",
      "instance-id": "string"
    }
  ],
  "id": "string",
  "vni": 42,
  "netmask": "string",
  "options": {
    "routers": [
      "string"
    ],
    "dns-servers": [
      "string"
    ],
    "ntp-servers": [
      "string"
    ],
    "domain-search": [
      "string"
    ]
  },
  "end-ip": "string"
}