Get Allocated Or Released IP Address

Get Allocated Or Released IP Address

Get an allocated or released address of an IPAM network IP range

Request
URI
GET
https://vra-interop-222-139.lvn.broadcom.net/iaas/api/network-ip-ranges/{networkIPRangeId}/ip-addresses/{ipAddressId}
COPY
Path Parameters
string
networkIPRangeId
Required

The ID of a network IP range.

string
ipAddressId
Required

The ID attribute of the IP Address

Query Parameters
string
apiVersion
Required

The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about


Authentication
This operation uses the following authentication methods.
Responses
200

Successful operation

Returns NetworkIPAddress of type(s) application/json
{
    "id": "9.0E49",
    "createdAt": "2012-09-27",
    "updatedAt": "2012-09-27",
    "owner": "[email protected]",
    "ownerType": "ad_group",
    "orgId": "42413b31-1716-477e-9a88-9dc1c3cb1cdf",
    "_links": {
        "empty": false
    },
    "name": "my-name",
    "description": "my-description",
    "externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
    "ipAddress": "string",
    "ipAddressDecimalValue": 0,
    "ipVersion": "string",
    "ipAddressStatus": "string",
    "ipAllocationType": "string"
}
string
id
Required

The id of this resource instance

string
createdAt
Optional

Date when the entity was created. The date is in ISO 8601 and UTC.

string
updatedAt
Optional

Date when the entity was last updated. The date is ISO 8601 and UTC.

string
owner
Optional

Email of the user or display name of the group that owns the entity.

string
ownerType
Optional

Type of a owner(user/ad_group) that owns the entity.

string
orgId
Optional

The id of the organization this entity belongs to.

object
_links
Required

HATEOAS of the entity

string
name
Optional

A human-friendly name used as an identifier in APIs that support this option.

string
description
Optional

A human-friendly description.

string
externalId
Optional

External entity Id on the provider side.

string
ipAddress
Required

IP address.

integer As int64 As int64
ipAddressDecimalValue
Required

Decimal value of the ip address.

string
ipVersion
Optional

IP address version: IPv4 or IPv6. Default: IPv4.

Possible values are : IPv4, IPv6,
string
ipAddressStatus
Optional

IP address status

Possible values are : ALLOCATED, RELEASED, AVAILABLE, UNREGISTERED,
string
ipAllocationType
Optional

IP Allocation type

Possible values are : SYSTEM, USER, NONE,

403

Forbidden

Returns ServiceErrorResponse of type(s) application/json
"ServiceErrorResponse Object"
string
message
Optional

message

string
messageId
Optional

messageId

array of string
stackTrace
Optional

stackTrace

integer As int32 As int32
statusCode
Optional

statusCode

integer As int32 As int32
errorCode
Optional

errorCode

array of string
details
Optional

details

string
serverErrorId
Optional

serverErrorId

string
documentKind
Optional

documentKind

integer As int32 As int32
internalErrorCode
Optional

internalErrorCode


404

Not found

Returns ServiceErrorResponse of type(s) application/json
"ServiceErrorResponse Object"
string
message
Optional

message

string
messageId
Optional

messageId

array of string
stackTrace
Optional

stackTrace

integer As int32 As int32
statusCode
Optional

statusCode

integer As int32 As int32
errorCode
Optional

errorCode

array of string
details
Optional

details

string
serverErrorId
Optional

serverErrorId

string
documentKind
Optional

documentKind

integer As int32 As int32
internalErrorCode
Optional

internalErrorCode


501

Not implemented

Returns ServiceErrorResponse of type(s) application/json
"ServiceErrorResponse Object"
string
message
Optional

message

string
messageId
Optional

messageId

array of string
stackTrace
Optional

stackTrace

integer As int32 As int32
statusCode
Optional

statusCode

integer As int32 As int32
errorCode
Optional

errorCode

array of string
details
Optional

details

string
serverErrorId
Optional

serverErrorId

string
documentKind
Optional

documentKind

integer As int32 As int32
internalErrorCode
Optional

internalErrorCode


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/iaas/api/network-ip-ranges/{networkIPRangeId}/ip-addresses/{ipAddressId}?apiVersion=v