Observatorium logo
API docs by Redocly

Observatorium API (0.0.1)

Download OpenAPI specification:Download

License: Apache 2.0

The Observatorium API

metrics/rulesrawv1

Lists all configured rules for a tenant in YAML form

You can list all configured rules for a tenant in YAML form

path Parameters
tenant
required
string

name of the tenant

Responses

Set/overwrite the rules for a tenant

You can set rules for a tenant

path Parameters
tenant
required
string

name of the tenant

Request Body schema: application/yaml

Rules to set for a tenant

required
Array of objects (RuleGroup)

Responses

metrics/rulesv1

Get Rules for a tenant in JSON form

You can get rules for a tenant with health data

path Parameters
tenant
required
string

name of the tenant

query Parameters
type
string
Enum: "alert" "record"

type of Rules

match[]
Array of strings

Repeated label selector argument

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "errorType": "string",
  • "warnings": [
    ],
  • "status": "success",
  • "data": {
    }
}

metrics/labelsv1

Get all labels for a tenant

You can get labels for a tenant

path Parameters
tenant
required
string

name of the tenant

query Parameters
match[]
Array of strings

Repeated series selector argument

start
string <rfc3339 | unix_timestamp>

Start timestamp

end
string <rfc3339 | unix_timestamp>

End timestamp

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "errorType": "string",
  • "warnings": [
    ],
  • "status": "success",
  • "data": [
    ]
}

metrics/labelvaluesv1

Get label values for a tenant

You can get label values for a label of a tenant

path Parameters
tenant
required
string

name of the tenant

label_name
required
string

label name to get values for

query Parameters
match[]
Array of strings

Repeated series selector argument

start
string <rfc3339 | unix_timestamp>

Start timestamp

end
string <rfc3339 | unix_timestamp>

End timestamp

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "errorType": "string",
  • "warnings": [
    ],
  • "status": "string",
  • "data": [
    ]
}

metrics/queryv1

Evaluate instant queries for a tenant

You can evaluate instant queries for a tenant

path Parameters
tenant
required
string

name of the tenant

query Parameters
query
string

PromQL query to fetch result for metrics

timeout
string

Evaluation timeout

dedup
boolean

Query deduplication (Thanos)

partial_response
boolean

Query partial response (Thanos)

time
string <rfc3339 | unix_timestamp>

Evaluation timestamp

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "errorType": "string",
  • "warnings": [
    ],
  • "status": "success",
  • "data": {
    }
}

Evaluate range queries for a tenant

You can evaluate range queries for a tenant

path Parameters
tenant
required
string

name of the tenant

query Parameters
query
string

PromQL query to fetch result for metrics

start
string <rfc3339 | unix_timestamp>

Start timestamp

end
string <rfc3339 | unix_timestamp>

End timestamp

timeout
string

Evaluation timeout

dedup
boolean

Query deduplication (Thanos)

partial_response
boolean

Query partial response (Thanos)

step
string

Query resolution step width

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "errorType": "string",
  • "warnings": [
    ],
  • "status": "success",
  • "data": {
    }
}

metrics/seriesv1

Get series for a tenant

You can get series for a tenant

path Parameters
tenant
required
string

name of the tenant

query Parameters
match[]
required
Array of strings

Repeated series selector argument

start
string <rfc3339 | unix_timestamp>

Start timestamp

end
string <rfc3339 | unix_timestamp>

End timestamp

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "errorType": "string",
  • "warnings": [
    ],
  • "status": "success",
  • "data": [
    ]
}

logs/pushv1

sends log entries to Loki

path Parameters
tenant
required
string

name of the tenant

Request Body schema: application/json
required

You can send all the log entries of clusters to Loki

required
object
required
Array of strings or strings (ScalarOrString) [ items ]

Responses

Request samples

Content type
application/json
{
  • "stream": {
    },
  • "values": [
    ]
}

logs/labelsv1

Get all labels for a tenant

You can get labels for a tenant

path Parameters
tenant
required
string

name of the tenant

query Parameters
start
string <rfc3339 | unix_timestamp>

Start timestamp

end
string <rfc3339 | unix_timestamp>

End timestamp

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "errorType": "string",
  • "warnings": [
    ],
  • "status": "success",
  • "data": [
    ]
}

logs/labelvaluesv1

Get label values for a tenant

You can get label values for a label of a tenant

path Parameters
tenant
required
string

name of the tenant

name
required
string

label name to get values for

query Parameters
start
string <rfc3339 | unix_timestamp>

Start timestamp

end
string <rfc3339 | unix_timestamp>

End timestamp

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "errorType": "string",
  • "warnings": [
    ],
  • "status": "string",
  • "data": [
    ]
}

logs/queryv1

Evaluate instant queries for a tenant

