GET /alerts/config
Bearer auth

Retrieves the current alerting configuration from Mimir (source of truth). By default returns structured JSON (AlertingConfig). Use ?format=yaml to get the raw redacted YAML.

Query parameters

  • organization_id string

    Target organization ID. Required for Owner, Distributor, and Reseller roles.

  • format string

    Response format. Omit for JSON (default) or set to "yaml" for raw YAML.

    Value is yaml.

Responses

  • 200 application/json

    Current alerting configuration

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object
      Hide data attribute Show data attribute object

      • config object | string

        One of:
        AlertingConfig object string-2 string

        Raw redacted YAML (when ?format=yaml)
  • 400 application/json

    Bad request - validation error

    Hide response attributes Show response attributes object
    • code integer

      HTTP error code

    • message string

      Error message

    • data object
      Hide data attributes Show data attributes object
      • type string

        Type of error

        Values are validation_error or external_api_error.

      • errors array[object]
        Hide errors attributes Show errors attributes object
        • key string

          Field name that failed validation

        • message string

          Error code or message

        • value string

          Value that failed validation

      • details

        Additional error details
  • 401 application/json

    Unauthorized - invalid or missing token

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object | null
  • 403 application/json

    Forbidden - insufficient permissions

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object | null
  • 500 application/json

    Internal server error

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object | null
GET /alerts/config 
curl \
 --request GET 'https://api.your-domain.com/api/alerts/config' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "code": 200,
  "message": "alerting configuration retrieved successfully",
  "data": {
    "config": {
      "mail_enabled": true,
      "webhook_enabled": true,
      "telegram_enabled": true,
      "mail_addresses": [
        "global@example.com"
      ],
      "webhook_receivers": [
        {
          "name": "slack",
          "url": "https://hooks.slack.com/services/T00/B00/XXX"
        }
      ],
      "telegram_receivers": [
        {
          "bot_token": "123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11",
          "chat_id": -1001234567890
        }
      ],
      "email_template_lang": "en",
      "severities": [
        {
          "severity": "critical",
          "mail_enabled": true,
          "webhook_enabled": true,
          "mail_addresses": [
            "oncall@example.com"
          ]
        },
        {
          "severity": "warning",
          "mail_enabled": false,
          "webhook_enabled": false
        }
      ],
      "systems": [
        {
          "system_key": "ns8-prod-01",
          "mail_enabled": false,
          "webhook_enabled": true
        }
      ]
    }
  }
}
Response examples (400) 
{
  "code": 400,
  "message": "validation failed",
  "data": {
    "type": "validation_error",
    "errors": [
      {
        "key": "username",
        "message": "required",
        "value": "string"
      }
    ]
  }
}
Response examples (401) 
{
  "code": 401,
  "message": "invalid token",
  "data": {}
}
Response examples (403) 
{
  "code": 403,
  "message": "insufficient permissions",
  "data": {}
}
Response examples (500) 
{
  "code": 500,
  "message": "internal server error",
  "data": {}
}