Get Nics

Table 1. API: GET AWS Nics
Element Description
API GetAWSNics
Description API returns AWS Nic(s) exist in Endpoint.
Method GET
URL Http(s)://{xx.xxxx.xx.xx:xxx}/v3/aws/provisioningEndPoints/{endpointId}/nics
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.
  • queryParams (Optional): It is used for filtering and sorting of records. It has three properties, which are as follows:
  • Filter: To filter records based on column name received from output. E.g. Filter="keyname='keyvalue'"
  • Sort Order: To define sorting order either ASC (Ascending) or DESC (descending). E.g. Sortorder="ASC".
  • Page Number: To get the records for related page number. Eg. Pagenumber="1”
  • Page Size: To get the number of records on selected page. Eg. Pagesize="10”
  • For e.g. 
    {"filter": "regionName=’us-east-1’","sortorder": "desc", "pagenumber" : "1", "pagesize" : "10"}
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:

{
"totalRecords": 63,
 "records": [
 {
 "id": 1,
 "nicEntityId": null,
 "actualIdOnEnv": "eni-03c35e8bc61d63d74",
 "regionName": "us-east-1",
 "platformEntityId": "AMAZN-62A2E3B7-5484-4DD3-B328-0B331FB8A161",
 "description": "Primary network interface",
 "actualStateIdOnEnv": "in-use",
 "physicalAddressOnEnv": "xx",
 "instanceId": "i-xxxxxx",
 "deviceIndexOnEnv": "0",
 "attachmentIdOnEnv": "eni-attach-07f5080d8280b092a",
 "associatedServicePlans": [
 {
 "servicePlanId": "1",
 "servicePlanName": "platinum"
 }
 ]
 }
 ]
 }
Response Parameters
  • Result:
  • id
  • nicEntityId
  • actualIdOnEnv
  • regionName
  • platformEntityId
  • description
  • actualStateIdOnEnv
  • physicalAddressOnEnv
  • instanceId
  • deviceIndexOnEnv
  • attachmentIdOnEnv
  • associatedServicePlans