api.network.ip

/network/(name)/ip

api.network.ip.views.net_ip_list(*args, **kwargs)

List (GET) all IP addresses in a network (name). Delete (DELETE) list (data.ips) of IP addresses in the network (name).

GET /network/(name)/ip
DC-bound?:
  • ✓ - dc_bound=true
  • ✗ - dc_bound=false
Permissions:
Asynchronous?:
Parameters:
  • name (string) – required - Network name
  • data.full (boolean) – Return list of objects with all network IP address details (default: false)
  • data.usage (integer) – Filter by usage (1 - Server [in DB], 2 - Server [on compute node], 3 - Compute node, 9 - Other)
  • data.order_by (string) – Available fields for sorting: ip, hostname (default: id)
Status Codes:
DELETE /network/(name)/ip
DC-bound?:
  • ✓ - dc_bound=true
  • ✗ - dc_bound=false
Permissions:
Asynchronous?:
Parameters:
  • name (string) – required - Network name
  • data.ips (array) – required List of IPs to be deleted
Status Codes:

es example:

es get /network/private1/ip

{
    "url": "https://my.erigones.com/api/network/private1/ip/",
    "status": 200,
    "method": "GET",
    "text": {
        "status": "SUCCESS",
        "result": [
            "10.1.1.20",
            "10.1.1.21",
            "10.1.1.22",
            "10.1.1.23",
            "10.1.1.24"
        ],
        "task_id": "1e1d1-6f75849b-0fbe-4295-9df3"
    }
}

/network/(name)/ip/(ip)

api.network.ip.views.net_ip(*args, **kwargs)

Show (GET), create (POST, update (PUT) or delete (DELETE) a network IP address.

GET /network/(name)/ip/(ip)
DC-bound?:
  • ✓ - dc_bound=true
  • ✗ - dc_bound=false
Permissions:
Asynchronous?:
Parameters:
  • name (string) – required - Network name
  • ip (string) – required - IP address
Status Codes:
POST /network/(name)/ip/(ip)
DC-bound?:
  • ✓ - dc_bound=true
  • ✗ - dc_bound=false
Permissions:
Asynchronous?:
Parameters:
  • name (string) – required - Network name
  • ip (string) – required - IP address
  • data.usage (integer) – Purpose of this IP address. Only server (1) IP addresses can be used for virtual servers (1 - Server, 9 - Other) (default: 1)
  • data.note – Short comment
Status Codes:
PUT /network/(name)/ip/(ip)
DC-bound?:
  • ✓ - dc_bound=true
  • ✗ - dc_bound=false
Permissions:
Asynchronous?:
Parameters:
  • name (string) – required - Network name
  • ip (string) – required - IP address
  • data.usage (integer) – Purpose of this IP address. Only server (1) IP addresses can be used for virtual servers (1 - Server, 9 - Other)
  • data.note – Short comment
Status Codes:
DELETE /network/(name)/ip/(ip)
DC-bound?:
  • ✓ - dc_bound=true
  • ✗ - dc_bound=false
Permissions:
Asynchronous?:
Parameters:
  • name (string) – required - Network name
  • ip (string) – required - IP address
Status Codes:

es example:

es create /network/private1/ip/10.1.1.20

{
    "url": "https://my.erigones.com/api/network/private1/ip/10.1.1.20/",
    "status": 200,
    "method": "POST",
    "text": {
        "status": "SUCCESS",
        "result": {
            "ip": "10.1.1.20",
            "note": "",
            "usage": 1,
            "mac": null,
            "hostname": null,
            "nic_id": null,
            "dc": null
        },
        "task_id": "1e1d23-6f75849b-2018-4919-8164"
    }
}

/network/ip/(subnet)

api.network.ip.views.subnet_ip_list(*args, **kwargs)

List (GET) all IP addresses in a subnet (optional).

GET /network/ip/(subnet)
DC-bound?:
Permissions:
Asynchronous?:
Parameters:
  • subnet (string) – Show only IP addresses in this subnet. The subnet should be in CIDR notation
  • data.full (boolean) – Return list of objects with all network IP address details (default: false)
  • data.usage (integer) – Filter by usage (1 - Server [in DB], 2 - Server [on compute node], 3 - Compute node, 9 - Other)
  • data.order_by (string) – Available fields for sorting: ip, net, hostname (default: ip)
Status Codes: