sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-04-18 08:26:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update API pages with v0.35.0

Browse Source
This commit is contained in:
netbirddev
2024-12-23 17:49:49 +00:00
parent bf2c616dce
commit 81001b562c
5 changed files with 3934 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

184
src/pages/ipa/resources/groups.mdx
View File

@@ -165,12 +165,19 @@ echo $response;
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2,
"resources_count": 5,
"issued": "api",
"peers": [
{
"id": "chacbco6lnnbn6cg5s90",
"name": "stage-host-1"
}
],
"resources": [
{
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
]
}
]
@@ -181,12 +188,19 @@ echo $response;
"id": "string",
"name": "string",
"peers_count": "integer",
"resources_count": "integer",
"issued": "string",
"peers": [
{
"id": "string",
"name": "string"
}
],
"resources": [
{
"id": "string",
"type": "string"
}
]
}
]
@@ -217,6 +231,28 @@ echo $response;
List of peers ids
</Property>
<Property name="resources" type="object[]" required={false}>
<details class="custom-details" open>
<summary>More Information</summary>
<Properties>
<Properties><Property name="id" type="string" required={true}>
ID of the resource
</Property>
<Property name="type" type="string" required={true} enumList={["host","subnet","domain"]}>
Network resource type based of the address
</Property>
</Properties>
</Properties>
</details>
</Property>
</Properties>
@@ -234,6 +270,12 @@ curl -X POST https://api.netbird.io/api/groups \
"name": "devs",
"peers": [
"ch8i4ug6lnn4g9hqv7m1"
],
"resources": [
{
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
]
}'
```
@@ -244,6 +286,12 @@ let data = JSON.stringify({
"name": "devs",
"peers": [
"ch8i4ug6lnn4g9hqv7m1"
],
"resources": [
{
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
]
});
let config = {
@@ -276,6 +324,12 @@ payload = json.dumps({
"name": "devs",
"peers": [
"ch8i4ug6lnn4g9hqv7m1"
],
"resources": [
{
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
]
})
headers = {
@@ -308,6 +362,12 @@ func main() {
"name": "devs",
"peers": [
"ch8i4ug6lnn4g9hqv7m1"
],
"resources": [
{
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
]
}`)
client := &http.Client {
@@ -358,6 +418,12 @@ request.body = JSON.dump({
"name": "devs",
"peers": [
"ch8i4ug6lnn4g9hqv7m1"
],
"resources": [
{
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
]
})
response = https.request(request)
@@ -372,6 +438,12 @@ RequestBody body = RequestBody.create(mediaType, '{
"name": "devs",
"peers": [
"ch8i4ug6lnn4g9hqv7m1"
],
"resources": [
{
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
]
}');
Request request = new Request.Builder()
@@ -402,6 +474,12 @@ curl_setopt_array($curl, array(
"name": "devs",
"peers": [
"ch8i4ug6lnn4g9hqv7m1"
],
"resources": [
{
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
]
}',
CURLOPT_HTTPHEADER => array(
@@ -426,12 +504,19 @@ echo $response;
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2,
"resources_count": 5,
"issued": "api",
"peers": [
{
"id": "chacbco6lnnbn6cg5s90",
"name": "stage-host-1"
}
],
"resources": [
{
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
]
}
```
@@ -440,12 +525,19 @@ echo $response;
"id": "string",
"name": "string",
"peers_count": "integer",
"resources_count": "integer",
"issued": "string",
"peers": [
{
"id": "string",
"name": "string"
}
],
"resources": [
{
"id": "string",
"type": "string"
}
]
}
```
@@ -628,12 +720,19 @@ echo $response;
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2,
"resources_count": 5,
"issued": "api",
"peers": [
{
"id": "chacbco6lnnbn6cg5s90",
"name": "stage-host-1"
}
],
"resources": [
{
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
]
}
```
@@ -642,12 +741,19 @@ echo $response;
"id": "string",
"name": "string",
"peers_count": "integer",
"resources_count": "integer",
"issued": "string",
"peers": [
{
"id": "string",
"name": "string"
}
],
"resources": [
{
"id": "string",
"type": "string"
}
]
}
```
@@ -685,6 +791,28 @@ echo $response;
List of peers ids
</Property>
<Property name="resources" type="object[]" required={false}>
<details class="custom-details" open>
<summary>More Information</summary>
<Properties>
<Properties><Property name="id" type="string" required={true}>
ID of the resource
</Property>
<Property name="type" type="string" required={true} enumList={["host","subnet","domain"]}>
Network resource type based of the address
</Property>
</Properties>
</Properties>
</details>
</Property>
</Properties>
@@ -702,6 +830,12 @@ curl -X PUT https://api.netbird.io/api/groups/{groupId} \
"name": "devs",
"peers": [
"ch8i4ug6lnn4g9hqv7m1"
],
"resources": [
{
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
]
}'
```
@@ -712,6 +846,12 @@ let data = JSON.stringify({
"name": "devs",
"peers": [
"ch8i4ug6lnn4g9hqv7m1"
],
"resources": [
{
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
]
});
let config = {
@@ -744,6 +884,12 @@ payload = json.dumps({
"name": "devs",
"peers": [
"ch8i4ug6lnn4g9hqv7m1"
],
"resources": [
{
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
]
})
headers = {
@@ -776,6 +922,12 @@ func main() {
"name": "devs",
"peers": [
"ch8i4ug6lnn4g9hqv7m1"
],
"resources": [
{
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
]
}`)
client := &http.Client {
@@ -826,6 +978,12 @@ request.body = JSON.dump({
"name": "devs",
"peers": [
"ch8i4ug6lnn4g9hqv7m1"
],
"resources": [
{
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
]
})
response = https.request(request)
@@ -840,6 +998,12 @@ RequestBody body = RequestBody.create(mediaType, '{
"name": "devs",
"peers": [
"ch8i4ug6lnn4g9hqv7m1"
],
"resources": [
{
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
]
}');
Request request = new Request.Builder()
@@ -870,6 +1034,12 @@ curl_setopt_array($curl, array(
"name": "devs",
"peers": [
"ch8i4ug6lnn4g9hqv7m1"
],
"resources": [
{
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
]
}',
CURLOPT_HTTPHEADER => array(
@@ -894,12 +1064,19 @@ echo $response;
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2,
"resources_count": 5,
"issued": "api",
"peers": [
{
"id": "chacbco6lnnbn6cg5s90",
"name": "stage-host-1"
}
],
"resources": [
{
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
]
}
```
@@ -908,12 +1085,19 @@ echo $response;
"id": "string",
"name": "string",
"peers_count": "integer",
"resources_count": "integer",
"issued": "string",
"peers": [
{
"id": "string",
"name": "string"
}
],
"resources": [
{
"id": "string",
"type": "string"
}
]
}
```