Networking

Retrieve a IPv4 IP

Work with IPv4 IP.Retrieves the IPv4 IP with the given ID.

get/admin/networking/ipv4-ip/{network}--{ip}

Request

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

Path parameters

networknumber double required
Example:1

The ID of the desired IPv4 network.

ipnumber double required
Example:1

The ID of the IPv4 IP.

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.0",
  "hostname": "host",
  "location_id": 1,
  "title": "Alpha and Omega",
  "comment": "First IP",
  "host_category": 1,
  "is_used": 1,
  "status": 0,
  "last_check": 0,
  "customer_id": 1,
  "card_id": 0,
  "module": "",
  "module_item_id": 0,
  "id": 1
}

Changes

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