Network IP¶
Entity¶
IP Address¶
Ip resource:
Field |
Explanation |
---|---|
id |
ip identifier |
address |
ip address |
netmask |
ip netmask |
broadcast |
ip broadcast |
network_id |
ip’s network id |
gateway |
ip gateway |
disallowed_primary |
ip can’t be primary |
interface_id |
interface id |
status |
ip status |
Ip list resource:
[ip resource 1, ip resource 2, …]
Operations¶
Note
This is the recommended method.
Delete ip from interface¶
Get Ips from network¶
Delete ip address¶
- Method
DELETE
- Url
/account/<account_id>/ip_address/<ip_address_id>
- Success Code
204
- Returned Data
No data returned
- Has Token
No
Removes an ip address resource.
Note
Public ip addresses cannot be deleted
Note
ip addresses must be unassigned prior to deletion.
Get ip address¶
- Method
GET
- Url
/account/<account_id>/ip_address/<ip_address_id>
- Success Code
200
- Returned Data
- Has Token
No
Get an ip address resource
List ip addresses¶
- Method
GET
- Url
/account/<account_id>/ip_addresses
- Success Code
200
- Returned Data
- Has Token
No
List user’s ip addresses
Filters:
ip: partial ip address
network_id
address
public
owned
interface_id
network_interface_id
Curl example¶
curl -i -X GET "https://api.gigas.com/ip_addresses?ip=x.x.x.x" -H "Authorization: $TOKEN" -H "Content-Type: application/json"