Chilkat Online Tools

Ruby / MongoDB Atlas / Update Snapshot Schedule

Back to Collection Items

require '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(true)
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.

# {
#   "snapshotRetentionDays": 3,
#   "monthlySnapshotRetentionMonths": 2
# }

json = Chilkat::CkJsonObject.new()
json.UpdateInt("snapshotRetentionDays",3)
json.UpdateInt("monthlySnapshotRetentionMonths",2)

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("PATCH","https://domain.com/api/atlas/{{version}}/groups/{{ProjectID}}/clusters/{{CLUSTER-NAME}}/snapshotSchedule",sbRequestBody,"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -X PATCH
	--digest -u 'username:password'
	-d '{
    "snapshotRetentionDays": 3,
    "monthlySnapshotRetentionMonths": 2
}'
https://domain.com/api/atlas/{{version}}/groups/{{ProjectID}}/clusters/{{CLUSTER-NAME}}/snapshotSchedule

Postman Collection Item JSON

{
  "name": "Update Snapshot Schedule",
  "request": {
    "method": "PATCH",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"snapshotRetentionDays\": 3,\n    \"monthlySnapshotRetentionMonths\": 2\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{base_url}}/api/atlas/{{version}}/groups/{{ProjectID}}/clusters/{{CLUSTER-NAME}}/snapshotSchedule",
      "host": [
        "{{base_url}}"
      ],
      "path": [
        "api",
        "atlas",
        "{{version}}",
        "groups",
        "{{ProjectID}}",
        "clusters",
        "{{CLUSTER-NAME}}",
        "snapshotSchedule"
      ]
    },
    "description": "https://docs.atlas.mongodb.com/reference/api/legacy-backup/schedule/patch-schedule/"
  },
  "response": [
  ]
}