Chilkat Online Tools

phpExt / Datadog API Collection / Mute a host

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$http = new CkHttp();

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

// The following JSON is sent in the request body.

// {
//   "end": 1579098130,
//   "message": "Muting this host for a test!",
//   "override": false
// }

$json = new CkJsonObject();
$json->UpdateInt('end',1579098130);
$json->UpdateString('message','Muting this host for a test!');
$json->UpdateBool('override',false);

$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/host/:host_name/mute','application/json',$json);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);

$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->header() . "\n";
    print 'Failed.' . "\n";

    exit;
}

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

// {
//   "action": "Muted",
//   "end": 1579098130,
//   "hostname": "test.host",
//   "message": "Muting this host for a test!"
// }

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

$action = $jResp->stringOf('action');
$v_end = $jResp->IntOf('end');
$hostname = $jResp->stringOf('hostname');
$message = $jResp->stringOf('message');

?>

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "end": 1579098130,
  "message": "Muting this host for a test!",
  "override": false
}'
https://api.app.ddog-gov.com/api/v1/host/:host_name/mute

Postman Collection Item JSON

{
  "name": "Mute a host",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"end\": 1579098130,\n  \"message\": \"Muting this host for a test!\",\n  \"override\": false\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v1/host/:host_name/mute",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "host",
        ":host_name",
        "mute"
      ],
      "variable": [
        {
          "key": "host_name",
          "value": "tempor Ut sed velit"
        }
      ]
    },
    "description": "Mute a host."
  },
  "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  \"end\": 1579098130,\n  \"message\": \"Muting this host for a test!\",\n  \"override\": false\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/host/:host_name/mute",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "host",
            ":host_name",
            "mute"
          ],
          "variable": [
            {
              "key": "host_name"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"action\": \"Muted\",\n  \"end\": 1579098130,\n  \"hostname\": \"test.host\",\n  \"message\": \"Muting this host for a test!\"\n}"
    },
    {
      "name": "Invalid Parameter Error",
      "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  \"end\": 1579098130,\n  \"message\": \"Muting this host for a test!\",\n  \"override\": false\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/host/:host_name/mute",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "host",
            ":host_name",
            "mute"
          ],
          "variable": [
            {
              "key": "host_name"
            }
          ]
        }
      },
      "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": "Forbidden",
      "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  \"end\": 1579098130,\n  \"message\": \"Muting this host for a test!\",\n  \"override\": false\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/host/:host_name/mute",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "host",
            ":host_name",
            "mute"
          ],
          "variable": [
            {
              "key": "host_name"
            }
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_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  \"end\": 1579098130,\n  \"message\": \"Muting this host for a test!\",\n  \"override\": false\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/host/:host_name/mute",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "host",
            ":host_name",
            "mute"
          ],
          "variable": [
            {
              "key": "host_name"
            }
          ]
        }
      },
      "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}"
    }
  ]
}