Create a Private Network

POST /private-network

application/json

Body Required

name string Required

Private Network name

Minimum length is 1, maximum length is 255.
description string

Private Network description

Maximum length is 255.
netmask string(ipv4)

Private Network netmask
start-ip string(ipv4)

Private Network start IP address
end-ip string(ipv4)

Private Network end IP address
labels object

Resource labels
Hide labels attribute Show labels attribute object
- * string Additional properties
options object

DHCP options

Additional properties are allowed.
Hide options attributes Show options attributes object
- routers array[string(ipv4)]
  
  Routers
- dns-servers array[string(ipv4)]
  
  DNS Servers
- ntp-servers array[string(ipv4)]
  
  NTP Servers
- domain-search array[string]
  
  Domain search list, limited to 255 octets

Responses

200 application/json

200
Hide response attributes Show response attributes object
- id string(uuid)
  
  Operation ID
- reason string
  
  Operation failure reason
  
  Values are incorrect, unknown, unavailable, forbidden, busy, fault, partial, not-found, interrupted, unsupported, or conflict.
- reference object
  
  Related resource reference
  
  Additional properties are allowed.
  
  Hide reference attributes Show reference attributes object
  
  id string(uuid)
  
  Reference ID
  
  link string
  
  Link to the referenced resource
  
  command string
  
  Command name
- message string
  
  Operation message
- state string
  
  Operation status
  
  Values are failure, pending, success, or timeout.

POST /private-network

curl \
 -X POST https://api-ch-gva-2.exoscale.com/v2/private-network \
 -H "Content-Type: application/json" \
 -d '{"name":"string","description":"string","netmask":"string","start-ip":"string","end-ip":"string","labels":{"additionalProperty1":"string","additionalProperty2":"string"},"options":{"routers":["string"],"dns-servers":["string"],"ntp-servers":["string"],"domain-search":["string"]}}'

Request examples

{
  "name": "string",
  "description": "string",
  "netmask": "string",
  "start-ip": "string",
  "end-ip": "string",
  "labels": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  },
  "options": {
    "routers": [
      "string"
    ],
    "dns-servers": [
      "string"
    ],
    "ntp-servers": [
      "string"
    ],
    "domain-search": [
      "string"
    ]
  }
}

Response examples (200)

{
  "id": "string",
  "reason": "incorrect",
  "reference": {
    "id": "string",
    "link": "string",
    "command": "string"
  },
  "message": "string",
  "state": "failure"
}