console

Make console state available to an agent.

Changed on

Store console state so an agent can read it via MCP tool get_console. The MCP client must have the same session (Authorization header) as the REST client.

put/console

Request

  • Base URL: /api/v1alpha1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1alpha1/console
  • Auth: none declared

Request body

viewstring

Query for data objects, format is DOMAIN:CLASS:SELECTOR. DOMAIN: name of a domain (e.g. k8s, log, metric, alert, trace, netflow). CLASS: name of a class in the domain (e.g. Pod, application, metric, alert, span, network). SELECTOR: domain-specific query string.

Example request

{
  "search": {
    "goals": {
      "goals": [
        "k8s:Pod",
        "metric:metric"
      ],
      "start": {
        "constraint": {
          "end": "2017-07-21T17:32:28.1341231Z"
        },
        "queries": [
          "k8s:Pod:{\"namespace\":\"default\",\"name\":\"my-pod\"}"
        ]
      }
    },
    "neighbors": {
      "start": {
        "constraint": {
          "end": "2017-07-21T17:32:28.1341231Z"
        },
        "queries": [
          "k8s:Pod:{\"namespace\":\"default\",\"name\":\"my-pod\"}"
        ]
      }
    }
  }
}

Response

Console display updated successfully

object required

Changes

    • ▲

      removed the media type text/json from the request body

    • ○

      added the media type application/json to the request body

    • ○

      added the media type application/json for the response with the status