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

[API] add cloud and experimantal badges + new pages (#292)

Browse Source
This commit is contained in:
Pascal Fischer
2025-03-20 18:04:45 +01:00
committed by GitHub
parent 553d2908b8
commit 4a66f17880
18 changed files with 2873 additions and 97 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
generator/api.ts
View File

@@ -49,6 +49,7 @@ export default async function gen(inputFileName: string, outputDir: string) {
type v3OperationWithPath = OpenAPIV3.OperationObject & { type v3OperationWithPath = OpenAPIV3.OperationObject & {
path: string path: string
} }
export type objectRepresentation = { export type objectRepresentation = {
@@ -104,22 +105,16 @@ async function gen_v3(spec: OpenAPIV3.Document, dest: string) {
} }
} }
// if(operation.summary == "List all Tokens") {
// console.log(response.example)
// console.log(operation.responses["200"]["content"]["application/json"].schema.items.properties)
// }
const enriched = { const enriched = {
...operation, ...operation,
path: key, path: key,
fullPath, fullPath,
operationId: slugify(operation.summary!), operationId: slugify(operation.summary!),
responseList: toArrayWithKey(operation.responses!, 'responseCode') || [], responseList: toArrayWithKey(operation.responses!, 'responseCode') || [],
request: request, request: request,
response: response, response: response,
} }
let tag = operation.tags.pop() let tag = operation.tags.pop()
let tagOperations = tagGroups.get(tag) ?? [] let tagOperations = tagGroups.get(tag) ?? []
tagGroups.set(tag, tagOperations.concat(enriched)) tagGroups.set(tag, tagOperations.concat(enriched))

2
generator/templates/ApiTemplate.ts
View File

@@ -4,7 +4,7 @@ export const title = '<%- tag %>'
<% operations.forEach(function(operation){ %> <% operations.forEach(function(operation){ %>
## <%- operation.summary %> {{ tag: '<%- operation.operation.toUpperCase() %>' , label: '<%- operation.path %>' }} <% if(operation.deprecated) { %><Badge status="warning" text="Deprecated" /><% } %> ## <%- operation.summary %> <% if(operation.deprecated) { %> <Badge status="warning" text="Deprecated" /> <% } %><% if(operation["x-cloud-only"]) { %> <Badge status="cloud-only" text="Cloud-Only" /> <% } %><% if(operation["x-experimental"]) { %> <Badge status="experimental" text="Experimental" /> <% } %> {{ tag: '<%- operation.operation.toUpperCase() %>' , label: '<%- operation.path %>' }}
<Row> <Row>
<Col> <Col>

4
src/components/Badge.jsx
View File

@@ -9,6 +9,10 @@ export function Badge({ status, text }) {
case 'error': case 'error':
// Never tested colors // Never tested colors
return 'bg-red-300/30 text-red-400 dark:bg-red-400/10 dark:text-red-400'; return 'bg-red-300/30 text-red-400 dark:bg-red-400/10 dark:text-red-400';
case 'cloud-only':
return 'bg-orange-200/50 text-orange-400 dark:bg-orange-600/20 dark:text-orange-400';
case 'experimental':
return 'bg-teal-200/50 text-teal-400 dark:bg-teal-500/15 dark:text-teal-400';
default: default:
return 'bg-gray-500/30 text-gray-600 dark:bg-gray-400/10 dark:text-gray-400'; return 'bg-gray-500/30 text-gray-600 dark:bg-gray-400/10 dark:text-gray-400';
} }

1
src/components/NavigationAPI.jsx
View File

@@ -25,6 +25,7 @@ export const apiNavigation = [
{ title: 'Users', href: '/api/resources/users' }, { title: 'Users', href: '/api/resources/users' },
{ title: 'Tokens', href: '/api/resources/tokens' }, { title: 'Tokens', href: '/api/resources/tokens' },
{ title: 'Peers', href: '/api/resources/peers' }, { title: 'Peers', href: '/api/resources/peers' },
{ title: 'Ingress Ports', href: '/api/resources/ingress-ports' },
{ title: 'Setup Keys', href: '/api/resources/setup-keys' }, { title: 'Setup Keys', href: '/api/resources/setup-keys' },
{ title: 'Groups', href: '/api/resources/groups' }, { title: 'Groups', href: '/api/resources/groups' },
{ title: 'Policies', href: '/api/resources/policies' }, { title: 'Policies', href: '/api/resources/policies' },

62
src/pages/ipa/resources/accounts.mdx
View File

@@ -2,7 +2,7 @@ export const title = 'Accounts'
## List all Accounts {{ tag: 'GET' , label: '/api/accounts' }} ## List all Accounts {{ tag: 'GET' , label: '/api/accounts' }}
<Row> <Row>
<Col> <Col>
@@ -177,7 +177,9 @@ echo $response;
], ],
"routing_peer_dns_resolution_enabled": true, "routing_peer_dns_resolution_enabled": true,
"extra": { "extra": {
"peer_approval_enabled": true "peer_approval_enabled": true,
"network_traffic_logs_enabled": true,
"network_traffic_packet_counter_enabled": true
} }
} }
} }
@@ -201,7 +203,9 @@ echo $response;
], ],
"routing_peer_dns_resolution_enabled": "boolean", "routing_peer_dns_resolution_enabled": "boolean",
"extra": { "extra": {
"peer_approval_enabled": "boolean" "peer_approval_enabled": "boolean",
"network_traffic_logs_enabled": "boolean",
"network_traffic_packet_counter_enabled": "boolean"
} }
} }
} }
@@ -216,7 +220,7 @@ echo $response;
--- ---
## Delete an Account {{ tag: 'DELETE' , label: '/api/accounts/{accountId}' }} ## Delete an Account {{ tag: 'DELETE' , label: '/api/accounts/{accountId}' }}
<Row> <Row>
<Col> <Col>
@@ -380,7 +384,7 @@ echo $response;
--- ---
## Update an Account {{ tag: 'PUT' , label: '/api/accounts/{accountId}' }} ## Update an Account {{ tag: 'PUT' , label: '/api/accounts/{accountId}' }}
<Row> <Row>
<Col> <Col>
@@ -458,10 +462,20 @@ echo $response;
<summary>More Information</summary> <summary>More Information</summary>
<Properties> <Properties>
<Properties><Property name="peer_approval_enabled" type="boolean" required={false}> <Properties><Property name="peer_approval_enabled" type="boolean" required={true}>
(Cloud only) Enables or disables peer approval globally. If enabled, all peers added will be in pending state until approved by an admin. (Cloud only) Enables or disables peer approval globally. If enabled, all peers added will be in pending state until approved by an admin.
</Property>
<Property name="network_traffic_logs_enabled" type="boolean" required={true}>
Enables or disables network traffic logs. If enabled, all network traffic logs from peers will be stored.
</Property>
<Property name="network_traffic_packet_counter_enabled" type="boolean" required={true}>
Enables or disables network traffic packet counter. If enabled, network packets and their size will be counted and reported. (This can have an slight impact on performance)
</Property> </Property>
</Properties> </Properties>
@@ -502,7 +516,9 @@ curl -X PUT https://api.netbird.io/api/accounts/{accountId} \
], ],
"routing_peer_dns_resolution_enabled": true, "routing_peer_dns_resolution_enabled": true,
"extra": { "extra": {
"peer_approval_enabled": true "peer_approval_enabled": true,
"network_traffic_logs_enabled": true,
"network_traffic_packet_counter_enabled": true
} }
} }
}' }'
@@ -525,7 +541,9 @@ let data = JSON.stringify({
], ],
"routing_peer_dns_resolution_enabled": true, "routing_peer_dns_resolution_enabled": true,
"extra": { "extra": {
"peer_approval_enabled": true "peer_approval_enabled": true,
"network_traffic_logs_enabled": true,
"network_traffic_packet_counter_enabled": true
} }
} }
}); });
@@ -570,7 +588,9 @@ payload = json.dumps({
], ],
"routing_peer_dns_resolution_enabled": true, "routing_peer_dns_resolution_enabled": true,
"extra": { "extra": {
"peer_approval_enabled": true "peer_approval_enabled": true,
"network_traffic_logs_enabled": true,
"network_traffic_packet_counter_enabled": true
} }
} }
}) })
@@ -615,7 +635,9 @@ func main() {
], ],
"routing_peer_dns_resolution_enabled": true, "routing_peer_dns_resolution_enabled": true,
"extra": { "extra": {
"peer_approval_enabled": true "peer_approval_enabled": true,
"network_traffic_logs_enabled": true,
"network_traffic_packet_counter_enabled": true
} }
} }
}`) }`)
@@ -678,7 +700,9 @@ request.body = JSON.dump({
], ],
"routing_peer_dns_resolution_enabled": true, "routing_peer_dns_resolution_enabled": true,
"extra": { "extra": {
"peer_approval_enabled": true "peer_approval_enabled": true,
"network_traffic_logs_enabled": true,
"network_traffic_packet_counter_enabled": true
} }
} }
}) })
@@ -705,7 +729,9 @@ RequestBody body = RequestBody.create(mediaType, '{
], ],
"routing_peer_dns_resolution_enabled": true, "routing_peer_dns_resolution_enabled": true,
"extra": { "extra": {
"peer_approval_enabled": true "peer_approval_enabled": true,
"network_traffic_logs_enabled": true,
"network_traffic_packet_counter_enabled": true
} }
} }
}'); }');
@@ -748,7 +774,9 @@ curl_setopt_array($curl, array(
], ],
"routing_peer_dns_resolution_enabled": true, "routing_peer_dns_resolution_enabled": true,
"extra": { "extra": {
"peer_approval_enabled": true "peer_approval_enabled": true,
"network_traffic_logs_enabled": true,
"network_traffic_packet_counter_enabled": true
} }
} }
}', }',
@@ -786,7 +814,9 @@ echo $response;
], ],
"routing_peer_dns_resolution_enabled": true, "routing_peer_dns_resolution_enabled": true,
"extra": { "extra": {
"peer_approval_enabled": true "peer_approval_enabled": true,
"network_traffic_logs_enabled": true,
"network_traffic_packet_counter_enabled": true
} }
} }
} }
@@ -808,7 +838,9 @@ echo $response;
], ],
"routing_peer_dns_resolution_enabled": "boolean", "routing_peer_dns_resolution_enabled": "boolean",
"extra": { "extra": {
"peer_approval_enabled": "boolean" "peer_approval_enabled": "boolean",
"network_traffic_logs_enabled": "boolean",
"network_traffic_packet_counter_enabled": "boolean"
} }
} }
} }

