### Settings Response Examples

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Examples of JSON responses for new and existing settings files.

```json
{
  "version": 1
}
```

```json
{
  "version": 5,
  "theme": "dark",
  "language": "en",
  "dashboard": {
    "layout": "grid",
    "columns": 3
  },
  "notifications": {
    "enabled": true,
    "sound": false
  }
}
```

--------------------------------

### Example GET Request for Alert Transitions

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

This example demonstrates how to retrieve the last 100 alert transitions to a CRITICAL state within the past 24 hours. It utilizes query parameters for filtering and time range.

```http
GET /api/v3/alert_transitions?last=100&f_status=CRITICAL&after=-86400
```

--------------------------------

### Example Payload for Updating Existing Settings

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Shows the JSON payload for updating an existing settings file. The `version` field must match the current version obtained from a previous GET request, along with any modified or new settings.

```json
{
  "version": 5,
  "theme": "light",
  "dashboard": {
    "layout": "list"
  }
}
```

--------------------------------

### WebRTC SDP Offer Example

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Example of an SDP offer that might be sent to the server. This includes session details, media configuration, ICE credentials, and DTLS fingerprint. The server uses this to generate an SDP answer.

```text
v=0
o=- 123456789 2 IN IP4 127.0.0.1
s=-
t=0 0
a=group:BUNDLE 0
m=application 9 UDP/DTLS/SCTP webrtc-datachannel
c=IN IP4 0.0.0.0
a=ice-ufrag:abcd1234
a=ice-pwd:efgh5678ijkl9012mnop3456
a=fingerprint:sha-256 AB:CD:EF:01:23:45:67:89:AB:CD:EF:01:23:45:67:89:AB:CD:EF:01:23:45:67:89:AB:CD:EF:01:23:45:67:89:AB
a=setup:actpass
a=mid:0
a=sctp-port:5000
a=max-message-size:65536
```

--------------------------------

### Example Chart IDs for System Metrics

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Examples of common chart IDs for system-related metrics, useful when specifying the 'chart' parameter for the variable endpoint.

```bash
chart=system.cpu
```

```bash
chart=system.load
```

```bash
chart=system.ram
```

```bash
chart=system.io
```

--------------------------------

### Example Chart IDs for Disk Metrics

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Examples of common chart IDs for disk-related metrics, useful when specifying the 'chart' parameter for the variable endpoint.

```bash
chart=disk.space
```

```bash
chart=disk.io
```

```bash
chart=disk.inodes
```

--------------------------------

### SDP Offer Structure Example

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Example of a valid SDP offer string required for the /api/v3/rtc_offer endpoint. The offer must include session information, media descriptions, ICE credentials, and a DTLS fingerprint.

```text
v=0
o=- 123456789 2 IN IP4 127.0.0.1
s=-
t=0 0
a=group:BUNDLE 0
a=msid-semantic: WMS
m=application 9 UDP/DTLS/SCTP webrtc-datachannel
c=IN IP4 0.0.0.0
a=ice-ufrag:XXXX
a=ice-pwd:YYYY
a=fingerprint:sha-256 ZZ:ZZ:...
a=setup:actpass
a=mid:0
a=sctp-port:5000
a=max-message-size:65536
```

--------------------------------

### Example Chart IDs for Database Metrics

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Examples of common chart IDs for database-related metrics, useful when specifying the 'chart' parameter for the variable endpoint.

```bash
chart=mysql.queries
```

```bash
chart=postgres.connections
```

```bash
chart=redis.memory
```

--------------------------------

### Example Chart IDs for Network Metrics

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Examples of common chart IDs for network-related metrics, useful when specifying the 'chart' parameter for the variable endpoint.

```bash
chart=net.eth0
```

```bash
chart=net.packets
```

--------------------------------

### WebRTC SDP Answer Example

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Example of an SDP answer generated by the server for a WebRTC connection. This includes session information, media descriptions, ICE candidates, and DTLS fingerprint. The client should use this to complete the WebRTC handshake.

