Skip to content
Kupe Cloud Kupe Cloud Kupe Cloud Docs

Get tenant alertmanager configuration API Reference

GET
/tenants/{tenant}/alertmanager/config
 
curl --request GET \
  --url https://api.kupe.cloud/api/v1/tenants/acme/alertmanager/config \
  --header 'Authorization: <Authorization>'

Returns the full Mimir Alertmanager wrapper for the tenant. The response includes the embedded alertmanager_config (parsed receivers/routes/global) and any template files. Use the section endpoints (/receivers, /routes, /global) for individual edits.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
tenant
required
string

Tenant name

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Current configuration

Media type application/json
object
global

Global is the parsed global section (free-form).

object
key
additional properties
receivers

Receivers is the parsed receiver list.

Array<object>
object
email_configs
Array<object>
object
key
additional properties
name
string
slack_configs
Array<object>
object
key
additional properties
webhook_configs
Array<object>
object
key
additional properties
route

Route is the parsed root route.

object
active_time_intervals
Array<string>
continue
boolean
group_by
Array<string>
group_interval
string
group_wait
string
match
object
key
additional properties
string
match_re
object
key
additional properties
string
matchers
Array<string>
mute_time_intervals
Array<string>
receiver
string
repeat_interval
string
templates

Templates maps a template filename to its contents.

object
key
additional properties
string
Example 
{
  "receivers": [
    {
      "name": "slack"
    }
  ],
  "route": {
    "continue": false,
    "group_by": [
      "alertname",
      "cluster"
    ],
    "group_interval": "5m",
    "group_wait": "30s",
    "matchers": [
      "severity=\"critical\""
    ],
    "receiver": "slack",
    "repeat_interval": "4h"
  }
}

Headers

Section titled “ Headers ”
ETag
string

Wrapper ETag for optimistic locking

401

Section titled “ 401 ”

Missing or invalid authentication

Media type application/json
object
code
string
error
string
field
string
message
string
severity
string
Example generated 
{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

403

Section titled “ 403 ”

Not a member of this tenant

Media type application/json
object
code
string
error
string
field
string
message
string
severity
string
Example generated 
{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

501

Section titled “ 501 ”

Alertmanager proxy not enabled in this deployment

Media type application/json
object
code
string
error
string
field
string
message
string
severity
string
Example generated 
{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

503

Section titled “ 503 ”

Tenant credentials not yet available

Media type application/json
object
code
string
error
string
field
string
message
string
severity
string
Example generated 
{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}