sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-04-27 12:56:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

add pat and service user docs + remove empty lines from examples

Browse Source
This commit is contained in:
Pascal Fischer
2023-05-08 18:46:40 +02:00
parent c20cecf972
commit 4c51e12888
26 changed files with 946 additions and 1187 deletions
Download Patch File Download Diff File Expand all files Collapse all files

142
src/pages/rules.mdx
View File

@@ -19,7 +19,6 @@ export const title = 'Rules'
curl -X GET https://api.netbird.io/api/rules \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
```
```js
@@ -29,12 +28,10 @@ let config = {
method: 'get',
maxBodyLength: Infinity,
url: '/api/rules',
headers: {
'Accept': 'application/json',
headers: {
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
}
}
};
axios(config)
@@ -52,8 +49,7 @@ import json
url = "https://api.netbird.io/api/rules"
headers = {
headers: {
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
}
@@ -85,9 +81,8 @@ func main() {
if err != nil {
fmt.Println(err)
return
}
{
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -118,7 +113,6 @@ https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"
request["Authorization"] = "Token <TOKEN>"
@@ -132,8 +126,7 @@ OkHttpClient client = new OkHttpClient().newBuilder()
Request request = new Request.Builder()
.url("https://api.netbird.io/api/rules")
.method("GET")
.method("GET")
.addHeader("Accept", "application/json")
.addHeader("Authorization: Token <TOKEN>")
.build();
@@ -153,10 +146,8 @@ curl_setopt_array($curl, array(
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'Accept: application/json',
'Authorization: Token <TOKEN>'
),
@@ -327,12 +318,11 @@ let config = {
method: 'post',
maxBodyLength: Infinity,
url: '/api/rules',
headers: {
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
},
},
data : data
};
@@ -362,8 +352,8 @@ payload = json.dumps({
"ch8i4ug6lnn4g9hqv7m0"
]
})
headers = {
'Content-Type': 'application/json',
headers: {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
}
@@ -407,9 +397,9 @@ func main() {
if err != nil {
fmt.Println(err)
return
}
{
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -478,8 +468,8 @@ RequestBody body = RequestBody.create(mediaType, '{
}');
Request request = new Request.Builder()
.url("https://api.netbird.io/api/rules")
.method("POST", body)
.addHeader("Content-Type", "application/json")
.method("POST", body)
.addHeader("Content-Type", "application/json")
.addHeader("Accept", "application/json")
.addHeader("Authorization: Token <TOKEN>")
.build();
@@ -499,9 +489,8 @@ curl_setopt_array($curl, array(
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS =>'{
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => '{
"name": "Default",
"description": "This is a default rule that allows connections between all the resources",
"disabled": false,
@@ -513,8 +502,8 @@ curl_setopt_array($curl, array(
"ch8i4ug6lnn4g9hqv7m0"
]
}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json',
'Accept: application/json',
'Authorization: Token <TOKEN>'
),
@@ -606,7 +595,6 @@ echo $response;
curl -X GET https://api.netbird.io/api/rules/{ruleId} \
-H "Authorization: Token <TOKEN>" \
-H 'Accept: application/json' \
```
```js
@@ -616,12 +604,10 @@ let config = {
method: 'get',
maxBodyLength: Infinity,
url: '/api/rules/{ruleId}',
headers: {
'Accept': 'application/json',
headers: {
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
}
}
};
axios(config)
@@ -639,8 +625,7 @@ import json
url = "https://api.netbird.io/api/rules/{ruleId}"
headers = {
headers: {
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
}
@@ -672,9 +657,8 @@ func main() {
if err != nil {
fmt.Println(err)
return
}
{
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -705,7 +689,6 @@ https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"
request["Authorization"] = "Token <TOKEN>"
@@ -719,8 +702,7 @@ OkHttpClient client = new OkHttpClient().newBuilder()
Request request = new Request.Builder()
.url("https://api.netbird.io/api/rules/{ruleId}")
.method("GET")
.method("GET")
.addHeader("Accept", "application/json")
.addHeader("Authorization: Token <TOKEN>")
.build();
@@ -740,10 +722,8 @@ curl_setopt_array($curl, array(
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'Accept: application/json',
'Authorization: Token <TOKEN>'
),
@@ -918,12 +898,11 @@ let config = {
method: 'put',
maxBodyLength: Infinity,
url: '/api/rules/{ruleId}',
headers: {
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
},
},
data : data
};
@@ -953,8 +932,8 @@ payload = json.dumps({
"ch8i4ug6lnn4g9hqv7m0"
]
})
headers = {
'Content-Type': 'application/json',
headers: {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
}
@@ -998,9 +977,9 @@ func main() {
if err != nil {
fmt.Println(err)
return
}
{
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1069,8 +1048,8 @@ RequestBody body = RequestBody.create(mediaType, '{
}');
Request request = new Request.Builder()
.url("https://api.netbird.io/api/rules/{ruleId}")
.method("PUT", body)
.addHeader("Content-Type", "application/json")
.method("PUT", body)
.addHeader("Content-Type", "application/json")
.addHeader("Accept", "application/json")
.addHeader("Authorization: Token <TOKEN>")
.build();
@@ -1090,9 +1069,8 @@ curl_setopt_array($curl, array(
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_POSTFIELDS =>'{
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_POSTFIELDS => '{
"name": "Default",
"description": "This is a default rule that allows connections between all the resources",
"disabled": false,
@@ -1104,8 +1082,8 @@ curl_setopt_array($curl, array(
"ch8i4ug6lnn4g9hqv7m0"
]
}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json',
'Accept: application/json',
'Authorization: Token <TOKEN>'
),
@@ -1200,8 +1178,6 @@ echo $response;
```bash {{ title: 'cURL' }}
curl -X DELETE https://api.netbird.io/api/rules/{ruleId} \
-H "Authorization: Token <TOKEN>" \
```
```js
@@ -1211,12 +1187,9 @@ let config = {
method: 'delete',
maxBodyLength: Infinity,
url: '/api/rules/{ruleId}',
headers: {
headers: {
'Authorization': 'Token <TOKEN>'
}
}
};
axios(config)
@@ -1234,9 +1207,7 @@ import json
url = "https://api.netbird.io/api/rules/{ruleId}"
headers = {
headers: {
'Authorization': 'Token <TOKEN>'
}
@@ -1267,10 +1238,8 @@ func main() {
if err != nil {
fmt.Println(err)
return
}
{
req.Header.Add("Authorization", "Token <TOKEN>")
res, err := client.Do(req)
@@ -1300,8 +1269,6 @@ https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = "Token <TOKEN>"
response = https.request(request)
@@ -1314,9 +1281,7 @@ OkHttpClient client = new OkHttpClient().newBuilder()
Request request = new Request.Builder()
.url("https://api.netbird.io/api/rules/{ruleId}")
.method("DELETE")
.method("DELETE")
.addHeader("Authorization: Token <TOKEN>")
.build();
Response response = client.newCall(request).execute();
@@ -1335,11 +1300,8 @@ curl_setopt_array($curl, array(
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => array(
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => array(
'Authorization: Token <TOKEN>'
),
));