```json
{
  "sdp": "v=0\no=- 987654321 2 IN IP4 192.168.1.100\ns=- \nt=0 0\na=group:BUNDLE 0\nm=application 9 UDP/DTLS/SCTP webrtc-datachannel\nc=IN IP4 192.168.1.100\na=candidate:1 1 udp 2130706431 192.168.1.100 54321 typ host\na=candidate:2 1 udp 1694498815 203.0.113.1 54321 typ srflx raddr 192.168.1.100 rport 54321\na=ice-ufrag:wxyz9876\na=ice-pwd:stuv5432wxyz1098abcd7654\na=fingerprint:sha-256 12:34:56:78:9A:BC:DE:F0:12:34:56:78:9A:BC:DE:F0:12:34:56:78:9A:BC:DE:F0:12:34:56:78:9A:BC:DE:F0:12\na=setup:active\na=mid:0\na=sctp-port:5000\na=max-message-size:5242880",
  "type": "answer"
}
```

--------------------------------

### Bearer Protection State Response Example

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Example JSON response showing the current bearer protection state.

```json
{
  "bearer_protection": true
}
```

--------------------------------

### Configure Response Options

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Example value for the options query parameter to control detail level.

```text
full,labels
```

--------------------------------

### Progress response examples

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

JSON response structures for running and completed function states.

```json
{
  "transaction": "550e8400-e29b-41d4-a716-446655440000",
  "status": "running",
  "percentage": 45,
  "message": "Processing data...",
  "done": 450,
  "all": 1000,
  "eta_seconds": 30
}
```

```json
{
  "transaction": "550e8400-e29b-41d4-a716-446655440000",
  "status": "completed",
  "percentage": 100
}
```

--------------------------------

### GET /api/v1/contexts

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Retrieves a summary of all node contexts available on the Netdata server.

```APIDOC
## GET /api/v1/contexts

### Description
The contexts endpoint returns a summary about all contexts stored in the netdata server.

### Method
GET

### Endpoint
/api/v1/contexts

### Parameters
#### Query Parameters
- **dimensions** (reference) - Optional - Filter by dimensions
- **chart_label_key** (reference) - Optional - Filter by label key
- **chart_labels_filter** (reference) - Optional - Filter by labels
- **contextOptions1** (reference) - Optional - Context options
- **after** (reference) - Optional - Start time filter
- **before** (reference) - Optional - End time filter

### Response
#### Success Response (200)
- **Array** (object) - An array of contexts.
```

--------------------------------

### GET /api/v3/metrics

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Retrieves system metrics in various formats including shell and prometheus.

```APIDOC
## GET /api/v3/metrics

### Description
Retrieves system metrics from Netdata. Supports multiple output formats and filtering options.

### Method
GET

### Endpoint
/api/v3/metrics

### Parameters
#### Query Parameters
- **format** (string) - Required - The format of the response (shell, prometheus, prometheus_all_hosts, json).
- **filter** (string) - Optional - Allows to filter charts out using simple patterns.
- **variables** (string) - Optional - Expose system configuration variables (yes/no).
- **timestamps** (string) - Optional - Enable or disable timestamps in prometheus output (yes/no).
- **names** (string) - Optional - Report dimension names or IDs (yes/no).
- **oldunits** (string) - Optional - Use legacy unit naming conventions (yes/no).
- **hideunits** (string) - Optional - Do not include units in metric names (yes/no).
- **server** (string) - Optional - Set a distinct name of the client querying metrics.
- **prefix** (string) - Optional - Prefix all prometheus metrics with this string.
- **data** (string) - Optional - Select the prometheus response data source (as-collected, average, sum).

### Response
#### Success Response (200)
- **metrics** (object) - All the metrics returned in the format requested.

#### Error Response (400)
- **error** (string) - The format requested is not supported.
```

--------------------------------

### Get Dimension Value Example

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

This example demonstrates how to retrieve the value of the 'used' dimension for a chart. The '$' prefix is optional.

```http
GET /api/v1/alarm?chart=system.ram&variable=used
```

--------------------------------

### Get Dimension Value with '$' Prefix Example

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

This example shows retrieving the 'used' dimension value using the optional '$' prefix, which is functionally equivalent to not using it.

```http
GET /api/v1/alarm?chart=system.ram&variable=$used
```

--------------------------------

### Get Special Variable 'this' Example

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Retrieve the current calculated or evaluated value from an alert expression using the 'this' special variable.

```http
GET /api/v1/alarm?chart=system.ram&variable=this
```

--------------------------------

### GET /api/v2/alert_transitions

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

OBSOLETE: Get alert state transition history. Use /api/v3/alert_transitions instead.

