Get Instances

Table 1. API: GET AWS Instances
Element Description
API GetAWSInstances
Description API returns AWS instance(s) exist in Endpoint.
Method GET
URL Http(s)://{xx.xxxx.xx.xx:xxx}/v3/aws/provisioningEndPoints/{endpointId}/instances
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": "instaceId=’i-x’","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": 1,
 "records": [
 {
 "instanceId": "i-xxxxxx",
 "instanceEntityId": null,
 "associatedServicePlans": []
 }
 ]
 }
Response Parameters
  • Result:
  • instanceId
  • instanceentityId
  • associationServicePlans