This documentation has moved

This content now lives on the Virtana documentation site and is no longer updated. This site will be taken offline on January 31, 2027.

Go to the current documentation and update your bookmarks.

Dictionary service API

You can view the Virtana Service Observability API for metric, entity fields, and event fields resources of the dictionary service. Use the API if you want to override default dictionary entries with your own definitions, create new entries for metrics not included in the default dictionary, and manage custom entries.

Dictionary service API: Metric resources

• Create an entry (POST /v1/dictionary/metrics)
• Get one entry (GET /v1/dictionary/metrics/{name})
• Get multiple entries (POST /v1/dictionary/metrics:batchGet)
• Get all entries (GET /v1/dictionary/metrics)
• Update an entry (PATCH /v1/dictionary/metrics/{name})
• Delete an entry (DELETE /v1/dictionary/metrics/{name})

Dictionary service API: Entity fields resources

• Create an entry (POST /v1/dictionary/entity_fields)
• Get one entry (GET /v1/dictionary/entity_fields/{name})
• Get all entries (GET /v1/dictionary/entity_fields)
• Update an entry (PATCH /v1/dictionary/entity_fields/{name})
• Delete an entry (DELETE /v1/dictionary/entity_fields/{name})

Dictionary service API: Event fields resources

• Create an entry (POST /v1/dictionary/event_fields)
• Get one entry (GET /v1/dictionary/event_fields/{name})
• Get all entries (GET /v1/dictionary/event_fields)
• Update an entry (PATCH /v1/dictionary/event_fields/{name})
• Delete an entry (DELETE /v1/dictionary/event_fields/{name})