Chilkat Online Tools

Powershell / Datadog API Collection / Update a tag configuration

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.

# {
#   "data": {
#     "id": "<string>",
#     "type": "manage_tags",
#     "attributes": {
#       "aggregations": [
#         {
#           "time": "avg",
#           "space": "max"
#         },
#         {
#           "time": "count",
#           "space": "sum"
#         }
#       ],
#       "include_percentiles": "<boolean>"
#     }
#   }
# }

$json = New-Object Chilkat.JsonObject
$json.UpdateString("data.id","<string>")
$json.UpdateString("data.type","manage_tags")
$json.UpdateString("data.attributes.aggregations[0].time","avg")
$json.UpdateString("data.attributes.aggregations[0].space","max")
$json.UpdateString("data.attributes.aggregations[1].time","count")
$json.UpdateString("data.attributes.aggregations[1].space","sum")
$json.UpdateString("data.attributes.include_percentiles","<boolean>")

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

$sbRequestBody = New-Object Chilkat.StringBuilder
$json.EmitSb($sbRequestBody)

$resp = $http.PTextSb("PATCH","https://api.app.ddog-gov.com/api/v2/metrics/:metric_name/tags",$sbRequestBody,"utf-8","application/json",$false,$false)
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)

# {
#   "data": {
#     "attributes": {
#       "aggregations": [
#         {
#           "time": "avg",
#           "space": "avg"
#         },
#         {
#           "time": "count",
#           "space": "min"
#         }
#       ],
#       "created_at": "<dateTime>",
#       "include_percentiles": "<boolean>",
#       "metric_type": "gauge",
#       "modified_at": "<dateTime>",
#       "tags": [
#         "<string>",
#         "<string>"
#       ]
#     },
#     "id": "<string>",
#     "type": "manage_tags"
#   }
# }

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

$Created_at = $jResp.StringOf("data.attributes.created_at")
$Include_percentiles = $jResp.StringOf("data.attributes.include_percentiles")
$Metric_type = $jResp.StringOf("data.attributes.metric_type")
$Modified_at = $jResp.StringOf("data.attributes.modified_at")
$Id = $jResp.StringOf("data.id")
$v_Type = $jResp.StringOf("data.type")
$i = 0
$count_i = $jResp.SizeOfArray("data.attributes.aggregations")
while ($i -lt $count_i) {
    $jResp.I = $i
    $time = $jResp.StringOf("data.attributes.aggregations[i].time")
    $space = $jResp.StringOf("data.attributes.aggregations[i].space")
    $i = $i + 1
}

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

Curl Command

curl -X PATCH
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "data": {
    "id": "<string>",
    "type": "manage_tags",
    "attributes": {
      "aggregations": [
        {
          "time": "avg",
          "space": "max"
        },
        {
          "time": "count",
          "space": "sum"
        }
      ],
      "include_percentiles": "<boolean>"
    }
  }
}'
https://api.app.ddog-gov.com/api/v2/metrics/:metric_name/tags

Postman Collection Item JSON

