File: README.md

package info (click to toggle)
netdata 1.37.1-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 59,364 kB
  • sloc: ansic: 302,654; javascript: 77,865; python: 27,094; sh: 18,726; cpp: 2,916; makefile: 2,547; pascal: 171; xml: 10
file content (12 lines) | stat: -rw-r--r-- 935 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
 
<!--
title: "API"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/README.md
-->

# API

## Netdata REST API

The complete documentation of the Netdata API is available as a Swagger API document [in our GitHub repository](https://raw.githubusercontent.com/netdata/netdata/master/web/api/netdata-swagger.yaml). You can view it online using the **[Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/netdata/netdata/master/web/api/netdata-swagger.yaml)**.

If your prefer it over the Swagger Editor, you can also use [Swagger UI](https://github.com/swagger-api/swagger-ui) by pointing at `web/api/netdata-swagger.yaml` in the Netdata source tree (or at https://raw.githubusercontent.com/netdata/netdata/master/web/api/netdata-swagger.yaml if you want to use the Swagger API definitions directly from our GitHub repository). This however does not provide all the information available.