Get Regions

Table 1. API: GET AWS Regions
Element Description
API GetAWSRegion
Description API returns region(s) associated to endpoint.
Method GET
URL Http:// {xx. xxxx.xx. xx:xxx}/v3/aws/provisioningEndPoints/{endpointId}/regions
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": "cityName=’Virginia’","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": [
 {
 "regionEntityId": null,
 "regionName": "us-east-1",
 "id": 44,
 "cityName": "Virgffffinia",
 "longitude": "",
 "latitude": "",
 "displayName": "US East (N. Virfffginia)",
 "createdDate": "7/11/2019 7:25:18 AM",
 "isDeleted": "N",
 "isSynced": "N",
 "platFormCode": "AMAZN"
 }
 ]
}
Response Parameters
  • regionEntityId
  • regionName
  • id
  • cityName
  • longitude
  • latitude
  • displayName
  • createdDate
  • isDeleted
  • isSynced
  • platFormCode
  • Errormessage