Chilkat Online Tools

Ruby / Datadog API Collection / Trigger Synthetic tests

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()

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

# The following JSON is sent in the request body.

# {
#   "tests": [
#     {
#       "public_id": "aaa-aaa-aaa",
#       "metadata": {
#         "ci": {
#           "pipeline": {
#             "url": "aliquip in ex do"
#           },
#           "provider": {
#             "name": "nostrud culpa"
#           }
#         },
#         "git": {
#           "branch": "esse",
#           "commitSha": "occaecat incididunt aute exercitation"
#         }
#       }
#     },
#     {
#       "public_id": "aaa-aaa-aaa",
#       "metadata": {
#         "ci": {
#           "pipeline": {
#             "url": "pariatur ullamco sed"
#           },
#           "provider": {
#             "name": "adipisicing exercitation laborum non"
#           }
#         },
#         "git": {
#           "branch": "tempor fugiat consequat Lorem",
#           "commitSha": "esse aliqua"
#         }
#       }
#     }
#   ]
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("tests[0].public_id","aaa-aaa-aaa")
json.UpdateString("tests[0].metadata.ci.pipeline.url","aliquip in ex do")
json.UpdateString("tests[0].metadata.ci.provider.name","nostrud culpa")
json.UpdateString("tests[0].metadata.git.branch","esse")
json.UpdateString("tests[0].metadata.git.commitSha","occaecat incididunt aute exercitation")
json.UpdateString("tests[1].public_id","aaa-aaa-aaa")
json.UpdateString("tests[1].metadata.ci.pipeline.url","pariatur ullamco sed")
json.UpdateString("tests[1].metadata.ci.provider.name","adipisicing exercitation laborum non")
json.UpdateString("tests[1].metadata.git.branch","tempor fugiat consequat Lorem")
json.UpdateString("tests[1].metadata.git.commitSha","esse aliqua")

http.SetRequestHeader("Content-Type","application/json")
http.SetRequestHeader("Accept","application/json")

# resp is a CkHttpResponse
resp = http.PostJson3("https://api.app.ddog-gov.com/api/v1/synthetics/tests/trigger","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "batch_id": "anim quis",
#   "locations": [
#     {
#       "id": -79104764,
#       "name": "laborum"
#     },
#     {
#       "id": -12473023,
#       "name": "ullamco eu"
#     }
#   ],
#   "results": [
#     {
#       "device": "laptop_large",
#       "location": -53475818,
#       "public_id": "Excepteur et",
#       "result_id": "in"
#     },
#     {
#       "device": "laptop_large",
#       "location": 59458053,
#       "public_id": "ut labore",
#       "result_id": "quis tempor cillum est eu"
#     }
#   ],
#   "triggered_check_ids": [
#     "in irure culpa",
#     "sit ad do Ut esse"
#   ]
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

batch_id = jResp.stringOf("batch_id")
i = 0
count_i = jResp.SizeOfArray("locations")
while i < count_i
    jResp.put_I(i)
    id = jResp.IntOf("locations[i].id")
    name = jResp.stringOf("locations[i].name")
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("results")
while i < count_i
    jResp.put_I(i)
    device = jResp.stringOf("results[i].device")
    location = jResp.IntOf("results[i].location")
    public_id = jResp.stringOf("results[i].public_id")
    result_id = jResp.stringOf("results[i].result_id")
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("triggered_check_ids")
while i < count_i
    jResp.put_I(i)
    strVal = jResp.stringOf("triggered_check_ids[i]")
    i = i + 1
end

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "tests": [
    {
      "public_id": "aaa-aaa-aaa",
      "metadata": {
        "ci": {
          "pipeline": {
            "url": "aliquip in ex do"
          },
          "provider": {
            "name": "nostrud culpa"
          }
        },
        "git": {
          "branch": "esse",
          "commitSha": "occaecat incididunt aute exercitation"
        }
      }
    },
    {
      "public_id": "aaa-aaa-aaa",
      "metadata": {
        "ci": {
          "pipeline": {
            "url": "pariatur ullamco sed"
          },
          "provider": {
            "name": "adipisicing exercitation laborum non"
          }
        },
        "git": {
          "branch": "tempor fugiat consequat Lorem",
          "commitSha": "esse aliqua"
        }
      }
    }
  ]
}'
https://api.app.ddog-gov.com/api/v1/synthetics/tests/trigger

Postman Collection Item JSON

