Update API pages with v0.24.4

This commit is contained in:
netbirddev
2023-12-08 14:02:10 +00:00
parent ceddc4b1fc
commit 464530a4d8
7 changed files with 301 additions and 75 deletions

View File

@@ -186,6 +186,7 @@ echo $response;
"login_expiration_enabled": false,
"login_expired": false,
"last_login": "2023-05-05T09:00:35.477782Z",
"approval_required": true,
"accessible_peers_count": 5
}
]
@@ -216,6 +217,7 @@ echo $response;
"login_expiration_enabled": "boolean",
"login_expired": "boolean",
"last_login": "string",
"approval_required": "boolean",
"accessible_peers_count": "integer"
}
]
@@ -423,6 +425,7 @@ echo $response;
"login_expiration_enabled": false,
"login_expired": false,
"last_login": "2023-05-05T09:00:35.477782Z",
"approval_required": true,
"accessible_peers": [
{
"id": "chacbco6lnnbn6cg5s90",
@@ -459,6 +462,7 @@ echo $response;
"login_expiration_enabled": "boolean",
"login_expired": "boolean",
"last_login": "string",
"approval_required": "boolean",
"accessible_peers": [
{
"id": "string",
@@ -518,6 +522,13 @@ echo $response;
>
</Property>
<Property name="approval_required" type="boolean" required={false}
>
(Cloud only) Indicates whether peer needs approval
</Property>
</Properties>
</Col>
@@ -532,7 +543,8 @@ curl -X PUT https://api.netbird.io/api/peers/{peerId} \
--data-raw '{
"name": "stage-host-1",
"ssh_enabled": true,
"login_expiration_enabled": false
"login_expiration_enabled": false,
"approval_required": true
}'
```
@@ -541,7 +553,8 @@ const axios = require('axios');
let data = JSON.stringify({
"name": "stage-host-1",
"ssh_enabled": true,
"login_expiration_enabled": false
"login_expiration_enabled": false,
"approval_required": true
});
let config = {
method: 'put',
@@ -572,7 +585,8 @@ url = "https://api.netbird.io/api/peers/{peerId}"
payload = json.dumps({
"name": "stage-host-1",
"ssh_enabled": true,
"login_expiration_enabled": false
"login_expiration_enabled": false,
"approval_required": true
})
headers: {
'Content-Type': 'application/json',
@@ -603,7 +617,8 @@ func main() {
payload := strings.NewReader(`{
"name": "stage-host-1",
"ssh_enabled": true,
"login_expiration_enabled": false
"login_expiration_enabled": false,
"approval_required": true
}`)
client := &http.Client {
}
@@ -652,7 +667,8 @@ request["Authorization"] = "Token <TOKEN>"
request.body = JSON.dump({
"name": "stage-host-1",
"ssh_enabled": true,
"login_expiration_enabled": false
"login_expiration_enabled": false,
"approval_required": true
})
response = https.request(request)
puts response.read_body
@@ -665,7 +681,8 @@ MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, '{
"name": "stage-host-1",
"ssh_enabled": true,
"login_expiration_enabled": false
"login_expiration_enabled": false,
"approval_required": true
}');
Request request = new Request.Builder()
.url("https://api.netbird.io/api/peers/{peerId}")
@@ -694,7 +711,8 @@ curl_setopt_array($curl, array(
CURLOPT_POSTFIELDS => '{
"name": "stage-host-1",
"ssh_enabled": true,
"login_expiration_enabled": false
"login_expiration_enabled": false,
"approval_required": true
}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json',
@@ -739,6 +757,7 @@ echo $response;
"login_expiration_enabled": false,
"login_expired": false,
"last_login": "2023-05-05T09:00:35.477782Z",
"approval_required": true,
"accessible_peers": [
{
"id": "chacbco6lnnbn6cg5s90",
@@ -775,6 +794,7 @@ echo $response;
"login_expiration_enabled": "boolean",
"login_expired": "boolean",
"last_login": "string",
"approval_required": "boolean",
"accessible_peers": [
{
"id": "string",