1. REST API for Unified Inventory Management
  2. Tasks
  3. Resource
  4. IP Subnet

Get IP Subnets

get

/ipSubnet

Gets all IP subnets, including IPv4 and IPv6, that match the search criteria specified in the query parameters.

Attribute selection is enabled for all first-level attributes.

The version query parameter is required for identifying the IP version of the network to get.

The filtering criteria for IPv4 subnets can include below properties and the properties generic to resource. Properties generic to resource and usage of the filtering operators can be referred to GET PATH of /resource.

  • name
  • ipAddressDomain
  • ipAddress
  • lifecycleState
  • ownedBy
  • managedBy
  • lifecycleSubstate
  • ipNetwork.name
  • ipNetwork.ipAddressDomainName
  • ipNetwork.ipAddress
  • ipNetwork.lifecycleState
  • ipNetwork.ownedBy
  • ipNetwork.prefixLengthFrom
    • - Valid Operator is >= only.
  • ipNetwork.prefixLengthTo
    • - Valid Operator is <= only. < ul> Additionally, IPv6 networks can be filtered by:
    • ipv6AddressType
    • ipNetwork.ipv6AddressType

    Optionally, use the expand parameter to specify any resource relationships (resourceRelationship.INVOLVE, resourceRelationship.CONSUMER) that you want to see details for. By default, you'll just see links for these.

    Optionally, use the depth parameter to expand the level of referenced (related) entities. If depth=0, all referenced entities in RootEntity objects contain only ID, HREF, and @type. If depth = N, it expands the reference objects of related entities recursively. The last level contains only the references.

    Optionally, use the sort parameter to sort the search results.

    Usage: sort=(Direction)Fields

    where Direction is '-' for descending order and '+' for ascending order.

    For example, sort=-name, name

    Sorting can be performed on these fields:

    • name
    • lifecycleState
    • resourceSpecification.name

Request

Query Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The IP subnets were returned successfully.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : IPSubnet
An IP subnet.
Match All
An IP subnet.
An IP subnet.
Show Source
Nested Schema : schema
An IP network or IP subnet.
Match All
An IP network or IP subnet.
An IP network or IP subnet.
Show Source
Nested Schema : LogicalResource
Type: object
The base class for logical resources.
Match All
The base class for logical resources.
The base class for logical resources.
Show Source
Nested Schema : Discriminator: @type
Type: object
A base resource Class.
Show Source
Nested Schema : LogicalResource-allOf[1]
Type: object
Nested Schema : type
Type: object
Show Source
Nested Schema : IPSubnet-allOf[1]
Type: object
Show Source
Nested Schema : NetworkAddressDomain
A network address domain.
Match All
A network address domain.
A network address domain.
Show Source
Nested Schema : RelatedPartyRef
Type: object
A related party, which defines a party or party role linked to a specific entity.
Show Source
Nested Schema : NetworkAddressDomain-allOf[1]
Type: object
Show Source
Nested Schema : partitionedSubnets
Type: array
Read Only: true
The list of partitioned subnets.
Show Source

206 Response

A range of IP subnets were returned successfully.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : IPSubnet
An IP subnet.
Match All
An IP subnet.
An IP subnet.
Show Source
Nested Schema : schema
An IP network or IP subnet.
Match All
An IP network or IP subnet.
An IP network or IP subnet.
Show Source
Nested Schema : LogicalResource
Type: object
The base class for logical resources.
Match All
The base class for logical resources.
The base class for logical resources.
Show Source
Nested Schema : Discriminator: @type
Type: object
A base resource Class.
Show Source
Nested Schema : LogicalResource-allOf[1]
Type: object
Nested Schema : type
Type: object
Show Source
Nested Schema : IPSubnet-allOf[1]
Type: object
Show Source
Nested Schema : NetworkAddressDomain
A network address domain.
Match All
A network address domain.
A network address domain.
Show Source
Nested Schema : RelatedPartyRef
Type: object
A related party, which defines a party or party role linked to a specific entity.
Show Source
Nested Schema : NetworkAddressDomain-allOf[1]
Type: object
Show Source
Nested Schema : partitionedSubnets
Type: array
Read Only: true
The list of partitioned subnets.
Show Source

400 Response

The request isn't valid.
Body ()
Root Schema : Error
Type: object
Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).
Show Source
  • The error code.
  • Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicPlace", "GeographicLocation", "GeographicSite", "GeographicAddress", "GeographicAddressRange", "PropertyAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "NetworkEdge", "NetworkNode", "NetworkEntityCode", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "PipeTerminationPoint", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]
    The list of valid values for an entity class.
  • message
    The text that provides more details about the error as well as corrective actions.
  • The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
  • The URL pointing to the documentation that describes the error.
  • The HTTP error code extension, such as 400-2.
Nested Schema : message
Type: array
The text that provides more details about the error as well as corrective actions.
Show Source

401 Response

