ListMonitors - Cortex XCOR Documentation

cURL

curl --request GET \
  --url https://{tenant}.chronosphere.io/api/v1/config/monitors \
  --header 'API-Token: <api-key>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenant}.chronosphere.io/api/v1/config/monitors"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("API-Token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {'API-Token': '<api-key>'}};

fetch('https://{tenant}.chronosphere.io/api/v1/config/monitors', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "monitors": [
    {
      "name": "<string>",
      "annotations": {},
      "bucket_slug": "<string>",
      "collection": {
        "slug": "<string>",
        "type": "SIMPLE"
      },
      "collection_slug": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "graphite_query": "sumSeries(stats.timers.*.mean_90)",
      "interval_secs": 123,
      "labels": {},
      "logging_query": "<string>",
      "notification_policy_slug": "<string>",
      "notification_template": "{\"title\": \"[{{.Severity}}] {{.Labels.service}} threshold exceeded\", \"description\": \"{{.Labels.env}} crossed {{.ThresholdOp}} {{.Threshold}}\"}",
      "prometheus_query": "up{job=\"prometheus\"} == 0",
      "schedule": {
        "timezone": "<string>",
        "weekly_schedule": {
          "friday": {
            "active": "ALL_DAY",
            "ranges": [
              {
                "end_hh_mm": "<string>",
                "start_hh_mm": "<string>"
              }
            ]
          },
          "monday": {
            "active": "ALL_DAY",
            "ranges": [
              {
                "end_hh_mm": "<string>",
                "start_hh_mm": "<string>"
              }
            ]
          },
          "saturday": {
            "active": "ALL_DAY",
            "ranges": [
              {
                "end_hh_mm": "<string>",
                "start_hh_mm": "<string>"
              }
            ]
          },
          "sunday": {
            "active": "ALL_DAY",
            "ranges": [
              {
                "end_hh_mm": "<string>",
                "start_hh_mm": "<string>"
              }
            ]
          },
          "thursday": {
            "active": "ALL_DAY",
            "ranges": [
              {
                "end_hh_mm": "<string>",
                "start_hh_mm": "<string>"
              }
            ]
          },
          "tuesday": {
            "active": "ALL_DAY",
            "ranges": [
              {
                "end_hh_mm": "<string>",
                "start_hh_mm": "<string>"
              }
            ]
          },
          "wednesday": {
            "active": "ALL_DAY",
            "ranges": [
              {
                "end_hh_mm": "<string>",
                "start_hh_mm": "<string>"
              }
            ]
          }
        }
      },
      "series_conditions": {
        "defaults": {
          "critical": {
            "conditions": [
              {
                "new_series_delay_secs": 123,
                "op": "GEQ",
                "resolve_sustain_secs": 123,
                "resolve_value": {
                  "enabled": true,
                  "value": 123
                },
                "sustain_secs": 123,
                "value": 123
              }
            ]
          },
          "warn": {
            "conditions": [
              {
                "new_series_delay_secs": 123,
                "op": "GEQ",
                "resolve_sustain_secs": 123,
                "resolve_value": {
                  "enabled": true,
                  "value": 123
                },
                "sustain_secs": 123,
                "value": 123
              }
            ]
          }
        },
        "overrides": [
          {
            "label_matchers": [
              {
                "name": "<string>",
                "type": "EXACT",
                "value": "<string>"
              }
            ],
            "severity_conditions": {
              "critical": {
                "conditions": [
                  {
                    "new_series_delay_secs": 123,
                    "op": "GEQ",
                    "resolve_sustain_secs": 123,
                    "resolve_value": {
                      "enabled": true,
                      "value": 123
                    },
                    "sustain_secs": 123,
                    "value": 123
                  }
                ]
              },
              "warn": {
                "conditions": [
                  {
                    "new_series_delay_secs": 123,
                    "op": "GEQ",
                    "resolve_sustain_secs": 123,
                    "resolve_value": {
                      "enabled": true,
                      "value": 123
                    },
                    "sustain_secs": 123,
                    "value": 123
                  }
                ]
              }
            }
          }
        ]
      },
      "signal_grouping": {
        "label_names": [
          "<string>"
        ],
        "signal_per_series": true
      },
      "slug": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "page": {
    "next_token": "<string>"
  }
}

{
  "message": "<string>"
}

{}

GET

api

config

monitors

cURL

curl --request GET \
  --url https://{tenant}.chronosphere.io/api/v1/config/monitors \
  --header 'API-Token: <api-key>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenant}.chronosphere.io/api/v1/config/monitors"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("API-Token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {'API-Token': '<api-key>'}};

fetch('https://{tenant}.chronosphere.io/api/v1/config/monitors', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "monitors": [
    {
      "name": "<string>",
      "annotations": {},
      "bucket_slug": "<string>",
      "collection": {
        "slug": "<string>",
        "type": "SIMPLE"
      },
      "collection_slug": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "graphite_query": "sumSeries(stats.timers.*.mean_90)",
      "interval_secs": 123,
      "labels": {},
      "logging_query": "<string>",
      "notification_policy_slug": "<string>",
      "notification_template": "{\"title\": \"[{{.Severity}}] {{.Labels.service}} threshold exceeded\", \"description\": \"{{.Labels.env}} crossed {{.ThresholdOp}} {{.Threshold}}\"}",
      "prometheus_query": "up{job=\"prometheus\"} == 0",
      "schedule": {
        "timezone": "<string>",
        "weekly_schedule": {
          "friday": {
            "active": "ALL_DAY",
            "ranges": [
              {
                "end_hh_mm": "<string>",
                "start_hh_mm": "<string>"
              }
            ]
          },
          "monday": {
            "active": "ALL_DAY",
            "ranges": [
              {
                "end_hh_mm": "<string>",
                "start_hh_mm": "<string>"
              }
            ]
          },
          "saturday": {
            "active": "ALL_DAY",
            "ranges": [
              {
                "end_hh_mm": "<string>",
                "start_hh_mm": "<string>"
              }
            ]
          },
          "sunday": {
            "active": "ALL_DAY",
            "ranges": [
              {
                "end_hh_mm": "<string>",
                "start_hh_mm": "<string>"
              }
            ]
          },
          "thursday": {
            "active": "ALL_DAY",
            "ranges": [
              {
                "end_hh_mm": "<string>",
                "start_hh_mm": "<string>"
              }
            ]
          },
          "tuesday": {
            "active": "ALL_DAY",
            "ranges": [
              {
                "end_hh_mm": "<string>",
                "start_hh_mm": "<string>"
              }
            ]
          },
          "wednesday": {
            "active": "ALL_DAY",
            "ranges": [
              {
                "end_hh_mm": "<string>",
                "start_hh_mm": "<string>"
              }
            ]
          }
        }
      },
      "series_conditions": {
        "defaults": {
          "critical": {
            "conditions": [
              {
                "new_series_delay_secs": 123,
                "op": "GEQ",
                "resolve_sustain_secs": 123,
                "resolve_value": {
                  "enabled": true,
                  "value": 123
                },
                "sustain_secs": 123,
                "value": 123
              }
            ]
          },
          "warn": {
            "conditions": [
              {
                "new_series_delay_secs": 123,
                "op": "GEQ",
                "resolve_sustain_secs": 123,
                "resolve_value": {
                  "enabled": true,
                  "value": 123
                },
                "sustain_secs": 123,
                "value": 123
              }
            ]
          }
        },
        "overrides": [
          {
            "label_matchers": [
              {
                "name": "<string>",
                "type": "EXACT",
                "value": "<string>"
              }
            ],
            "severity_conditions": {
              "critical": {
                "conditions": [
                  {
                    "new_series_delay_secs": 123,
                    "op": "GEQ",
                    "resolve_sustain_secs": 123,
                    "resolve_value": {
                      "enabled": true,
                      "value": 123
                    },
                    "sustain_secs": 123,
                    "value": 123
                  }
                ]
              },
              "warn": {
                "conditions": [
                  {
                    "new_series_delay_secs": 123,
                    "op": "GEQ",
                    "resolve_sustain_secs": 123,
                    "resolve_value": {
                      "enabled": true,
                      "value": 123
                    },
                    "sustain_secs": 123,
                    "value": 123
                  }
                ]
              }
            }
          }
        ]
      },
      "signal_grouping": {
        "label_names": [
          "<string>"
        ],
        "signal_per_series": true
      },
      "slug": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "page": {
    "next_token": "<string>"
  }
}

{
  "message": "<string>"
}

{}

Authorizations

API-Token

string

header

required

Cortex XCOR API token

Query Parameters

page.max_size

integer<int64>

Sets the preferred number of items to return per page. If set to 0, the server will use its default value. Regardless of the value specified, clients must never assume how many items will be returned.

page.token

string

An opaque page token that identifies which page the client should request. An empty value indicates the first page.

slugs

string[]

Filters results by slug, where any Monitor with a matching slug in the given list (and matches all other filters) will be returned.

bucket_slugs

string[]

Filters results by bucket_slug, where any Monitor with a matching bucket_slug in the given list (and matches all other filters) will be returned.

collection_slugs

string[]

Filters results by collection_slug, where any Monitor with a matching collection_slug in the given list (and matches all other filters) will be returned.

names

string[]

Filters results by name, where any Monitor with a matching name in the given list (and matches all other filters) will be returned.

team_slugs

string[]

Filter returned monitors by the teams that own the collections that they belong to.

name_contains

string

Filter that returns monitors whose name contains this string. The filter is not case sensitive.

label_matchers

string[]

Filter returned monitors by their labels. Each entry is name=value or name!=value, for example team=payments or team!=payments; the value may be double-quoted. =~ and !~ are not accepted. A monitor is returned only if every entry holds for it: name=value requires the monitor to carry that label with that value (it may carry other labels too), and name!=value excludes monitors whose label has that value. With an empty value, name= matches monitors that do not have the label and name!= matches monitors that have it with any value. Unlike the other list filters, whose values are OR'd, entries here are AND'd.

Response

A successful response.

monitors

object[]

Show child attributes

page

object

Show child attributes