{
  "opencollection": "1.0.0",
  "info": {
    "name": "Dash0 Edge Collectors Manage Alerting API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Manage Alerting",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve a specific check rule (Prometheus alert rule) by its origin or id.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.eu-west-1.aws.dash0.com/api/alerting/check-rules/:originOrId",
            "params": [
              {
                "name": "originOrId",
                "value": "",
                "type": "path",
                "description": "Check rule origin or id"
              },
              {
                "name": "dataset",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Retrieve a specific check rule (Prometheus alert rule) by its origin or id."
        },
        {
          "info": {
            "name": "Update or insert a specific check rule (Prometheus alert rule) by origin or id.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.eu-west-1.aws.dash0.com/api/alerting/check-rules/:originOrId",
            "params": [
              {
                "name": "originOrId",
                "value": "",
                "type": "path",
                "description": "Check rule origin or id"
              },
              {
                "name": "dataset",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update or insert a specific check rule (Prometheus alert rule) by origin or id."
        },
        {
          "info": {
            "name": "Delete a specific check rule (Prometheus alert rule) by origin or id.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.eu-west-1.aws.dash0.com/api/alerting/check-rules/:originOrId",
            "params": [
              {
                "name": "originOrId",
                "value": "",
                "type": "path",
                "description": "Check rule origin or id"
              },
              {
                "name": "dataset",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Delete a specific check rule (Prometheus alert rule) by origin or id."
        },
        {
          "info": {
            "name": "Retrieve a list of check rule ids.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.eu-west-1.aws.dash0.com/api/alerting/check-rules",
            "params": [
              {
                "name": "dataset",
                "value": "",
                "type": "query"
              },
              {
                "name": "idPrefix",
                "value": "",
                "type": "query",
                "description": "If provided, only check rules for which the origin starts with the given string are returned. (deprecated)\n\nThe `originPrefix` query parameter takes precedence over this parameter if both are provided.\n"
              },
              {
                "name": "originPrefix",
                "value": "",
                "type": "query",
                "description": "If provided, only check rules for which the origin starts with the given string are returned."
              }
            ]
          },
          "docs": "Retrieve a list of check rule ids."
        },
        {
          "info": {
            "name": "Create a new check rule.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.eu-west-1.aws.dash0.com/api/alerting/check-rules",
            "params": [
              {
                "name": "dataset",
                "value": "",
                "type": "query",
                "description": "The associated dataset."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new check rule."
        },
        {
          "info": {
            "name": "Bulk create check rules.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.eu-west-1.aws.dash0.com/api/alerting/check-rules/bulk",
            "params": [
              {
                "name": "dataset",
                "value": "",
                "type": "query",
                "description": "The dataset to deploy rules into. Required to prevent accidental deployment to the wrong dataset."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Atomically create up to 1000 Prometheus alert rules in a single request.\nCreate-only — every item produces a brand-new check rule. The public\nschema uses `id` as the user-defined origin; per-item resolution\npriority mirrors the single-rule POST handler (id → server-generated\nUUID with \"api-\" prefix). Any item whose resolved origin or id\ncollides with an existing rule (including soft-deleted rules whose\norigin is still reserved by the unique constraint) is rejected with a\nper-item diagnostic.\n\nIf"
        },
        {
          "info": {
            "name": "Import a check rule.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.eu-west-1.aws.dash0.com/api/import/check-rule",
            "params": [
              {
                "name": "dataset",
                "value": "",
                "type": "query",
                "description": "The associated dataset."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint allows you **to import an existing check rule** into your organization. It's intended for one-time migrations rather than ongoing check rule management.\nUnlike the standard API, this endpoint supports importing check rules **with full editability**, allowing you to modify check rules that were previously created elsewhere.\n**Note:**\nThis endpoint is **not recommended for Infrastructure-as-Code (IaC)** workflows. Using it in IaC scenarios can cause configuration drift and inconsiste"
        },
        {
          "info": {
            "name": "Import multiple check rules in one batch.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.eu-west-1.aws.dash0.com/api/import/check-rules",
            "params": [
              {
                "name": "dataset",
                "value": "",
                "type": "query",
                "description": "The associated dataset."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Bulk variant of `/api/import/check-rule`. Atomically imports up to 1000\nPrometheus alert rules into your organization with **full editability**\n— the resulting rules behave like UI-created assets, not API-managed\nones, so they can be modified in the Dash0 UI afterwards. Intended for\none-time migrations rather than ongoing Infrastructure-as-Code\nmanagement.\n\nPer-item id/origin resolution mirrors the single-rule import handler:\nitems without an `id` receive a server-generated UUID; items with an\n`"
        }
      ]
    }
  ],
  "bundled": true
}