Snapshot Policy

Recurring, scheduled snapshot policies attached to a volume.

Resource base path: /restapi/snapshotPolicy

Method	Path	Description
POST	/restapi/snapshotPolicy/createSnapshotPolicy	Create Snapshot Policy
GET	/restapi/snapshotPolicy/snapshotPolicyList	Snapshot Policy List
DELETE	/restapi/snapshotPolicy/deleteSnapshotPolicy/{uuid}	Delete Snapshot Policy

note

apikey and secretkey are required HTTP headers on every request and are omitted from the parameter tables below. See Authentication.

---

Create Snapshot Policy

Create Snapshot Policy.

POST /restapi/snapshotPolicy/createSnapshotPolicy

Request body

Field	Type	Required	Description
timer	string	✅ Yes	Timer for snapshot policy
intervalType	string	✅ Yes	Interval Type (HOURLY,DAILY, MONTHLY, WEEKLY) Example: HOURLY/DAILY/MONTHLY/WEEKLY
volumeUuid	string	No	UUID of the volume.
dayOfWeek	string	No	Day of week for snapshot policy
dayOfMonth	string	No	Day of month for snapshot policy
timeZone	string	✅ Yes	Timezone for snapshot policy occurence Example: Etc/GMT+12
maximumSnapshots	string	No

{
  "timer": "string",
  "intervalType": "HOURLY/DAILY/MONTHLY/WEEKLY",
  "volumeUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "dayOfWeek": "string",
  "dayOfMonth": "string",
  "timeZone": "Etc/GMT+12",
  "maximumSnapshots": "string"
}

Example request

curl -X POST \
  "https://portal.your-domain.com/restapi/snapshotPolicy/createSnapshotPolicy" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "timer": "string",
  "intervalType": "HOURLY/DAILY/MONTHLY/WEEKLY",
  "volumeUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "dayOfWeek": "string",
  "dayOfMonth": "string",
  "timeZone": "Etc/GMT+12",
  "maximumSnapshots": "string"
}'

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

{
  "listSnapShotPoliciesResponse": [
    {
      "scheduleTime": "string",
      "intervalType": "string",
      "volumeUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "dayOfWeek": "string",
      "dayOfMonth": "string",
      "timeZone": "string",
      "maximumSnapshots": "string",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "status": "Active"
    }
  ],
  "count": 1
}

---

Snapshot Policy List

Snapshot Policy List.

GET /restapi/snapshotPolicy/snapshotPolicyList

Parameters

Parameter	In	Type	Required	Description
volumeUuid	query	string	✅ Yes	UUID of the volume.
uuid	query	string	No	UUID of the resource.

Example request

curl -X GET \
  "https://portal.your-domain.com/restapi/snapshotPolicy/snapshotPolicyList?volumeUuid=a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

{
  "listSnapShotPoliciesResponse": [
    {
      "scheduleTime": "string",
      "intervalType": "string",
      "volumeUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "dayOfWeek": "string",
      "dayOfMonth": "string",
      "timeZone": "string",
      "maximumSnapshots": "string",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "status": "Active"
    }
  ],
  "count": 1
}

---

Delete Snapshot Policy

Delete Snapshot Policy.

DELETE /restapi/snapshotPolicy/deleteSnapshotPolicy/{uuid}

Parameters

Parameter	In	Type	Required	Description
uuid	path	string	✅ Yes	UUID of the resource.

Example request

curl -X DELETE \
  "https://portal.your-domain.com/restapi/snapshotPolicy/deleteSnapshotPolicy/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
200	Successful operation.
204	No content.
401	Invalid authentication credentials.
550	Permission denied.

true