```APIDOC
## GET /api/v2/alert_transitions

### Description
**⚠️ OBSOLETE API - Will be removed in future versions**

This endpoint is deprecated. Use `/api/v3/alert_transitions` instead, which provides the same functionality.

**Migration:** Replace `/api/v2/alert_transitions` with `/api/v3/alert_transitions` in all API calls.

Returns historical alert state transitions showing how alerts changed over time. Supports faceted filtering by status, type, role, class, component, node, alert name, chart name, and context.

**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 `/api/v3/bearer_protection`, requires bearer token

### Method
GET

### Endpoint
/api/v2/alert_transitions

### Parameters
#### Query Parameters
- **scopeNodes** (string) - Optional - Scope for nodes
- **filterNodes** (string) - Optional - Filter nodes
- **scopeContexts** (string) - Optional - Scope for contexts
- **filterContexts** (string) - Optional - Filter contexts
- **scopeDimensions** (string) - Optional - Scope for dimensions
- **filterDimensions** (string) - Optional - Filter dimensions
- **baselineAfter** (integer) - Optional - Baseline after timestamp
- **baselineBefore** (integer) - Optional - Baseline before timestamp
- **after** (integer) - Optional - Unix timestamp for the start of the time range
- **before** (integer) - Optional - Unix timestamp for the end of the time range
- **tier** (string) - Optional - Filter by alert tier
- **points** (integer) - Optional - Number of points to retrieve
- **timeoutMS** (integer) - Optional - Timeout in milliseconds
- **dataQueryOptions** (object) - Optional - Data query options
- **dataTimeGroup2** (string) - Optional - Time grouping option
- **dataTimeGroupOptions2** (object) - Optional - Time grouping options
- **cardinalityLimit** (integer) - Optional - Limit for cardinality

### Responses
#### Success Response (200)
- **description**: JSON object with weights for each context, chart and dimension.

#### Error Response
- **400**: The given parameters are invalid.
- **403**: metrics correlations are not enabled on this Netdata Agent.
- **404**: No charts could be found, or the method that correlated the metrics did not produce any result.
- **504**: Timeout - the query took too long and has been cancelled.

```

--------------------------------

### Example Payload for Creating New Settings

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Illustrates the JSON payload structure for creating a new settings file. It includes the mandatory `version` field set to 0 and optional user-defined fields like `theme` and `language`.

```json
{
  "version": 0,
  "theme": "dark",
  "language": "en"
}
```

--------------------------------

### GET /api/v2/alerts

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

OBSOLETE: Get current alert status across all nodes. Use /api/v3/alerts instead.

```APIDOC
## GET /api/v2/alerts

### Description
**⚠️ OBSOLETE API - Will be removed in future versions**

This endpoint is deprecated. Use `/api/v3/alerts` instead, which provides the same functionality.

**Migration:** Replace `/api/v2/alerts` with `/api/v3/alerts` in all API calls.

Returns the current status of health monitoring alerts across all nodes in the infrastructure. Supports filtering by status, alert name, and node selection.

**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 `/api/v3/bearer_protection`, requires bearer token
- **IP Restrictions:** Subject to `allow dashboard from` in netdata.conf
- **Access Methods:** Direct HTTP/HTTPS, Netdata Cloud, external tools

### Method
GET

### Endpoint
/api/v2/alerts

### Parameters
#### Query Parameters
- **scopeNodes** (string) - Optional - Scope for nodes
- **filterNodes** (string) - Optional - Filter nodes
- **scopeContexts** (string) - Optional - Scope for contexts
- **filterContexts** (string) - Optional - Filter contexts
- **status** (string) - Optional - Filter alerts by status (e.g., CRITICAL, WARNING, CLEAR)
- **alert** (string) - Optional - Filter by alert name pattern
- **dataQueryOptions** (object) - Optional - Data query options
- **after** (integer) - Optional - Unix timestamp for the start of the time range
- **before** (integer) - Optional - Unix timestamp for the end of the time range
- **timeoutMS** (integer) - Optional - Timeout in milliseconds
- **cardinalityLimit** (integer) - Optional - Limit for cardinality

### Responses
#### Success Response (200)
- **description**: Alert status successfully retrieved

#### Error Response
- **400**: Invalid parameters

```

--------------------------------

### Get Alert Configuration API

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Use this GET request to retrieve the alert configuration for a specific UUID, which can reveal available variables.

```http
GET /api/v3/alert_config?config=<uuid>
```

--------------------------------

