query-netdata-cloud

Construct REST API queries to retrieve metrics, logs, topology, and configuration data from Netdata Cloud infrastructure.

80.4k|6.6k|Updated Jun 17, 2013
One-click install
npx skills add https://github.com/netdata/netdata --skill query-netdata-cloud
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: query-netdata-cloud
Source: https://github.com/netdata/netdata/tree/main/docs/netdata-ai/skills/query-netdata-cloud
Command: npx skills add https://github.com/netdata/netdata --skill query-netdata-cloud

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires jq, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill addresses the complexity of interacting with the Netdata Cloud REST API, providing a standardized, secure, and documented way to query infrastructure metrics, logs, and configurations without exposing sensitive credentials.

Core Features & Use Cases

  • Unified Querying: Access metrics, systemd-journal logs, network flows, and alert transitions through a single interface.
  • Operational Recipes: Includes a live catalog of how-to guides for common tasks like listing nodes, rooms, or evaluating alert configurations.
  • Secure Execution: Uses token-safe wrappers to prevent accidental exposure of API tokens in assistant interactions.

Quick Start

Use the query-netdata-cloud skill to list all nodes in my current room.

Frequently Asked Questions about query-netdata-cloud

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I query Netdata Cloud metrics via API?

Use the POST /api/v2/nodes/{nodeID}/function endpoint with the appropriate function name. Ensure your request body includes the required scope and context parameters as defined in the metrics domain guide.

Can I access systemd-journal logs through Netdata Cloud?

Yes, use the systemd-journal Function via the Cloud REST API. You must filter by source using the selections parameter in your JSON body to ensure efficient and performant log retrieval.

What permissions are required to query Netdata Cloud?

Your API token must have the appropriate scope, such as scope:all or specific permissions like PermissionAlertReadAll or PermissionFunctionExec, depending on the endpoint you are accessing.

How do I handle sensitive data in API responses?

Treat all raw API responses as sensitive, as they may contain hostnames, IP addresses, and machine identifiers. Never commit raw response bodies to version control; redirect output to gitignored local files.

Why am I receiving an HTTP 403 error?

An HTTP 403 error indicates that your API token lacks the necessary scope or role for the requested endpoint. Verify your token permissions in the Netdata Cloud User Settings.