{
  "name": "Trigger Synthetic tests",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"tests\": [\n    {\n      \"public_id\": \"aaa-aaa-aaa\",\n      \"metadata\": {\n        \"ci\": {\n          \"pipeline\": {\n            \"url\": \"aliquip in ex do\"\n          },\n          \"provider\": {\n            \"name\": \"nostrud culpa\"\n          }\n        },\n        \"git\": {\n          \"branch\": \"esse\",\n          \"commitSha\": \"occaecat incididunt aute exercitation\"\n        }\n      }\n    },\n    {\n      \"public_id\": \"aaa-aaa-aaa\",\n      \"metadata\": {\n        \"ci\": {\n          \"pipeline\": {\n            \"url\": \"pariatur ullamco sed\"\n          },\n          \"provider\": {\n            \"name\": \"adipisicing exercitation laborum non\"\n          }\n        },\n        \"git\": {\n          \"branch\": \"tempor fugiat consequat Lorem\",\n          \"commitSha\": \"esse aliqua\"\n        }\n      }\n    }\n  ]\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v1/synthetics/tests/trigger",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "synthetics",
        "tests",
        "trigger"
      ]
    },
    "description": "Trigger a set of Synthetic tests."
  },
  "response": [
    {
      "name": "OK",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"tests\": [\n    {\n      \"public_id\": \"aaa-aaa-aaa\",\n      \"metadata\": {\n        \"ci\": {\n          \"pipeline\": {\n            \"url\": \"aliquip in ex do\"\n          },\n          \"provider\": {\n            \"name\": \"nostrud culpa\"\n          }\n        },\n        \"git\": {\n          \"branch\": \"esse\",\n          \"commitSha\": \"occaecat incididunt aute exercitation\"\n        }\n      }\n    },\n    {\n      \"public_id\": \"aaa-aaa-aaa\",\n      \"metadata\": {\n        \"ci\": {\n          \"pipeline\": {\n            \"url\": \"pariatur ullamco sed\"\n          },\n          \"provider\": {\n            \"name\": \"adipisicing exercitation laborum non\"\n          }\n        },\n        \"git\": {\n          \"branch\": \"tempor fugiat consequat Lorem\",\n          \"commitSha\": \"esse aliqua\"\n        }\n      }\n    }\n  ]\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/synthetics/tests/trigger",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "tests",
            "trigger"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"batch_id\": \"anim quis\",\n  \"locations\": [\n    {\n      \"id\": -79104764,\n      \"name\": \"laborum\"\n    },\n    {\n      \"id\": -12473023,\n      \"name\": \"ullamco eu\"\n    }\n  ],\n  \"results\": [\n    {\n      \"device\": \"laptop_large\",\n      \"location\": -53475818,\n      \"public_id\": \"Excepteur et\",\n      \"result_id\": \"in\"\n    },\n    {\n      \"device\": \"laptop_large\",\n      \"location\": 59458053,\n      \"public_id\": \"ut labore\",\n      \"result_id\": \"quis tempor cillum est eu\"\n    }\n  ],\n  \"triggered_check_ids\": [\n    \"in irure culpa\",\n    \"sit ad do Ut esse\"\n  ]\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"tests\": [\n    {\n      \"public_id\": \"aaa-aaa-aaa\",\n      \"metadata\": {\n        \"ci\": {\n          \"pipeline\": {\n            \"url\": \"aliquip in ex do\"\n          },\n          \"provider\": {\n            \"name\": \"nostrud culpa\"\n          }\n        },\n        \"git\": {\n          \"branch\": \"esse\",\n          \"commitSha\": \"occaecat incididunt aute exercitation\"\n        }\n      }\n    },\n    {\n      \"public_id\": \"aaa-aaa-aaa\",\n      \"metadata\": {\n        \"ci\": {\n          \"pipeline\": {\n            \"url\": \"pariatur ullamco sed\"\n          },\n          \"provider\": {\n            \"name\": \"adipisicing exercitation laborum non\"\n          }\n        },\n        \"git\": {\n          \"branch\": \"tempor fugiat consequat Lorem\",\n          \"commitSha\": \"esse aliqua\"\n        }\n      }\n    }\n  ]\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/synthetics/tests/trigger",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "tests",
            "trigger"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    },
    {
      "name": "Too many requests",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"tests\": [\n    {\n      \"public_id\": \"aaa-aaa-aaa\",\n      \"metadata\": {\n        \"ci\": {\n          \"pipeline\": {\n            \"url\": \"aliquip in ex do\"\n          },\n          \"provider\": {\n            \"name\": \"nostrud culpa\"\n          }\n        },\n        \"git\": {\n          \"branch\": \"esse\",\n          \"commitSha\": \"occaecat incididunt aute exercitation\"\n        }\n      }\n    },\n    {\n      \"public_id\": \"aaa-aaa-aaa\",\n      \"metadata\": {\n        \"ci\": {\n          \"pipeline\": {\n            \"url\": \"pariatur ullamco sed\"\n          },\n          \"provider\": {\n            \"name\": \"adipisicing exercitation laborum non\"\n          }\n        },\n        \"git\": {\n          \"branch\": \"tempor fugiat consequat Lorem\",\n          \"commitSha\": \"esse aliqua\"\n        }\n      }\n    }\n  ]\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/synthetics/tests/trigger",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "tests",
            "trigger"
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    }
  ]
}