WHERE DO I START?
You are here:... (Miscellaneous) > API > Elements
  • Top ↑

Elements

The elements API allows you to access and manage your elements, with available activities including maintaining tags, deleting elements, getting metric results, and more.

Tip   To explore Netuitive's REST API and test some requests, go here.

Get a list of elements

This method will return a list of elements filtered by any parameters you pass into the method call.

Method GET URL https://api.app.netuitive.com/elements
Parameters Required/Optional Description
id Optional Query parameter. The FQN of the element(s).
name Optional Query parameter. The name of the element.
type Optional Query parameter. The type of element.
location Optional Query parameter. The location of the element is used for filtering and display purposes in Netuitive. The location can reflect either the element's physical location or business needs.
tags Optional Query parameter. The name of the tag.
startTime Optional Query parameter. The start of the window of time from which elements will be returned. The startTime must be in ISO 8601 format. The default startTime is 12:00 AM in the authenticating user's specified time zone.
endTime Optional Query parameter. The end of the window of time from which elements will be returned. The endTime must be in ISO 8601 format. The default endTime is the current time.
state Optional Query parameter. The state of the element reflected by the netuitive.metrics.collected.percent metric. False means no metrics are being collected; True means any number of metrics are being collected.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Get Element IDs

This method will return a list of element IDs for elements seen within a given timeframe.

Method GET URL https://api.app.netuitive.com/elements/ids
Parameters Required/Optional Description
startTime Optional Query parameter. The start of the window of time from which elements will be returned. The startTime must be in ISO 8601 format. The default startTime is 12:00 AM in the authenticating user's specified time zone.
endTime Optional Query parameter. The end of the window of time from which elements will be returned. The endTime must be in ISO 8601 format. The default endTime is the current time.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Element Name Preview

This method will return a name preview for an element using the given template.

Method POST URL https://api.app.netuitive.com/elements/name/preview
Parameters Required/Optional Description
elementTemplate Required Body parameter; see below.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Input JSON Format for Request Body

Attribute Required/Optional Description
elementTemplate Required

Template for creating a custom element display name. It contains two attributes:

  • elementId (optional)
    • The ID of the element you want to create a custom display name for.
  • template (optional)
    • The template used to parse your element name.

Get a list of events for an element

This method will return a list of events for a given element.

Method GET URL https://api.app.netuitive.com/elements/{elementId}/events
Important   Replace {elementId} in the above URL with the element ID from any of your elements.
Parameters Required/Optional Description
elementId Required URL (path) parameter. The ID of the element.
duration Optional Query parameter. Gives Netuitive an ISO 8601-formatted duration time frame to retrieve data. The duration ends at the current time and begins anytime in the past two weeks. The duration parameter will take precedence over startTime and endTime if all attributes are included in your request.
startTime Optional Query parameter. The start of the window of time from which events will be returned. The startTime must be in ISO 8601 format. The default startTime is 12:00 AM in the authenticating user's specified time zone.
endTime Optional Query parameter. The end of the window of time from which events will be returned. The endTime must be in ISO 8601 format. The default endTime is the current time.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Get metadata for a metric

This method will return a list of metadata for a metric.

Method GET URL https://api.app.netuitive.com/elements/{elementId}/metrics
Important   Replace {elementId} in the above URL with the element ID from any of your elements.
Parameters Required/Optional Description
elementId Required URL (path) parameter. The ID of the element.
metricFQN Optional Query parameter. The metric's fully qualified name.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Get the metric results for an element

This method will return the metric results for a given metric associated with a given element.

Method GET URL https://api.app.netuitive.com/elements/{elementId}/metrics/{metricId}/samples
Important   Replace {elementId} in the above URL with the element ID from any of your elements. Replace {metricId} with the metric ID from a metric associated with the given element.
Parameters Required/Optional Description
elementId Required URL (path) parameter. The ID of the element.
metricId Required URL (path) parameter. The ID of the metric associated with the element.
duration Optional Query parameter. Gives Netuitive an ISO 8601-formatted duration time frame to retrieve data. The duration ends at the current time and begins anytime in the past two weeks. The duration parameter will take precedence over startTime and endTime if all attributes are included in your request.
startTime Optional Query parameter. The start of the window of time from which metric results will be returned. The startTime must be in ISO 8601 format. The default startTime is 12:00 AM in the authenticating user's specified time zone.
endTime Optional Query parameter. The end of the window of time from which metric results will be returned. The endTime must be in ISO 8601 format. The default endTime is the current time.
rollup Optional Query parameter. Select the data aggregation roll-up you wish to receive: ZERO (none), PT5M (past 5 minutes), PT1H (past 1 hour), or PT24H (past 24 hours).

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Get the metric tags for an element

This method will return a list of tags for a given metric associated with a given element.

Method GET URL https://api.app.netuitive.com/elements/{elementId}/metrics/{metricId}/tags
Important   Replace {elementId} in the above URL with the element ID from any of your elements. Replace {metricId} with the metric ID from a metric associated with the given element.
Parameters Required/Optional Description
elementId Required URL (path) parameter. The ID of the element.
metricId Required URL (path) parameter. The ID of the metric associated with the element.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Create a metric tag for an element

This method will create a tag for a given metric associated with a given element.

Method POST URL https://api.app.netuitive.com/elements/{elementId}/metrics/{metricId}/tags
Important   Replace {elementId} in the above URL with the element ID from any of your elements. Replace {metricId} with the metric ID from a metric associated with the given element.
Parameters Required/Optional Description
elementId Required URL (path) parameter. The ID of the element.
metricId Required URL (path) parameter. The ID of the metric associated with the element.
tagWrapper Optional Body parameter. See below.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Input JSON Format for Request Body