14
src/pages/ipa/resources/dns.mdx
View File

@@ -2,7 +2,7 @@ export const title = 'DNS'
## List all Nameserver Groups {{ tag: 'GET' , label: '/api/dns/nameservers' }} ## List all Nameserver Groups {{ tag: 'GET' , label: '/api/dns/nameservers' }}
<Row> <Row>
<Col> <Col>
@@ -218,7 +218,7 @@ echo $response;
--- ---
## Create a Nameserver Group {{ tag: 'POST' , label: '/api/dns/nameservers' }} ## Create a Nameserver Group {{ tag: 'POST' , label: '/api/dns/nameservers' }}
<Row> <Row>
<Col> <Col>
@@ -644,7 +644,7 @@ echo $response;
--- ---
## Retrieve a Nameserver Group {{ tag: 'GET' , label: '/api/dns/nameservers/{nsgroupId}' }} ## Retrieve a Nameserver Group {{ tag: 'GET' , label: '/api/dns/nameservers/{nsgroupId}' }}
<Row> <Row>
<Col> <Col>
@@ -864,7 +864,7 @@ echo $response;
--- ---
## Update a Nameserver Group {{ tag: 'PUT' , label: '/api/dns/nameservers/{nsgroupId}' }} ## Update a Nameserver Group {{ tag: 'PUT' , label: '/api/dns/nameservers/{nsgroupId}' }}
<Row> <Row>
<Col> <Col>
@@ -1298,7 +1298,7 @@ echo $response;
--- ---
## Delete a Nameserver Group {{ tag: 'DELETE' , label: '/api/dns/nameservers/{nsgroupId}' }} ## Delete a Nameserver Group {{ tag: 'DELETE' , label: '/api/dns/nameservers/{nsgroupId}' }}
<Row> <Row>
<Col> <Col>
@@ -1462,7 +1462,7 @@ echo $response;
--- ---
## Retrieve DNS settings {{ tag: 'GET' , label: '/api/dns/settings' }} ## Retrieve DNS settings {{ tag: 'GET' , label: '/api/dns/settings' }}
<Row> <Row>
<Col> <Col>
@@ -1646,7 +1646,7 @@ echo $response;
--- ---
## Update DNS Settings {{ tag: 'PUT' , label: '/api/dns/settings' }} ## Update DNS Settings {{ tag: 'PUT' , label: '/api/dns/settings' }}
<Row> <Row>
<Col> <Col>

