Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Netdata functions API

Everything related to functions

Netdata functions API is one of 20 APIs that Netdata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include functions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 8 operations across 7 paths. It is described by OpenAPI 3.0.0, at version v1-rolling.

Requests are made against 3 base URLs: https://registry.my-netdata.io, http://registry.my-netdata.io, http://localhost:19999.

8 operations 7 paths 0 schemas 7 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v1-rolling
Base URL
http://localhost:19999
Authentication
HTTP Bearer, HTTP Bearer, API Key
License
Resource Areas
1

Authentication & Security 3

Netdata functions API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP bearer tokens (aclkAuth). An API key is passed in the header as X-Forwarded-For (ipAcl).

  • bearerAuth — Bearer token authentication for API access when bearer protection is enabled. How to obtain a token: 1. Token must be obtained via /api/v3/bearergettoken endpo…
  • aclkAuth — ACLK-only authentication - these APIs are ONLY accessible via Netdata Cloud (ACLK). Access Requirements: - User must be authenticated via Netdata Cloud (SIGNED…
  • ipAcl — IP-based Access Control List restrictions (informational only). Configuration: APIs are subject to IP-based ACL restrictions configured in netdata.conf: conf […

Paths & Operations 8

Across 7 paths, the API surfaces 8 operations — 7 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

functions 8

Everything related to functions

GET
/api/v3/progress
Track progress of long-running function executions
progress3 1 param → 200400404500
GET
/api/v3/function
Execute a Netdata function on a specific node
function3 2 params → 200202400403404500503504
POST
/api/v3/function
Execute a Netdata function with request body parameters
function3_post 2 params body → 200202400403404500503504
GET
/api/v3/functions
List available functions across all nodes
functions3 5 params → 200400500504
GET
/api/v2/progressdeprecated
OBSOLETE: Track async operation progress (use /api/v3/progress instead)
progress2 1 param → 200400
GET
/api/v2/functionsdeprecated
OBSOLETE: List available functions (use /api/v3/functions instead)
functions2 5 params → 200400
GET
/api/v1/functiondeprecated
| Security & Access Control: - 📊 Public Data API - Bearer token optional, IP-based ACL restrictions apply - Default Access: Public (no authentication required) - Bearer Protection: When enabled via /…
function1 2 params → 200400404500503504591
GET
/api/v1/functionsdeprecated
Get a list of all registered collector functions.
functions1 → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netdata-functions-api-openapi.yml Raw ↑

Other APIs Netdata publishes across the network.

Netdata Agent API
Netdata alerts API
Netdata authentication API
Netdata badges API
Netdata charts API
Netdata claiming API
Netdata config API
Netdata contexts API
Netdata data API
Netdata dyncfg API
Netdata management API
Netdata nodes API