### Browse Configuration Tree

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Use this endpoint to view the hierarchical structure of Netdata's configuration. The 'path' parameter can be used to navigate specific directories.

```bash
/api/v3/config?action=tree&path=/
```

--------------------------------

### GET /api/v3/progress

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Retrieves the current progress and status of a specific function execution transaction. This endpoint is designed for polling to get real-time updates.

```APIDOC
## GET /api/v3/progress

### Description
Retrieves the current progress and status of a specific function execution transaction. This endpoint is designed for polling to get real-time updates.

### Method
GET

### Endpoint
/api/v3/progress

### Parameters
#### Query Parameters
- **transaction** (string) - Required - Transaction ID (UUID) of the function execution to track. This ID is returned when initiating a function execution via `/api/v3/function` or similar endpoints. The UUID format is standard v4, case-insensitive. Valid for the lifetime of the function execution, expires after completion or timeout. Invalid or expired transactions will result in a 400 or 404 error.

### Request Example
```json
{
  "example": "/api/v3/progress?transaction=550e8400-e29b-41d4-a716-446655440000"
}
```

### Response
#### Success Response (200)
- **transaction** (string) - The transaction ID being tracked.
- **status** (string) - Current status of the function execution. Enum: [running, completed, failed, cancelled].
- **percentage** (integer) - Completion percentage (0-100).
- **message** (string) - Human-readable status message or error description.
- **done** (integer) - Number of items processed (if applicable).
- **all** (integer) - Total number of items to process (if applicable).
- **eta_seconds** (integer) - Estimated time remaining in seconds (if available).

#### Response Example
```json
{
  "example": {
    "transaction": "550e8400-e29b-41d4-a716-446655440000",
    "status": "running",
    "percentage": 45,
    "message": "Processing data...",
    "done": 450,
    "all": 1000,
    "eta_seconds": 30
  }
}
```

```json
{
  "example": {
    "transaction": "550e8400-e29b-41d4-a716-446655440000",
    "status": "completed",
    "percentage": 100
  }
}
```

### Security & Access Control
- **Always Public API**: Accessible without authentication.
- **No Restrictions**: Not subject to bearer protection or IP-based ACL restrictions.
- **Access**: Available to anyone who can reach the agent's HTTP endpoint.
```

--------------------------------

### Retrieve Netdata Agent Versions

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Examples of querying the versions endpoint for all nodes, specific node patterns, or scoped infrastructure.

```text
/api/v3/versions
```

```text
/api/v3/versions?nodes=prod-*
```

```text
/api/v3/versions?scope_nodes=prod-*
```

--------------------------------

### Get Chart Details API

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Retrieve details for a specific chart using this GET request. Dimension names listed here are typically available as variables.

```http
GET /api/v1/chart?chart=system.ram
```

--------------------------------

### Bearer Token Generation and Usage

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Demonstrates how to obtain a bearer token using curl and jq, and how to use that token in subsequent API requests.

```bash
# Obtain token
TOKEN=$(curl "http://localhost:19999/api/v3/bearer_get_token?claim_id=...&machine_guid=...&node_id=..." | jq -r .token)

# Use token in subsequent requests
curl -H "Authorization: Bearer $TOKEN" http://localhost:19999/api/v3/data?chart=system.cpu
```

--------------------------------

### Optimistic Locking Flow Example

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Illustrates the client-side flow for updating settings using optimistic locking, including handling potential conflicts.

```APIDOC
## Optimistic Locking Flow Example

### Description
This example demonstrates the client-side implementation of the optimistic locking strategy for updating user settings. It covers fetching current settings, modifying them, sending the update with the original version, and handling a 409 Conflict response by re-fetching and retrying.

### Code Example
```javascript
// 1. Get current settings
const response = await fetch('/api/v3/settings?file=my-dashboard');
const settings = await response.json(); // e.g., { version: 3, ... }

// 2. Modify settings locally
settings.theme = 'dark';

// 3. PUT updated settings WITH ORIGINAL VERSION (still 3)
const result = await fetch('/api/v3/settings?file=my-dashboard', {
  method: 'PUT',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify(settings) // settings object includes version: 3
});

if (result.status === 409) {
  // Conflict! Another client updated the file.
  // Action: GET the file again to retrieve the latest version,
  // reapply your changes to the new version, and PUT again.
  console.error('Conflict detected. Please retry the operation.');
} else if (result.ok) {
  // Update successful. The file on the server now has version: 4.
  console.log('Settings updated successfully.');
}
```
```

