openapi: 3.0.0 info: title: Netdata Cloud API description: Netdata Cloud API Documentation version: 0.0.1 contact: name: Support url: https://www.netdata.cloud/support servers: - url: https://app.netdata.cloud description: Netdata Cloud paths: /api/v2/spaces/{spaceID}/notifications/silencing/rrule/evaluate: post: summary: Evaluate an RRule and return occurrences description: '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.' operationId: evaluate-rrule tags: - alerts parameters: - name: spaceID in: path required: true description: The unique identifier of the requested space. schema: type: string format: uuid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.evaluateRRuleReq' responses: '200': description: The evaluated RRule occurrences content: application/json: schema: $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.evaluateRRuleRes' '400': description: ' `\"errorCode\": \"ErrBadRequest\"`: when the request payload is invalid' content: application/json: schema: $ref: '#/components/schemas/errors.Error' '401': description: ' `\"errorCode\": \"ErrUnauthorized\"`: when the provided user token/cookie cannot be matched with an account' content: application/json: schema: $ref: '#/components/schemas/errors.Error' '403': description: ' `\"errorCode\": \"ErrForbidden\"`: when caller has no permissions to access the space or evaluate silencing rrules' content: application/json: schema: $ref: '#/components/schemas/errors.Error' '413': description: ' `\"errorCode\": \"ErrRequestEntityTooLarge\"`: when the rrule evaluation exceeds the allowed processing time, indicating a too wide time window' content: application/json: schema: $ref: '#/components/schemas/errors.Error' '422': description: ' `\"errorCode\": \"ErrUnprocessableEntity\"`: when invalid spaceID is provided' content: application/json: schema: $ref: '#/components/schemas/errors.Error' '500': description: ' `\"errorCode\": \"ErrInternal\"`: when some Internal Server Error has occurred' content: application/json: schema: $ref: '#/components/schemas/errors.Error' /api/v2/spaces/{spaceID}/notifications/silencing/rule: post: summary: Create a new Alert Notification Silencing Rule description: Creates an Alert Notification Silencing Rule according to the specifications provided operationId: create-silencing-rule tags: - alerts parameters: - name: spaceID in: path required: true description: The unique identifier of the requested space. schema: type: string format: uuid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.silencingRule' responses: '200': description: The newly created Silencing Rule content: application/json: schema: $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.silencingRule' '400': description: ' `"errorCode": "ErrBadRequest"`: when the Silencing Rule request payload is invalid. Per-field validation errors are returned' content: application/json: schema: $ref: '#/components/schemas/errors.Error' '401': description: ' `"errorCode": "ErrUnauthorized"`: when the provided user token/cookie cannot be matched with an account ' content: application/json: schema: $ref: '#/components/schemas/errors.Error' '403': description: ' `"errorCode": "ErrForbidden"`: when caller is not authorized to access the space or create an Alert Notification Silencing Rule' content: application/json: schema: $ref: '#/components/schemas/errors.Error' '422': description: ' `"errorCode": "ErrUnprocessableEntity"`: when invalid spaceID is provided. ' content: application/json: schema: $ref: '#/components/schemas/errors.Error' '500': description: ' `"errorCode": "ErrInternal"`: when some Internal Server Error has occurred ' content: application/json: schema: $ref: '#/components/schemas/errors.Error' /api/v2/spaces/{spaceID}/notifications/silencing/rule/ruleID: put: summary: Update an existing Alert Notification Silencing Rule description: Updates an existing Alert Notification Silencing Rule according to the specifications provided operationId: update-silencing-rule tags: - alerts parameters: - name: spaceID in: path required: true description: The unique identifier of the requested space. schema: type: string format: uuid - name: ruleID in: path required: true description: The unique identifier of the Silencing Rule to be updated. schema: type: string format: uuid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.silencingRule' responses: '200': description: The newly updated Silencing Rule content: application/json: schema: $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.silencingRule' '400': description: ' `"errorCode": "ErrBadRequest"`: when the Silencing Rule ID or request payload is invalid. Per-field validation errors are returned in case of invalid Silencing Rule definition' content: application/json: schema: $ref: '#/components/schemas/errors.Error' '401': description: ' `"errorCode": "ErrUnauthorized"`: when the provided user token/cookie cannot be matched with an account ' content: application/json: schema: $ref: '#/components/schemas/errors.Error' '403': description: ' `"errorCode": "ErrForbidden"`: when caller is not authorized to access the space or update an Alert Notification Silencing Rule' content: application/json: schema: $ref: '#/components/schemas/errors.Error' '404': description: ' `"errorCode": "ErrNotFound"`: when the Silencing Rule to be updated was not found' content: application/json: schema: $ref: '#/components/schemas/errors.Error' '422': description: ' `"errorCode": "ErrUnprocessableEntity"`: when invalid spaceID is provided. ' content: application/json: schema: $ref: '#/components/schemas/errors.Error' '500': description: ' `"errorCode": "ErrInternal"`: when some Internal Server Error has occurred ' content: application/json: schema: $ref: '#/components/schemas/errors.Error' /api/v2/spaces/{spaceID}/notifications/silencing/rules: get: summary: Get all the Alert Notification Silencing Rules description: Retrieve the Alert Notification Silencing Rules of a given space operationId: get-silencing-rules tags: - alerts parameters: - name: spaceID in: path required: true description: The unique identifier of the requested space. schema: type: string format: uuid responses: '200': description: The available Silencing Rules content: application/json: schema: type: array items: $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.silencingRule' '401': description: ' `"errorCode": "ErrUnauthorized"`: when the provided user token/cookie cannot be matched with an account ' content: application/json: schema: $ref: '#/components/schemas/errors.Error' '403': description: ' `"errorCode": "ErrForbidden"`: when caller is not authorized to access the space or retrieve Alert Notification Silencing Rules' content: application/json: schema: $ref: '#/components/schemas/errors.Error' '422': description: ' `"errorCode": "ErrUnprocessableEntity"`: when invalid spaceID is provided. ' content: application/json: schema: $ref: '#/components/schemas/errors.Error' '500': description: ' `"errorCode": "ErrInternal"`: when some Internal Server Error has occurred ' content: application/json: schema: $ref: '#/components/schemas/errors.Error' /api/v2/spaces/{spaceID}/notifications/silencing/rules/delete: post: summary: Delete Alert Notification Silencing Rules description: Deletes the targeted Alert Notification Silencing Rules of a given space operationId: delete-silencing-rules tags: - alerts parameters: - name: spaceID in: path required: true description: The unique identifier of the requested space. schema: type: string format: uuid requestBody: required: true content: application/json: schema: type: array items: type: string responses: '200': description: OK '400': description: ' `"errorCode": "ErrBadRequest"`: at least one of the Silencing Rule IDs in the request payload is invalid' content: application/json: schema: $ref: '#/components/schemas/errors.Error' '401': description: ' `"errorCode": "ErrUnauthorized"`: when the provided user token/cookie cannot be matched with an account ' content: application/json: schema: $ref: '#/components/schemas/errors.Error' '403': description: ' `"errorCode": "ErrForbidden"`: when caller is not authorized to access the space or delete Alert Notification Silencing Rules' content: application/json: schema: $ref: '#/components/schemas/errors.Error' '422': description: ' `"errorCode": "ErrUnprocessableEntity"`: when invalid spaceID is provided. ' content: application/json: schema: $ref: '#/components/schemas/errors.Error' '500': description: ' `"errorCode": "ErrInternal"`: when some Internal Server Error has occurred ' content: application/json: schema: $ref: '#/components/schemas/errors.Error' /api/v2/spaces/{spaceID}/rooms/{roomID}/alerts:misconfigured: post: summary: Get misconfigured alerts for a room description: Retrieve alerts that are firing too often, stuck in a raised state, silenced for too long, or never dispatched for a given room operationId: get-room-alerts-misconfigured tags: - alerts parameters: - name: spaceID in: path required: true description: The unique identifier of the space. schema: type: string format: uuid - name: roomID in: path required: true description: The unique identifier of the room. schema: type: string format: uuid requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.misconfiguredAlertsRequest' responses: '200': description: The misconfigured alerts results content: application/json: schema: $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.misconfiguredAlertsResponse' '400': description: ' `\"errorCode\": \"ErrBadRequest\"`: when the request payload is invalid ' content: application/json: schema: $ref: '#/components/schemas/errors.Error' '401': description: ' `\"errorCode\": \"ErrUnauthorized\"`: when the provided user token/cookie cannot be matched with an account ' content: application/json: schema: $ref: '#/components/schemas/errors.Error' '403': description: ' `\"errorCode\": \"ErrForbidden\"`: when caller is not authorized to access the space or room ' content: application/json: schema: $ref: '#/components/schemas/errors.Error' '422': description: ' `\"errorCode\": \"ErrUnprocessableEntity\"`: when invalid spaceID or roomID is provided ' content: application/json: schema: $ref: '#/components/schemas/errors.Error' '500': description: ' `\"errorCode\": \"ErrInternal\"`: when some Internal Server Error has occurred ' content: application/json: schema: $ref: '#/components/schemas/errors.Error' /api/v3/spaces/{spaceID}/rooms/{roomID}/data: post: summary: Time series data queries description: Multi-node, multi-context, multi-instance, multi-dimension data queries, with time and metric aggregation. operationId: post-scope-data tags: - charts parameters: - name: spaceID in: path required: true description: The unique identifier of the requested space. schema: type: string format: uuid - name: roomID in: path required: true description: The unique identifier of the requested room. schema: type: string format: uuid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.ScopeDataRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.ScopeDataResponse' '400': description: ' `"errorCode": "ErrBadRequest"`: when invalid query parameters/req. payload are provided
`"errorCode": "ErrBigAgentResponses"`: when Agents return big responses and the caller needs to filter further, reduce the amount of requested `points` or use parents
`"errorCode": "ErrNoEligibleNodeRequested"`: when no eligible nodes were targeted due to space plan restrictions
`"errorCode": "ErrAllNodesFailed"`: when all Agent requests failed, details on every failure are included ' content: application/json: schema: $ref: '#/components/schemas/errors.Error' '401': description: ' `"errorCode": "ErrUnauthorized"`: when the caller is not authenticated or not authorized to access this resource ' content: application/json: schema: $ref: '#/components/schemas/errors.Error' '500': description: ' `"errorCode": "ErrInternal"`: when some Internal Server Error has occurred ' content: application/json: schema: $ref: '#/components/schemas/errors.Error' components: schemas: errors.Error: type: object properties: details: type: object additionalProperties: {} errorCode: type: string errorMessage: type: string errorMsgKey: type: string validationErrors: type: object additionalProperties: $ref: '#/components/schemas/errors.ValidationError' errors.ValidationError: type: object properties: code: type: string message: type: string github_com_netdata_cloud-alarm-processor-service_api.MisconfiguredNode: type: object properties: id: description: Node unique identifier type: string example: a1b2c3d4-e5f6-7890-abcd-ef1234567890 name: description: Node hostname type: string example: ip-172-31-0-1 github_com_netdata_cloud-alarm-processor-service_api.dispatchNoneAlert: type: object properties: chart: description: Chart the alert belongs to type: string example: disk_space._ context: description: Chart context type: string example: disk.space name: description: Alert name type: string example: disk_space_usage github_com_netdata_cloud-alarm-processor-service_api.dispatchNoneItem: type: object properties: alert: description: Alert identity allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.dispatchNoneAlert' count: description: Number of dispatch events where no notification was sent within the lookback window type: integer example: 42 first: description: Timestamp of the first non-dispatched event, in unix milliseconds type: integer example: 1710892800000 last: description: Timestamp of the last non-dispatched event, in unix milliseconds type: integer example: 1711497600000 node: description: Node where this alert is not dispatched allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.MisconfiguredNode' github_com_netdata_cloud-alarm-processor-service_api.dispatchNoneResponse: type: object properties: items: description: Individual alerts that exceeded the non-dispatched event threshold type: array items: $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.dispatchNoneItem' totals: description: Aggregated counts across all dispatch-none items allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.dispatchNoneTotals' github_com_netdata_cloud-alarm-processor-service_api.dispatchNoneThresholds: type: object properties: count: description: Minimum non-dispatched event count to flag an alert (default 10, max 5000) type: integer example: 10 window_seconds: description: Lookback window in seconds for dispatch-none detection (default 2592000, max 7776000) type: integer example: 2592000 github_com_netdata_cloud-alarm-processor-service_api.dispatchNoneTotals: type: object properties: count: description: Sum of non-dispatched event counts across all flagged alerts type: integer example: 150 items: description: Number of alerts flagged as never dispatched type: integer example: 3 github_com_netdata_cloud-alarm-processor-service_api.evaluateRRuleReq: type: object properties: lasts_until: description: The end time for the daily active window (optional) type: string example: '2025-05-20T01:49:01.803Z' limit: description: 'Maximum number of occurrences to return (optional, default: 10, max: 100)' type: integer example: 10 rrule: description: The RRule string to evaluate (RFC 5545 format) type: string example: RRULE:FREQ=DAILY starts_at: description: The start time for the rrule (DTSTART) type: string example: '2025-05-19T13:49:01.803Z' timezone: description: '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' type: string example: America/New_York window: description: The evaluation time window allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.evaluateRRuleWindowReq' github_com_netdata_cloud-alarm-processor-service_api.evaluateRRuleRes: type: object properties: has_more: description: Whether there are more occurrences beyond the limit type: boolean example: false occurrences: description: List of occurrence timestamps within the window type: array items: $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.occurrence' rrule: description: The normalized rrule string type: string example: 'DTSTART:20250519T134901Z RRULE:FREQ=DAILY' github_com_netdata_cloud-alarm-processor-service_api.evaluateRRuleWindowReq: type: object properties: end: description: End of the evaluation time window type: string example: '2025-06-19T00:00:00Z' start: description: Start of the evaluation time window type: string example: '2025-05-19T00:00:00Z' github_com_netdata_cloud-alarm-processor-service_api.firingOftenAlert: type: object properties: chart: description: Chart the alert belongs to type: string example: system.cpu context: description: Chart context type: string example: system.cpu name: description: Alert name type: string example: 10min_cpu_usage github_com_netdata_cloud-alarm-processor-service_api.firingOftenItem: type: object properties: alert: description: Alert identity allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.firingOftenAlert' node: description: Node where this alert fires allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.MisconfiguredNode' transitions: description: Number of transitions within the lookback window type: integer example: 100 github_com_netdata_cloud-alarm-processor-service_api.firingOftenResponse: type: object properties: items: description: Individual alerts that exceeded the transition threshold type: array items: $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.firingOftenItem' totals: description: Aggregated counts across all firing-often items allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.firingOftenTotals' github_com_netdata_cloud-alarm-processor-service_api.firingOftenThresholds: type: object properties: transitions: description: Minimum number of transitions to flag an alert (default 30, max 5000) type: integer example: 30 window_seconds: description: Lookback window in seconds for counting transitions (default 259200, max 7776000) type: integer example: 259200 github_com_netdata_cloud-alarm-processor-service_api.firingOftenTotals: type: object properties: items: description: Number of alerts flagged as firing too often type: integer example: 5 transitions: description: Sum of transitions across all flagged alerts type: integer example: 420 github_com_netdata_cloud-alarm-processor-service_api.misconfiguredAlertsRequest: type: object properties: categories: description: Filter results to specific misconfiguration categories; empty means all categories type: array items: type: string enum: - firing_often - stuck_raised - silenced_long - dispatch_none example: - firing_often - stuck_raised - silenced_long - dispatch_none thresholds: description: Override default detection thresholds per category allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.misconfiguredAlertsThresholds' github_com_netdata_cloud-alarm-processor-service_api.misconfiguredAlertsResponse: type: object properties: dispatch_none: description: Results for alerts where no notification was dispatched; nil when category is excluded allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.dispatchNoneResponse' firing_often: description: Results for alerts transitioning too frequently; nil when category is excluded allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.firingOftenResponse' silenced_long: description: Results for alerts silenced for too long; nil when category is excluded allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.silencedLongResponse' stuck_raised: description: Results for alerts stuck in a raised state; nil when category is excluded allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.stuckRaisedResponse' thresholds: description: Thresholds used for the calculation; always present allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.misconfiguredAlertsThresholds' github_com_netdata_cloud-alarm-processor-service_api.misconfiguredAlertsThresholds: type: object properties: dispatch_none: description: Thresholds for the dispatch-none category allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.dispatchNoneThresholds' firing_often: description: Thresholds for the firing-often category allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.firingOftenThresholds' silenced_long: description: Thresholds for the silenced-long category allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.silencedLongThresholds' stuck_raised: description: Thresholds for the stuck-raised category allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.stuckRaisedThresholds' github_com_netdata_cloud-alarm-processor-service_api.occurrence: type: object properties: end: description: The end time of the occurrence (only present if lasts_until was provided) type: string example: '2025-05-20T01:49:01.803Z' start: description: The start time of the occurrence type: string example: '2025-05-19T13:49:01.803Z' github_com_netdata_cloud-alarm-processor-service_api.silencedLongAlert: type: object properties: chart: description: Chart the alert belongs to type: string example: disk_space._ context: description: Chart context type: string example: disk.space name: description: Alert name type: string example: disk_space_usage github_com_netdata_cloud-alarm-processor-service_api.silencedLongItem: type: object properties: alert: description: Alert identity allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.silencedLongAlert' count: description: Number of dispatch events where the alert was silenced within the lookback window type: integer example: 72 first_silenced: description: Timestamp of the first silenced dispatch event, in unix milliseconds type: integer example: 1710892800000 last_silenced: description: Timestamp of the last silenced dispatch event, in unix milliseconds type: integer example: 1711497600000 node: description: Node where this alert is silenced allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.MisconfiguredNode' github_com_netdata_cloud-alarm-processor-service_api.silencedLongResponse: type: object properties: items: description: Individual alerts that exceeded the silenced dispatch threshold type: array items: $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.silencedLongItem' totals: description: Aggregated counts across all silenced-long items allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.silencedLongTotals' github_com_netdata_cloud-alarm-processor-service_api.silencedLongThresholds: type: object properties: count: description: Minimum silenced dispatch count to flag an alert (default 20, max 5000) type: integer example: 20 window_seconds: description: Lookback window in seconds for silenced-long detection (default 2592000, max 7776000) type: integer example: 2592000 github_com_netdata_cloud-alarm-processor-service_api.silencedLongTotals: type: object properties: count: description: Sum of silenced dispatch counts across all flagged alerts type: integer example: 150 items: description: Number of alerts flagged as silenced for too long type: integer example: 3 github_com_netdata_cloud-alarm-processor-service_api.silencingRule: type: object properties: account_id: description: The Account ID of the user that created the Silencing Rule type: string format: uuid example: 0deede74-2257-48d7-8b3b-22e3728cd2ff alert_contexts: description: The Alert Contexts to which the Silencing Rule is applicable type: array items: type: string example: - system.cpu - cpu.cpu alert_instances: description: The Alert Instances to which the Silencing Rule is applicable type: array items: type: string example: - system.post_update_reboot_status alert_names: description: The Alert names to which the Silencing Rule is applicable type: array items: type: string example: - 10min_cpu_iowait alert_roles: description: The Alert Roles to which the Silencing Rule is applicable type: array items: type: string example: - webmaster disabled: description: true if the Silencing Rule is Disabled type: boolean example: false host_labels: description: The host label key-values targeting the Nodes the Silencing Rule applies to type: object additionalProperties: type: string example: '{"os"': '"linux"}' id: description: The Silencing Rule ID type: string format: uuid example: 550e8400-e29b-41d4-a716-446655440000 integration_ids: description: The Alert Notification Methods Integration IDs to which the Silencing Rule is applicable type: array items: type: string example: - 303f0cc7-8613-4960-bea6-827be15cb043 - 32000626-37df-4c20-9dd0-cbe2c834384e lasts_until: description: The end of the time window during which the Silencing Rule is applicable type: string example: '2025-05-20T01:49:01.803Z' name: description: The Silencing Rule friendly name type: string example: notify only for Criticals node_ids: description: The Node IDs to which the Silencing Rule is applicable type: array items: type: string format: uuid example: - 21b52a82-8a5f-4a92-8446-8a84c7d1539c - c6b6bcc9-27f1-47c0-ab47-c9cd2b6fc45a - 805e93d7-ad28-4003-a3cb-83e42d1765df read_only: description: true if the Silencing Rule is ReadOnly and cannot be edited type: boolean example: false room_ids: description: The Room IDs to which the Silencing Rule is applicable type: array items: type: string format: uuid example: - 7314a1f2-dcc9-44cb-b9af-297a362bd800 - fff17c3c-4a7c-4990-87c7-dcb7e5d70de8 rrule: description: The RRule string defining the recurrence pattern of the Silencing Rule, if any type: string example: RRULE:FREQ=DAILY severities: description: The Alert Severities to which the Silencing Rule is applicable type: array items: type: string enum: - CLEAR - WARNING - CRITICAL example: - WARNING - CRITICAL starts_at: description: The beginning of the time window during which the Silencing Rule is applicable type: string example: '2025-05-19T13:49:01.803Z' state: description: The current state of the Silencing Rule type: string enum: - INACTIVE - ACTIVE - SCHEDULED example: ACTIVE timezone: description: 'The IANA timezone the Silencing Rule''s recurrence is anchored to, if any. All times stay UTC on the wire; the timezone is applied only when computing recurrence, so it fires at the intended wall-clock time across DST transitions.' type: string example: Europe/Lisbon github_com_netdata_cloud-alarm-processor-service_api.stuckRaisedAlert: type: object properties: chart: description: Chart the alert belongs to type: string example: system.cpu context: description: Chart context type: string example: system.cpu duration_seconds: description: How long the alert has been raised in seconds type: integer example: 86400 name: description: Alert name type: string example: 10min_cpu_usage status: description: Current alert status type: string enum: - critical - warning example: critical triggered_at: description: When the alert was triggered, in unix milliseconds type: integer example: 1710892800000 units: description: Unit of the alert value (e.g. "%", "MB/s"); empty when the alert config has no units type: string example: '%' value: description: Current alert value type: number example: 95.5 github_com_netdata_cloud-alarm-processor-service_api.stuckRaisedItem: type: object properties: alert: description: Alert identity and current state allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.stuckRaisedAlert' node: description: Node where this alert is stuck allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.MisconfiguredNode' github_com_netdata_cloud-alarm-processor-service_api.stuckRaisedResponse: type: object properties: items: description: Individual alerts stuck in a raised state, sorted by duration descending type: array items: $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.stuckRaisedItem' totals: description: Aggregated counts and durations across all stuck-raised items allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.stuckRaisedTotals' github_com_netdata_cloud-alarm-processor-service_api.stuckRaisedStatusTotal: type: object properties: duration_seconds: description: Sum of raised durations in seconds for this status type: integer example: 172800 items: description: Number of alerts with this status type: integer example: 2 github_com_netdata_cloud-alarm-processor-service_api.stuckRaisedThresholds: type: object properties: duration_seconds: description: Minimum raised duration in seconds to flag an alert (default 1209600, max 7776000) type: integer example: 1209600 github_com_netdata_cloud-alarm-processor-service_api.stuckRaisedTotals: type: object properties: critical: description: Breakdown for critical-status alerts allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.stuckRaisedStatusTotal' duration_seconds: description: Sum of raised durations in seconds across all items type: integer example: 259200 items: description: Number of stuck alerts type: integer example: 3 warning: description: Breakdown for warning-status alerts allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-alarm-processor-service_api.stuckRaisedStatusTotal' github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.MisconfiguredNode: type: object properties: id: description: Node unique identifier type: string example: a1b2c3d4-e5f6-7890-abcd-ef1234567890 name: description: Node hostname type: string example: ip-172-31-0-1 github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.dispatchNoneAlert: type: object properties: chart: description: Chart the alert belongs to type: string example: disk_space._ context: description: Chart context type: string example: disk.space name: description: Alert name type: string example: disk_space_usage github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.dispatchNoneItem: type: object properties: alert: description: Alert identity allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.dispatchNoneAlert' count: description: Number of dispatch events where no notification was sent within the lookback window type: integer example: 42 first: description: Timestamp of the first non-dispatched event, in unix milliseconds type: integer example: 1710892800000 last: description: Timestamp of the last non-dispatched event, in unix milliseconds type: integer example: 1711497600000 node: description: Node where this alert is not dispatched allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.MisconfiguredNode' github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.dispatchNoneResponse: type: object properties: items: description: Individual alerts that exceeded the non-dispatched event threshold type: array items: $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.dispatchNoneItem' totals: description: Aggregated counts across all dispatch-none items allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.dispatchNoneTotals' github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.dispatchNoneThresholds: type: object properties: count: description: Minimum non-dispatched event count to flag an alert (default 10, max 5000) type: integer example: 10 window_seconds: description: Lookback window in seconds for dispatch-none detection (default 2592000, max 7776000) type: integer example: 2592000 github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.dispatchNoneTotals: type: object properties: count: description: Sum of non-dispatched event counts across all flagged alerts type: integer example: 150 items: description: Number of alerts flagged as never dispatched type: integer example: 3 github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.evaluateRRuleReq: type: object properties: lasts_until: description: The end time for the daily active window (optional) type: string example: '2025-05-20T01:49:01.803Z' limit: description: 'Maximum number of occurrences to return (optional, default: 10, max: 100)' type: integer example: 10 rrule: description: The RRule string to evaluate (RFC 5545 format) type: string example: RRULE:FREQ=DAILY starts_at: description: The start time for the rrule (DTSTART) type: string example: '2025-05-19T13:49:01.803Z' timezone: description: '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' type: string example: America/New_York window: description: The evaluation time window allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.evaluateRRuleWindowReq' github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.evaluateRRuleRes: type: object properties: has_more: description: Whether there are more occurrences beyond the limit type: boolean example: false occurrences: description: List of occurrence timestamps within the window type: array items: $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.occurrence' rrule: description: The normalized rrule string type: string example: 'DTSTART:20250519T134901Z RRULE:FREQ=DAILY' github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.evaluateRRuleWindowReq: type: object properties: end: description: End of the evaluation time window type: string example: '2025-06-19T00:00:00Z' start: description: Start of the evaluation time window type: string example: '2025-05-19T00:00:00Z' github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.firingOftenAlert: type: object properties: chart: description: Chart the alert belongs to type: string example: system.cpu context: description: Chart context type: string example: system.cpu name: description: Alert name type: string example: 10min_cpu_usage github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.firingOftenItem: type: object properties: alert: description: Alert identity allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.firingOftenAlert' node: description: Node where this alert fires allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.MisconfiguredNode' transitions: description: Number of transitions within the lookback window type: integer example: 100 github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.firingOftenResponse: type: object properties: items: description: Individual alerts that exceeded the transition threshold type: array items: $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.firingOftenItem' totals: description: Aggregated counts across all firing-often items allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.firingOftenTotals' github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.firingOftenThresholds: type: object properties: transitions: description: Minimum number of transitions to flag an alert (default 30, max 5000) type: integer example: 30 window_seconds: description: Lookback window in seconds for counting transitions (default 259200, max 7776000) type: integer example: 259200 github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.firingOftenTotals: type: object properties: items: description: Number of alerts flagged as firing too often type: integer example: 5 transitions: description: Sum of transitions across all flagged alerts type: integer example: 420 github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.misconfiguredAlertsRequest: type: object properties: categories: description: Filter results to specific misconfiguration categories; empty means all categories type: array items: type: string enum: - firing_often - stuck_raised - silenced_long - dispatch_none example: - firing_often - stuck_raised - silenced_long - dispatch_none thresholds: description: Override default detection thresholds per category allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.misconfiguredAlertsThresholds' github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.misconfiguredAlertsResponse: type: object properties: dispatch_none: description: Results for alerts where no notification was dispatched; nil when category is excluded allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.dispatchNoneResponse' firing_often: description: Results for alerts transitioning too frequently; nil when category is excluded allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.firingOftenResponse' silenced_long: description: Results for alerts silenced for too long; nil when category is excluded allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.silencedLongResponse' stuck_raised: description: Results for alerts stuck in a raised state; nil when category is excluded allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.stuckRaisedResponse' thresholds: description: Thresholds used for the calculation; always present allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.misconfiguredAlertsThresholds' github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.misconfiguredAlertsThresholds: type: object properties: dispatch_none: description: Thresholds for the dispatch-none category allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.dispatchNoneThresholds' firing_often: description: Thresholds for the firing-often category allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.firingOftenThresholds' silenced_long: description: Thresholds for the silenced-long category allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.silencedLongThresholds' stuck_raised: description: Thresholds for the stuck-raised category allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.stuckRaisedThresholds' github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.occurrence: type: object properties: end: description: The end time of the occurrence (only present if lasts_until was provided) type: string example: '2025-05-20T01:49:01.803Z' start: description: The start time of the occurrence type: string example: '2025-05-19T13:49:01.803Z' github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.silencedLongAlert: type: object properties: chart: description: Chart the alert belongs to type: string example: disk_space._ context: description: Chart context type: string example: disk.space name: description: Alert name type: string example: disk_space_usage github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.silencedLongItem: type: object properties: alert: description: Alert identity allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.silencedLongAlert' count: description: Number of dispatch events where the alert was silenced within the lookback window type: integer example: 72 first_silenced: description: Timestamp of the first silenced dispatch event, in unix milliseconds type: integer example: 1710892800000 last_silenced: description: Timestamp of the last silenced dispatch event, in unix milliseconds type: integer example: 1711497600000 node: description: Node where this alert is silenced allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.MisconfiguredNode' github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.silencedLongResponse: type: object properties: items: description: Individual alerts that exceeded the silenced dispatch threshold type: array items: $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.silencedLongItem' totals: description: Aggregated counts across all silenced-long items allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.silencedLongTotals' github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.silencedLongThresholds: type: object properties: count: description: Minimum silenced dispatch count to flag an alert (default 20, max 5000) type: integer example: 20 window_seconds: description: Lookback window in seconds for silenced-long detection (default 2592000, max 7776000) type: integer example: 2592000 github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.silencedLongTotals: type: object properties: count: description: Sum of silenced dispatch counts across all flagged alerts type: integer example: 150 items: description: Number of alerts flagged as silenced for too long type: integer example: 3 github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.silencingRule: type: object properties: account_id: description: The Account ID of the user that created the Silencing Rule type: string format: uuid example: 0deede74-2257-48d7-8b3b-22e3728cd2ff alert_contexts: description: The Alert Contexts to which the Silencing Rule is applicable type: array items: type: string example: - system.cpu - cpu.cpu alert_instances: description: The Alert Instances to which the Silencing Rule is applicable type: array items: type: string example: - system.post_update_reboot_status alert_names: description: The Alert names to which the Silencing Rule is applicable type: array items: type: string example: - 10min_cpu_iowait alert_roles: description: The Alert Roles to which the Silencing Rule is applicable type: array items: type: string example: - webmaster disabled: description: true if the Silencing Rule is Disabled type: boolean example: false host_labels: description: The host label key-values targeting the Nodes the Silencing Rule applies to type: object additionalProperties: type: string example: '{"os"': '"linux"}' id: description: The Silencing Rule ID type: string format: uuid example: 550e8400-e29b-41d4-a716-446655440000 integration_ids: description: The Alert Notification Methods Integration IDs to which the Silencing Rule is applicable type: array items: type: string example: - 303f0cc7-8613-4960-bea6-827be15cb043 - 32000626-37df-4c20-9dd0-cbe2c834384e lasts_until: description: The end of the time window during which the Silencing Rule is applicable type: string example: '2025-05-20T01:49:01.803Z' name: description: The Silencing Rule friendly name type: string example: notify only for Criticals node_ids: description: The Node IDs to which the Silencing Rule is applicable type: array items: type: string format: uuid example: - 21b52a82-8a5f-4a92-8446-8a84c7d1539c - c6b6bcc9-27f1-47c0-ab47-c9cd2b6fc45a - 805e93d7-ad28-4003-a3cb-83e42d1765df read_only: description: true if the Silencing Rule is ReadOnly and cannot be edited type: boolean example: false room_ids: description: The Room IDs to which the Silencing Rule is applicable type: array items: type: string format: uuid example: - 7314a1f2-dcc9-44cb-b9af-297a362bd800 - fff17c3c-4a7c-4990-87c7-dcb7e5d70de8 rrule: description: The RRule string defining the recurrence pattern of the Silencing Rule, if any type: string example: RRULE:FREQ=DAILY severities: description: The Alert Severities to which the Silencing Rule is applicable type: array items: type: string enum: - CLEAR - WARNING - CRITICAL example: - WARNING - CRITICAL starts_at: description: The beginning of the time window during which the Silencing Rule is applicable type: string example: '2025-05-19T13:49:01.803Z' state: description: The current state of the Silencing Rule type: string enum: - INACTIVE - ACTIVE - SCHEDULED example: ACTIVE timezone: description: 'The IANA timezone the Silencing Rule''s recurrence is anchored to, if any. All times stay UTC on the wire; the timezone is applied only when computing recurrence, so it fires at the intended wall-clock time across DST transitions.' type: string example: Europe/Lisbon github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.stuckRaisedAlert: type: object properties: chart: description: Chart the alert belongs to type: string example: system.cpu context: description: Chart context type: string example: system.cpu duration_seconds: description: How long the alert has been raised in seconds type: integer example: 86400 name: description: Alert name type: string example: 10min_cpu_usage status: description: Current alert status type: string enum: - critical - warning example: critical triggered_at: description: When the alert was triggered, in unix milliseconds type: integer example: 1710892800000 units: description: Unit of the alert value (e.g. "%", "MB/s"); empty when the alert config has no units type: string example: '%' value: description: Current alert value type: number example: 95.5 github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.stuckRaisedItem: type: object properties: alert: description: Alert identity and current state allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.stuckRaisedAlert' node: description: Node where this alert is stuck allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.MisconfiguredNode' github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.stuckRaisedResponse: type: object properties: items: description: Individual alerts stuck in a raised state, sorted by duration descending type: array items: $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.stuckRaisedItem' totals: description: Aggregated counts and durations across all stuck-raised items allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.stuckRaisedTotals' github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.stuckRaisedStatusTotal: type: object properties: duration_seconds: description: Sum of raised durations in seconds for this status type: integer example: 172800 items: description: Number of alerts with this status type: integer example: 2 github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.stuckRaisedThresholds: type: object properties: duration_seconds: description: Minimum raised duration in seconds to flag an alert (default 1209600, max 7776000) type: integer example: 1209600 github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.stuckRaisedTotals: type: object properties: critical: description: Breakdown for critical-status alerts allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.stuckRaisedStatusTotal' duration_seconds: description: Sum of raised durations in seconds across all items type: integer example: 259200 items: description: Number of stuck alerts type: integer example: 3 warning: description: Breakdown for warning-status alerts allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.stuckRaisedStatusTotal' github_com_netdata_cloud-charts-service_internal_model.AgentSummary: type: object properties: ai: description: The index of the Agent in the summaries array type: integer claim_id: description: The Agent Claim ID type: string format: uuid example: 550e8400-e29b-41d4-a716-446655440000 mg: description: The Agent Machine GUID type: string format: uuid example: 550e8400-e29b-41d4-a716-446655440000 nd: description: The Agent Node ID type: string format: uuid example: 550e8400-e29b-41d4-a716-446655440000 nm: description: The Agent Node name type: string example: my_node timings: description: Timing information for all the stages included until the final composite response is returned allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.Timings' github_com_netdata_cloud-charts-service_internal_model.AggregationMethod: type: string enum: - sum - min - max - avg - median - percentage x-enum-varnames: - Sum - Min - Max - Avg - Median - Pct github_com_netdata_cloud-charts-service_internal_model.Aggregations: type: object properties: metrics: type: array items: $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.MetricsAggregation' time: $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.TimeAggregation' github_com_netdata_cloud-charts-service_internal_model.AlertSummary: type: object properties: cl: description: The count of Clear alerts type: integer cr: description: The count of Critical alerts type: integer nm: description: The Name of the alert can be absent when the counters refer to more than one alert instances. type: string ot: description: The count of Other alerts type: integer wr: description: The count of Warning alerts type: integer github_com_netdata_cloud-charts-service_internal_model.ContextSummary: type: object properties: al: description: Summary of the Alert counts of the participating nodes by severity allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.AlertSummary' ds: description: A breakdown summary of the Dimensions by outcome and filter allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.ItemsCount' id: description: The Context ID type: string is: description: A breakdown summary of the Instances by outcome and filter allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.ItemsCount' sts: description: Provides global statistics such as `min`, `max`, `sum`, `volume`, `count` and `anomaly-rate-count` type: array items: type: integer github_com_netdata_cloud-charts-service_internal_model.DB: type: object properties: dimensions: description: The Database dimensions details allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.DBDimensions' first_entry: description: The `min` (earliest) FirstEntry across participating Nodes type: integer last_entry: description: The `max` (latest) LastEntry across participating Nodes type: integer per_tier: description: Aggregated tier information for all participating Nodes type: array items: $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.Tier' tiers: description: The `max` amount of Database Tiers type: integer units: description: The Units of the database data type: array items: type: integer update_every: description: The `max` UpdateEvery across participating Nodes type: integer github_com_netdata_cloud-charts-service_internal_model.DBDimensions: type: object properties: ids: description: An array with the dimension ids that uniquely identify the dimensions for this query type: array items: type: string sts: description: Statistics of the database dimensions including `max`, `min`, `average`, `sum`, `volume`, `count`, `anomaly-rate-count`, `average-anomaly-rate` and `contribution-percentage` allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.StatsArray' units: description: An array with the units each dimension has in the database (independent of group-by aggregation that may override the units). type: array items: type: string github_com_netdata_cloud-charts-service_internal_model.DimensionSummary: type: object properties: ds: $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.ItemsCount' id: type: string nm: type: string pri: type: integer sts: type: array items: type: integer github_com_netdata_cloud-charts-service_internal_model.GlobalSummary: type: object properties: sts: type: array items: type: integer github_com_netdata_cloud-charts-service_internal_model.InstanceSummary: type: object properties: al: $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.AlertSummary' ds: $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.ItemsCount' id: type: string ni: type: integer nm: type: string sts: type: array items: type: integer github_com_netdata_cloud-charts-service_internal_model.ItemsCount: type: object properties: ex: description: The amount of items that were Excluded type: integer fl: description: The amount of items that were not queried successfully type: integer qr: description: The amount of items that were queried successfully type: integer sl: description: The amount of items that were Selected type: integer github_com_netdata_cloud-charts-service_internal_model.LabelSummary: type: object properties: ds: description: Dimensions are th available label keys allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.ItemsCount' id: description: ID is the label key type: string sts: description: Statistics object including `min`, `max`, `avg`, `anomaly-rate` and `contribution-percentage` type: array items: type: integer vl: description: The Values are summarizing the label values of the result type: array items: $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.LabelValueSummary' github_com_netdata_cloud-charts-service_internal_model.LabelValueSummary: type: object properties: ds: description: Dimensions are the label key-value pairs allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.ItemsCount' id: description: ID is the label value type: string sts: description: Statistics object including `min`, `max`, `avg`, `anomaly-rate` and `contribution-percentage` type: array items: type: integer github_com_netdata_cloud-charts-service_internal_model.MetricsAggregation: type: object properties: aggregation: description: The aggregation function to apply when grouping metrics together. default: average enum: - sum - min - max - avg - median allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.AggregationMethod' example: sum group_by: description: A list of groupings. All possible values can be combined together, except `selected`. If `selected` is provided, all others are ignored. The order they are placed in the list is currently ignored. type: array items: type: string enum: - dimension - instance - percentage-of-instance - label - node - context - units - selected example: - selected group_by_label: description: A list of the label keys to group by their values. The order of the labels in the list is respected. type: array items: type: string example: - a_label_key github_com_netdata_cloud-charts-service_internal_model.NodeStatus: type: object properties: ai: description: The index of the Agent that the Node belongs to type: integer code: description: The HTTP response code the Agent returned type: integer example: 200 ms: description: The required time in milliseconds until the Cloud got back the Agent's response type: number msg: description: Any error message the Agent might have returned type: string example: timed out github_com_netdata_cloud-charts-service_internal_model.NodeSummary: type: object properties: al: description: Summary of the Alert counts of the participating nodes by severity allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.AlertSummary' ds: description: Information regarding the dimensions that were selected, excluded and whether their query was successful or not allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.ItemsCount' is: description: Information regarding the instances that were selected, excluded and whether their query was successful or not allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.ItemsCount' mg: description: The Machine GUID type: string format: uuid example: 550e8400-e29b-41d4-a716-446655440000 nd: description: The Node ID type: string format: uuid example: 550e8400-e29b-41d4-a716-446655440000 ni: description: The index of the Node in the summaries array type: integer nm: description: The Node name type: string example: my_node st: description: Node Status information allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.NodeStatus' sts: description: Provides global statistics such as `min`, `max`, `sum`, `volume`, `count` and `anomaly-rate-count` type: array items: type: integer github_com_netdata_cloud-charts-service_internal_model.PartialDataTrimming: type: object properties: expected_after: type: integer max_update_every: type: integer trimmed_after: type: integer github_com_netdata_cloud-charts-service_internal_model.Result: type: object properties: data: description: The actual time series data is a 2D array whose contents may vary. The first element should be the timestamp while the rest should be arrays of values for the various dimensions type: array items: type: array items: {} labels: description: The IDs of the dimensions returned. The first is always `time`. type: array items: type: string point: description: The format of each point returned. type: object additionalProperties: type: integer github_com_netdata_cloud-charts-service_internal_model.Scope: type: object properties: contexts: description: The targeted contexts. type: array items: type: string example: - disk.space dimensions: description: The targeted dimensions. type: array items: type: string example: - avail - used instances: description: The targeted instances. type: array items: type: string example: - disk_space./@bd498fed-8aa1-440c-a9d6-7c33db570608 labels: description: The targeted labels. type: array items: type: string example: - filesystem:btrfs - mount_point:/host/var/log nodes: description: The targeted nodes. type: array items: type: string example: - node_id_1 - node_id_2 github_com_netdata_cloud-charts-service_internal_model.ScopeDataRequest: type: object properties: aggregations: description: Aggregations define the time and metric aggregation specs. At last one metric aggregation is required allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.Aggregations' format: description: The format of the data to be returned. Only `json2` is currently supported by Netdata Cloud. type: string default: json2 enum: - json2 example: json2 options: description: 'Options that affect data generation, more info on each option : https://learn.netdata.cloud/api#/data/dataQuery2.' type: array items: type: string enum: - jsonwrap - raw - minify - debug - nonzero - null2zero - abs - absolute - display-absolute - flip - reversed - min2max - percentage - seconds - ms - milliseconds - unaligned - match-ids - match-names - anomaly-bit - jw-anomaly-rates - details - group-by-labels - natural-points - virtual-points - selected-tier - all-dimensions - label-quotes - objectrows - google_json example: - jsonwrap - minify scope: description: Scope defines the data that the agent must take into account in order to generate the response. Affects the response data and metadata. allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.Scope' selectors: description: Selectors act as filters when the agent generates the response, and can only affect response data, not metadata. allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.Selectors' timeout: description: Timeout defined in milliseconds. type: integer default: 10000 example: 12000 window: description: Window defines the time-frame of a query. allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.Window' github_com_netdata_cloud-charts-service_internal_model.ScopeDataResponse: type: object properties: agents: description: The Agents consulted to compose this response. type: array items: $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.AgentSummary' api: description: The API version used. type: integer example: 2 db: description: Summarized Agent DB related information allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.DB' functions: description: A list of the supported Functions type: array items: type: string result: description: The composite data query Result allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.Result' summary: description: Summarized information about nodes, contexts, instances, labels, alerts, and dimensions. The items returned are determined by the scope of the query only, however the statistical data in them are influenced by the filters of the query. Using this information the dashboard allows users to slice and dice the data by filtering and grouping. allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.Summary' timings: description: Timing information regarding the various phases of the composite query allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.Timings' totals: description: A summary of the Totals of Nodes, Contexts, Instances, Dimensions and Labels allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.Totals' versions: description: Hashes that allow the caller to detect important database changes of Netdata Agents. allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.Versions' view: description: View includes presentation related details allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.View' github_com_netdata_cloud-charts-service_internal_model.Selectors: type: object properties: alerts: description: A simple pattern matching the alerts to be queried. The simple pattern is checked against the name of alerts and the combination of name:status, when status is one of CLEAR, WARNING, CRITICAL, REMOVED, UNDEFINED, UNINITIALIZED, of all the alerts of all the eligible instances (as filtered by all the above). A negative simple pattern will exclude the instances having the labels matched. type: array items: type: string example: - '*' contexts: description: A simple pattern matching the contexts to be queried. This only controls the data response, not the metadata. Both positive and negative simple pattern expressions are supported. type: array items: type: string example: - '*' dimensions: description: A simple patterns matching the dimensions to be queried. The simple pattern is checked against and id and the name of the dimensions of the eligible instances (as filtered by all the above). Both positive and negative simple pattern expressions are supported. type: array items: type: string example: - sent - received instances: description: A simple pattern matching the instances to be queried. The simple pattern is checked against the instance id, the instance name, the fully qualified name of the instance id and name, like instance@machine_guid, where instance is either its id or name. Both positive and negative simple pattern expressions are supported. type: array items: type: string example: - instance1@machine_guid1 - instance2@machine_guid1 - instanceX@machine_guidX labels: description: 'A simple pattern matching the labels to be queried. The simple pattern is checked against name:value of all the labels of all the eligible instances (as filtered by all the above: scope nodes, scope contexts, nodes, contexts and instances). Negative simple patterns should not be used in this filter.' type: array items: type: string example: - '*' nodes: description: A simple pattern matching the nodes to be queried. This only controls the data response, not the metadata. The simple pattern is checked against the nodes' machine guid, node id, hostname. The default nodes selector is all the nodes matched by the nodes scope. Both positive and negative simple pattern expressions are supported. type: array items: type: string example: - '*' github_com_netdata_cloud-charts-service_internal_model.StatsArray: type: object properties: arc: type: array items: type: number arp: type: array items: type: number avg: type: array items: type: number cnt: type: array items: type: number con: type: array items: type: number max: type: array items: type: number min: type: array items: type: number sum: type: array items: type: number vol: type: array items: type: number github_com_netdata_cloud-charts-service_internal_model.Summary: type: object properties: alerts: description: An array of all the unique alerts running, grouped by alert name type: array items: $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.AlertSummary' contexts: description: Summary of the related Contexts type: array items: $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.ContextSummary' dimensions: description: Summary of the related Dimensions type: array items: $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.DimensionSummary' globals: description: Provides global statistics for all entities including the following aggregate values `min`, `max`, `sum`, `volume`, `count` and `anomaly-rate-count` allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.GlobalSummary' instances: description: Summary of the related Instances type: array items: $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.InstanceSummary' labels: description: Summary of the related Labels type: array items: $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.LabelSummary' nodes: description: Summary of the related nodes type: array items: $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.NodeSummary' github_com_netdata_cloud-charts-service_internal_model.Tier: type: object properties: first_entry: type: integer last_entry: type: integer points: type: integer queries: type: integer tier: type: integer update_every: type: integer github_com_netdata_cloud-charts-service_internal_model.TimeAggregation: type: object properties: time_group: description: Time aggregation function. If multiple collected values are to be grouped in order to return fewer points, this parameters defines the method of grouping. If the `absolute` option is set, the values are turned positive before applying this calculation. type: string default: average enum: - min - max - avg - average - median - stddev - sum - incremental-sum - ses - des - cv - countif - percentile - percentile25 - percentile50 - percentile75 - percentile80 - percentile90 - percentile95 - percentile97 - percentile98 - percentile99 - trimmed-mean - trimmed-mean1 - trimmed-mean2 - trimmed-mean3 - trimmed-mean5 - trimmed-mean10 - trimmed-mean15 - trimmed-mean20 - trimmed-mean25 - trimmed-median - trimmed-median1 - trimmed-median2 - trimmed-median3 - trimmed-median5 - trimmed-median10 - trimmed-median15 - trimmed-median20 - trimmed-median25 example: min time_group_options: description: When the time grouping function supports additional parameters, this field can be used to pass them to it. type: string enum: - countif - trimmed-mean - trimmed-median - percentile example: countif time_resampling: description: For incremental values that are "per second", this value is used to resample them to "per minute` (60) or "per hour" (3600). It can only be used when `time_group` function is `average`. type: integer example: 60 github_com_netdata_cloud-charts-service_internal_model.Timings: type: object properties: cloud_ms: type: number node_max_ms: type: number output_ms: type: number prep_ms: type: number query_ms: type: number routing_ms: type: number total_ms: type: number github_com_netdata_cloud-charts-service_internal_model.Totals: type: object properties: contexts: description: A breakdown summary of the Contexts by outcome and filter allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.ItemsCount' dimensions: description: A breakdown summary of the Dimensions by outcome and filter allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.ItemsCount' instances: description: A breakdown summary of the Instances by outcome and filter allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.ItemsCount' label_key_values: description: A breakdown summary of the LabelKeyValues by outcome and filter allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.ItemsCount' label_keys: description: A breakdown summary of the LabelKeys by outcome and filter allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.ItemsCount' nodes: description: A breakdown summary of the Nodes by outcome and filter allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.ItemsCount' github_com_netdata_cloud-charts-service_internal_model.Versions: type: object properties: alerts_hard_hash: description: An auto-increment value that reflects the number of changes to the number of alerts. Everytime an alert is added or removed, this number gets incremented. type: integer alerts_soft_hash: description: An auto-increment value that reflects the number of alerts transitions. Everytime an alert transitions to a new state, this number gets incremented. type: integer contexts_hard_hash: description: An auto-increment value that reflects the number of changes to the number of contexts maintained by the server. Everytime a context is added or removed, this number gets incremented. type: integer contexts_soft_hash: description: An auto-increment value that reflects the number of changes to the queue that sends contexts updates to Netdata Cloud. Everytime the contents of a context are updated, this number gets incremented. type: integer nodes_hard_hash: description: An auto-increment value that reflects the number of changes to the number of nodes maintained by the server. Everytime a node is added or removed, this number gets incremented. type: integer github_com_netdata_cloud-charts-service_internal_model.View: type: object properties: after: description: The oldest unix epoch timestamp of the data returned type: integer before: description: The newest unix epoch timestamp of the data returned type: integer chart_type: description: The default chart type of the query type: string dimensions: description: Detailed information about the chart dimensions included in the response allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.ViewDimensions' max: description: The maximum value of all points included in the result. type: number min: description: The minimum value of all points included in the type: number partial_data_trimming: description: Holds information related to trimming of the last few points of the result, that was required to remove (increasing) partial data. Trimming is disabled when the `raw` option is given to the query allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.PartialDataTrimming' points: description: The number of points in result. Available only when `raw` option is provided type: integer title: description: The title the chart should have type: string units: description: The units of the query. type: array items: type: integer update_every: description: The UpdateEvery interval in seconds type: integer github_com_netdata_cloud-charts-service_internal_model.ViewDimensions: type: object properties: aggregated: description: An array with the number of source metrics aggregated into each dimension. type: array items: type: integer grouped_by: description: An array with the order of the groupings performed. type: array items: type: string ids: description: An array with the dimension ids that uniquely identify the dimensions for this query. type: array items: type: string labels: description: The labels associated with each dimension in the query. This object is only available when the `group-by-labels` option is provided. type: object additionalProperties: type: array items: type: array items: type: string names: description: An array with the dimension names to be presented to users. Names may be overlapping, but IDs are not. type: array items: type: string priorities: description: An array with the relative priorities of the dimensions. Numbers may not be sequential or unique. The application is expected to order by this and then by name. type: array items: type: integer sts: description: Statistics about the view points for each dimension allOf: - $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.StatsArray' units: description: An array with the units each dimension includes. type: array items: type: string github_com_netdata_cloud-charts-service_internal_model.Window: type: object properties: after: description: After can be a negative number of seconds, up to 3 years (-94608000), relative to before. If not set, it is usually assumed to be -600. When non-data endpoints support the after and before, they use the time-frame to limit their response for objects having data retention within the time-frame given. type: integer example: 1745928492 baseline: $ref: '#/components/schemas/github_com_netdata_cloud-charts-service_internal_model.WindowSpan' before: description: Before can be a negative number of seconds, up to 3 years (-94608000), relative to current clock. If not set, it is assumed to be the current clock time. When before is positive, it is assumed to be a unix epoch timestamp. When non-data endpoints support the after and before, they use the time-frame to limit their response for objects having data retention within the time-frame given. type: integer example: 1745929392 duration: type: integer points: description: The number of points to be returned. If not given, or it is <= 0, or it is bigger than the points stored in the database for the given duration, all the available collected values for the given duration will be returned. type: integer example: 100 tier: description: Use only the given dbengine tier for executing the query. type: integer github_com_netdata_cloud-charts-service_internal_model.WindowSpan: type: object properties: after: description: After can be a negative number of seconds, up to 3 years (-94608000), relative to before. If not set, it is usually assumed to be -600. When non-data endpoints support the after and before, they use the time-frame to limit their response for objects having data retention within the time-frame given. type: integer example: 1745928492 before: description: Before can be a negative number of seconds, up to 3 years (-94608000), relative to current clock. If not set, it is assumed to be the current clock time. When before is positive, it is assumed to be a unix epoch timestamp. When non-data endpoints support the after and before, they use the time-frame to limit their response for objects having data retention within the time-frame given. type: integer example: 1745929392 duration: type: integer points: description: The number of points to be returned. If not given, or it is <= 0, or it is bigger than the points stored in the database for the given duration, all the available collected values for the given duration will be returned. type: integer example: 100 securitySchemes: BearerAuth: type: http scheme: bearer description: Bearer token from Netdata Cloud account settings security: - BearerAuth: [] tags: - name: Spaces description: Operations on Netdata Cloud spaces - name: Rooms description: Operations on rooms within spaces - name: Alerts description: Alert management and silencing - name: Notifications description: Notification silencing rules - name: Data description: Metrics data queries