Chilkat Online Tools

PureBasic / MongoDB Atlas / Modify Cloud Backup Backup Policy

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    CkHttp::setCkDigestAuth(http, 1)
    CkHttp::setCkLogin(http, "username")
    CkHttp::setCkPassword(http, "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.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateInt(json,"referenceHourOfDay",12)
    CkJsonObject::ckUpdateInt(json,"referenceMinuteOfHour",30)
    CkJsonObject::ckUpdateString(json,"policies[0].id","5f8dc2299b9d310a7fde98e6")
    CkJsonObject::ckUpdateString(json,"policies[0].policyItems[0].id","5f8dc2299b9d310a7fde98e7")
    CkJsonObject::ckUpdateString(json,"policies[0].policyItems[0].frequencyType","hourly")
    CkJsonObject::ckUpdateInt(json,"policies[0].policyItems[0].frequencyInterval",6)
    CkJsonObject::ckUpdateInt(json,"policies[0].policyItems[0].retentionValue",2)
    CkJsonObject::ckUpdateString(json,"policies[0].policyItems[0].retentionUnit","days")
    CkJsonObject::ckUpdateString(json,"policies[0].policyItems[1].id","5f8dc2299b9d310a7fde98e9")
    CkJsonObject::ckUpdateString(json,"policies[0].policyItems[1].frequencyType","weekly")
    CkJsonObject::ckUpdateInt(json,"policies[0].policyItems[1].frequencyInterval",1)
    CkJsonObject::ckUpdateInt(json,"policies[0].policyItems[1].retentionValue",3)
    CkJsonObject::ckUpdateString(json,"policies[0].policyItems[1].retentionUnit","weeks")
    CkJsonObject::ckUpdateBool(json,"updateSnapshots",1)

    sbRequestBody.i = CkStringBuilder::ckCreate()
    If sbRequestBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckEmitSb(json,sbRequestBody)

    resp.i = CkHttp::ckPTextSb(http,"PATCH","https://domain.com/api/atlas/{{version}}/groups/{{ProjectID}}/clusters/{{CLUSTER-NAME}}/backup/schedule",sbRequestBody,"utf-8","application/json",0,0)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)


    ProcedureReturn
EndProcedure

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": [
  ]
}