--------------------------------

### GET /api/v1/config

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Retrieves dynamic configuration information from the Netdata agent. This endpoint supports various actions such as listing the configuration tree, retrieving schemas, or getting specific configuration details.

```APIDOC
## GET /api/v1/config

### Description
Get dynamic configuration information. This endpoint is public by default but may require a bearer token if protection is enabled.

### Method
GET

### Endpoint
/api/v1/config

### Parameters
#### Query Parameters
- **action** (string) - Optional - The type of information required (tree, schema, get, enable, disable, restart). Default: tree
- **id** (string) - Optional - The ID of the dynamic configuration entity
- **path** (string) - Optional - Top level path of the configuration entities, used with action 'tree'. Default: '/'
- **timeout** (number) - Optional - The timeout in seconds. Default: 120

### Response
#### Success Response (200)
- **response** (object) - Returns configuration data based on the requested action.
```

--------------------------------

### Get Instances for Nodes Matching Pattern

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Use pattern matching to retrieve instances from nodes that fit a specific naming convention. This allows for dynamic selection of nodes based on patterns like 'prod-*'.

```bash
GET /api/v3/node_instances?scope_nodes=prod-*
```

--------------------------------

### Execute Netdata Functions via API

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Examples of triggering various Netdata functions using query parameters.

```http
/api/v3/function?function=processes
```

```http
/api/v3/function?function=systemd-list-units&timeout=30
```

```http
/api/v3/function?function=network-connections
```

```http
/api/v3/function?function=docker-containers&timeout=60
```

--------------------------------

### Get Claiming Info and Verification Command

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

This `curl` command initiates the claiming process by requesting information and the OS-specific command to retrieve the verification key from the agent.

```bash
# 1. Get claiming info and verification command
curl http://localhost:19999/api/v3/claim
```

--------------------------------

### Retrieve Settings via HTTP GET

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Use these requests to fetch settings files. Anonymous users are restricted to the 'default' file.

```http
GET /api/v3/settings?file=default
```

```http
GET /api/v3/settings?file=production-dashboard
```

--------------------------------

### GET /api/v1/function

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Executes a specific collector function.

```APIDOC
## GET /api/v1/function

### Description
Executes a collector function on demand. This endpoint is deprecated.

### Method
GET

### Endpoint
/api/v1/function

### Parameters
#### Query Parameters
- **function** (string) - Required - The name of the function, as returned by the collector.
- **timeoutSecs** (integer) - Optional - Timeout in seconds for the collector execution.

### Response
#### Success Response (200)
- **content** (object) - The collector function has been executed successfully. Each collector may return a different type of content.
```

--------------------------------

### GET /api/v1/alarms

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Retrieves a list of active or raised alarms.

```APIDOC
## GET /api/v1/alarms

### Description
Returns the list of all raised or enabled alarms on the Netdata server. Called without parameters, it returns alarms in WARNING or CRITICAL state. This endpoint is deprecated.

### Method
GET

### Endpoint
/api/v1/alarms

### Parameters
#### Query Parameters
- **all** (boolean) - Optional - If provided, returns all enabled alarms instead of just raised ones.
```

--------------------------------

### Retrieve Node Information via API v3

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Examples of querying the /api/v3/info endpoint for all nodes, specific nodes, pattern-matched nodes, or with extended options.

```http
# Get info for all nodes
GET /api/v3/info

# Get info for specific nodes
GET /api/v3/info?nodes=web-server-01,db-server-01

# Get info for nodes matching pattern
GET /api/v3/info?scope_nodes=prod-*

# Include specific options
GET /api/v3/info?options=full
```

--------------------------------

### POST /api/v3/rtc_offer

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Establishes a WebRTC peer connection by exchanging an SDP offer for an SDP answer.

```APIDOC
## POST /api/v3/rtc_offer

### Description
This endpoint implements the WebRTC signaling process for establishing peer-to-peer data connections with the Netdata agent. It follows the standard WebRTC negotiation flow using SDP (Session Description Protocol) offer/answer exchange.

### Method
POST

### Endpoint
/api/v3/rtc_offer

### Request Body
- **SDP Offer** (string) - Required - The SDP offer string from the client's WebRTC peer connection, containing session information, media descriptions, ICE credentials, and DTLS fingerprint.

### Request Example
{
  "v=0\r\no=- 123456789 2 IN IP4 127.0.0.1\r\n..."
}

### Response
#### Success Response (200)
- **SDP Answer** (string) - The SDP answer generated by the agent, including gathered ICE candidates.

#### Response Example
{
  "v=0\r\no=- 987654321 2 IN IP4 127.0.0.1\r\n..."
}
```