Attribute Required/Optional Description
tagWrapper Optional Tags used for filtering in Netuitive. In the format of [{"name":"key1", "value":"value1"}, {"name":"key2", "value":"value2"}, (etc.)].

Update a metric tag for an element

This method will update a specified tag for a given metric associated with a given element.

Method PUT URL https://api.app.netuitive.com/elements/{elementId}/metrics/{metricId}/tags/{tagName}
Important   Replace {elementId} in the above URL with the element ID from any of your elements. Replace {metricId} with the metric ID from a metric associated with the given element. Replace {tagName} with the name of the tag you wish to modify.
Parameters Required/Optional Description
elementId Required URL (path) parameter. The ID of the element.
metricId Required URL (path) parameter. The ID of the metric associated with the element.
tagName Required URL (path) parameter. The name of the tag associated with the metric.
tagWrapper Required Body parameter. See below.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Input JSON Format for Request Body

Attribute Required/Optional Description
tagWrapper Required Tags used for filtering in Netuitive. In the format of [{"name":"key1", "value":"value1"}, {"name":"key2", "value":"value2"}, (etc.)].

Delete a metric tag for an element

This method will delete a specified tag for a given metric associated with a given element.

Method DELETE URL https://api.app.netuitive.com/elements/{elementId}/metrics/{metricId}/tags/{tag}
Important   Replace {elementId} in the above URL with the element ID from any of your elements. Replace {metricId} with the metric ID from a metric associated with the given element. Replace {tag} with the name of the tag you wish to delete.
Parameters Required/Optional Description
elementId Required URL (path) parameter. The ID of the element.
metricId Required URL (path) parameter. The ID of the metric associated with the element.
tag Required URL (path) parameter. The name of the tag associated with the metric.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Get the policies associated with an element

This method will return a list of policies associated with a given element.

Method GET URL https://api.app.netuitive.com/elements/{elementId}/policies
Important   Replace {elementId} in the above URL with the element ID from any of your elements.
Parameters Required/Optional Description
elementId Required URL (path) parameter. The ID of the element.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Get the tags for an element

This method will return a list of tags for a given element.

Method GET URL https://api.app.netuitive.com/elements/{elementId}/tags
Important   Replace {elementId} in the above URL with the element ID from any of your elements.
Parameters Required/Optional Description
elementId Required URL (path) parameter. The ID of the element.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Create a tag for an element

This method will create a tag for a given element.

Method POST URL https://api.app.netuitive.com/elements/{elementId}/tags
Important   Replace {elementId} in the above URL with the element ID from any of your elements.
Parameters Required/Optional Description
elementId Required URL (path) parameter. The ID of the element.
tagWrapper Required Body parameter. See below.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Input JSON Format for Request Body

Attribute Required/Optional Description
tagWrapper Required Tags used for filtering in Netuitive. In the format of [{"name":"key1", "value":"value1"}, {"name":"key2", "value":"value2"}, (etc.)].
Tip   Creating the tag n.state.maintenance with a value of true places an element in maintenance mode. To read more about maintenance mode or to turn maintenance mode on or off via the UI, see Maintenance Mode.

Update the tags for an element

This method will update a specified tag for a given element.

Method PUT URL https://api.app.netuitive.com/elements/{elementId}/tags/{tagName}
Important   Replace {elementId} in the above URL with the element ID from any of your elements. Replace {tagName} with the name of the tag you wish to modify.
Parameters Required/Optional Description
elementId Required URL (path) parameter. The ID of the element.
tag Required URL (path) parameter. The name of the tag associated with the metric.
tagWrapper Required Body parameter. See below.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Input JSON Format for Request Body

Attribute Required/Optional Description
tagWrapper Required Tags used for filtering in Netuitive. In the format of [{"name":"key1", "value":"value1"}, {"name":"key2", "value":"value2"}, (etc.)].

Delete a tag for an element

This method will delete a specified tag for a given element.

Method DELETE URL https://api.app.netuitive.com/elements/{elementId}/tags/{tag}
Important   Replace {elementId} in the above URL with the element ID from any of your elements. Replace {tag} with the name of the tag you wish to delete.
Parameters Required/Optional Description
elementId Required URL (path) parameter. The ID of the element.
tag Required URL (path) parameter. The name of the tag associated with the metric.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Delete an element

This method will delete a specified element.

Method DELETE URL https://api.app.netuitive.com/elements/{id}
Important   Replace {id} in the above URL with the element ID from any of your elements.
Parameters Required/Optional Description
id Required URL (path) parameter. The ID of the element.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Get an element by ID

This method will return a specified element's information.

Method GET URL https://api.app.netuitive.com/elements/{id}
Important   Replace {id} in the above URL with the element ID from any of your elements.
Parameters Required/Optional Description
id Required URL (path) parameter. The ID of the element.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Get element relationships

This method will return a list elements that are related to the given element.

Method GET URL https://api.app.netuitive.com/elements/{id}/relationships
Important   Replace {id} in the above URL with the element ID from any of your elements.
Parameters Required/Optional Description
id Required URL (path) parameter. The ID of the element.
levels Optional The number of levels of relationships returned, e.g., 2 would return an element related to a listed element related to the given element.
startTime Optional Query parameter. The start of the window of time from which elements will be returned. The startTime must be in ISO 8601 format. The default startTime is 12:00 AM in the authenticating user's specified time zone.
endTime Optional Query parameter. The end of the window of time from which elements will be returned. The endTime must be in ISO 8601 format. The default endTime is the current time.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)