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

Create IPv4 Addresses

post

/ipv4Address

Creates one IPv4 address with the given details by default.

To create a range of IPv4 addresses, include the toAddress query parameter. In this case, the ipAddress attribute is used as the from-Address.

The minimum required parameters are:

  • @type
  • name
  • ipAddress
  • ipAddressDomain

The created IPv4 addresses will be shown in the response along with the location URL, except when "fields=none" is provided in the request. When a range of IP addresses are created, the location header will point to the parent subnet of the created addresses. The same relationships will be created for all addresses in the range.

Request

Query Parameters
Supported Media Types
Request Body - application/json ()
The Resource to be created
Root Schema : schema
An IPv4 address.
Match All
Show Source
Nested Schema : IPAddress
An IP address.
Match All
Show Source
Nested Schema : LogicalResource
Type: object
The base class for logical resources.
Match All
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 : type
Type: object
Show Source
Nested Schema : NetworkAddressDomain
A network address domain.
Match All
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
Show Source
Nested Schema : parentSubnet
Type: object
Read Only: true
The parent IP subnet of the IP address.
Match All
Show Source
Nested Schema : NetworkAddressDomain-allOf[1]
Type: object
Show Source
Nested Schema : schema
An IP network or IP subnet.
Match All
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : schema
An IP subnet.
Match All
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : partitionedSubnets
Type: array
Read Only: true
The list of partitioned subnets.
Show Source
Back to Top

Response

Supported Media Types

201 Response

The Ipv4 address was created successfully.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : schema
An IPv4 address.
Match All
Show Source
Nested Schema : IPAddress
An IP address.
Match All
Show Source
Nested Schema : LogicalResource
Type: object
The base class for logical resources.
Match All
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 : type
Type: object
Show Source
Nested Schema : NetworkAddressDomain
A network address domain.
Match All
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
Show Source
Nested Schema : parentSubnet
Type: object
Read Only: true
The parent IP subnet of the IP address.
Match All
Show Source
Nested Schema : NetworkAddressDomain-allOf[1]
Type: object
Show Source
Nested Schema : schema
An IP network or IP subnet.
Match All
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : schema
An IP subnet.
Match All
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

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

Create a Single IPv4 Address

This example shows how to create a single IPv4 address by submitting a POST request on the REST resource using cURL. For more information about cURL, see "Install and Use cURL".

cURL Command

curl -X POST "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/ipv4Address" -H 'content-type: application/json' -H credentials -d @ipv4Addresscreate.json

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".
  • ipv4Addresscreate.json is the JSON file that specifies the IPv4 address to create.

Example of Request Body

This shows an example of the contents of the ipv4Addresscreate.json file sent as the request body. 

{
   "@type": "IPV4Address",
   "@baseType": "LogicalResource",
   "name": " WebHosting_Admin",
   "resourceSpecification": {
      "id": "IPv4Address",
      "href": "http://hostname:port/InventoryRSOpenAPI/specification/IPv4Address",
      "name": "IPv4Address"
   },
      "prefixLength": 9,
      "ipAddressDomain": {
         "id": "25-Public ",
         "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/25-Public",
         "@type": "NetworkAddressDomain"
      },
   "ipv4Address": "73.0.0.20"
}

Example of Response Body

This example shows the contents of the response body in JSON format. The ID is auto-generated as a composite value of the business object identifier, IP address, and IP address domain separated by a hyphen (-), and it's included in the response. 

[
   {
      "id": "26-73.0.0.20 - Public ",
      "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/12-73.0.0.20 - Public",
      "@type": "IPV4Address",
      "@baseType": "LogicalResource",
      "name": "WebHosting_Admin",
      "version": "1",
      "lifecycleState": "INSTALLED",
      "lifecycleSubState": "UNASSIGNED",
      "startDate": "2020-01-02T14:50:48.796Z",
      "endDate": "2038-01-19T08:44:07.000Z",
      "resourceSpecification": {
         "id": "IPv4Address",
         "href": "http://hostname:port/InventoryRSOpenAPI/specification/IPv4Address",
         "name": "IPv4Address",
         "version": "1",
         "entityType": "IPv4Address",
         "startDate": "2019-11-18T00:00:01.000Z",
         "endDate": "2038-01-19T08:44:07.000Z"
      },
      "prefixLength": 9,
      "ipAddressDomain": {
         "id": "25-Public",
         "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/25-Public",
         "@type": "NetworkAddressDomain"
      },
      "parentSubnet": {
         "id": "24-73.0.0.0-9 - Public",
         "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/24-73.0.0.0-9 - Public",
         "@type": "IPSubnet"
      },
      "parentNetwork": {
         "id": "23-73.0.0.0-8 - Public",
         "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/23-73.0.0.0-8 - Public",
         "@type": "IPNetwork"
      },
      "ipv4Address": "73.0.0.20"
   }
]

