Upsert a Cloud Cost Management tag description

PUT https://api.ap1.datadoghq.com/api/v2/cost/tag_descriptions/{tag_key}https://api.ap2.datadoghq.com/api/v2/cost/tag_descriptions/{tag_key}https://api.datadoghq.eu/api/v2/cost/tag_descriptions/{tag_key}https://api.ddog-gov.com/api/v2/cost/tag_descriptions/{tag_key}https://api.us2.ddog-gov.com/api/v2/cost/tag_descriptions/{tag_key}https://api.datadoghq.com/api/v2/cost/tag_descriptions/{tag_key}https://api.us3.datadoghq.com/api/v2/cost/tag_descriptions/{tag_key}https://api.us5.datadoghq.com/api/v2/cost/tag_descriptions/{tag_key}

Overview

Create or update a Cloud Cost Management tag key description. The new description and optional cloud scoping are supplied in the request body. Omit cloud to set a cross-cloud default for the tag key. This endpoint requires the cloud_cost_management_write permission.

OAuth apps require the cloud_cost_management_write authorization scope to access this endpoint.

Arguments

Path Parameters

Name

Type

Description

tag_key [required]

string

The tag key whose description is being upserted.

Request

Body Data (required)

Expand All

Field

Type

Description

data [required]

object

Resource envelope carrying the tag key description being upserted. The id is informational; the authoritative tag key is taken from the URL path.

attributes [required]

object

Mutable attributes set when creating or updating a Cloud Cost Management tag key description.

cloud

string

Cloud provider this description applies to (for example, aws). Omit to set the cross-cloud default for the tag key.

description [required]

string

The human-readable description for the tag key.

id

string

Identifier of the tag key the description applies to. Matches the tag_key path parameter.

type [required]

enum

Type of the Cloud Cost Management tag description resource. Allowed enum values: cost_tag_description

default: cost_tag_description

{
  "data": {
    "attributes": {
      "cloud": "aws",
      "description": "AWS account that owns this cost."
    },
    "id": "account_id",
    "type": "cost_tag_description"
  }
}

Response

No Content

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  ## default
# 

# Path parameters
export tag_key="CHANGE_ME"
# Curl command
curl -X PUT "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/cost/tag_descriptions/${tag_key}" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": { "attributes": { "cloud": "aws", "description": "AWS account that owns this cost." }, "id": "account_id", "type": "cost_tag_description" } } EOF