Get Snapshots

Table 1. API: GET AWS Snapshots
Element Description
API GetAWSSnapShots
Description API returns AWS snapshot(s) exist in Endpoint.
Method GET
URL Http(s)://{xx.xxxx.xx.xx:xxx}/v3/aws/provisioningEndPoints/{endpointId}/snapShots
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": 28,
 "records": [
 {
 "snapshotId": "snap-xxxxxx",
 "text": null,
 "dataEncryptionKeyId": "",
 "description": "Created by CreateImage(i-02be28ba4bf32d586) for ami-xxxxxx",
 "encrypted": "false",
 "kmsKeyId": "",
 "ownerId": "016701022611",
 "ownerAlias": "",
 "progress": "100%",
 "state": "completed",
 "stateMessage": "",
 "volumeId": "vol-xxxxxx",
 "volumeSize": "80",
 "regionName": "us-east-1",
 "tags": [
 {
 "Purpose": "Failover_AMI"
 },
 {
 "Owner": "Seema and Ashok"
 },
 {
 "Expiry": "Number"
 }
 ],
 "isActive": "Y",
 "associatedServicePlans": []
 }
 ]
}
Response Parameters
  • Result:
  • snapshotId
  • text
  • dataEncryptionId
  • description
  • encrypted
  • kmsKeyId
  • ownerId
  • ownerAlias
  • progress
  • state
  • stateMessage
  • volumeId
  • volumeSize
  • regionName
  • tags
  • isActive
  • associatedServicePlans