282
src/pages/ipa/resources/events.mdx
View File

@@ -2,17 +2,17 @@ export const title = 'Events'
## List all Events {{ tag: 'GET' , label: '/api/events' }} ## List all Audit Events {{ tag: 'GET' , label: '/api/events/audit' }}
<Row> <Row>
<Col> <Col>
Returns a list of all events Returns a list of all audit events
</Col> </Col>
<Col sticky> <Col sticky>
<CodeGroup title="Request" tag="GET" label="/api/events"> <CodeGroup title="Request" tag="GET" label="/api/events/audit">
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/events \ curl -X GET https://api.netbird.io/api/events/audit \
-H 'Accept: application/json' \ -H 'Accept: application/json' \
-H 'Authorization: Token <TOKEN>' -H 'Authorization: Token <TOKEN>'
``` ```
@@ -23,7 +23,7 @@ const axios = require('axios');
let config = { let config = {
method: 'get', method: 'get',
maxBodyLength: Infinity, maxBodyLength: Infinity,
url: '/api/events', url: '/api/events/audit',
headers: { headers: {
'Accept': 'application/json', 'Accept': 'application/json',
'Authorization': 'Token <TOKEN>' 'Authorization': 'Token <TOKEN>'
@@ -43,7 +43,7 @@ axios(config)
import requests import requests
import json import json
url = "https://api.netbird.io/api/events" url = "https://api.netbird.io/api/events/audit"
headers = { headers = {
'Accept': 'application/json', 'Accept': 'application/json',
@@ -67,7 +67,7 @@ import (
func main() { func main() {
url := "https://api.netbird.io/api/events" url := "https://api.netbird.io/api/events/audit"
method := "GET" method := "GET"
client := &http.Client { client := &http.Client {
@@ -103,7 +103,7 @@ require "uri"
require "json" require "json"
require "net/http" require "net/http"
url = URI("https://api.netbird.io/api/events") url = URI("https://api.netbird.io/api/events/audit")
https = Net::HTTP.new(url.host, url.port) https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true https.use_ssl = true
@@ -121,7 +121,7 @@ OkHttpClient client = new OkHttpClient().newBuilder()
.build(); .build();
Request request = new Request.Builder() Request request = new Request.Builder()
.url("https://api.netbird.io/api/events") .url("https://api.netbird.io/api/events/audit")
.method("GET") .method("GET")
.addHeader("Accept", "application/json") .addHeader("Accept", "application/json")
.addHeader("Authorization: Token <TOKEN>") .addHeader("Authorization: Token <TOKEN>")
@@ -135,7 +135,7 @@ Response response = client.newCall(request).execute();
$curl = curl_init(); $curl = curl_init();
curl_setopt_array($curl, array( curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.netbird.io/api/events', CURLOPT_URL => 'https://api.netbird.io/api/events/audit',
CURLOPT_RETURNTRANSFER => true, CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '', CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10, CURLOPT_MAXREDIRS => 10,
@@ -209,3 +209,265 @@ echo $response;
</Row> </Row>
--- ---
## List all Network Traffic Events <Badge status="cloud-only" text="Cloud-Only" /> <Badge status="experimental" text="Experimental" /> {{ tag: 'GET' , label: '/api/events/network-traffic' }}
<Row>
<Col>
Returns a list of all network traffic events
</Col>
<Col sticky>
<CodeGroup title="Request" tag="GET" label="/api/events/network-traffic">
```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/events/network-traffic \
-H 'Accept: application/json' \
-H 'Authorization: Token <TOKEN>'
```
```js
const axios = require('axios');
let config = {
method: 'get',
maxBodyLength: Infinity,
url: '/api/events/network-traffic',
headers: {
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
}
};
axios(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
```
```python
import requests
import json
url = "https://api.netbird.io/api/events/network-traffic"
headers = {
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
}
response = requests.request("GET", url, headers=headers)
print(response.text)
```
```go
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://api.netbird.io/api/events/network-traffic"
method := "GET"
client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)
if err != nil {
fmt.Println(err)
return
{
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := ioutil.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
```
```ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.netbird.io/api/events/network-traffic")
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>"
response = https.request(request)
puts response.read_body
```
```java
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
Request request = new Request.Builder()
.url("https://api.netbird.io/api/events/network-traffic")
.method("GET")
.addHeader("Accept", "application/json")
.addHeader("Authorization: Token <TOKEN>")
.build();
Response response = client.newCall(request).execute();
```
```php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.netbird.io/api/events/network-traffic',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'Accept: application/json',
'Authorization: Token <TOKEN>'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```
</CodeGroup>
<CodeGroup title="Response">
```json {{ title: 'Example' }}
[
{
"id": "18e204d6-f7c6-405d-8025-70becb216add",
"flow_id": "61092452-b17c-4b14-b7cf-a2158c549826",
"reporter_id": "ch8i4ug6lnn4g9hqv7m0",
"timestamp": "2025-03-20T16:23:58.125397Z",
"source": {
"id": "ch8i4ug6lnn4g9hqv7m0",
"type": "PEER",
"name": "My Peer",
"geo_location": {
"city_name": "Berlin",
"country_code": "DE"
},
"os": "Linux",
"address": "100.64.0.10:51820",
"dns_label": "*.mydomain.com"
},
"user_id": "google-oauth2|123456789012345678901",
"user_email": "alice@netbird.io",
"user_name": "Alice Smith",
"destination": {
"id": "ch8i4ug6lnn4g9hqv7m0",
"type": "PEER",
"name": "My Peer",
"geo_location": {
"city_name": "Berlin",
"country_code": "DE"
},
"os": "Linux",
"address": "100.64.0.10:51820",
"dns_label": "*.mydomain.com"
},
"protocol": 6,
"type": "TYPE_START",
"direction": "INGRESS",
"rx_bytes": 1234,
"rx_packets": 5,
"tx_bytes": 1234,
"tx_packets": 5,
"policy_id": "ch8i4ug6lnn4g9hqv7m0",
"policy_name": "All to All",
"icmp_type": 8,
"icmp_code": 0
}
]
```
```json {{ title: 'Schema' }}
[
{
"id": "string",
"flow_id": "string",
"reporter_id": "string",
"timestamp": "string",
"source": {
"id": "string",
"type": "string",
"name": "string",
"geo_location": {
"city_name": "string",
"country_code": "string"
},
"os": "string",
"address": "string",
"dns_label": "string"
},
"user_id": "string",
"user_email": "string",
"user_name": "string",
"destination": {
"id": "string",
"type": "string",
"name": "string",
"geo_location": {
"city_name": "string",
"country_code": "string"
},
"os": "string",
"address": "string",
"dns_label": "string"
},
"protocol": "integer",
"type": "string",
"direction": "string",
"rx_bytes": "integer",
"rx_packets": "integer",
"tx_bytes": "integer",
"tx_packets": "integer",
"policy_id": "string",
"policy_name": "string",
"icmp_type": "integer",
"icmp_code": "integer"
}
]
```
</CodeGroup>
</Col>
</Row>
---

4
src/pages/ipa/resources/geo-locations.mdx
View File

@@ -2,7 +2,7 @@ export const title = 'Geo Locations'
## List all country codes {{ tag: 'GET' , label: '/api/locations/countries' }} ## List all country codes {{ tag: 'GET' , label: '/api/locations/countries' }}
<Row> <Row>
<Col> <Col>
@@ -178,7 +178,7 @@ echo $response;
--- ---
## List all city names by country {{ tag: 'GET' , label: '/api/locations/countries/{country}/cities' }} ## List all city names by country {{ tag: 'GET' , label: '/api/locations/countries/{country}/cities' }}
<Row> <Row>
<Col> <Col>

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

@@ -2,7 +2,7 @@ export const title = 'Groups'
## List all Groups {{ tag: 'GET' , label: '/api/groups' }} ## List all Groups {{ tag: 'GET' , label: '/api/groups' }}
<Row> <Row>
<Col> <Col>
@@ -214,7 +214,7 @@ echo $response;
--- ---
## Create a Group {{ tag: 'POST' , label: '/api/groups' }} ## Create a Group {{ tag: 'POST' , label: '/api/groups' }}
<Row> <Row>
<Col> <Col>
@@ -550,7 +550,7 @@ echo $response;
--- ---
## Retrieve a Group {{ tag: 'GET' , label: '/api/groups/{groupId}' }} ## Retrieve a Group {{ tag: 'GET' , label: '/api/groups/{groupId}' }}
<Row> <Row>
<Col> <Col>
@@ -766,7 +766,7 @@ echo $response;
--- ---
## Update a Group {{ tag: 'PUT' , label: '/api/groups/{groupId}' }} ## Update a Group {{ tag: 'PUT' , label: '/api/groups/{groupId}' }}
<Row> <Row>
<Col> <Col>
@@ -1110,7 +1110,7 @@ echo $response;
--- ---
## Delete a Group {{ tag: 'DELETE' , label: '/api/groups/{groupId}' }} ## Delete a Group {{ tag: 'DELETE' , label: '/api/groups/{groupId}' }}
<Row> <Row>
<Col> <Col>

2470
src/pages/ipa/resources/ingress-ports.mdx Normal file
View File

File diff suppressed because it is too large Load Diff

30
src/pages/ipa/resources/networks.mdx
View File

@@ -2,7 +2,7 @@ export const title = 'Networks'
## List all Networks {{ tag: 'GET' , label: '/api/networks' }} ## List all Networks {{ tag: 'GET' , label: '/api/networks' }}
<Row> <Row>
<Col> <Col>
@@ -206,7 +206,7 @@ echo $response;
--- ---
## Create a Network {{ tag: 'POST' , label: '/api/networks' }} ## Create a Network {{ tag: 'POST' , label: '/api/networks' }}
<Row> <Row>
<Col> <Col>
@@ -456,7 +456,7 @@ echo $response;
--- ---
## Retrieve a Network {{ tag: 'GET' , label: '/api/networks/{networkId}' }} ## Retrieve a Network {{ tag: 'GET' , label: '/api/networks/{networkId}' }}
<Row> <Row>
<Col> <Col>
@@ -664,7 +664,7 @@ echo $response;
--- ---
## Update a Network {{ tag: 'PUT' , label: '/api/networks/{networkId}' }} ## Update a Network {{ tag: 'PUT' , label: '/api/networks/{networkId}' }}
<Row> <Row>
<Col> <Col>
@@ -922,7 +922,7 @@ echo $response;
--- ---
## Delete a Network {{ tag: 'DELETE' , label: '/api/networks/{networkId}' }} ## Delete a Network {{ tag: 'DELETE' , label: '/api/networks/{networkId}' }}
<Row> <Row>
<Col> <Col>
@@ -1086,7 +1086,7 @@ echo $response;
--- ---
## List all Network Resources {{ tag: 'GET' , label: '/api/networks/{networkId}/resources' }} ## List all Network Resources {{ tag: 'GET' , label: '/api/networks/{networkId}/resources' }}
<Row> <Row>
<Col> <Col>
@@ -1302,7 +1302,7 @@ echo $response;
--- ---
## Create a Network Resource {{ tag: 'POST' , label: '/api/networks/{networkId}/resources' }} ## Create a Network Resource {{ tag: 'POST' , label: '/api/networks/{networkId}/resources' }}
<Row> <Row>
<Col> <Col>
@@ -1614,7 +1614,7 @@ echo $response;
--- ---
## Retrieve a Network Resource {{ tag: 'GET' , label: '/api/networks/{networkId}/resources/{resourceId}' }} ## Retrieve a Network Resource {{ tag: 'GET' , label: '/api/networks/{networkId}/resources/{resourceId}' }}
<Row> <Row>
<Col> <Col>
@@ -1830,7 +1830,7 @@ echo $response;
--- ---
## Update a Network Resource {{ tag: 'PUT' , label: '/api/networks/{networkId}/resources/{resourceId}' }} ## Update a Network Resource {{ tag: 'PUT' , label: '/api/networks/{networkId}/resources/{resourceId}' }}
<Row> <Row>
<Col> <Col>
@@ -2146,7 +2146,7 @@ echo $response;
--- ---
## Delete a Network Resource {{ tag: 'DELETE' , label: '/api/networks/{networkId}/resources/{resourceId}' }} ## Delete a Network Resource {{ tag: 'DELETE' , label: '/api/networks/{networkId}/resources/{resourceId}' }}
<Row> <Row>
<Col> <Col>
@@ -2314,7 +2314,7 @@ echo $response;
--- ---
## List all Network Routers {{ tag: 'GET' , label: '/api/networks/{networkId}/routers' }} ## List all Network Routers {{ tag: 'GET' , label: '/api/networks/{networkId}/routers' }}
<Row> <Row>
<Col> <Col>
@@ -2516,7 +2516,7 @@ echo $response;
--- ---
## Create a Network Router {{ tag: 'POST' , label: '/api/networks/{networkId}/routers' }} ## Create a Network Router {{ tag: 'POST' , label: '/api/networks/{networkId}/routers' }}
<Row> <Row>
<Col> <Col>
@@ -2814,7 +2814,7 @@ echo $response;
--- ---
## Retrieve a Network Router {{ tag: 'GET' , label: '/api/networks/{networkId}/routers/{routerId}' }} ## Retrieve a Network Router {{ tag: 'GET' , label: '/api/networks/{networkId}/routers/{routerId}' }}
<Row> <Row>
<Col> <Col>
@@ -3016,7 +3016,7 @@ echo $response;
--- ---
## Update a Network Router {{ tag: 'PUT' , label: '/api/networks/{networkId}/routers/{routerId}' }} ## Update a Network Router {{ tag: 'PUT' , label: '/api/networks/{networkId}/routers/{routerId}' }}
<Row> <Row>
<Col> <Col>
@@ -3318,7 +3318,7 @@ echo $response;
--- ---
## Delete a Network Router {{ tag: 'DELETE' , label: '/api/networks/{networkId}/routers/{routerId}' }} ## Delete a Network Router {{ tag: 'DELETE' , label: '/api/networks/{networkId}/routers/{routerId}' }}
<Row> <Row>
<Col> <Col>

24
src/pages/ipa/resources/peers.mdx
View File

@@ -2,12 +2,24 @@ export const title = 'Peers'
## List all Peers {{ tag: 'GET' , label: '/api/peers' }} ## List all Peers {{ tag: 'GET' , label: '/api/peers' }}
<Row> <Row>
<Col> <Col>
Returns a list of all peers Returns a list of all peers
</Col>
### Query Parameters
<Properties>
<Property name="name" type="string" required={false}>
Filter peers by name
</Property>
<Property name="ip" type="string" required={false}>
Filter peers by IP address
</Property>
</Properties>
</Col>
<Col sticky> <Col sticky>
<CodeGroup title="Request" tag="GET" label="/api/peers"> <CodeGroup title="Request" tag="GET" label="/api/peers">
@@ -252,7 +264,7 @@ echo $response;
--- ---
## Retrieve a Peer {{ tag: 'GET' , label: '/api/peers/{peerId}' }} ## Retrieve a Peer {{ tag: 'GET' , label: '/api/peers/{peerId}' }}
<Row> <Row>
<Col> <Col>
@@ -504,7 +516,7 @@ echo $response;
--- ---
## Update a Peer {{ tag: 'PUT' , label: '/api/peers/{peerId}' }} ## Update a Peer {{ tag: 'PUT' , label: '/api/peers/{peerId}' }}
<Row> <Row>
<Col> <Col>
@@ -842,7 +854,7 @@ echo $response;
--- ---
## Delete a Peer {{ tag: 'DELETE' , label: '/api/peers/{peerId}' }} ## Delete a Peer {{ tag: 'DELETE' , label: '/api/peers/{peerId}' }}
<Row> <Row>
<Col> <Col>
@@ -1006,7 +1018,7 @@ echo $response;
--- ---
## List accessible Peers {{ tag: 'GET' , label: '/api/peers/{peerId}/accessible-peers' }} ## List accessible Peers {{ tag: 'GET' , label: '/api/peers/{peerId}/accessible-peers' }}
<Row> <Row>
<Col> <Col>

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

@@ -2,7 +2,7 @@ export const title = 'Policies'
## List all Policies {{ tag: 'GET' , label: '/api/policies' }} ## List all Policies {{ tag: 'GET' , label: '/api/policies' }}
<Row> <Row>
<Col> <Col>
@@ -286,7 +286,7 @@ echo $response;
--- ---
## Create a Policy {{ tag: 'POST' , label: '/api/policies' }} ## Create a Policy {{ tag: 'POST' , label: '/api/policies' }}
<Row> <Row>
<Col> <Col>
@@ -1020,7 +1020,7 @@ echo $response;
--- ---
## Retrieve a Policy {{ tag: 'GET' , label: '/api/policies/{policyId}' }} ## Retrieve a Policy {{ tag: 'GET' , label: '/api/policies/{policyId}' }}
<Row> <Row>
<Col> <Col>
@@ -1308,7 +1308,7 @@ echo $response;
--- ---
## Update a Policy {{ tag: 'PUT' , label: '/api/policies/{policyId}' }} ## Update a Policy {{ tag: 'PUT' , label: '/api/policies/{policyId}' }}
<Row> <Row>
<Col> <Col>
@@ -2050,7 +2050,7 @@ echo $response;
--- ---
## Delete a Policy {{ tag: 'DELETE' , label: '/api/policies/{policyId}' }} ## Delete a Policy {{ tag: 'DELETE' , label: '/api/policies/{policyId}' }}
<Row> <Row>
<Col> <Col>

10
src/pages/ipa/resources/posture-checks.mdx
View File

@@ -2,7 +2,7 @@ export const title = 'Posture Checks'
## List all Posture Checks {{ tag: 'GET' , label: '/api/posture-checks' }} ## List all Posture Checks {{ tag: 'GET' , label: '/api/posture-checks' }}
<Row> <Row>
<Col> <Col>
@@ -280,7 +280,7 @@ echo $response;
--- ---
## Create a Posture Check {{ tag: 'POST' , label: '/api/posture-checks' }} ## Create a Posture Check {{ tag: 'POST' , label: '/api/posture-checks' }}
<Row> <Row>
<Col> <Col>
@@ -1166,7 +1166,7 @@ echo $response;
--- ---
## Retrieve a Posture Check {{ tag: 'GET' , label: '/api/posture-checks/{postureCheckId}' }} ## Retrieve a Posture Check {{ tag: 'GET' , label: '/api/posture-checks/{postureCheckId}' }}
<Row> <Row>
<Col> <Col>
@@ -1448,7 +1448,7 @@ echo $response;
--- ---
## Update a Posture Check {{ tag: 'PUT' , label: '/api/posture-checks/{postureCheckId}' }} ## Update a Posture Check {{ tag: 'PUT' , label: '/api/posture-checks/{postureCheckId}' }}
<Row> <Row>
<Col> <Col>
@@ -2342,7 +2342,7 @@ echo $response;
--- ---
## Delete a Posture Check {{ tag: 'DELETE' , label: '/api/posture-checks/{postureCheckId}' }} ## Delete a Posture Check {{ tag: 'DELETE' , label: '/api/posture-checks/{postureCheckId}' }}
<Row> <Row>
<Col> <Col>

10
src/pages/ipa/resources/routes.mdx
View File

@@ -2,7 +2,7 @@ export const title = 'Routes'
## List all Routes {{ tag: 'GET' , label: '/api/routes' }} ## List all Routes {{ tag: 'GET' , label: '/api/routes' }}
<Row> <Row>
<Col> <Col>
@@ -224,7 +224,7 @@ echo $response;
--- ---
## Create a Route {{ tag: 'POST' , label: '/api/routes' }} ## Create a Route {{ tag: 'POST' , label: '/api/routes' }}
<Row> <Row>
<Col> <Col>
@@ -668,7 +668,7 @@ echo $response;
--- ---
## Retrieve a Route {{ tag: 'GET' , label: '/api/routes/{routeId}' }} ## Retrieve a Route {{ tag: 'GET' , label: '/api/routes/{routeId}' }}
<Row> <Row>
<Col> <Col>
@@ -894,7 +894,7 @@ echo $response;
--- ---
## Update a Route {{ tag: 'PUT' , label: '/api/routes/{routeId}' }} ## Update a Route {{ tag: 'PUT' , label: '/api/routes/{routeId}' }}
<Row> <Row>
<Col> <Col>
@@ -1346,7 +1346,7 @@ echo $response;
--- ---
## Delete a Route {{ tag: 'DELETE' , label: '/api/routes/{routeId}' }} ## Delete a Route {{ tag: 'DELETE' , label: '/api/routes/{routeId}' }}
<Row> <Row>
<Col> <Col>

10
src/pages/ipa/resources/setup-keys.mdx
View File

@@ -2,7 +2,7 @@ export const title = 'Setup Keys'
## List all Setup Keys {{ tag: 'GET' , label: '/api/setup-keys' }} ## List all Setup Keys {{ tag: 'GET' , label: '/api/setup-keys' }}
<Row> <Row>
<Col> <Col>
@@ -214,7 +214,7 @@ echo $response;
--- ---
## Create a Setup Key {{ tag: 'POST' , label: '/api/setup-keys' }} ## Create a Setup Key {{ tag: 'POST' , label: '/api/setup-keys' }}
<Row> <Row>
<Col> <Col>
@@ -546,7 +546,7 @@ echo $response;
--- ---
## Retrieve a Setup Key {{ tag: 'GET' , label: '/api/setup-keys/{keyId}' }} ## Retrieve a Setup Key {{ tag: 'GET' , label: '/api/setup-keys/{keyId}' }}
<Row> <Row>
<Col> <Col>
@@ -762,7 +762,7 @@ echo $response;
--- ---
## Update a Setup Key {{ tag: 'PUT' , label: '/api/setup-keys/{keyId}' }} ## Update a Setup Key {{ tag: 'PUT' , label: '/api/setup-keys/{keyId}' }}
<Row> <Row>
<Col> <Col>
@@ -1042,7 +1042,7 @@ echo $response;
--- ---
## Delete a Setup Key {{ tag: 'DELETE' , label: '/api/setup-keys/{keyId}' }} ## Delete a Setup Key {{ tag: 'DELETE' , label: '/api/setup-keys/{keyId}' }}
<Row> <Row>
<Col> <Col>

8
src/pages/ipa/resources/tokens.mdx
View File

@@ -2,7 +2,7 @@ export const title = 'Tokens'
## List all Tokens {{ tag: 'GET' , label: '/api/users/{userId}/tokens' }} ## List all Tokens {{ tag: 'GET' , label: '/api/users/{userId}/tokens' }}
<Row> <Row>
<Col> <Col>
@@ -200,7 +200,7 @@ echo $response;
--- ---
## Create a Token {{ tag: 'POST' , label: '/api/users/{userId}/tokens' }} ## Create a Token {{ tag: 'POST' , label: '/api/users/{userId}/tokens' }}
<Row> <Row>
<Col> <Col>
@@ -450,7 +450,7 @@ echo $response;
--- ---
## Retrieve a Token {{ tag: 'GET' , label: '/api/users/{userId}/tokens/{tokenId}' }} ## Retrieve a Token {{ tag: 'GET' , label: '/api/users/{userId}/tokens/{tokenId}' }}
<Row> <Row>
<Col> <Col>
@@ -648,7 +648,7 @@ echo $response;
--- ---
## Delete a Token {{ tag: 'DELETE' , label: '/api/users/{userId}/tokens/{tokenId}' }} ## Delete a Token {{ tag: 'DELETE' , label: '/api/users/{userId}/tokens/{tokenId}' }}
<Row> <Row>
<Col> <Col>

10
src/pages/ipa/resources/users.mdx
View File

@@ -2,7 +2,7 @@ export const title = 'Users'
## List all Users {{ tag: 'GET' , label: '/api/users' }} ## List all Users {{ tag: 'GET' , label: '/api/users' }}
<Row> <Row>
<Col> <Col>
@@ -220,7 +220,7 @@ echo $response;
--- ---
## Create a User {{ tag: 'POST' , label: '/api/users' }} ## Create a User {{ tag: 'POST' , label: '/api/users' }}
<Row> <Row>
<Col> <Col>
@@ -526,7 +526,7 @@ echo $response;
--- ---
## Update a User {{ tag: 'PUT' , label: '/api/users/{userId}' }} ## Update a User {{ tag: 'PUT' , label: '/api/users/{userId}' }}
<Row> <Row>
<Col> <Col>
@@ -816,7 +816,7 @@ echo $response;
--- ---
## Delete a User {{ tag: 'DELETE' , label: '/api/users/{userId}' }} ## Delete a User {{ tag: 'DELETE' , label: '/api/users/{userId}' }}
<Row> <Row>
<Col> <Col>
@@ -980,7 +980,7 @@ echo $response;
--- ---
## Resend user invitation {{ tag: 'POST' , label: '/api/users/{userId}/invite' }} ## Resend user invitation {{ tag: 'POST' , label: '/api/users/{userId}/invite' }}
<Row> <Row>
<Col> <Col>