Network

Entity

Network

Network resource:

Field Explanation
id network identifier
label network label
vlan network vlan
network_group_id network group id
status network status
multidatacenter works across datacenters
public true, false

Network resource list:

[network resource 1, network resource 2, ...]

Operations

Get network

Method:GET
Url:/account/<account_id>/network/<network_id>
Success Code:200
Returned Data:Network resource
Has Token:No

Get network resources.

List networks

Method:GET
Url:/account/<account_id>/networks
Success Code:200
Returned Data:Network resource list
Has Token:No

List networks which the user has access to.

Filters:

  • vlan: networks related to an vlan
  • network_group_id: the ID of the network group to which networks are attached
  • id: shows only one result (if found)
  • type: (‘public’, ‘private’)
  • console_id

Curl example

curl -i -X GET https://api.gigas.com/account/ACCOUNT_ID/networks -H "Authorization: $TOKEN" -H "Content-Type: application/json"

Get Ips from network

Method:GET
Url:/account/<account_id>/network/<network_id>/ip_addresses
Success Code:200
Returned Data:IP resource list
Has Token:No

List user ips on the network

Add IP to network

Method:POST
Url:/account/<account_id>/network/<network_id>/ip_address
Success Code:201
Returned Data:Ip resource
Has Token:No

Create a new ip address on the specified network

Mandatory parameters:

  • address: IP address

Optional parameters

  • disallowed_primary: set true not to use this address as primary (for VM build),
    otherwise set false
  • netmask: network mask
  • broadcast: a logical address at which all devices connected to a multiple-access
    communications network are enabled to receive datagrams.
  • network_address: IP address of the network
  • gateway: gateway address

Table Of Contents

Previous topic

Locations

Next topic

Network Group