Chilkat Online Tools

Perl / MongoDB Atlas / Modify Cloud Backup Backup Policy

Back to Collection Items

use chilkat();

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$http = chilkat::CkHttp->new();

$http->put_DigestAuth(1);
$http->put_Login("username");
$http->put_Password("password");

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "referenceHourOfDay": 12,
#   "referenceMinuteOfHour": 30,
#   "policies": [
#     {
#       "id": "5f8dc2299b9d310a7fde98e6",
#       "policyItems": [
#         {
#           "id": "5f8dc2299b9d310a7fde98e7",
#           "frequencyType": "hourly",
#           "frequencyInterval": 6,
#           "retentionValue": 2,
#           "retentionUnit": "days"
#         },
#         {
#           "id": "5f8dc2299b9d310a7fde98e9",
#           "frequencyType": "weekly",
#           "frequencyInterval": 1,
#           "retentionValue": 3,
#           "retentionUnit": "weeks"
#         }
#       ]
#     }
#   ],
#   "updateSnapshots": true
# }

$json = chilkat::CkJsonObject->new();
$json->UpdateInt("referenceHourOfDay",12);
$json->UpdateInt("referenceMinuteOfHour",30);
$json->UpdateString("policies[0].id","5f8dc2299b9d310a7fde98e6");
$json->UpdateString("policies[0].policyItems[0].id","5f8dc2299b9d310a7fde98e7");
$json->UpdateString("policies[0].policyItems[0].frequencyType","hourly");
$json->UpdateInt("policies[0].policyItems[0].frequencyInterval",6);
$json->UpdateInt("policies[0].policyItems[0].retentionValue",2);
$json->UpdateString("policies[0].policyItems[0].retentionUnit","days");
$json->UpdateString("policies[0].policyItems[1].id","5f8dc2299b9d310a7fde98e9");
$json->UpdateString("policies[0].policyItems[1].frequencyType","weekly");
$json->UpdateInt("policies[0].policyItems[1].frequencyInterval",1);
$json->UpdateInt("policies[0].policyItems[1].retentionValue",3);
$json->UpdateString("policies[0].policyItems[1].retentionUnit","weeks");
$json->UpdateBool("updateSnapshots",1);

$sbRequestBody = chilkat::CkStringBuilder->new();
$json->EmitSb($sbRequestBody);

# resp is a HttpResponse
$resp = $http->PTextSb("PATCH","https://domain.com/api/atlas/{{version}}/groups/{{ProjectID}}/clusters/{{CLUSTER-NAME}}/backup/schedule",$sbRequestBody,"utf-8","application/json",0,0);
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

print $resp->get_StatusCode() . "\r\n";
print $resp->bodyStr() . "\r\n";

Curl Command

curl -X PATCH
	--digest -u 'username:password'
	-d '{
    "referenceHourOfDay": 12,
    "referenceMinuteOfHour": 30,
    "policies": [
        {
            "id": "5f8dc2299b9d310a7fde98e6",
            "policyItems": [
                {
                    "id": "5f8dc2299b9d310a7fde98e7",
                    "frequencyType": "hourly",
                    "frequencyInterval": 6,
                    "retentionValue": 2,
                    "retentionUnit": "days"
                },
                {
                    "id": "5f8dc2299b9d310a7fde98e9",
                    "frequencyType": "weekly",
                    "frequencyInterval": 1,
                    "retentionValue": 3,
                    "retentionUnit": "weeks"
                }
            ]
        }
    ],
    "updateSnapshots": true
}'
https://domain.com/api/atlas/{{version}}/groups/{{ProjectID}}/clusters/{{CLUSTER-NAME}}/backup/schedule

Postman Collection Item JSON

{
  "name": "Modify Cloud Backup Backup Policy",
  "request": {
    "method": "PATCH",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"referenceHourOfDay\": 12,\n    \"referenceMinuteOfHour\": 30,\n    \"policies\": [\n        {\n            \"id\": \"5f8dc2299b9d310a7fde98e6\",\n            \"policyItems\": [\n                {\n                    \"id\": \"5f8dc2299b9d310a7fde98e7\",\n                    \"frequencyType\": \"hourly\",\n                    \"frequencyInterval\": 6,\n                    \"retentionValue\": 2,\n                    \"retentionUnit\": \"days\"\n                },\n                {\n                    \"id\": \"5f8dc2299b9d310a7fde98e9\",\n                    \"frequencyType\": \"weekly\",\n                    \"frequencyInterval\": 1,\n                    \"retentionValue\": 3,\n                    \"retentionUnit\": \"weeks\"\n                }\n            ]\n        }\n    ],\n    \"updateSnapshots\": true\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{base_url}}/api/atlas/{{version}}/groups/{{ProjectID}}/clusters/{{CLUSTER-NAME}}/backup/schedule",
      "host": [
        "{{base_url}}"
      ],
      "path": [
        "api",
        "atlas",
        "{{version}}",
        "groups",
        "{{ProjectID}}",
        "clusters",
        "{{CLUSTER-NAME}}",
        "backup",
        "schedule"
      ]
    },
    "description": "https://docs.atlas.mongodb.com/reference/api/cloud-backup/schedule/get-all-schedules/"
  },
  "response": [
  ]
}