mirror of
https://github.com/netbirdio/docs.git
synced 2026-04-18 16:36:35 +00:00
29 lines
1.3 KiB
Plaintext
29 lines
1.3 KiB
Plaintext
---
|
|
id: netbird-rest-api
|
|
title: "NetBird REST API"
|
|
description: "API to manipulate groups, rules, policies and retrieve information about peers and users"
|
|
sidebar_label: Introduction
|
|
sidebar_position: 0
|
|
hide_title: true
|
|
custom_edit_url: null
|
|
---
|
|
|
|
import ApiLogo from "@theme/ApiLogo";
|
|
import SchemaTabs from "@theme/SchemaTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
import Export from "@theme/ApiDemoPanel/Export";
|
|
|
|
<span className={"theme-doc-version-badge badge badge--secondary"}>Version: 0.0.1</span>
|
|
|
|
# NetBird REST API
|
|
|
|
|
|
|
|
API to manipulate groups, rules, policies and retrieve information about peers and users
|
|
|
|
<div style={{"marginBottom":"2rem"}}><h2 id={"authentication"} style={{"marginBottom":"1rem"}}>Authentication</h2><SchemaTabs className={"openapi-tabs__security-schemes"}><TabItem label={"HTTP: Bearer Auth"} value={"BearerAuth"}><div><table><tbody><tr><th>Security Scheme Type:</th><td>http</td></tr><tr><th>HTTP Authorization Scheme:</th><td>bearer</td></tr><tr><th>Bearer format:</th><td>JWT</td></tr></tbody></table></div></TabItem><TabItem label={"API Key: TokenAuth"} value={"TokenAuth"}>
|
|
|
|
Prefix the value with \"Token\" to indicate the custom authorization type
|
|
|
|
<div><table><tbody><tr><th>Security Scheme Type:</th><td>apiKey</td></tr><tr><th>Header parameter name:</th><td>Authorization</td></tr></tbody></table></div></TabItem></SchemaTabs></div>
|
|
|