You can evaluate instant queries for a tenant

path Parameters
tenant
required
string

name of the tenant

query Parameters
query
string

LogQL query to fetch result for logs

limit
number

Max number of entries

time
string <rfc3339 | unix_timestamp>

Evaluation timestamp

direction
string

Determines the sort order of logs.Supported values are forward or backward. Defaults to backward.

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "errorType": "string",
  • "warnings": [
    ],
  • "status": "success",
  • "data": {
    }
}

Evaluate range queries for a tenant

You can evaluate range queries for a tenant

path Parameters
tenant
required
string

name of the tenant

query Parameters
query
string

LogQL query to fetch result for logs

start
string <rfc3339 | unix_timestamp>

Start timestamp

end
string <rfc3339 | unix_timestamp>

End timestamp

limit
number

Max number of entries

step
string

Query resolution step width

interval
string

Only return entries at (or >) the specified interval,Only applies to queries which produce a stream response.

direction
string

Determines the sort order of logs.Supported values are forward or backward. Defaults to backward.

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "errorType": "string",
  • "warnings": [
    ],
  • "status": "success",
  • "data": {
    }
}

logs/rulesrawv1

Get all logs rules for a tenant in YAML form

You can get all logs rules for a tenant in YAML form for all known namespaces and groups.

path Parameters
tenant
required
string

name of the tenant

Responses

Get all logs rules in a namespace for a tenant in YAML form

You can get all logs rules in a namespace for a tenant.

path Parameters
tenant
required
string

name of the tenant

namespace
required
string

namespace of the log rule group

Responses

Set logs rule groups in a namespace for a tenant

You can create and update rule groups in a namespace for a tenant.

path Parameters
tenant
required
string

name of the tenant

namespace
required
string

namespace of the log rule group

Request Body schema: application/yaml
name
string
interval
string
Array of RecordingRule (object) or AlertingRule (object)

Responses

Delete logs rules groups in a namespace for a tenant

You can delete all the rule groups in a namespace (including the namespace itself).

path Parameters
tenant
required
string

name of the tenant

namespace
required
string

namespace of the log rule group

Responses

Get the logs Rule group in a namespace for a tenant in YAML form

You get the logs Rule group in a namespace for a tenant

path Parameters
tenant
required
string

name of the tenant

namespace
required
string

namespace of the log rule group

group
required
string

group of the log rule

Responses

Delete a logs rule group in a namespace for a tenant

You delete a rule group by namespace and group name for a tenant.

path Parameters
tenant
required
string

name of the tenant

namespace
required
string

namespace of the log rule group

group
required
string

group of the log rule

Responses

logs/rulesv1

Prometheus-compatible rules endpoint to list alerting and recording rules that are currently loaded for a tenant in JSON form

Prometheus-compatible rules endpoint to list alerting and recording rules that are currently loaded for a tenant.

path Parameters
tenant
required
string

name of the tenant

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "errorType": "string",
  • "warnings": [
    ],
  • "status": "success",
  • "data": {
    }
}

Prometheus-compatible rules endpoint to list all active alerts for a tenant in JSON form

Prometheus-compatible rules endpoint to list all active alerts for a tenant.

path Parameters
tenant
required
string

name of the tenant

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "errorType": "string",
  • "warnings": [
    ],
  • "status": "success",
  • "data": {
    }
}

logs/seriesv1

Get series for a tenant

You can get series for a tenant

path Parameters
tenant
required
string

name of the tenant

query Parameters
match[]
required
Array of strings

Repeated series selector argument

start
string <rfc3339 | unix_timestamp>

Start timestamp

end
string <rfc3339 | unix_timestamp>

End timestamp

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "errorType": "string",
  • "warnings": [
    ],
  • "status": "success",
  • "data": [
    ]
}

Get series for a tenant

Used when specifying a large or dynamic number of stream selectors that may breach server-side URL character limits.

path Parameters
tenant
required
string

name of the tenant

query Parameters
match[]
required
Array of strings

Repeated series selector argument

start
string <rfc3339 | unix_timestamp>

Start timestamp

end
string <rfc3339 | unix_timestamp>

End timestamp

Request Body schema: application/x-www-form-urlencoded
match[]
Array of strings
start
string <rfc3339 | unix_timestamp>
end
string <rfc3339 | unix_timestamp>

Responses

logs/tailV1

lists log messages based on query

You can get log messages based on query

path Parameters
tenant
required
string

name of the tenant

query Parameters
start
string <rfc3339 | unix_timestamp>

Start timestamp

query
string

LogQL query to fetch result for logs

integer or integer

delay retrieving logs

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "errorType": "string",
  • "warnings": [ ],
  • "items": "string",
  • "status": "success",
  • "streams": [
    ],
  • "dropped_entries": [
    ]
}