Metric resources

 {
  "name": "<name>",
  "label": "<label>",
  "description": "<description>",
  "tags": [ "<tag>" ],
  "units": "<units>",
  "minimum": "<minimum>",
  "maximum": "<maximum>",
  "scaleFactor": "<factor>",
  "scaleFactorUnits": "<units>"
  "isRate": <boolean>
}

Request example

 curl https://YOUR-API-ENDPOINT/v1/dictionary/metrics \
  -H "zenoss-api-key: YOUR-API-KEY" \
  -X POST -s \
  -d '{
  "name": "sysUpTime_sysUpTime",
  "label": "Custom Uptime"
}'

Response example

 {
  "name": "sysUpTime_sysUpTime",
  "layer": "YOUR-ORGANIZATION-NAME",
  "label": "Custom Uptime"
}

Request example

 curl https://YOUR-API-ENDPOINT/v1/dictionary/metrics/sysUpTime_sysUpTime \
  -H "zenoss-api-key: YOUR-API-KEY" \
  -X GET -s

Response example (default)

 {
  "name": "sysUpTime_sysUpTime",
  "label": "Uptime",
  "description": "The time (in hundredths of a second) ...",
  "units": "centiseconds",
  "minimum": "0",
  "isRate": false
}

Response example (custom)

 {
  "name": "sysUpTime_sysUpTime",
  "layer": "YOUR-ORGANIZATION-NAME",
  "description": "This has been overridden.",
  "isRate": false
}

Request example

 curl https://YOUR-API-ENDPOINT/v1/dictionary/metrics:batchGet \
  -H "zenoss-api-key: YOUR-API-KEY" \
  -X POST -s \
  -d '{
  "name": ["sysUpTime_sysUpTime", "ifInOctets_ifInOctets"]
}'

Response example

 {
  "metrics": [
    {
      "name": "sysUpTime_sysUpTime",
      "label": "Uptime",
      "description": "The time (in hundredths of a second) since the network management portion of the system was last re-initialized.",
      "units": "centiseconds",
      "minimum": "0",
      "isRate": false
    },
    {
      "name": "ifInOctets_ifInOctets",
      "label": "Interface Bytes In",
      "description": "The total number of octets received on the interface, including framing characters.",
      "units": "count",
      "minimum": "0",
      "isRate": false
    }
  ]
}

Request example

 curl https://YOUR-API-ENDPOINT/v1/dictionary/metrics \
  -H "zenoss-api-key: YOUR-API-KEY" \
  -X GET -s

Response example (truncated)

 {
  "metrics": [
    {
      "name": "ActiveConnectionCount_ActiveConnectionCount",
      "label": "Active Connection Count",
      "description": "The total number of concurrent TCP connections active from clients to the load balancer and from the load balancer to targets.\n\nSource: AWS CloudWatch\nNamespace: AWS/ApplicationELB\nMetric: ActiveConnectionCount",
      "units": "connections",
      "minimum": "0",
      "isRate": false
    },
    {
      "name": "ActiveFlowCount_ActiveFlowCount",
      "label": "Active Flow Count",
      "description": "The total number of concurrent flows (or connections) from clients to targets. This metric includes connections in the SYN_SENT and ESTABLISHED states. TCP connections are not terminated at the load balancer, so a client opening a TCP connection to a target counts as a single flow.\n\nSource: AWS CloudWatch\nNamespace: AWS/NetworkELB\nMetric: ActiveFlowCount",
      "units": "flows",
      "minimum": "0",
      "isRate": false
    },
    {
      "name": "ActiveTransactions_ActiveTransactions",
      "label": "Active Transactions",
      "description": "Active Transactions",
      "units": "transactions",
      "minimum": "0",
      "isRate": false
    },
    .
    .
    .
  ],
  "totalCount": "1604"
}

Update requests use the same fields as create requests. The name field is required but cannot be changed.

Request example

 curl https://YOUR-API-ENDPOINT/v1/dictionary/metrics/sysUpTime_sysUpTime \
  -H "zenoss-api-key: YOUR-API-KEY" \
  -X PATCH -s \
  -d '{
  "name": "sysUpTime_sysUpTime",
  "label": "Updated Uptime"
}'

Response example

 {
  "name": "sysUpTime_sysUpTime",
  "layer": "YOUR-ORGANIZATION-NAME",
  "label": "Updated Uptime"
}

Request example

 curl https://YOUR-API-ENDPOINT/v1/dictionary/metrics/sysUpTime_sysUpTime \
  -H "zenoss-api-key: YOUR-API-KEY" \
  -X DELETE -s

Response example

 {}