You aren't authorized to make this request.
Body ()
Root Schema : Error
Type: object
Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).
Show Source
  • The error code.
  • Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicPlace", "GeographicLocation", "GeographicSite", "GeographicAddress", "GeographicAddressRange", "PropertyAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "NetworkEdge", "NetworkNode", "NetworkEntityCode", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "PipeTerminationPoint", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]
    The list of valid values for an entity class.
  • message
    The text that provides more details about the error as well as corrective actions.
  • The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
  • The URL pointing to the documentation that describes the error.
  • The HTTP error code extension, such as 400-2.
Nested Schema : message
Type: array
The text that provides more details about the error as well as corrective actions.
Show Source

403 Response

The request is forbidden.
Body ()
Root Schema : Error
Type: object
Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).
Show Source
  • The error code.
  • Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicPlace", "GeographicLocation", "GeographicSite", "GeographicAddress", "GeographicAddressRange", "PropertyAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "NetworkEdge", "NetworkNode", "NetworkEntityCode", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "PipeTerminationPoint", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]
    The list of valid values for an entity class.
  • message
    The text that provides more details about the error as well as corrective actions.
  • The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
  • The URL pointing to the documentation that describes the error.
  • The HTTP error code extension, such as 400-2.
Nested Schema : message
Type: array
The text that provides more details about the error as well as corrective actions.
Show Source

404 Response

The IP networks weren't found.
Body ()
Root Schema : Error
Type: object
Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).
Show Source
  • The error code.
  • Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicPlace", "GeographicLocation", "GeographicSite", "GeographicAddress", "GeographicAddressRange", "PropertyAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "NetworkEdge", "NetworkNode", "NetworkEntityCode", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "PipeTerminationPoint", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]
    The list of valid values for an entity class.
  • message
    The text that provides more details about the error as well as corrective actions.
  • The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
  • The URL pointing to the documentation that describes the error.
  • The HTTP error code extension, such as 400-2.
Nested Schema : message
Type: array
The text that provides more details about the error as well as corrective actions.
Show Source

500 Response

An internal server error occurred.
Body ()
Root Schema : Error
Type: object
Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).
Show Source
  • The error code.
  • Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicPlace", "GeographicLocation", "GeographicSite", "GeographicAddress", "GeographicAddressRange", "PropertyAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "NetworkEdge", "NetworkNode", "NetworkEntityCode", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "PipeTerminationPoint", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]
    The list of valid values for an entity class.
  • message
    The text that provides more details about the error as well as corrective actions.
  • The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
  • The URL pointing to the documentation that describes the error.
  • The HTTP error code extension, such as 400-2.
Nested Schema : message
Type: array
The text that provides more details about the error as well as corrective actions.
Show Source
Back to Top

Examples

This example shows how to get the details for the IPv4 or IPv6 subnets with a given name by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Install and Use cURL".

cURL Command

curl -X GET "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/ipSubnet?version=IPv4&name=name" -H credentials

where:

  • hostname is the URL for the UIM REST server.
  • port is the port for the UIM REST server.
  • version is the version of the API you're using.
  • credentials is the base64 encoding of the user ID and password joined by a single colon (ID:password). See "Authentication and Authorization".
  • name is the name of the IP subnet to get.

Example of Response Body

This example shows the contents of the response body in JSON format. It shows the full details for IPv4 networks named "WebHosting". 

[
   {
      "id": "24-1.19.96.0-28 - Public",
      "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/24-1.19.96.0-28 - Public",
      "@type": "IPSubnet",
      "@baseType": "LogicalResource",
      "name": "WebHosting",
      "version": "1",
      "lifecycleState": "INSTALLED",
      "lifecycleSubState": "UNASSIGNED",
      "startDate": "2019-09-09T16:25:22.657Z",
      "endDate": "2038-01-19T08:44:07.000Z",
      "resourceSpecification": {
         "id": "IPv4Subnet",
         "href": "http://hostname:port/InventoryRSOpenAPI/specification/IPv4Subnet",
         "name": "IPv4Subnet",
         "version": "1",
         "entityType": "IPSubnet",
         "startDate": "2019-11-18T00:00:01.000Z",
         "endDate": "2038-01-19T08:44:07.000Z"
      },
      "prefixLength": 28,
      "isIPNetwork": false,
      "availableHostCount": 14,
      "numericLowerAddress": 18046976,
      "numericUpperAddress": 18046991,
      "allowHostAtSubnetBoundaries": false,
      "ipAddressDomain": {
         "id": "25- Public",
         "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/25-Public",
         "@type": "NetworkAddressDomain"
      },
      "ipAddressVersion": "IPV4",
      "prefix": "255.255.255.240",
      "isSubnetPartitioned": true,
      "ipNetwork": {
         "id": "23-1.19.96.0-28 - Public",
         "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/23-1.19.96.0-28 - Public",
         "@type": "IPNetwork"
      },
      "ipAddresses": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/ipSubnet/IPV4/1.19.96.0-28 - Public/ipAddresses",
      "partitionedSubnets": [
         {
            "id": "24-1.19.96.0-30 - Public",
            "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/24-1.19.96.0-30 - Public",
            "@type": "IPSubnet"
         },
         {
            "id": "24-1.19.96.4-30 - Public",
            "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/24-1.19.96.4-30 - Public",
            "@type": "IPSubnet"
         }
      ]
   }
]
Back to Top