o11y IM How to update the description of a metric or dimension through REST API

Applicability

Description

You can easily read or update the description of a dimension or metric using Observability's API endpoints . For this example, we will be using the PUT method to update an existing metric's description. 

Using PUT REST API - https://api.eu0.signalfx.com/v2/metric/{metric_name}

PUT /v2/metric/<metric/dimension name> HTTP/1.1
Host: api.<realm>.signalfx.com
X-SF-TOKEN: {INGEST ORG TOKEN}
Content-Type: application/json
{
    "description": "test put api update metric description",
    "type": "GAUGE"
}

Here's an example using PAW:

GET /v2/metric?query=sf_metric%3Acpu.utilization HTTP/1.1
X-SF-TOKEN: <token_id>
Host: <API host>

 
Here's an example using CURL method
====

curl --location --request PUT 'https://api.<realm>.signalfx.com/v2/metric/<metric/dimension name>' \
--header 'X-SF-TOKEN: { INGEST ORG TOKEN}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "test put api update metric description",
    "type": "GAUGE"
}'

Investigation