{id}/dashboards/{id}/variables/{id}

Note: When making API requests, ensure the following headers are included:

  • Authorization: Bearer UserToken (replace UserToken with your actual access token. For details on how to obtain the token, refer Actions on a user section.
  • Content-Type: application/json
  • Accept: application/json

Manages a single variable defined within a specific dashboard.

Get a dashboard by ID.

Path Parameters

  • idstringrequired

    Unique ID of the dashboard collection.

  • idstringrequired

    Unique ID of the dashboard.

  • idstringrequired

    Unique ID of the variable.

Responses

  • idstring

    Unique identifier of the variable.

  • namestring

    Name of the variable.

  • defaultValuestring

    Default value assigned to the variable.

  • tagstring

    The tag associated with the variable used for filtering (e.g., hostName, os, make).

  • entityTypestring

    Type of the entity the variable applies to. For example, resource.

  • querystring

    Query expression used to dynamically generate values for the variable.

Loading Examples...
  • Updates the configuration of an existing variable within a dashboard.

Path Parameters

  • idstringrequired

    Unique ID of the dashboard collection.

  • idstringrequired

    Unique ID of the dashboard.

  • idstringrequired

    Unique ID of the variable.

Request Body

application/json

  • idstring

    Unique identifier of the variable.

  • namestring

    Name of the variable.

  • defaultValuestring

    Default value assigned to the variable.

  • tagstring

    Tag key used for filtering the entity data.

  • entityTypestring

    Type of the entity to which the variable is applied.

  • querystring

    Optional query to fetch values dynamically.

Loading Examples...

Responses

204No Content

Deletes the specified variable from the given dashboard.

Path Parameters

  • idstringrequired

    Unique ID of the dashboard collection.

  • idstringrequired

    Unique ID of the dashboard.

  • idstringrequired

    Unique ID of the variable.

Responses

204No Content