Skip to main content
REST API reference
A newer release of this product is available.

Retrieve IP subnet details

PDFs

GET /network/ip/subnets/{uuid}

Introduced In: 9.11

Retrieves details for a specific IP subnet.

  • network subnet show

Parameters

Name Type In Required Description

uuid

string

path

True

IP subnet UUID

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

available_count

integer

available_ip_ranges

array[ip_address_range]

broadcast_domain

broadcast_domain

The broadcast domain that the subnet is associated with. Either the UUID or name must be supplied on POST.

gateway

string

The IP address of the gateway for this subnet.

ip_ranges

array[ip_address_range]

ipspace

ipspace

The IPspace that the subnet is associated with. Either the UUID or name must be supplied on POST.

name

string

Subnet name

subnet

ip_info

IP information

total_count

integer

used_count

integer

uuid

string

The UUID that uniquely identifies the subnet.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "available_count": 0,
  "available_ip_ranges": [
    {
      "end": "10.10.10.7",
      "family": "string",
      "start": "10.10.10.7"
    }
  ],
  "broadcast_domain": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "bd1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "fail_if_lifs_conflict": true,
  "gateway": "10.1.1.1",
  "ip_ranges": [
    {
      "end": "10.10.10.7",
      "family": "string",
      "start": "10.10.10.7"
    }
  ],
  "ipspace": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "exchange",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "name": "subnet1",
  "subnet": {
    "address": "10.10.10.7",
    "family": "string",
    "netmask": "24"
  },
  "total_count": 0,
  "used_count": 0,
  "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}

Error

Status: Default, Error
Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href

ip_address_range

IP address range

Name Type Description

end

string

IPv4 or IPv6 address

family

string

IPv4 or IPv6

start

string

IPv4 or IPv6 address

broadcast_domain

The broadcast domain that the subnet is associated with. Either the UUID or name must be supplied on POST.

Name Type Description

_links

_links

name

string

Name of the broadcast domain, scoped to its IPspace

uuid

string

Broadcast domain UUID

ipspace

The IPspace that the subnet is associated with. Either the UUID or name must be supplied on POST.

Name Type Description

_links

_links

name

string

IPspace name

uuid

string

IPspace UUID

ip_info

IP information

Name Type Description

address

string

IPv4 or IPv6 address

family

string

IPv4 or IPv6

netmask

string

Input as netmask length (16) or IPv4 mask (255.255.0.0). For IPv6, the default value is 64 with a valid range of 1 to 127. Output is always netmask length.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.