--------------------------------

### GET /api/v1/functions

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Retrieves a list of all registered collector functions.

```APIDOC
## GET /api/v1/functions

### Description
Returns a list of all registered collector functions that can be executed on demand. This endpoint is deprecated.

### Method
GET

### Endpoint
/api/v1/functions

### Response
#### Success Response (200)
- **functions** (object) - A JSON object containing one object per supported function.
```

--------------------------------

### GET /api/v3/me

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Retrieves information about the currently authenticated user.

```APIDOC
## GET /api/v3/me

### Description
Retrieves information about the currently authenticated user.

### Method
GET

### Endpoint
/api/v3/me
```

--------------------------------

### Combine Multiple Options

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Request both detailed debug information and raw function definitions by providing a comma-separated list of options.

```bash
/api/v3/functions?options=debug,raw
```

--------------------------------

### GET /api/v1/ml_info

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Retrieves machine learning detection information. This endpoint is deprecated.

```APIDOC
## GET /api/v1/ml_info

### Description
**[DEPRECATED]**

Retrieves machine learning detection information.

### Method
GET

### Endpoint
/api/v1/ml_info
```

--------------------------------

### Get Configuration Schema

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Obtain the schema or template for a component's configuration. This defines the structure and valid parameters for configuration settings.

```bash
/api/v3/config?action=schema&id=collectors:go.d:prometheus
```

--------------------------------

### GET /api/v3/functions

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Retrieves a catalog of all available functions across the monitored infrastructure.

```APIDOC
## GET /api/v3/functions

### Description
Retrieves a catalog of available functions across the monitored infrastructure, including per-node availability, metadata, and plugin information.

### Method
GET

### Endpoint
/api/v3/functions
```

--------------------------------

### Request Raw Function Definitions

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Include the raw source code or definition of functions in the response by using the 'raw' option. This is helpful for understanding function implementation details.

```bash
/api/v3/functions?options=raw
```

--------------------------------

### GET /api/v3/alert-transitions

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Retrieve filtered alert transitions using facet parameters.

```APIDOC
## GET /api/v3/alert-transitions

### Description
Retrieve alert transitions filtered by various system facets such as components, nodes, alerts, instances, and contexts.

### Method
GET

### Endpoint
/api/v3/alert-transitions

### Parameters
#### Query Parameters
- **f_component** (string) - Optional - Comma-separated list of system components (e.g., Network, Disk, Memory, CPU, Database).
- **f_node** (string) - Optional - Comma-separated list of exact node hostnames.
- **f_alert** (string) - Optional - Comma-separated list of exact alert names.
- **f_instance** (string) - Optional - Comma-separated list of chart instance names (e.g., disk_sda, eth0).
- **f_context** (string) - Optional - Comma-separated list of exact metric context names (e.g., system.cpu).
- **timeout** (integer) - Optional - Maximum time in milliseconds to wait for the query to complete.
```

--------------------------------

### Execute logs-query function with JSON parameters

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Example request body for the logs-query function, specifying time ranges, filtering, and result limits.

```json
{
  "after": -3600,
  "before": 0,
  "filter": "error",
  "limit": 100
}
```

--------------------------------

### GET /api/v1/badge.svg

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Generates a badge in SVG format for a specific chart or dimension.

```APIDOC
## GET /api/v1/badge.svg

### Description
Generates a badge in the form of an SVG image for a chart or dimension. Note: This endpoint is deprecated.

### Method
GET

### Endpoint
/api/v1/badge.svg

### Parameters
#### Query Parameters
- **alarm** (string) - Optional - The name of an alarm linked to the chart.

### Response
#### Success Response (200)
- **image** (image/svg+xml) - Successful responses are SVG images.
```

--------------------------------

### Query Alert Transitions with Faceted Filters

Source: https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml

Examples of URL query parameters for filtering alert transition history by status, component, alert name, or node.

```text
?last=100&f_status=CRITICAL
```

```text
?f_component=Database&after=-86400
```

```text
?f_alert=disk_space_usage&last=50
```

```text
?f_node=web-server-01&after=-604800
```