Networking

Search IPs by params (example)

Returns a list of IPs by params.<br>Highly recommended to use ipv4_networks_id param for search<br>(GET params example: ?main_attributes[ipv4_networks_id]=1).<br>More details about search by params you can find here.

get/admin/networking/ipv4-ip

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/networking/ipv4-ip
  • Auth: HTTP basic

Query parameters

is_usednumber double required

Example of param for search (Search all free IPs).

network_idnumber double required
Example:1

Example of param for search (Search IPs in specific network by id).

main_attributes[is_used]string required
Example:{is_used}
main_attributes[ipv4_networks_id]string required
Example:{network_id}

Response

ipv4_networks_idnumber required

IPv4 Network ID

ipstring

IPv4 IP

hostnamestring

Hostname

location_idnumber

Location (id)

titlestring

Title

commentstring

Comment

host_categorynumber

ID of host category from "Config / Networking / IP Host categories"

is_usednumber

IP used status. Can be '1' for used or '0' when unused

statusnumber

Status after ping. Statuses: 0 => 'OK', 1 => 'TimeOut', 2 => 'Error', 9 => 'Unknown'

last_checknumber

Last check

customer_idnumber

Customer id

card_idnumber

Customer id

modulestring

Name of module. It used when there are AF field with type IP

module_item_idnumber

Id of module item

idnumber

IPv4 IP ID

Example response

[
  {
    "ipv4_networks_id": 1,
    "ip": "10.0.0.1",
    "hostname": "host",
    "location_id": 1,
    "title": "Alpha and Beta",
    "comment": "Second IP",
    "host_category": 1,
    "is_used": 0,
    "status": 0,
    "last_check": 0,
    "customer_id": 0,
    "card_id": 0,
    "module": "",
    "module_item_id": 0,
    "id": 2
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.