| API
|
ReserveAndGetAWSFreeIpDetails |
| Description |
API reserves and returns IPaddress for an object i.e. IP will be blocked in
passed subnet. |
| Method |
POST
|
| URL |
Http(s)://{xx.xxxx.xx.xx:xxx}/v3/aws/provisioningEndPoints/{endpointId}/subnets/{subnetEntityId}/freeIps |
| URL Parameters (fields in curly {} braces) |
-
endpointId (Mandatory): This is a unique identifier of Cloud Endpoint
created in HCL BigFix CLM. It can be any value either PlatformEntityId or Name
of the Platform available on Manage Provisioning Platform screen.
-
subnetEntityId (Mandatory): this parameter represents the subnet entity
id for which IPs are to be fetched.
|
| Body Parameters |
{
"objectId": "string",
"nicPrefix": "string"
}
-
Objectid (Mandatory): This is a unique identifier of Resource like VM -Virtual Machine, LB-Load Balancer
etc.
-
Nicprefix: Prefix of IP addresses such as NIC1, NIC2.
|
| Header |
-
Authorization Key: The initial step that needs to be performed before
consuming HCL BigFix CLM API is to obtain the
Token Value for an
authorization key. Once a Token value is
obtained, it remains valid for all API calls made in a
session. For more information on how to do that, refer Token API description.
-
Content-type: application/json
|
| Response
|
A Sample Response:
{
"subnetName": "PublicSubnet3",
"ipAddress": "xxxxxx",
"subnetMask": "255.255.252.0",
"defaultGateway": "xxxxxx",
"networkType": "NET_T1"
}
|
| Response Parameters |
- Result:
- SubnetName
- ipAddress
- subnetmask
- defaultGateway
- networkType
|
