Reference
Exoscale API
Compute
Private Network

Private Network

Private Network provides private L2 networking functionality between Compute instances.

Read more

create-private-network

Create a Private Network

POST /private-network

Request body

  • application/json
    • name (required) (string): Private Network name
    • description (string): Private Network description
    • netmask (string): Private Network netmask
    • start-ip (string): Private Network start IP address
    • end-ip (string): Private Network end IP address
    • labels (object)
    • options (object): Private Network DHCP Options - schema details

Responses

  • 200: 200
    • application/json
      • id (string): Operation ID
      • reason (string): Operation failure reason
      • reference (object): Related resource reference - schema details
      • message (string): Operation message
      • state (string): Operation status

SDK reference for create-private-network: golang | Python | Java

CLI: exo api create-private-network

get-private-network

Retrieve Private Network details

GET /private-network/{id}

Path parameters

  • id in path (required)

Responses

  • 200: 200
    • application/json
      • description (string): Private Network description
      • labels (object)
      • name (string): Private Network name
      • start-ip (string): Private Network start IP address
      • leases (array[object]): Private Network leased IP addresses - schema details
      • id (string): Private Network ID
      • vni (integer): Private Network VXLAN ID
      • netmask (string): Private Network netmask
      • options (object): Private Network DHCP Options - schema details
      • end-ip (string): Private Network end IP address

SDK reference for get-private-network: golang | Python | Java

CLI: exo api get-private-network

update-private-network

Update a Private Network

PUT /private-network/{id}

Path parameters

  • id in path (required)

Request body

  • application/json
    • name (string): Private Network name
    • description (string): Private Network description
    • netmask (string): Private Network netmask
    • start-ip (string): Private Network start IP address
    • end-ip (string): Private Network end IP address
    • labels (object)
    • options (object): Private Network DHCP Options - schema details

Responses

  • 200: 200
    • application/json
      • id (string): Operation ID
      • reason (string): Operation failure reason
      • reference (object): Related resource reference - schema details
      • message (string): Operation message
      • state (string): Operation status

SDK reference for update-private-network: golang | Python | Java

CLI: exo api update-private-network

delete-private-network

Delete a Private Network

DELETE /private-network/{id}

Path parameters

  • id in path (required)

Responses

  • 200: 200
    • application/json
      • id (string): Operation ID
      • reason (string): Operation failure reason
      • reference (object): Related resource reference - schema details
      • message (string): Operation message
      • state (string): Operation status

SDK reference for delete-private-network: golang | Python | Java

CLI: exo api delete-private-network

Other Operations

detach-instance-from-private-network

Detach a Compute instance from a Private Network

PUT /private-network/{id}:detach

Path parameters

  • id in path (required)

Request body

  • application/json

Responses

  • 200: 200
    • application/json
      • id (string): Operation ID
      • reason (string): Operation failure reason
      • reference (object): Related resource reference - schema details
      • message (string): Operation message
      • state (string): Operation status

SDK reference for detach-instance-from-private-network: golang | Python | Java

CLI: exo api detach-instance-from-private-network

attach-instance-to-private-network

Attach a Compute instance to a Private Network

PUT /private-network/{id}:attach

Path parameters

  • id in path (required)

Request body

  • application/json
    • ip (string): Static IP address lease for the corresponding network interface
    • instance (required) (object): Compute instance - schema details

Responses

  • 200: 200
    • application/json
      • id (string): Operation ID
      • reason (string): Operation failure reason
      • reference (object): Related resource reference - schema details
      • message (string): Operation message
      • state (string): Operation status

SDK reference for attach-instance-to-private-network: golang | Python | Java

CLI: exo api attach-instance-to-private-network

reset-private-network-field

Reset Private Network field

DELETE /private-network/{id}/{field}

Path parameters

  • id in path (required)
  • field in path (required)

Responses

  • 200: 200
    • application/json
      • id (string): Operation ID
      • reason (string): Operation failure reason
      • reference (object): Related resource reference - schema details
      • message (string): Operation message
      • state (string): Operation status

SDK reference for reset-private-network-field: golang | Python | Java

CLI: exo api reset-private-network-field

update-private-network-instance-ip

Update the IP address of an instance attached to a managed private network

PUT /private-network/{id}:update-ip

Path parameters

  • id in path (required)

Request body

  • application/json
    • ip (string): Static IP address lease for the corresponding network interface
    • instance (object) - schema details

Responses

  • 200: 200
    • application/json
      • id (string): Operation ID
      • reason (string): Operation failure reason
      • reference (object): Related resource reference - schema details
      • message (string): Operation message
      • state (string): Operation status

SDK reference for update-private-network-instance-ip: golang | Python | Java

CLI: exo api update-private-network-instance-ip

list-private-networks

List Private Networks

GET /private-network

Responses

  • 200: 200

SDK reference for list-private-networks: golang | Python | Java

CLI: exo api list-private-networks

Last updated on