alerts

Evaluate an RRule and return occurrences

Evaluates an RRule string and returns the next occurrences within the specified time window. This endpoint allows users to verify their rrule configuration for silencing rules.

post/api/v2/spaces/{spaceID}/notifications/silencing/rrule/evaluate

Request

Base URL
https://api.netdata.cloud (the document declares no server; this is the origin it was published from)
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/netdata/apis/netdata-cloud-api/docs/api/v2/spaces/:spaceID/notifications/silencing/rrule/evaluate/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

spaceIDstring uuid required

The unique identifier of the requested space.

Request body

lasts_untilstring

The end time for the daily active window (optional)

limitinteger

Maximum number of occurrences to return (optional, default: 25, max: 200)

rrulestring

The RRule string to evaluate (RFC 5545 format). FREQ must be DAILY, WEEKLY, MONTHLY or YEARLY and may recur at most 24 times a day

starts_atstring

The start time for the rrule (DTSTART)

timezonestring

IANA timezone the recurrence is anchored to (optional, default: UTC). The rrule fires at the intended wall-clock time in this zone across DST transitions

Example request

{
  "lasts_until": "2025-05-20T01:49:01.803Z",
  "limit": 10,
  "rrule": "RRULE:FREQ=DAILY",
  "starts_at": "2025-05-19T13:49:01.803Z",
  "timezone": "America/New_York",
  "window": {
    "end": "2025-06-19T00:00:00Z",
    "start": "2025-05-19T00:00:00Z"
  }
}

Response

The evaluated RRule occurrences

has_moreboolean

Whether there are more occurrences beyond the limit

rrulestring

The normalized rrule string

Example response

{
  "occurrences": [
    {
      "end": "2025-05-20T01:49:01.803Z",
      "start": "2025-05-19T13:49:01.803Z"
    }
  ],
  "rrule": "DTSTART:20250519T134901Z\nRRULE:FREQ=DAILY"
}

Changes

No recorded changes to this operation across all 1 revision of this API.