Skip to content

Commit

Permalink
Update API pages with v0.30.0
Browse files Browse the repository at this point in the history
  • Loading branch information
netbirddev committed Oct 4, 2024
1 parent 57a6fa7 commit b7a15c6
Show file tree
Hide file tree
Showing 3 changed files with 330 additions and 114 deletions.
180 changes: 178 additions & 2 deletions src/pages/ipa/resources/policies.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,12 @@ echo $response;
"ports": [
"80"
],
"port_ranges": [
{
"start": 80,
"end": 320
}
],
"sources": [
{
"id": "ch8i4ug6lnn4g9hqv7m0",
Expand Down Expand Up @@ -224,6 +230,12 @@ echo $response;
"ports": [
"string"
],
"port_ranges": [
{
"start": "integer",
"end": "integer"
}
],
"sources": [
{
"id": "string",
Expand Down Expand Up @@ -330,7 +342,29 @@ echo $response;
</Property>
<Property name="ports" type="string[]" required={false}>
Policy rule affected ports or it ranges list
Policy rule affected ports
</Property>
<Property name="port_ranges" type="object[]" required={false}>
<details class="custom-details" open>
<summary>Policy rule affected ports ranges list</summary>
<Properties>
<Properties><Property name="start" type="integer" required={true}>
The starting port of the range
</Property>
<Property name="end" type="integer" required={true}>
The ending port of the range
</Property>
</Properties>
</Properties>
</details>
</Property>
<Property name="sources" type="string[]" required={true}>
Expand Down Expand Up @@ -381,6 +415,12 @@ curl -X POST https://api.netbird.io/api/policies \
"ports": [
"80"
],
"port_ranges": [
{
"start": 80,
"end": 320
}
],
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
Expand Down Expand Up @@ -414,6 +454,12 @@ let data = JSON.stringify({
"ports": [
"80"
],
"port_ranges": [
{
"start": 80,
"end": 320
}
],
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
Expand Down Expand Up @@ -469,6 +515,12 @@ payload = json.dumps({
"ports": [
"80"
],
"port_ranges": [
{
"start": 80,
"end": 320
}
],
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
Expand Down Expand Up @@ -524,6 +576,12 @@ func main() {
"ports": [
"80"
],
"port_ranges": [
{
"start": 80,
"end": 320
}
],
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
Expand Down Expand Up @@ -597,6 +655,12 @@ request.body = JSON.dump({
"ports": [
"80"
],
"port_ranges": [
{
"start": 80,
"end": 320
}
],
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
Expand Down Expand Up @@ -634,6 +698,12 @@ RequestBody body = RequestBody.create(mediaType, '{
"ports": [
"80"
],
"port_ranges": [
{
"start": 80,
"end": 320
}
],
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
Expand Down Expand Up @@ -687,6 +757,12 @@ curl_setopt_array($curl, array(
"ports": [
"80"
],
"port_ranges": [
{
"start": 80,
"end": 320
}
],
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
Expand Down Expand Up @@ -734,6 +810,12 @@ echo $response;
"ports": [
"80"
],
"port_ranges": [
{
"start": 80,
"end": 320
}
],
"sources": [
{
"id": "ch8i4ug6lnn4g9hqv7m0",
Expand Down Expand Up @@ -775,6 +857,12 @@ echo $response;
"ports": [
"string"
],
"port_ranges": [
{
"start": "integer",
"end": "integer"
}
],
"sources": [
{
"id": "string",
Expand Down Expand Up @@ -990,6 +1078,12 @@ echo $response;
"ports": [
"80"
],
"port_ranges": [
{
"start": 80,
"end": 320
}
],
"sources": [
{
"id": "ch8i4ug6lnn4g9hqv7m0",
Expand Down Expand Up @@ -1031,6 +1125,12 @@ echo $response;
"ports": [
"string"
],
"port_ranges": [
{
"start": "integer",
"end": "integer"
}
],
"sources": [
{
"id": "string",
Expand Down Expand Up @@ -1144,7 +1244,29 @@ echo $response;
</Property>
<Property name="ports" type="string[]" required={false}>
Policy rule affected ports or it ranges list
Policy rule affected ports
</Property>
<Property name="port_ranges" type="object[]" required={false}>
<details class="custom-details" open>
<summary>Policy rule affected ports ranges list</summary>
<Properties>
<Properties><Property name="start" type="integer" required={true}>
The starting port of the range
</Property>
<Property name="end" type="integer" required={true}>
The ending port of the range
</Property>
</Properties>
</Properties>
</details>
</Property>
<Property name="sources" type="string[]" required={true}>
Expand Down Expand Up @@ -1195,6 +1317,12 @@ curl -X PUT https://api.netbird.io/api/policies/{policyId} \
"ports": [
"80"
],
"port_ranges": [
{
"start": 80,
"end": 320
}
],
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
Expand Down Expand Up @@ -1228,6 +1356,12 @@ let data = JSON.stringify({
"ports": [
"80"
],
"port_ranges": [
{
"start": 80,
"end": 320
}
],
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
Expand Down Expand Up @@ -1283,6 +1417,12 @@ payload = json.dumps({
"ports": [
"80"
],
"port_ranges": [
{
"start": 80,
"end": 320
}
],
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
Expand Down Expand Up @@ -1338,6 +1478,12 @@ func main() {
"ports": [
"80"
],
"port_ranges": [
{
"start": 80,
"end": 320
}
],
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
Expand Down Expand Up @@ -1411,6 +1557,12 @@ request.body = JSON.dump({
"ports": [
"80"
],
"port_ranges": [
{
"start": 80,
"end": 320
}
],
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
Expand Down Expand Up @@ -1448,6 +1600,12 @@ RequestBody body = RequestBody.create(mediaType, '{
"ports": [
"80"
],
"port_ranges": [
{
"start": 80,
"end": 320
}
],
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
Expand Down Expand Up @@ -1501,6 +1659,12 @@ curl_setopt_array($curl, array(
"ports": [
"80"
],
"port_ranges": [
{
"start": 80,
"end": 320
}
],
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
Expand Down Expand Up @@ -1548,6 +1712,12 @@ echo $response;
"ports": [
"80"
],
"port_ranges": [
{
"start": 80,
"end": 320
}
],
"sources": [
{
"id": "ch8i4ug6lnn4g9hqv7m0",
Expand Down Expand Up @@ -1589,6 +1759,12 @@ echo $response;
"ports": [
"string"
],
"port_ranges": [
{
"start": "integer",
"end": "integer"
}
],
"sources": [
{
"id": "string",
Expand Down
Loading

0 comments on commit b7a15c6

Please sign in to comment.