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

Get IPv6 Addresses

get

/ipv6Address

Gets all IPv6 addresses.

Attribute selection is enabled for all first-level attributes.

Request

Query Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The IPv6 addresses were returned successfully.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : IPV6Address
An iPv6 address.
Match All
An iPv6 address.
An iPv6 address.
Show Source
Nested Schema : IPAddress
An IP address.
Match All
An IP address.
An IP address.
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 : IPAddress-allOf[1]
Type: object
Show Source
Nested Schema : IPV6Address-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 : parentNetwork
Type: object
Read Only: true
The parent IP network of the IP address.
Match All
The parent IP network of the IP address.
Show Source
Nested Schema : parentSubnet
Type: object
Read Only: true
The parent IP subnet of the IP address.
Match All
The parent IP subnet of the IP address.
Show Source
Nested Schema : NetworkAddressDomain-allOf[1]
Type: object
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 : type
Type: object
Show Source
Nested Schema : schema
An IP subnet.
Match All
An IP subnet.
An IP subnet.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : partitionedSubnets
Type: array
Read Only: true
The list of partitioned subnets.
Show Source

206 Response

A range of IPv6 addresses were returned successfully.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : IPV6Address
An iPv6 address.
Match All
An iPv6 address.
An iPv6 address.
Show Source
Nested Schema : IPAddress
An IP address.
Match All
An IP address.
An IP address.
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 : IPAddress-allOf[1]
Type: object
Show Source
Nested Schema : IPV6Address-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 : parentNetwork
Type: object
Read Only: true
The parent IP network of the IP address.
Match All
The parent IP network of the IP address.
Show Source
Nested Schema : parentSubnet
Type: object
Read Only: true
The parent IP subnet of the IP address.
Match All
The parent IP subnet of the IP address.
Show Source
Nested Schema : NetworkAddressDomain-allOf[1]
Type: object
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 : type
Type: object
Show Source
Nested Schema : schema
An IP subnet.
Match All
An IP subnet.
An IP subnet.
Show Source
Nested Schema : type
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", "GeographicLocation", "GeographicSite", "GeographicAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "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", "GeographicLocation", "GeographicSite", "GeographicAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "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", "GeographicLocation", "GeographicSite", "GeographicAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "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 IPv6 addresses 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", "GeographicLocation", "GeographicSite", "GeographicAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "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", "GeographicLocation", "GeographicSite", "GeographicAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "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 of all IPv6 addresses with a given IP address domain 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/ipv6Address?ipAddressDomainName=domainName" -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".
  • domainName is the name of the IP address domain.

Example of Response Body

This example shows the contents of the response body in JSON format. It shows the full IPv6 address details for the given IP address domain filtering criteria. 

[
   {
      "id": "27-2001:0db8:1234:0000:0000:0000:0000:0001 - Public",
      "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/12-2001:0db8:1234:0000:0000:0000:0000:0001 - Public",
      "@type": "IPV6Address",
      "@baseType": "LogicalResource",
      "name": "Lab Users",
      "version": "1",
      "lifecycleState": "INSTALLED",
      "lifecycleSubState": "UNASSIGNED",
      "startDate": "2019-09-09T16:31:09.152Z",
      "endDate": "2038-01-19T08:44:07.000Z",
      "resourceSpecification": {
         "id": "IPv6Address",
         "href": "http://hostname:port/InventoryRSOpenAPI/specification/IPv6Address",
         "name": "IPv6Address",
         "version": "1",
         "entityType": "IPv6Address",
         "startDate": "2019-11-18T00:00:01.000Z",
         "endDate": "2038-01-19T08:44:07.000Z"
      },
      "prefixLength": 48,
      "numericAddress": 1,
      "ipAddressDomain": {
         "id": "25-Public",
         "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/25-Public",
         "@type": "NetworkAddressDomain"
      },
      "parentSubnet": {
         "id": "24-2001:0db8:1234:0000:0000:0000:0000:0000-48 - Public",
         "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/24-2001:0db8:1234:0000:0000:0000:0000:0000-48 - Public",
         "@type": "IPSubnet"
      },
      "ipv6Address": "2001:0db8:1234:0000:0000:0000:0000:0001",
      "ipv6AddressType": "GLOBAL_UNICAST"
   },
   {
      "id": "27-2001:0db8:1234:0000:0000:0000:0000:0002 - Public",
      "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/12-2001:0db8:1234:0000:0000:0000:0000:0002 - Public",
      "@type": "IPV6Address",
      "@baseType": "LogicalResource",
      "name": "Lab Users",
      "version": "1",
      "lifecycleState": "INSTALLED",
      "lifecycleSubState": "UNASSIGNED",
      "startDate": "2019-09-09T16:31:09.153Z",
      "endDate": "2038-01-19T08:44:07.000Z",
      "resourceSpecification": {
         "id": "IPv6Address",
         "href": "http://hostname:port/InventoryRSOpenAPI/specification/IPv6Address",
         "name": "IPv6Address",
         "version": "1",
         "entityType": "IPv6Address",
         "startDate": "2019-11-18T00:00:01.000Z",
         "endDate": "2038-01-19T08:44:07.000Z"
      },
      "prefixLength": 48,
      "numericAddress": 2,
      "ipAddressDomain": {
         "id": "25-Public",
         "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/25-Public",
         "@type": "NetworkAddressDomain"
      },
      "parentSubnet": {
         "id": "24-2001:0db8:1234:0000:0000:0000:0000:0000-48 - Public",
         "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/24-2001:0db8:1234:0000:0000:0000:0000:0000-48 - Public",
         "@type": "IPSubnet"
      },
      "ipv6Address": "2001:0db8:1234:0000:0000:0000:0000:0002",
      "ipv6AddressType": "GLOBAL_UNICAST"
   }
]
Back to Top