mirror of
https://github.com/netbirdio/docs.git
synced 2026-04-20 01:16:36 +00:00
Update API pages with v0.37.0
This commit is contained in:
@@ -194,6 +194,9 @@ echo $response;
|
|||||||
"country_code": "DE",
|
"country_code": "DE",
|
||||||
"city_name": "Berlin",
|
"city_name": "Berlin",
|
||||||
"serial_number": "C02XJ0J0JGH7",
|
"serial_number": "C02XJ0J0JGH7",
|
||||||
|
"extra_dns_labels": [
|
||||||
|
"stage-host-1"
|
||||||
|
],
|
||||||
"accessible_peers_count": 5
|
"accessible_peers_count": 5
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
@@ -233,6 +236,9 @@ echo $response;
|
|||||||
"country_code": "string",
|
"country_code": "string",
|
||||||
"city_name": "string",
|
"city_name": "string",
|
||||||
"serial_number": "string",
|
"serial_number": "string",
|
||||||
|
"extra_dns_labels": [
|
||||||
|
"string"
|
||||||
|
],
|
||||||
"accessible_peers_count": "integer"
|
"accessible_peers_count": "integer"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
@@ -444,7 +450,10 @@ echo $response;
|
|||||||
"approval_required": true,
|
"approval_required": true,
|
||||||
"country_code": "DE",
|
"country_code": "DE",
|
||||||
"city_name": "Berlin",
|
"city_name": "Berlin",
|
||||||
"serial_number": "C02XJ0J0JGH7"
|
"serial_number": "C02XJ0J0JGH7",
|
||||||
|
"extra_dns_labels": [
|
||||||
|
"stage-host-1"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
```json {{ title: 'Schema' }}
|
```json {{ title: 'Schema' }}
|
||||||
@@ -480,7 +489,10 @@ echo $response;
|
|||||||
"approval_required": "boolean",
|
"approval_required": "boolean",
|
||||||
"country_code": "string",
|
"country_code": "string",
|
||||||
"city_name": "string",
|
"city_name": "string",
|
||||||
"serial_number": "string"
|
"serial_number": "string",
|
||||||
|
"extra_dns_labels": [
|
||||||
|
"string"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
</CodeGroup>
|
</CodeGroup>
|
||||||
@@ -776,7 +788,10 @@ echo $response;
|
|||||||
"approval_required": true,
|
"approval_required": true,
|
||||||
"country_code": "DE",
|
"country_code": "DE",
|
||||||
"city_name": "Berlin",
|
"city_name": "Berlin",
|
||||||
"serial_number": "C02XJ0J0JGH7"
|
"serial_number": "C02XJ0J0JGH7",
|
||||||
|
"extra_dns_labels": [
|
||||||
|
"stage-host-1"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
```json {{ title: 'Schema' }}
|
```json {{ title: 'Schema' }}
|
||||||
@@ -812,7 +827,10 @@ echo $response;
|
|||||||
"approval_required": "boolean",
|
"approval_required": "boolean",
|
||||||
"country_code": "string",
|
"country_code": "string",
|
||||||
"city_name": "string",
|
"city_name": "string",
|
||||||
"serial_number": "string"
|
"serial_number": "string",
|
||||||
|
"extra_dns_labels": [
|
||||||
|
"string"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
</CodeGroup>
|
</CodeGroup>
|
||||||
|
|||||||
@@ -177,6 +177,7 @@ echo $response;
|
|||||||
"updated_at": "2023-05-05T09:00:35.477782Z",
|
"updated_at": "2023-05-05T09:00:35.477782Z",
|
||||||
"usage_limit": 0,
|
"usage_limit": 0,
|
||||||
"ephemeral": true,
|
"ephemeral": true,
|
||||||
|
"allow_extra_dns_labels": true,
|
||||||
"key": "A6160****"
|
"key": "A6160****"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
@@ -199,6 +200,7 @@ echo $response;
|
|||||||
"updated_at": "string",
|
"updated_at": "string",
|
||||||
"usage_limit": "integer",
|
"usage_limit": "integer",
|
||||||
"ephemeral": "boolean",
|
"ephemeral": "boolean",
|
||||||
|
"allow_extra_dns_labels": "boolean",
|
||||||
"key": "string"
|
"key": "string"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
@@ -249,6 +251,11 @@ echo $response;
|
|||||||
|
|
||||||
Indicate that the peer will be ephemeral or not
|
Indicate that the peer will be ephemeral or not
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
<Property name="allow_extra_dns_labels" type="boolean" required={false}>
|
||||||
|
|
||||||
|
Allow extra DNS labels to be added to the peer
|
||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
</Properties>
|
</Properties>
|
||||||
|
|
||||||
@@ -270,7 +277,8 @@ curl -X POST https://api.netbird.io/api/setup-keys \
|
|||||||
"ch8i4ug6lnn4g9hqv7m0"
|
"ch8i4ug6lnn4g9hqv7m0"
|
||||||
],
|
],
|
||||||
"usage_limit": 0,
|
"usage_limit": 0,
|
||||||
"ephemeral": true
|
"ephemeral": true,
|
||||||
|
"allow_extra_dns_labels": true
|
||||||
}'
|
}'
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -284,7 +292,8 @@ let data = JSON.stringify({
|
|||||||
"ch8i4ug6lnn4g9hqv7m0"
|
"ch8i4ug6lnn4g9hqv7m0"
|
||||||
],
|
],
|
||||||
"usage_limit": 0,
|
"usage_limit": 0,
|
||||||
"ephemeral": true
|
"ephemeral": true,
|
||||||
|
"allow_extra_dns_labels": true
|
||||||
});
|
});
|
||||||
let config = {
|
let config = {
|
||||||
method: 'post',
|
method: 'post',
|
||||||
@@ -320,7 +329,8 @@ payload = json.dumps({
|
|||||||
"ch8i4ug6lnn4g9hqv7m0"
|
"ch8i4ug6lnn4g9hqv7m0"
|
||||||
],
|
],
|
||||||
"usage_limit": 0,
|
"usage_limit": 0,
|
||||||
"ephemeral": true
|
"ephemeral": true,
|
||||||
|
"allow_extra_dns_labels": true
|
||||||
})
|
})
|
||||||
headers = {
|
headers = {
|
||||||
'Content-Type': 'application/json',
|
'Content-Type': 'application/json',
|
||||||
@@ -356,7 +366,8 @@ func main() {
|
|||||||
"ch8i4ug6lnn4g9hqv7m0"
|
"ch8i4ug6lnn4g9hqv7m0"
|
||||||
],
|
],
|
||||||
"usage_limit": 0,
|
"usage_limit": 0,
|
||||||
"ephemeral": true
|
"ephemeral": true,
|
||||||
|
"allow_extra_dns_labels": true
|
||||||
}`)
|
}`)
|
||||||
client := &http.Client {
|
client := &http.Client {
|
||||||
}
|
}
|
||||||
@@ -410,7 +421,8 @@ request.body = JSON.dump({
|
|||||||
"ch8i4ug6lnn4g9hqv7m0"
|
"ch8i4ug6lnn4g9hqv7m0"
|
||||||
],
|
],
|
||||||
"usage_limit": 0,
|
"usage_limit": 0,
|
||||||
"ephemeral": true
|
"ephemeral": true,
|
||||||
|
"allow_extra_dns_labels": true
|
||||||
})
|
})
|
||||||
response = https.request(request)
|
response = https.request(request)
|
||||||
puts response.read_body
|
puts response.read_body
|
||||||
@@ -428,7 +440,8 @@ RequestBody body = RequestBody.create(mediaType, '{
|
|||||||
"ch8i4ug6lnn4g9hqv7m0"
|
"ch8i4ug6lnn4g9hqv7m0"
|
||||||
],
|
],
|
||||||
"usage_limit": 0,
|
"usage_limit": 0,
|
||||||
"ephemeral": true
|
"ephemeral": true,
|
||||||
|
"allow_extra_dns_labels": true
|
||||||
}');
|
}');
|
||||||
Request request = new Request.Builder()
|
Request request = new Request.Builder()
|
||||||
.url("https://api.netbird.io/api/setup-keys")
|
.url("https://api.netbird.io/api/setup-keys")
|
||||||
@@ -462,7 +475,8 @@ curl_setopt_array($curl, array(
|
|||||||
"ch8i4ug6lnn4g9hqv7m0"
|
"ch8i4ug6lnn4g9hqv7m0"
|
||||||
],
|
],
|
||||||
"usage_limit": 0,
|
"usage_limit": 0,
|
||||||
"ephemeral": true
|
"ephemeral": true,
|
||||||
|
"allow_extra_dns_labels": true
|
||||||
}',
|
}',
|
||||||
CURLOPT_HTTPHEADER => array(
|
CURLOPT_HTTPHEADER => array(
|
||||||
'Content-Type: application/json',
|
'Content-Type: application/json',
|
||||||
@@ -498,6 +512,7 @@ echo $response;
|
|||||||
"updated_at": "2023-05-05T09:00:35.477782Z",
|
"updated_at": "2023-05-05T09:00:35.477782Z",
|
||||||
"usage_limit": 0,
|
"usage_limit": 0,
|
||||||
"ephemeral": true,
|
"ephemeral": true,
|
||||||
|
"allow_extra_dns_labels": true,
|
||||||
"key": "A616097E-FCF0-48FA-9354-CA4A61142761"
|
"key": "A616097E-FCF0-48FA-9354-CA4A61142761"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@@ -518,6 +533,7 @@ echo $response;
|
|||||||
"updated_at": "string",
|
"updated_at": "string",
|
||||||
"usage_limit": "integer",
|
"usage_limit": "integer",
|
||||||
"ephemeral": "boolean",
|
"ephemeral": "boolean",
|
||||||
|
"allow_extra_dns_labels": "boolean",
|
||||||
"key": "string"
|
"key": "string"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@@ -712,6 +728,7 @@ echo $response;
|
|||||||
"updated_at": "2023-05-05T09:00:35.477782Z",
|
"updated_at": "2023-05-05T09:00:35.477782Z",
|
||||||
"usage_limit": 0,
|
"usage_limit": 0,
|
||||||
"ephemeral": true,
|
"ephemeral": true,
|
||||||
|
"allow_extra_dns_labels": true,
|
||||||
"key": "A6160****"
|
"key": "A6160****"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@@ -732,6 +749,7 @@ echo $response;
|
|||||||
"updated_at": "string",
|
"updated_at": "string",
|
||||||
"usage_limit": "integer",
|
"usage_limit": "integer",
|
||||||
"ephemeral": "boolean",
|
"ephemeral": "boolean",
|
||||||
|
"allow_extra_dns_labels": "boolean",
|
||||||
"key": "string"
|
"key": "string"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@@ -990,6 +1008,7 @@ echo $response;
|
|||||||
"updated_at": "2023-05-05T09:00:35.477782Z",
|
"updated_at": "2023-05-05T09:00:35.477782Z",
|
||||||
"usage_limit": 0,
|
"usage_limit": 0,
|
||||||
"ephemeral": true,
|
"ephemeral": true,
|
||||||
|
"allow_extra_dns_labels": true,
|
||||||
"key": "A6160****"
|
"key": "A6160****"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@@ -1010,6 +1029,7 @@ echo $response;
|
|||||||
"updated_at": "string",
|
"updated_at": "string",
|
||||||
"usage_limit": "integer",
|
"usage_limit": "integer",
|
||||||
"ephemeral": "boolean",
|
"ephemeral": "boolean",
|
||||||
|
"allow_extra_dns_labels": "boolean",
|
||||||
"key": "string"
|
"key": "string"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user