sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-04-20 17:36:36 +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

332
src/pages/ipa/resources/policies.mdx
View File

@@ -192,17 +192,27 @@ echo $response;
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2,
"resources_count": 5,
"issued": "api"
}
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2,
"resources_count": 5,
"issued": "api"
}
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
}
@@ -241,17 +251,27 @@ echo $response;
"id": "string",
"name": "string",
"peers_count": "integer",
"resources_count": "integer",
"issued": "string"
}
],
"sourceResource": {
"id": "string",
"type": "string"
},
"destinations": [
{
"id": "string",
"name": "string",
"peers_count": "integer",
"resources_count": "integer",
"issued": "string"
}
]
],
"destinationResource": {
"id": "string",
"type": "string"
}
}
]
}
@@ -367,15 +387,59 @@ echo $response;
</details>
</Property>
<Property name="sources" type="string[]" required={true}>
<Property name="sources" type="string[]" required={false}>
Policy rule source group IDs
</Property>
<Property name="destinations" type="string[]" required={true}>
<Property name="sourceResource" 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>
<Property name="destinations" type="string[]" required={false}>
Policy rule destination group IDs
</Property>
<Property name="destinationResource" 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>
@@ -424,9 +488,17 @@ curl -X POST https://api.netbird.io/api/policies \
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
"ch8i4ug6lnn4g9h7v7m0"
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
}'
@@ -463,9 +535,17 @@ let data = JSON.stringify({
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
"ch8i4ug6lnn4g9h7v7m0"
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
});
@@ -524,9 +604,17 @@ payload = json.dumps({
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
"ch8i4ug6lnn4g9h7v7m0"
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
})
@@ -585,9 +673,17 @@ func main() {
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
"ch8i4ug6lnn4g9h7v7m0"
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
}`)
@@ -664,9 +760,17 @@ request.body = JSON.dump({
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
"ch8i4ug6lnn4g9h7v7m0"
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
})
@@ -707,9 +811,17 @@ RequestBody body = RequestBody.create(mediaType, '{
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
"ch8i4ug6lnn4g9h7v7m0"
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
}');
@@ -766,9 +878,17 @@ curl_setopt_array($curl, array(
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
"ch8i4ug6lnn4g9h7v7m0"
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
}',
@@ -821,17 +941,27 @@ echo $response;
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2,
"resources_count": 5,
"issued": "api"
}
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2,
"resources_count": 5,
"issued": "api"
}
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
}
@@ -868,17 +998,27 @@ echo $response;
"id": "string",
"name": "string",
"peers_count": "integer",
"resources_count": "integer",
"issued": "string"
}
],
"sourceResource": {
"id": "string",
"type": "string"
},
"destinations": [
{
"id": "string",
"name": "string",
"peers_count": "integer",
"resources_count": "integer",
"issued": "string"
}
]
],
"destinationResource": {
"id": "string",
"type": "string"
}
}
]
}
@@ -1089,17 +1229,27 @@ echo $response;
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2,
"resources_count": 5,
"issued": "api"
}
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2,
"resources_count": 5,
"issued": "api"
}
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
}
@@ -1136,17 +1286,27 @@ echo $response;
"id": "string",
"name": "string",
"peers_count": "integer",
"resources_count": "integer",
"issued": "string"
}
],
"sourceResource": {
"id": "string",
"type": "string"
},
"destinations": [
{
"id": "string",
"name": "string",
"peers_count": "integer",
"resources_count": "integer",
"issued": "string"
}
]
],
"destinationResource": {
"id": "string",
"type": "string"
}
}
]
}
@@ -1269,15 +1429,59 @@ echo $response;
</details>
</Property>
<Property name="sources" type="string[]" required={true}>
<Property name="sources" type="string[]" required={false}>
Policy rule source group IDs
</Property>
<Property name="destinations" type="string[]" required={true}>
<Property name="sourceResource" 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>
<Property name="destinations" type="string[]" required={false}>
Policy rule destination group IDs
</Property>
<Property name="destinationResource" 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>
@@ -1326,9 +1530,17 @@ curl -X PUT https://api.netbird.io/api/policies/{policyId} \
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
"ch8i4ug6lnn4g9h7v7m0"
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
}'
@@ -1365,9 +1577,17 @@ let data = JSON.stringify({
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
"ch8i4ug6lnn4g9h7v7m0"
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
});
@@ -1426,9 +1646,17 @@ payload = json.dumps({
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
"ch8i4ug6lnn4g9h7v7m0"
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
})
@@ -1487,9 +1715,17 @@ func main() {
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
"ch8i4ug6lnn4g9h7v7m0"
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
}`)
@@ -1566,9 +1802,17 @@ request.body = JSON.dump({
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
"ch8i4ug6lnn4g9h7v7m0"
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
})
@@ -1609,9 +1853,17 @@ RequestBody body = RequestBody.create(mediaType, '{
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
"ch8i4ug6lnn4g9h7v7m0"
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
}');
@@ -1668,9 +1920,17 @@ curl_setopt_array($curl, array(
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
"ch8i4ug6lnn4g9h7v7m0"
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
}',
@@ -1723,17 +1983,27 @@ echo $response;
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2,
"resources_count": 5,
"issued": "api"
}
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "devs",
"peers_count": 2,
"resources_count": 5,
"issued": "api"
}
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
}
@@ -1770,17 +2040,27 @@ echo $response;
"id": "string",
"name": "string",
"peers_count": "integer",
"resources_count": "integer",
"issued": "string"
}
],
"sourceResource": {
"id": "string",
"type": "string"
},
"destinations": [
{
"id": "string",
"name": "string",
"peers_count": "integer",
"resources_count": "integer",
"issued": "string"
}
]
],
"destinationResource": {
"id": "string",
"type": "string"
}
}
]
}