sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-10-27 06:59:03 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
2cc722e436540215c5f9b9a08841ec18cc002fc2
netbird-docs/src/pages/ipa/resources/ingress-ports.mdx
T

2481 lines
51 KiB
Plaintext
Raw Blame History

export const title = 'Ingress Ports'
## List all Port Allocations <Badge status="cloud-only" text="cloud-only" hoverText="This feature is only available in the cloud version of NetBird." /> {{ tag: 'GET' , label: '/api/peers/{peerId}/ingress/ports' }}
<Row>
<Col>
Returns a list of all ingress port allocations for a peer
### Path Parameters
<Properties>
<Property name="peerId" type="string" required={true}>
The unique identifier of a peer
</Property>
</Properties>
### Query Parameters
<Properties>
<Property name="name" type="string" required={false}>
Filters ingress port allocations by name
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="GET" label="/api/peers/{peerId}/ingress/ports">
```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/peers/{peerId}/ingress/ports \
-H 'Accept: application/json' \
-H 'Authorization: Token <TOKEN>'
```
```js
const axios = require('axios');
let config = {
method: 'get',
maxBodyLength: Infinity,
url: '/api/peers/{peerId}/ingress/ports',
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/peers/{peerId}/ingress/ports"
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/peers/{peerId}/ingress/ports"
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/peers/{peerId}/ingress/ports")
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/peers/{peerId}/ingress/ports")
.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/peers/{peerId}/ingress/ports',
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": "ch8i4ug6lnn4g9hqv7m0",
"name": "Ingress Peer Allocation 1",
"ingress_peer_id": "x7p3kqf2rdd8j5zxw4n9",
"region": "germany",
"enabled": true,
"ingress_ip": "192.34.0.123",
"port_range_mappings": [
{
"translated_start": 80,
"translated_end": 320,
"ingress_start": 1080,
"ingress_end": 1320,
"protocol": "tcp"
}
]
}
]
```
```json {{ title: 'Schema' }}
[
{
"id": "string",
"name": "string",
"ingress_peer_id": "string",
"region": "string",
"enabled": "boolean",
"ingress_ip": "string",
"port_range_mappings": [
{
"translated_start": "integer",
"translated_end": "integer",
"ingress_start": "integer",
"ingress_end": "integer",
"protocol": "string"
}
]
}
]
```
</CodeGroup>
</Col>
</Row>
---
## Create a Port Allocation <Badge status="cloud-only" text="cloud-only" hoverText="This feature is only available in the cloud version of NetBird." /> {{ tag: 'POST' , label: '/api/peers/{peerId}/ingress/ports' }}
<Row>
<Col>
Creates a new ingress port allocation for a peer
### Path Parameters
<Properties>
<Property name="peerId" type="string" required={true}>
The unique identifier of a peer
</Property>
</Properties>
### Request-Body Parameters
<Properties><Property name="name" type="string" required={true}>
Name of the ingress port allocation
</Property>
<Property name="enabled" type="boolean" required={true}>
Indicates if an ingress port allocation is enabled
</Property>
<Property name="port_ranges" type="object[]" required={false}>
<details className="custom-details" open>
<summary>List of port ranges that are forwarded by the ingress peer</summary>
<Properties>
<Properties><Property name="start" type="integer" required={true}>
The starting port of the range of forwarded ports
</Property>
<Property name="end" type="integer" required={true}>
The ending port of the range of forwarded ports
</Property>
<Property name="protocol" type="string" required={true} enumList={["tcp","udp","tcp/udp"]}>
The protocol accepted by the port range
</Property>
</Properties>
</Properties>
</details>
</Property>
<Property name="direct_port" type="object" required={false}>
<details className="custom-details" open>
<summary>More Information</summary>
<Properties>
<Properties><Property name="count" type="integer" required={true}>
The number of ports to be forwarded
</Property>
<Property name="protocol" type="string" required={true} enumList={["tcp","udp","tcp/udp"]}>
The protocol accepted by the port
</Property>
</Properties>
</Properties>
</details>
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="POST" label="/api/peers/{peerId}/ingress/ports">
```bash {{ title: 'cURL' }}
curl -X POST https://api.netbird.io/api/peers/{peerId}/ingress/ports \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Token <TOKEN>' \
--data-raw '{
"name": "Ingress Port Allocation 1",
"enabled": true,
"port_ranges": [
{
"start": 80,
"end": 320,
"protocol": "tcp"
}
],
"direct_port": {
"count": 5,
"protocol": "udp"
}
}'
```
```js
const axios = require('axios');
let data = JSON.stringify({
"name": "Ingress Port Allocation 1",
"enabled": true,
"port_ranges": [
{
"start": 80,
"end": 320,
"protocol": "tcp"
}
],
"direct_port": {
"count": 5,
"protocol": "udp"
}
});
let config = {
method: 'post',
maxBodyLength: Infinity,
url: '/api/peers/{peerId}/ingress/ports',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json',
'Authorization': 'Token <TOKEN>'
},
data : data
};
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/peers/{peerId}/ingress/ports"
payload = json.dumps({
"name": "Ingress Port Allocation 1",
"enabled": true,
"port_ranges": [
{
"start": 80,
"end": 320,
"protocol": "tcp"
}
],
"direct_port": {
"count": 5,
"protocol": "udp"
}
})
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
```
```go
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://api.netbird.io/api/peers/{peerId}/ingress/ports"
method := "POST"
payload := strings.NewReader(`{
"name": "Ingress Port Allocation 1",
"enabled": true,
"port_ranges": [
{
"start": 80,
"end": 320,
"protocol": "tcp"
}
],
"direct_port": {
"count": 5,
"protocol": "udp"
}
}`)
client := &http.Client {
}
req, err := http.NewRequest(method, url, payload)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Content-Type", "application/json")
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/peers/{peerId}/ingress/ports")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Accept"] = "application/json"
request["Authorization"] = "Token <TOKEN>"
request.body = JSON.dump({
"name": "Ingress Port Allocation 1",
"enabled": true,
"port_ranges": [
{
"start": 80,
"end": 320,
"protocol": "tcp"
}
],
"direct_port": {
"count": 5,
"protocol": "udp"
}
})
response = https.request(request)
puts response.read_body
```
```java
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, '{
"name": "Ingress Port Allocation 1",
"enabled": true,
"port_ranges": [
{
"start": 80,
"end": 320,
"protocol": "tcp"
}
],
"direct_port": {
"count": 5,
"protocol": "udp"
}
}');
Request request = new Request.Builder()
.url("https://api.netbird.io/api/peers/{peerId}/ingress/ports")
.method("POST", body)
.addHeader("Content-Type", "application/json")
.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/peers/{peerId}/ingress/ports',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => '{
"name": "Ingress Port Allocation 1",
"enabled": true,
"port_ranges": [
{
"start": 80,
"end": 320,
"protocol": "tcp"
}
],
"direct_port": {
"count": 5,
"protocol": "udp"
}
}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json',
'Accept: application/json',
'Authorization: Token <TOKEN>'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```
</CodeGroup>
<CodeGroup title="Response">
```json {{ title: 'Example' }}
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "Ingress Peer Allocation 1",
"ingress_peer_id": "x7p3kqf2rdd8j5zxw4n9",
"region": "germany",
"enabled": true,
"ingress_ip": "192.34.0.123",
"port_range_mappings": [
{
"translated_start": 80,
"translated_end": 320,
"ingress_start": 1080,
"ingress_end": 1320,
"protocol": "tcp"
}
]
}
```
```json {{ title: 'Schema' }}
{
"id": "string",
"name": "string",
"ingress_peer_id": "string",
"region": "string",
"enabled": "boolean",
"ingress_ip": "string",
"port_range_mappings": [
{
"translated_start": "integer",
"translated_end": "integer",
"ingress_start": "integer",
"ingress_end": "integer",
"protocol": "string"
}
]
}
```
</CodeGroup>
</Col>
</Row>
---
## Retrieve a Port Allocation <Badge status="cloud-only" text="cloud-only" hoverText="This feature is only available in the cloud version of NetBird." /> {{ tag: 'GET' , label: '/api/peers/{peerId}/ingress/ports/{allocationId}' }}
<Row>
<Col>
Get information about an ingress port allocation
### Path Parameters
<Properties>
<Property name="peerId" type="string" required={true}>
The unique identifier of a peer
</Property>
<Property name="allocationId" type="string" required={true}>
The unique identifier of an ingress port allocation
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="GET" label="/api/peers/{peerId}/ingress/ports/{allocationId}">
```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/peers/{peerId}/ingress/ports/{allocationId} \
-H 'Accept: application/json' \
-H 'Authorization: Token <TOKEN>'
```
```js
const axios = require('axios');
let config = {
method: 'get',
maxBodyLength: Infinity,
url: '/api/peers/{peerId}/ingress/ports/{allocationId}',
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/peers/{peerId}/ingress/ports/{allocationId}"
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/peers/{peerId}/ingress/ports/{allocationId}"
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/peers/{peerId}/ingress/ports/{allocationId}")
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/peers/{peerId}/ingress/ports/{allocationId}")
.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/peers/{peerId}/ingress/ports/{allocationId}',
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": "ch8i4ug6lnn4g9hqv7m0",
"name": "Ingress Peer Allocation 1",
"ingress_peer_id": "x7p3kqf2rdd8j5zxw4n9",
"region": "germany",
"enabled": true,
"ingress_ip": "192.34.0.123",
"port_range_mappings": [
{
"translated_start": 80,
"translated_end": 320,
"ingress_start": 1080,
"ingress_end": 1320,
"protocol": "tcp"
}
]
}
```
```json {{ title: 'Schema' }}
{
"id": "string",
"name": "string",
"ingress_peer_id": "string",
"region": "string",
"enabled": "boolean",
"ingress_ip": "string",
"port_range_mappings": [
{
"translated_start": "integer",
"translated_end": "integer",
"ingress_start": "integer",
"ingress_end": "integer",
"protocol": "string"
}
]
}
```
</CodeGroup>
</Col>
</Row>
---
## Update a Port Allocation <Badge status="cloud-only" text="cloud-only" hoverText="This feature is only available in the cloud version of NetBird." /> {{ tag: 'PUT' , label: '/api/peers/{peerId}/ingress/ports/{allocationId}' }}
<Row>
<Col>
Update information about an ingress port allocation
### Path Parameters
<Properties>
<Property name="peerId" type="string" required={true}>
The unique identifier of a peer
</Property>
<Property name="allocationId" type="string" required={true}>
The unique identifier of an ingress port allocation
</Property>
</Properties>
### Request-Body Parameters
<Properties><Property name="name" type="string" required={true}>
Name of the ingress port allocation
</Property>
<Property name="enabled" type="boolean" required={true}>
Indicates if an ingress port allocation is enabled
</Property>
<Property name="port_ranges" type="object[]" required={false}>
<details className="custom-details" open>
<summary>List of port ranges that are forwarded by the ingress peer</summary>
<Properties>
<Properties><Property name="start" type="integer" required={true}>
The starting port of the range of forwarded ports
</Property>
<Property name="end" type="integer" required={true}>
The ending port of the range of forwarded ports
</Property>
<Property name="protocol" type="string" required={true} enumList={["tcp","udp","tcp/udp"]}>
The protocol accepted by the port range
</Property>
</Properties>
</Properties>
</details>
</Property>
<Property name="direct_port" type="object" required={false}>
<details className="custom-details" open>
<summary>More Information</summary>
<Properties>
<Properties><Property name="count" type="integer" required={true}>
The number of ports to be forwarded
</Property>
<Property name="protocol" type="string" required={true} enumList={["tcp","udp","tcp/udp"]}>
The protocol accepted by the port
</Property>
</Properties>
</Properties>
</details>
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="PUT" label="/api/peers/{peerId}/ingress/ports/{allocationId}">
```bash {{ title: 'cURL' }}
curl -X PUT https://api.netbird.io/api/peers/{peerId}/ingress/ports/{allocationId} \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Token <TOKEN>' \
--data-raw '{
"name": "Ingress Port Allocation 1",
"enabled": true,
"port_ranges": [
{
"start": 80,
"end": 320,
"protocol": "tcp"
}
],
"direct_port": {
"count": 5,
"protocol": "udp"
}
}'
```
```js
const axios = require('axios');
let data = JSON.stringify({
"name": "Ingress Port Allocation 1",
"enabled": true,
"port_ranges": [
{
"start": 80,
"end": 320,
"protocol": "tcp"
}
],
"direct_port": {
"count": 5,
"protocol": "udp"
}
});
let config = {
method: 'put',
maxBodyLength: Infinity,
url: '/api/peers/{peerId}/ingress/ports/{allocationId}',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json',
'Authorization': 'Token <TOKEN>'
},
data : data
};
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/peers/{peerId}/ingress/ports/{allocationId}"
payload = json.dumps({
"name": "Ingress Port Allocation 1",
"enabled": true,
"port_ranges": [
{
"start": 80,
"end": 320,
"protocol": "tcp"
}
],
"direct_port": {
"count": 5,
"protocol": "udp"
}
})
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
}
response = requests.request("PUT", url, headers=headers, data=payload)
print(response.text)
```
```go
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://api.netbird.io/api/peers/{peerId}/ingress/ports/{allocationId}"
method := "PUT"
payload := strings.NewReader(`{
"name": "Ingress Port Allocation 1",
"enabled": true,
"port_ranges": [
{
"start": 80,
"end": 320,
"protocol": "tcp"
}
],
"direct_port": {
"count": 5,
"protocol": "udp"
}
}`)
client := &http.Client {
}
req, err := http.NewRequest(method, url, payload)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Content-Type", "application/json")
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/peers/{peerId}/ingress/ports/{allocationId}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = "application/json"
request["Accept"] = "application/json"
request["Authorization"] = "Token <TOKEN>"
request.body = JSON.dump({
"name": "Ingress Port Allocation 1",
"enabled": true,
"port_ranges": [
{
"start": 80,
"end": 320,
"protocol": "tcp"
}
],
"direct_port": {
"count": 5,
"protocol": "udp"
}
})
response = https.request(request)
puts response.read_body
```
```java
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, '{
"name": "Ingress Port Allocation 1",
"enabled": true,
"port_ranges": [
{
"start": 80,
"end": 320,
"protocol": "tcp"
}
],
"direct_port": {
"count": 5,
"protocol": "udp"
}
}');
Request request = new Request.Builder()
.url("https://api.netbird.io/api/peers/{peerId}/ingress/ports/{allocationId}")
.method("PUT", body)
.addHeader("Content-Type", "application/json")
.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/peers/{peerId}/ingress/ports/{allocationId}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_POSTFIELDS => '{
"name": "Ingress Port Allocation 1",
"enabled": true,
"port_ranges": [
{
"start": 80,
"end": 320,
"protocol": "tcp"
}
],
"direct_port": {
"count": 5,
"protocol": "udp"
}
}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json',
'Accept: application/json',
'Authorization: Token <TOKEN>'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```
</CodeGroup>
<CodeGroup title="Response">
```json {{ title: 'Example' }}
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"name": "Ingress Peer Allocation 1",
"ingress_peer_id": "x7p3kqf2rdd8j5zxw4n9",
"region": "germany",
"enabled": true,
"ingress_ip": "192.34.0.123",
"port_range_mappings": [
{
"translated_start": 80,
"translated_end": 320,
"ingress_start": 1080,
"ingress_end": 1320,
"protocol": "tcp"
}
]
}
```
```json {{ title: 'Schema' }}
{
"id": "string",
"name": "string",
"ingress_peer_id": "string",
"region": "string",
"enabled": "boolean",
"ingress_ip": "string",
"port_range_mappings": [
{
"translated_start": "integer",
"translated_end": "integer",
"ingress_start": "integer",
"ingress_end": "integer",
"protocol": "string"
}
]
}
```
</CodeGroup>
</Col>
</Row>
---
## Delete a Port Allocation <Badge status="cloud-only" text="cloud-only" hoverText="This feature is only available in the cloud version of NetBird." /> {{ tag: 'DELETE' , label: '/api/peers/{peerId}/ingress/ports/{allocationId}' }}
<Row>
<Col>
Delete an ingress port allocation
### Path Parameters
<Properties>
<Property name="peerId" type="string" required={true}>
The unique identifier of a peer
</Property>
<Property name="allocationId" type="string" required={true}>
The unique identifier of an ingress port allocation
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="DELETE" label="/api/peers/{peerId}/ingress/ports/{allocationId}">
```bash {{ title: 'cURL' }}
curl -X DELETE https://api.netbird.io/api/peers/{peerId}/ingress/ports/{allocationId} \
-H 'Authorization: Token <TOKEN>'
```
```js
const axios = require('axios');
let config = {
method: 'delete',
maxBodyLength: Infinity,
url: '/api/peers/{peerId}/ingress/ports/{allocationId}',
headers: {
'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/peers/{peerId}/ingress/ports/{allocationId}"
headers = {
'Authorization': 'Token <TOKEN>'
}
response = requests.request("DELETE", url, headers=headers)
print(response.text)
```
```go
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://api.netbird.io/api/peers/{peerId}/ingress/ports/{allocationId}"
method := "DELETE"
client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)
if err != nil {
fmt.Println(err)
return
}
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/peers/{peerId}/ingress/ports/{allocationId}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Delete.new(url)
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/peers/{peerId}/ingress/ports/{allocationId}")
.method("DELETE")
.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/peers/{peerId}/ingress/ports/{allocationId}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => array(
'Authorization: Token <TOKEN>'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```
</CodeGroup>
</Col>
</Row>
---
## List all Ingress Peers <Badge status="cloud-only" text="cloud-only" hoverText="This feature is only available in the cloud version of NetBird." /> {{ tag: 'GET' , label: '/api/ingress/peers' }}
<Row>
<Col>
Returns a list of all ingress peers
</Col>
<Col sticky>
<CodeGroup title="Request" tag="GET" label="/api/ingress/peers">
```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/ingress/peers \
-H 'Accept: application/json' \
-H 'Authorization: Token <TOKEN>'
```
```js
const axios = require('axios');
let config = {
method: 'get',
maxBodyLength: Infinity,
url: '/api/ingress/peers',
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/ingress/peers"
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/ingress/peers"
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/ingress/peers")
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/ingress/peers")
.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/ingress/peers',
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": "ch8i4ug6lnn4g9hqv7m0",
"peer_id": "x7p3kqf2rdd8j5zxw4n9",
"ingress_ip": "192.34.0.123",
"available_ports": {
"tcp": 45765,
"udp": 50000
},
"enabled": true,
"connected": true,
"fallback": true,
"region": "germany"
}
]
```
```json {{ title: 'Schema' }}
[
{
"id": "string",
"peer_id": "string",
"ingress_ip": "string",
"available_ports": {
"tcp": "integer",
"udp": "integer"
},
"enabled": "boolean",
"connected": "boolean",
"fallback": "boolean",
"region": "string"
}
]
```
</CodeGroup>
</Col>
</Row>
---
## Create a Ingress Peer <Badge status="cloud-only" text="cloud-only" hoverText="This feature is only available in the cloud version of NetBird." /> {{ tag: 'POST' , label: '/api/ingress/peers' }}
<Row>
<Col>
Creates a new ingress peer
### Request-Body Parameters
<Properties><Property name="peer_id" type="string" required={true}>
ID of the peer that is used as an ingress peer
</Property>
<Property name="enabled" type="boolean" required={true}>
Defines if an ingress peer is enabled
</Property>
<Property name="fallback" type="boolean" required={true}>
Defines if an ingress peer can be used as a fallback if no ingress peer can be found in the region of the forwarded peer
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="POST" label="/api/ingress/peers">
```bash {{ title: 'cURL' }}
curl -X POST https://api.netbird.io/api/ingress/peers \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Token <TOKEN>' \
--data-raw '{
"peer_id": "ch8i4ug6lnn4g9hqv7m0",
"enabled": true,
"fallback": true
}'
```
```js
const axios = require('axios');
let data = JSON.stringify({
"peer_id": "ch8i4ug6lnn4g9hqv7m0",
"enabled": true,
"fallback": true
});
let config = {
method: 'post',
maxBodyLength: Infinity,
url: '/api/ingress/peers',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json',
'Authorization': 'Token <TOKEN>'
},
data : data
};
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/ingress/peers"
payload = json.dumps({
"peer_id": "ch8i4ug6lnn4g9hqv7m0",
"enabled": true,
"fallback": true
})
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
```
```go
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://api.netbird.io/api/ingress/peers"
method := "POST"
payload := strings.NewReader(`{
"peer_id": "ch8i4ug6lnn4g9hqv7m0",
"enabled": true,
"fallback": true
}`)
client := &http.Client {
}
req, err := http.NewRequest(method, url, payload)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Content-Type", "application/json")
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/ingress/peers")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Accept"] = "application/json"
request["Authorization"] = "Token <TOKEN>"
request.body = JSON.dump({
"peer_id": "ch8i4ug6lnn4g9hqv7m0",
"enabled": true,
"fallback": true
})
response = https.request(request)
puts response.read_body
```
```java
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, '{
"peer_id": "ch8i4ug6lnn4g9hqv7m0",
"enabled": true,
"fallback": true
}');
Request request = new Request.Builder()
.url("https://api.netbird.io/api/ingress/peers")
.method("POST", body)
.addHeader("Content-Type", "application/json")
.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/ingress/peers',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => '{
"peer_id": "ch8i4ug6lnn4g9hqv7m0",
"enabled": true,
"fallback": true
}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json',
'Accept: application/json',
'Authorization: Token <TOKEN>'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```
</CodeGroup>
<CodeGroup title="Response">
```json {{ title: 'Example' }}
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"peer_id": "x7p3kqf2rdd8j5zxw4n9",
"ingress_ip": "192.34.0.123",
"available_ports": {
"tcp": 45765,
"udp": 50000
},
"enabled": true,
"connected": true,
"fallback": true,
"region": "germany"
}
```
```json {{ title: 'Schema' }}
{
"id": "string",
"peer_id": "string",
"ingress_ip": "string",
"available_ports": {
"tcp": "integer",
"udp": "integer"
},
"enabled": "boolean",
"connected": "boolean",
"fallback": "boolean",
"region": "string"
}
```
</CodeGroup>
</Col>
</Row>
---
## Retrieve a Ingress Peer <Badge status="cloud-only" text="cloud-only" hoverText="This feature is only available in the cloud version of NetBird." /> {{ tag: 'GET' , label: '/api/ingress/peers/{ingressPeerId}' }}
<Row>
<Col>
Get information about an ingress peer
### Path Parameters
<Properties>
<Property name="ingressPeerId" type="string" required={true}>
The unique identifier of an ingress peer
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="GET" label="/api/ingress/peers/{ingressPeerId}">
```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/ingress/peers/{ingressPeerId} \
-H 'Accept: application/json' \
-H 'Authorization: Token <TOKEN>'
```
```js
const axios = require('axios');
let config = {
method: 'get',
maxBodyLength: Infinity,
url: '/api/ingress/peers/{ingressPeerId}',
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/ingress/peers/{ingressPeerId}"
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/ingress/peers/{ingressPeerId}"
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/ingress/peers/{ingressPeerId}")
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/ingress/peers/{ingressPeerId}")
.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/ingress/peers/{ingressPeerId}',
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": "ch8i4ug6lnn4g9hqv7m0",
"peer_id": "x7p3kqf2rdd8j5zxw4n9",
"ingress_ip": "192.34.0.123",
"available_ports": {
"tcp": 45765,
"udp": 50000
},
"enabled": true,
"connected": true,
"fallback": true,
"region": "germany"
}
```
```json {{ title: 'Schema' }}
{
"id": "string",
"peer_id": "string",
"ingress_ip": "string",
"available_ports": {
"tcp": "integer",
"udp": "integer"
},
"enabled": "boolean",
"connected": "boolean",
"fallback": "boolean",
"region": "string"
}
```
</CodeGroup>
</Col>
</Row>
---
## Update a Ingress Peer <Badge status="cloud-only" text="cloud-only" hoverText="This feature is only available in the cloud version of NetBird." /> {{ tag: 'PUT' , label: '/api/ingress/peers/{ingressPeerId}' }}
<Row>
<Col>
Update information about an ingress peer
### Path Parameters
<Properties>
<Property name="ingressPeerId" type="string" required={true}>
The unique identifier of an ingress peer
</Property>
</Properties>
### Request-Body Parameters
<Properties><Property name="enabled" type="boolean" required={true}>
Defines if an ingress peer is enabled
</Property>
<Property name="fallback" type="boolean" required={true}>
Defines if an ingress peer can be used as a fallback if no ingress peer can be found in the region of the forwarded peer
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="PUT" label="/api/ingress/peers/{ingressPeerId}">
```bash {{ title: 'cURL' }}
curl -X PUT https://api.netbird.io/api/ingress/peers/{ingressPeerId} \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Token <TOKEN>' \
--data-raw '{
"enabled": true,
"fallback": true
}'
```
```js
const axios = require('axios');
let data = JSON.stringify({
"enabled": true,
"fallback": true
});
let config = {
method: 'put',
maxBodyLength: Infinity,
url: '/api/ingress/peers/{ingressPeerId}',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json',
'Authorization': 'Token <TOKEN>'
},
data : data
};
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/ingress/peers/{ingressPeerId}"
payload = json.dumps({
"enabled": true,
"fallback": true
})
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
}
response = requests.request("PUT", url, headers=headers, data=payload)
print(response.text)
```
```go
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://api.netbird.io/api/ingress/peers/{ingressPeerId}"
method := "PUT"
payload := strings.NewReader(`{
"enabled": true,
"fallback": true
}`)
client := &http.Client {
}
req, err := http.NewRequest(method, url, payload)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Content-Type", "application/json")
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/ingress/peers/{ingressPeerId}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = "application/json"
request["Accept"] = "application/json"
request["Authorization"] = "Token <TOKEN>"
request.body = JSON.dump({
"enabled": true,
"fallback": true
})
response = https.request(request)
puts response.read_body
```
```java
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, '{
"enabled": true,
"fallback": true
}');
Request request = new Request.Builder()
.url("https://api.netbird.io/api/ingress/peers/{ingressPeerId}")
.method("PUT", body)
.addHeader("Content-Type", "application/json")
.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/ingress/peers/{ingressPeerId}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_POSTFIELDS => '{
"enabled": true,
"fallback": true
}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json',
'Accept: application/json',
'Authorization: Token <TOKEN>'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```
</CodeGroup>
<CodeGroup title="Response">
```json {{ title: 'Example' }}
{
"id": "ch8i4ug6lnn4g9hqv7m0",
"peer_id": "x7p3kqf2rdd8j5zxw4n9",
"ingress_ip": "192.34.0.123",
"available_ports": {
"tcp": 45765,
"udp": 50000
},
"enabled": true,
"connected": true,
"fallback": true,
"region": "germany"
}
```
```json {{ title: 'Schema' }}
{
"id": "string",
"peer_id": "string",
"ingress_ip": "string",
"available_ports": {
"tcp": "integer",
"udp": "integer"
},
"enabled": "boolean",
"connected": "boolean",
"fallback": "boolean",
"region": "string"
}
```
</CodeGroup>
</Col>
</Row>
---
## Delete a Ingress Peer <Badge status="cloud-only" text="cloud-only" hoverText="This feature is only available in the cloud version of NetBird." /> {{ tag: 'DELETE' , label: '/api/ingress/peers/{ingressPeerId}' }}
<Row>
<Col>
Delete an ingress peer
### Path Parameters
<Properties>
<Property name="ingressPeerId" type="string" required={true}>
The unique identifier of an ingress peer
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="DELETE" label="/api/ingress/peers/{ingressPeerId}">
```bash {{ title: 'cURL' }}
curl -X DELETE https://api.netbird.io/api/ingress/peers/{ingressPeerId} \
-H 'Authorization: Token <TOKEN>'
```
```js
const axios = require('axios');
let config = {
method: 'delete',
maxBodyLength: Infinity,
url: '/api/ingress/peers/{ingressPeerId}',
headers: {
'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/ingress/peers/{ingressPeerId}"
headers = {
'Authorization': 'Token <TOKEN>'
}
response = requests.request("DELETE", url, headers=headers)
print(response.text)
```
```go
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://api.netbird.io/api/ingress/peers/{ingressPeerId}"
method := "DELETE"
client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)
if err != nil {
fmt.Println(err)
return
}
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/ingress/peers/{ingressPeerId}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Delete.new(url)
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/ingress/peers/{ingressPeerId}")
.method("DELETE")
.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/ingress/peers/{ingressPeerId}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => array(
'Authorization: Token <TOKEN>'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```
</CodeGroup>
</Col>
</Row>
---
Reference in New Issue View Git Blame Copy Permalink