{
  "opencollection": "1.0.0",
  "info": {
    "name": "SigNoz alerts rules API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "rules",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List alert rules",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}{base_path}/api/v2/rules",
            "auth": {
              "type": "apikey",
              "key": "SigNoz-Api-Key",
              "value": "{{SigNoz-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint lists all alert rules with their current evaluation state"
        },
        {
          "info": {
            "name": "Create alert rule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{host}:{port}{base_path}/api/v2/rules",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "SigNoz-Api-Key",
              "value": "{{SigNoz-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint creates a new alert rule"
        },
        {
          "info": {
            "name": "Get alert rule by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}{base_path}/api/v2/rules/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "SigNoz-Api-Key",
              "value": "{{SigNoz-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint returns an alert rule by ID"
        },
        {
          "info": {
            "name": "Update alert rule",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}:{port}{base_path}/api/v2/rules/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "SigNoz-Api-Key",
              "value": "{{SigNoz-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint updates an alert rule by ID"
        },
        {
          "info": {
            "name": "Patch alert rule",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{host}:{port}{base_path}/api/v2/rules/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "SigNoz-Api-Key",
              "value": "{{SigNoz-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint applies a partial update to an alert rule by ID"
        },
        {
          "info": {
            "name": "Delete alert rule",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{host}:{port}{base_path}/api/v2/rules/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "SigNoz-Api-Key",
              "value": "{{SigNoz-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint deletes an alert rule by ID"
        },
        {
          "info": {
            "name": "Get rule history filter keys",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}{base_path}/api/v2/rules/:id/history/filter_keys",
            "params": [
              {
                "name": "signal",
                "value": "",
                "type": "query"
              },
              {
                "name": "source",
                "value": "",
                "type": "query"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "startUnixMilli",
                "value": "",
                "type": "query"
              },
              {
                "name": "endUnixMilli",
                "value": "",
                "type": "query"
              },
              {
                "name": "fieldContext",
                "value": "",
                "type": "query"
              },
              {
                "name": "fieldDataType",
                "value": "",
                "type": "query"
              },
              {
                "name": "metricName",
                "value": "",
                "type": "query"
              },
              {
                "name": "metricNamespace",
                "value": "",
                "type": "query"
              },
              {
                "name": "searchText",
                "value": "",
                "type": "query"
              },
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "SigNoz-Api-Key",
              "value": "{{SigNoz-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "Returns distinct label keys from rule history entries for the selected range."
        },
        {
          "info": {
            "name": "Get rule history filter values",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}{base_path}/api/v2/rules/:id/history/filter_values",
            "params": [
              {
                "name": "signal",
                "value": "",
                "type": "query"
              },
              {
                "name": "source",
                "value": "",
                "type": "query"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "startUnixMilli",
                "value": "",
                "type": "query"
              },
              {
                "name": "endUnixMilli",
                "value": "",
                "type": "query"
              },
              {
                "name": "fieldContext",
                "value": "",
                "type": "query"
              },
              {
                "name": "fieldDataType",
                "value": "",
                "type": "query"
              },
              {
                "name": "metricName",
                "value": "",
                "type": "query"
              },
              {
                "name": "metricNamespace",
                "value": "",
                "type": "query"
              },
              {
                "name": "searchText",
                "value": "",
                "type": "query"
              },
              {
                "name": "name",
                "value": "",
                "type": "query"
              },
              {
                "name": "existingQuery",
                "value": "",
                "type": "query"
              },
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "SigNoz-Api-Key",
              "value": "{{SigNoz-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "Returns distinct label values for a given key from rule history entries."
        },
        {
          "info": {
            "name": "Get rule overall status timeline",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}{base_path}/api/v2/rules/:id/history/overall_status",
            "params": [
              {
                "name": "start",
                "value": "",
                "type": "query"
              },
              {
                "name": "end",
                "value": "",
                "type": "query"
              },
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "SigNoz-Api-Key",
              "value": "{{SigNoz-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "Returns overall firing/inactive intervals for a rule in the selected time range."
        },
        {
          "info": {
            "name": "Get rule history stats",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}{base_path}/api/v2/rules/:id/history/stats",
            "params": [
              {
                "name": "start",
                "value": "",
                "type": "query"
              },
              {
                "name": "end",
                "value": "",
                "type": "query"
              },
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "SigNoz-Api-Key",
              "value": "{{SigNoz-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "Returns trigger and resolution statistics for a rule in the selected time range."
        },
        {
          "info": {
            "name": "Get rule history timeline",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}{base_path}/api/v2/rules/:id/history/timeline",
            "params": [
              {
                "name": "start",
                "value": "",
                "type": "query"
              },
              {
                "name": "end",
                "value": "",
                "type": "query"
              },
              {
                "name": "state",
                "value": "",
                "type": "query"
              },
              {
                "name": "filterExpression",
                "value": "",
                "type": "query"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "order",
                "value": "",
                "type": "query"
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query"
              },
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "SigNoz-Api-Key",
              "value": "{{SigNoz-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "Returns paginated timeline entries for rule state transitions."
        },
        {
          "info": {
            "name": "Get top contributors to rule firing",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}{base_path}/api/v2/rules/:id/history/top_contributors",
            "params": [
              {
                "name": "start",
                "value": "",
                "type": "query"
              },
              {
                "name": "end",
                "value": "",
                "type": "query"
              },
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "SigNoz-Api-Key",
              "value": "{{SigNoz-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "Returns top label combinations contributing to rule firing in the selected time range."
        },
        {
          "info": {
            "name": "Test alert rule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{host}:{port}{base_path}/api/v2/rules/test",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "SigNoz-Api-Key",
              "value": "{{SigNoz-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint fires a test notification for the given rule definition"
        }
      ]
    }
  ],
  "bundled": true
}