mirror of
https://github.com/netbirdio/docs.git
synced 2026-05-04 00:06:36 +00:00
[API] add cloud and experimantal badges + new pages (#292)
This commit is contained in:
@@ -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>
|
||||
<Col>
|
||||
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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<Col>
|
||||
|
||||
Reference in New Issue
Block a user