How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
SigNoz

SigNoz rules API

The rules API from SigNoz — 9 operation(s) for rules.

Documentation Provider Profile APIs.io OpenAPI GitHub

SigNoz rules API is one of 29 APIs that SigNoz publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Rules. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a GitHub repository, pricing, and a getting-started guide.

This API exposes 13 operations across 9 paths, and defines 84 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://{host}:{port}{base_path}.

13 operations 9 paths 84 schemas 1 DELETE8 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://{host}:{port}
Authentication
API Key, HTTP Bearer
Contact
SigNoz Support
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

SigNoz rules API declares 2 security schemes for authenticating requests. An API key is passed in the header as SigNoz-Api-Key (api_key). It accepts HTTP bearer tokens (Tokenizer) (tokenizer).

  • api_key — API Keys
  • tokenizer — Tokens generated by the tokenizer

Paths & Operations 13

Across 9 paths, the API surfaces 13 operations — 1 DELETE, 8 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

rules 13
GET
/api/v2/rules
List alert rules
ListRules → 200401403500
POST
/api/v2/rules
Create alert rule
CreateRule body → 201400401403500
DELETE
/api/v2/rules/{id}
Delete alert rule
DeleteRuleByID 1 param → 204401403404500
GET
/api/v2/rules/{id}
Get alert rule by ID
GetRuleByID 1 param → 200401403404500
PATCH
/api/v2/rules/{id}
Patch alert rule
PatchRuleByID 1 param body → 200400401403404500
PUT
/api/v2/rules/{id}
Update alert rule
UpdateRuleByID 1 param body → 204400401403404500
GET
/api/v2/rules/{id}/history/filter_keys
Get rule history filter keys
GetRuleHistoryFilterKeys 11 params → 200400401403500
GET
/api/v2/rules/{id}/history/filter_values
Get rule history filter values
GetRuleHistoryFilterValues 13 params → 200400401403500
GET
/api/v2/rules/{id}/history/overall_status
Get rule overall status timeline
GetRuleHistoryOverallStatus 3 params → 200400401403500
GET
/api/v2/rules/{id}/history/stats
Get rule history stats
GetRuleHistoryStats 3 params → 200400401403500
GET
/api/v2/rules/{id}/history/timeline
Get rule history timeline
GetRuleHistoryTimeline 8 params → 200400401403500
GET
/api/v2/rules/{id}/history/top_contributors
Get top contributors to rule firing
GetRuleHistoryTopContributors 3 params → 200400401403500
POST
/api/v2/rules/test
Test alert rule
TestRule body → 200400401403500

Schemas 84

The contract defines 84 schemas that model the data the API accepts and returns. The most detailed are RuletypesRule (22 properties), Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregation (18 properties), Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation (18 properties), Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregation (18 properties). Each schema is shown below with its type and property counts.

