Chilkat Online Tools

Ruby / MongoDB Atlas / Return Status of One Specific Validation Job

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.

# {
#   "source": {
#     "clusterName": "exampleClusterA",
#     "groupId": "9b43a5b329223c3a1591a678",
#     "username": "example",
#     "password": "string",
#     "ssl": true,
#     "caCertificatePath": "/path/to/ca",
#     "managedAuthentication": false
#   },
#   "destination": {
#     "groupId": "e01c9427f054fe80745f3f6c",
#     "clusterName": "exampleClusterB"
#   },
#   "migrationHosts": [
#     "vm001.example.com"
#   ],
#   "dropEnabled": true
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("source.clusterName","exampleClusterA")
json.UpdateString("source.groupId","9b43a5b329223c3a1591a678")
json.UpdateString("source.username","example")
json.UpdateString("source.password","string")
json.UpdateBool("source.ssl",true)
json.UpdateString("source.caCertificatePath","/path/to/ca")
json.UpdateBool("source.managedAuthentication",false)
json.UpdateString("destination.groupId","e01c9427f054fe80745f3f6c")
json.UpdateString("destination.clusterName","exampleClusterB")
json.UpdateString("migrationHosts[0]","vm001.example.com")
json.UpdateBool("dropEnabled",true)

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

# resp is a CkHttpResponse
resp = http.PTextSb("GET","https://domain.com/api/atlas/{{version}}/groups/{{ProjectID}}/liveMigrations/validate/{{VALIDATION-ID}}",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 GET
	--digest -u 'username:password'
	-d '{
    "source": {
        "clusterName": "exampleClusterA",
        "groupId": "9b43a5b329223c3a1591a678",
        "username": "example",
        "password": "string",
        "ssl": true,
        "caCertificatePath": "/path/to/ca",
        "managedAuthentication": false
    },
    "destination": {
        "groupId": "e01c9427f054fe80745f3f6c",
        "clusterName": "exampleClusterB"
    },
    "migrationHosts": [
        "vm001.example.com"
    ],
    "dropEnabled": true
}'
https://domain.com/api/atlas/{{version}}/groups/{{ProjectID}}/liveMigrations/validate/{{VALIDATION-ID}}

Postman Collection Item JSON

{
  "name": "Return Status of One Specific Validation Job",
  "protocolProfileBehavior": {
    "disableBodyPruning": true
  },
  "request": {
    "method": "GET",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"source\": {\n        \"clusterName\": \"exampleClusterA\",\n        \"groupId\": \"9b43a5b329223c3a1591a678\",\n        \"username\": \"example\",\n        \"password\": \"string\",\n        \"ssl\": true,\n        \"caCertificatePath\": \"/path/to/ca\",\n        \"managedAuthentication\": false\n    },\n    \"destination\": {\n        \"groupId\": \"e01c9427f054fe80745f3f6c\",\n        \"clusterName\": \"exampleClusterB\"\n    },\n    \"migrationHosts\": [\n        \"vm001.example.com\"\n    ],\n    \"dropEnabled\": true\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{base_url}}/api/atlas/{{version}}/groups/{{ProjectID}}/liveMigrations/validate/{{VALIDATION-ID}}",
      "host": [
        "{{base_url}}"
      ],
      "path": [
        "api",
        "atlas",
        "{{version}}",
        "groups",
        "{{ProjectID}}",
        "liveMigrations",
        "validate",
        "{{VALIDATION-ID}}"
      ]
    },
    "description": "https://docs.atlas.mongodb.com/reference/api/live-migration/return-one-specific-validation-job/"
  },
  "response": [
  ]
}