Create a Range of IPv4 Addresses

This example shows how to create a range of IPv4 addresses by submitting a POST request on the REST resource using cURL. The end of the IPv4 address range is provided as a query parameter as shown. For more information about cURL, see "Install and Use cURL".

cURL Command

curl -X POST "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/ipv4Address?toAddress=toAddress" -H 'content-type: application/json' -H credentials -d @ipv4Addresscreate.json

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"".
  • toAddress is the end of the address range.
  • ipv4Addresscreate.json is the JSON file that specifies the IPv4 address to create.

Example of Request Body

This shows an example of the contents of the ipv4Addresscreate.json file sent as the request body. 

{
   "@type": "IPV4Address",
   "@baseType": "LogicalResource",
   "name": "RGIA_Lounge",
   "resourceSpecification": {
      "id": "IPv4Address",
      "href": "http://hostname:port/InventoryRSOpenAPI/specification/IPv4Address",
      "name": "IPv4Address"
   },
   "prefixLength": 9,
   "ipAddressDomain": {
      "id": "25-Public",
      "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/25-Public",
      "@type": "NetworkAddressDomain"
   },
   "ipv4Address": "75.0.0.3"
}

Example of Response Body

This example shows the contents of the response body in JSON format. The ID is auto-generated as a composite value of the business object identifier, IP address, and IP address domain separated by a hyphen (-), and it's included in the response. 

[
   {
      "id": "26-75.0.0.3 - Public",
      "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/12-75.0.0.3 - Public",
      "@type": "IPV4Address",
      "@baseType": "LogicalResource",
      "name": "RGIA_Lounge",
      "version": "1",
      "lifecycleState": "INSTALLED",
      "lifecycleSubState": "UNASSIGNED",
      "startDate": "2020-01-06T14:05:21.712Z",
      "endDate": "2038-01-19T08:44:07.000Z",
      "resourceSpecification": {
         "id": "IPv4Address",
         "href": "http://hostname:port/InventoryRSOpenAPI/specification/IPv4Address",
         "name": "IPv4Address",
         "version": "1",
         "entityType": "IPv4Address",
         "startDate": "2019-11-18T00:00:01.000Z",
         "endDate": "2038-01-19T08:44:07.000Z"
      },
      "prefixLength": 9,
      "ipAddressDomain": {
         "id": "25-Public",
         "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/25-Public",
         "@type": "NetworkAddressDomain"
      },
      "parentSubnet": {
         "id": "24-75.0.0.0-9 - Public",
         "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/24-75.0.0.0-9 - Public",
         "@type": "IPSubnet"
      },
      "parentNetwork": {
         "id": "23-75.0.0.0-9 - Public",
         "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/23-75.0.0.0-9 - Public",
         "@type": "IPNetwork"
      },
      "ownedBy": {
         "id": "150001",
         "href": "http://hostname:port/InventoryRSOpenAPI/party/150001",
         "name": "AAI",
         "@referredType": "Party"
      },
      "ipv4Address": "75.0.0.3"
   },
   {
      "id": "26-75.0.0.4 - Public",
      "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/12-75.0.0.4 - Public",
      "@type": "IPV4Address",
      "@baseType": "LogicalResource",
      "name": "RGIA_Lounge",
      "version": "1",
      "lifecycleState": "INSTALLED",
      "lifecycleSubState": "UNASSIGNED",
      "startDate": "2020-01-06T14:05:21.724Z",
      "endDate": "2038-01-19T08:44:07.000Z",
      "resourceSpecification": {
         "id": "IPv4Address",
         "href": "http://hostname:port/InventoryRSOpenAPI/specification/IPv4Address",
         "name": "IPv4Address",
         "version": "1",
         "entityType": "IPv4Address",
         "startDate": "2019-11-18T00:00:01.000Z",
         "endDate": "2038-01-19T08:44:07.000Z"
      },
      "prefixLength": 9,
      "ipAddressDomain": {
         "id": "25-Public",
         "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/25-Public",
         "@type": "NetworkAddressDomain"
      },
      "parentSubnet": {
         "id": "24-75.0.0.0-9 - Public",
         "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/24-75.0.0.0-9 - Public",
         "@type": "IPSubnet"
      },
      "parentNetwork": {
         "id": "23-75.0.0.0-9 - Public",
         "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/23-75.0.0.0-9 - Public",
         "@type": "IPNetwork"
      },
      "ownedBy": {
         "id": "150001",
         "href": "http://hostname:port/InventoryRSOpenAPI/party/150001",
         "name": "AAI",
         "@referredType": "Party"
      },
      "ipv4Address": "75.0.0.4"
   }
]
Back to Top