Chilkat Online Tools

Powershell / Datadog API Collection / Add tags to a host

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

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

$http = New-Object Chilkat.Http

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

# The following JSON is sent in the request body.

# {
#   "host": "test.host",
#   "tags": [
#     "environment:production",
#     "environment:production"
#   ]
# }

$json = New-Object Chilkat.JsonObject
$json.UpdateString("host","test.host")
$json.UpdateString("tags[0]","environment:production")
$json.UpdateString("tags[1]","environment:production")

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

$resp = $http.PostJson3("https://api.app.ddog-gov.com/api/v1/tags/hosts/:host_name?source=chef","application/json",$json)
if ($http.LastMethodSuccess -eq $false) {
    $($http.LastErrorText)
    exit
}

$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)

$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($resp.Header)
    $("Failed.")

    exit
}

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

# {
#   "host": "test.host",
#   "tags": [
#     "environment:production",
#     "environment:production"
#   ]
# }

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

$host = $jResp.StringOf("host")
$i = 0
$count_i = $jResp.SizeOfArray("tags")
while ($i -lt $count_i) {
    $jResp.I = $i
    $strVal = $jResp.StringOf("tags[i]")
    $i = $i + 1
}

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "host": "test.host",
  "tags": [
    "environment:production",
    "environment:production"
  ]
}'
https://api.app.ddog-gov.com/api/v1/tags/hosts/:host_name?source=chef

Postman Collection Item JSON

{
  "name": "Add tags to a host",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"host\": \"test.host\",\n  \"tags\": [\n    \"environment:production\",\n    \"environment:production\"\n  ]\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v1/tags/hosts/:host_name?source=chef",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "tags",
        "hosts",
        ":host_name"
      ],
      "query": [
        {
          "key": "source",
          "value": "chef",
          "description": "The source of the tags.\n[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value)."
        }
      ],
      "variable": [
        {
          "key": "host_name",
          "value": "tempor Ut sed velit"
        }
      ]
    },
    "description": "This endpoint allows you to add new tags to a host,\noptionally specifying where these tags come from."
  },
  "response": [
    {
      "name": "Created",
      "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  \"host\": \"test.host\",\n  \"tags\": [\n    \"environment:production\",\n    \"environment:production\"\n  ]\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/tags/hosts/:host_name?source=chef",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "tags",
            "hosts",
            ":host_name"
          ],
          "query": [
            {
              "key": "source",
              "value": "chef",
              "description": "The source of the tags.\n[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value)."
            }
          ],
          "variable": [
            {
              "key": "host_name"
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"host\": \"test.host\",\n  \"tags\": [\n    \"environment:production\",\n    \"environment:production\"\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  \"host\": \"test.host\",\n  \"tags\": [\n    \"environment:production\",\n    \"environment:production\"\n  ]\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/tags/hosts/:host_name?source=chef",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "tags",
            "hosts",
            ":host_name"
          ],
          "query": [
            {
              "key": "source",
              "value": "chef",
              "description": "The source of the tags.\n[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value)."
            }
          ],
          "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": "Not Found",
      "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  \"host\": \"test.host\",\n  \"tags\": [\n    \"environment:production\",\n    \"environment:production\"\n  ]\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/tags/hosts/:host_name?source=chef",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "tags",
            "hosts",
            ":host_name"
          ],
          "query": [
            {
              "key": "source",
              "value": "chef",
              "description": "The source of the tags.\n[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value)."
            }
          ],
          "variable": [
            {
              "key": "host_name"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_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  \"host\": \"test.host\",\n  \"tags\": [\n    \"environment:production\",\n    \"environment:production\"\n  ]\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/tags/hosts/:host_name?source=chef",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "tags",
            "hosts",
            ":host_name"
          ],
          "query": [
            {
              "key": "source",
              "value": "chef",
              "description": "The source of the tags.\n[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value)."
            }
          ],
          "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}"
    }
  ]
}