Elements API

About the Elements API

CloudWisdom’s Elements API can be used to create, edit, delete and review elements. Users can also update tags and policies associated with these elements. You can test these endpoints by visiting our Swagger page and by clicking the interactive buttons below.

POST to /elements/elasticsearch/elementAgg/{term}

Use this endpoint to find a count of objects based on the fields chosen for aggregation.

View Method Details.

POST to /elements/elasticsearch/elementQuery

Use this endpoint to query elements by datasource, type, and more. Supports filtering.

View Method Details.

POST to /elements/name/preview

Use this endpoint to preview custom display names for elements within the CloudWisdom UI.

View Method Details.

POST to /elements/search

This is a deprecated method. Use /elements/elasticsearch/elementQuery instead.


GET from /elements/{elementId}/events

Use this endpoint to discover events within certain time frames (days, hours, minutes).

View Method Details.

GET from /elements/{elementId}/metrics

Use this endpoint to obtain one or many metric details associated to an element.

View Method Details.

GET from /elements/{elementId}/metrics/{metricId}/samples

Use this endpoint to grab metric samples in a given rollup frequency for a specific period of time.

View Method Details.

GET from /elements/{elementId}/metrics/{metricId}/tags

Use this endpoint to get a list of tags associated to a specified metric for a given element.

View Method Details.

POST to /elements/{elementId}/metrics/{metricId}/tags

Use this endpoint to post new tags (key-value pairs) to a specified metric.

View Method Details.

PUT to /elements/{elementId}/metrics/{metricId}/tags/{tagName}

Use this endpoint to update the value of a tag for a specified metric.

View Method Details.

DELETE to /elements/{elementId}/metrics/{metricId}/tags/{tag}

Use this endpoint to delete a tag (key) from a specified metric.

View Method Details.

GET from /elements/{elementId}/policies

Use this endpoint to get a list of policies associated to an element.

View Method Details.

GET from /elements/{elementId}/tags

Use this endpoint to get a list of CloudWisdom and Source tags for a particular element.

View Method Details.

POST to /elements/{elementId}/tags

Use this endpoint to create a new tag (key-value pair) for the specified element.

View Method Details.

PUT to /elements/{elementId}/tags/{tagName}

Use this endpoint to update tag values for the specified element’s tag.

View Method Details.

DELETE to /elements/{elementId}/tags/{tag}

Use this endpoint to delete a tag for a given element.

View Method Details.

DELETE to /elements/{elementId}

Use this endpoint to delete specified elements.

View Method Details.

GET from /elements/{elementId}

Use this endpoint to get details of a specified element.

View Method Details.

GET from /elements/{elementId}/relationships

Use this endpoint to view an element’s relationships.

View Method Details.

How to Find an Element ID and Delete it via the API

You can automate element removal from CloudWisdom using two Element endpoints: /elasticsearchElementQueryUsingPOST and /elements/{id}. This is useful for keeping a clean inventory and it helps avoid false-positive alerts when routinely shutting down instances that are using the Metricly agent.

View Walkthrough.

Fetch Raw and 5 Min Samples for a Single Element

You can fetch metric samples for a single element using the /elements/{elementId}/metrics/{metricId}/samples endpoint. First you must obtain some element details from the /elements/elasticsearch/elementQuery endpoint.

View Walkthrough.