mirror of
https://github.com/netbirdio/docs.git
synced 2026-04-19 00:46:35 +00:00
add first version using docusaurus-openapi-docs
This commit is contained in:
29
docs/api/netbird-rest-api.info.mdx
Normal file
29
docs/api/netbird-rest-api.info.mdx
Normal file
@@ -0,0 +1,29 @@
|
||||
---
|
||||
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>
|
||||
|
||||
Reference in New Issue
Block a user