{
  "name": "Update a tag configuration",
  "request": {
    "method": "PATCH",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"data\": {\n    \"id\": \"<string>\",\n    \"type\": \"manage_tags\",\n    \"attributes\": {\n      \"aggregations\": [\n        {\n          \"time\": \"avg\",\n          \"space\": \"max\"\n        },\n        {\n          \"time\": \"count\",\n          \"space\": \"sum\"\n        }\n      ],\n      \"include_percentiles\": \"<boolean>\"\n    }\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "metrics",
        ":metric_name",
        "tags"
      ],
      "variable": [
        {
          "key": "metric_name",
          "value": "<string>"
        }
      ]
    },
    "description": "Update the tag configuration of a metric or percentile aggregations of a distribution metric or custom aggregations\nof a count, rate, or gauge metric.\nCan only be used with application keys from users with the `Manage Tags for Metrics` permission."
  },
  "response": [
    {
      "name": "OK",
      "originalRequest": {
        "method": "PATCH",
        "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  \"data\": {\n    \"id\": \"<string>\",\n    \"type\": \"manage_tags\",\n    \"attributes\": {\n      \"aggregations\": [\n        {\n          \"time\": \"avg\",\n          \"space\": \"max\"\n        },\n        {\n          \"time\": \"count\",\n          \"space\": \"sum\"\n        }\n      ],\n      \"include_percentiles\": \"<boolean>\"\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "metrics",
            ":metric_name",
            "tags"
          ],
          "variable": [
            {
              "key": "metric_name"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\n    \"attributes\": {\n      \"aggregations\": [\n        {\n          \"time\": \"avg\",\n          \"space\": \"avg\"\n        },\n        {\n          \"time\": \"count\",\n          \"space\": \"min\"\n        }\n      ],\n      \"created_at\": \"<dateTime>\",\n      \"include_percentiles\": \"<boolean>\",\n      \"metric_type\": \"gauge\",\n      \"modified_at\": \"<dateTime>\",\n      \"tags\": [\n        \"<string>\",\n        \"<string>\"\n      ]\n    },\n    \"id\": \"<string>\",\n    \"type\": \"manage_tags\"\n  }\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "PATCH",
        "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  \"data\": {\n    \"id\": \"<string>\",\n    \"type\": \"manage_tags\",\n    \"attributes\": {\n      \"aggregations\": [\n        {\n          \"time\": \"avg\",\n          \"space\": \"max\"\n        },\n        {\n          \"time\": \"count\",\n          \"space\": \"sum\"\n        }\n      ],\n      \"include_percentiles\": \"<boolean>\"\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "metrics",
            ":metric_name",
            "tags"
          ],
          "variable": [
            {
              "key": "metric_name"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    },
    {
      "name": "Forbidden",
      "originalRequest": {
        "method": "PATCH",
        "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  \"data\": {\n    \"id\": \"<string>\",\n    \"type\": \"manage_tags\",\n    \"attributes\": {\n      \"aggregations\": [\n        {\n          \"time\": \"avg\",\n          \"space\": \"max\"\n        },\n        {\n          \"time\": \"count\",\n          \"space\": \"sum\"\n        }\n      ],\n      \"include_percentiles\": \"<boolean>\"\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "metrics",
            ":metric_name",
            "tags"
          ],
          "variable": [
            {
              "key": "metric_name"
            }
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    },
    {
      "name": "Unprocessable Entity",
      "originalRequest": {
        "method": "PATCH",
        "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  \"data\": {\n    \"id\": \"<string>\",\n    \"type\": \"manage_tags\",\n    \"attributes\": {\n      \"aggregations\": [\n        {\n          \"time\": \"avg\",\n          \"space\": \"max\"\n        },\n        {\n          \"time\": \"count\",\n          \"space\": \"sum\"\n        }\n      ],\n      \"include_percentiles\": \"<boolean>\"\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "metrics",
            ":metric_name",
            "tags"
          ],
          "variable": [
            {
              "key": "metric_name"
            }
          ]
        }
      },
      "status": "Unprocessable Entity (WebDAV) (RFC 4918)",
      "code": 422,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    },
    {
      "name": "Too Many Requests",
      "originalRequest": {
        "method": "PATCH",
        "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  \"data\": {\n    \"id\": \"<string>\",\n    \"type\": \"manage_tags\",\n    \"attributes\": {\n      \"aggregations\": [\n        {\n          \"time\": \"avg\",\n          \"space\": \"max\"\n        },\n        {\n          \"time\": \"count\",\n          \"space\": \"sum\"\n        }\n      ],\n      \"include_percentiles\": \"<boolean>\"\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "metrics",
            ":metric_name",
            "tags"
          ],
          "variable": [
            {
              "key": "metric_name"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    }
  ]
}