RuletypesCompareOperator
string
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregation
object
18 properties
Querybuildertypesv5QueryEnvelopeFormula
object
2 properties
Querybuildertypesv5ClickHouseQuery
object
4 properties
RuletypesThresholdBasic
object
2 properties
Querybuildertypesv5TraceAggregation
object
2 properties
TelemetrytypesSource
string
Querybuildertypesv5Label
object
2 properties
RuletypesPostableRule
object
16 properties 4 required
TelemetrytypesFieldDataType
string
RuletypesGettableTestRule
object
2 properties
Querybuildertypesv5QueryEnvelopeBuilderMetric
object
2 properties
Querybuildertypesv5QueryEnvelopeBuilderTrace
object
2 properties
RuletypesAlertCompositeQuery
object
4 properties 3 required
Querybuildertypesv5OrderByKey
object
6 properties 1 required
RuletypesRule
object
22 properties 6 required
RulestatehistorytypesGettableRuleStateHistoryStats
object
8 properties 8 required
MetrictypesTemporality
string
RenderErrorResponse
object
2 properties 2 required
RuletypesRuleCondition
object
13 properties 1 required
Querybuildertypesv5Bucket
object
1 property
RuletypesScheduleType
string
Querybuildertypesv5Having
object
1 property
Querybuildertypesv5Filter
object
1 property
RuletypesThresholdKind
string
RuletypesEvaluationEnvelope
object
2 properties 2 required
RuletypesSeasonality
string
TelemetrytypesSignal
string
RulestatehistorytypesGettableRuleStateWindow
object
3 properties 3 required
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregation
object
18 properties
RuletypesNotificationSettings
object
4 properties
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation
object
18 properties
RuletypesBasicRuleThresholds
arraynull
Querybuildertypesv5Step
Step interval. Accepts a Go duration string (e.g., "60s", "1m", "1h") or a number representing seconds (e.g., 60).
Querybuildertypesv5QueryEnvelope
object
2 properties
RuletypesAlertState
string
Querybuildertypesv5QueryEnvelopeTraceOperator
object
2 properties
Querybuildertypesv5QueryType
string
RuletypesPanelType
string
Querybuildertypesv5QueryEnvelopeBuilderLog
object
2 properties
Querybuildertypesv5FunctionName
string
Querybuildertypesv5MetricAggregation
object
6 properties
Querybuildertypesv5TimeSeries
object
2 properties
RulestatehistorytypesGettableRuleStateHistoryContributor
object
5 properties 3 required
Querybuildertypesv5LogAggregation
object
2 properties
ErrorsResponseerroradditional
object
1 property
MetrictypesTimeAggregation
string
Querybuildertypesv5QueryEnvelopePromQL
object
2 properties
Querybuildertypesv5GroupByKey
object
6 properties 1 required
TelemetrytypesTelemetryFieldValues
object
4 properties
MetrictypesSpaceAggregation
string
RuletypesRenotify
object
3 properties
Querybuildertypesv5Function
object
2 properties
RuletypesEvaluationCumulative
object
2 properties
Querybuildertypesv5TimeSeriesValue
object
5 properties
ErrorsJSON
object
4 properties 2 required
Querybuildertypesv5QueryBuilderTraceOperator
object
16 properties
RuletypesEvaluationKind
string
RuletypesCumulativeSchedule
object
5 properties 1 required
Querybuildertypesv5ReduceTo
string
Querybuildertypesv5FunctionArg
object
2 properties
TelemetrytypesTelemetryFieldKey
object
6 properties 1 required
TelemetrytypesFieldContext
string
Querybuildertypesv5OrderDirection
string
TelemetrytypesGettableFieldValues
object
2 properties 2 required
Querybuildertypesv5SecondaryAggregation
object
7 properties
RuletypesRuleThresholdData
object
2 properties 2 required
MetrictypesComparisonSpaceAggregationParam
object
2 properties 2 required
RulestatehistorytypesGettableRuleStateTimeline
object
3 properties 2 required
RuletypesQueryType
string
RuletypesRuleType
string
Querybuildertypesv5OrderBy
object
2 properties
TelemetrytypesGettableFieldKeys
object
2 properties 2 required
RuletypesRollingWindow
object
2 properties 2 required
Querybuildertypesv5QueryEnvelopeClickHouseSQL
object
2 properties
RulestatehistorytypesGettableRuleStateHistory
object
10 properties 10 required
Querybuildertypesv5PromQuery
object
6 properties
RuletypesEvaluationRolling
object
2 properties
RuletypesBasicRuleThreshold
object
7 properties 4 required
RuletypesMatchType
string
Querybuildertypesv5QueryBuilderFormula
object
8 properties
RuletypesAlertType
string
RuletypesCumulativeWindow
object
3 properties 3 required
Querybuildertypesv5LimitBy
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

signoz-rules-api-openapi.yml Raw ↑

Other APIs SigNoz publishes across the network.

SigNoz alerts API
AE Profile APIs.io
SigNoz authdomains API
AE Profile APIs.io
SigNoz authz API
AE Profile APIs.io
SigNoz channels API
AE Profile APIs.io
SigNoz cloudintegration API
AE Profile APIs.io
SigNoz dashboard API
AE Profile APIs.io
SigNoz downtimeschedules API
AE Profile APIs.io
SigNoz features API
AE Profile APIs.io
SigNoz fields API
AE Profile APIs.io
SigNoz gateway API
AE Profile APIs.io
SigNoz global API
AE Profile APIs.io
SigNoz health API
AE Profile APIs.io
#Rules
← Back to S APIs
API Details
ID
signoz:signoz-rules-api
Base URL
https://{host}:{port}
Docs
https://signoz.io
Provider
SigNoz
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=signoz-rules-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/signoz-rules-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of SigNoz rules API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.