Mirrors/wg-portal
1
0
Fork 0
mirror of https://github.com/h44z/wg-portal.git synced 2025-07-12 16:16:58 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Deployed 6cbccf6 to master with MkDocs 1.6.1 and mike 2.1.3

Browse Source
This commit is contained in:
github-actions[bot] 2025-03-29 15:43:09 +00:00
parent c230f8105d
commit e726d99921
1 changed files with 1466 additions and 1531 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

195
master/documentation/rest-api/swagger.yaml
View File

@ -45,16 +45,14 @@ definitions:
models.Interface: models.Interface:
properties: properties:
Addresses: Addresses:
description: Addresses is a list of IP addresses (in CIDR format) that are description: Addresses is a list of IP addresses (in CIDR format) that are assigned to the interface.
assigned to the interface.
example: example:
- 10.11.12.1/24 - 10.11.12.1/24
items: items:
type: string type: string
type: array type: array
Disabled: Disabled:
description: Disabled is a flag that specifies if the interface is enabled description: Disabled is a flag that specifies if the interface is enabled (up) or not (down). Disabled interfaces are not able to accept connections.
(up) or not (down). Disabled interfaces are not able to accept connections.
example: false example: false
type: boolean type: boolean
DisabledReason: DisabledReason:
@ -67,45 +65,38 @@ definitions:
maxLength: 64 maxLength: 64
type: string type: string
Dns: Dns:
description: Dns is a list of DNS servers that should be set if the interface description: Dns is a list of DNS servers that should be set if the interface is up.
is up.
example: example:
- 1.1.1.1 - 1.1.1.1
items: items:
type: string type: string
type: array type: array
DnsSearch: DnsSearch:
description: DnsSearch is the dns search option string that should be set description: DnsSearch is the dns search option string that should be set if the interface is up, will be appended to Dns servers.
if the interface is up, will be appended to Dns servers.
example: example:
- wg.local - wg.local
items: items:
type: string type: string
type: array type: array
EnabledPeers: EnabledPeers:
description: EnabledPeers is the number of enabled peers for this interface. description: EnabledPeers is the number of enabled peers for this interface. Only enabled peers are able to connect.
Only enabled peers are able to connect.
readOnly: true readOnly: true
type: integer type: integer
FirewallMark: FirewallMark:
description: FirewallMark is an optional firewall mark which is used to handle description: FirewallMark is an optional firewall mark which is used to handle interface traffic.
interface traffic.
type: integer type: integer
Identifier: Identifier:
description: Identifier is the unique identifier of the interface. It is always description: Identifier is the unique identifier of the interface. It is always equal to the device name of the interface.
equal to the device name of the interface.
example: wg0 example: wg0
type: string type: string
ListenPort: ListenPort:
description: 'ListenPort is the listening port, for example: 51820. The listening description: 'ListenPort is the listening port, for example: 51820. The listening port is only required for server interfaces.'
port is only required for server interfaces.'
example: 51820 example: 51820
maximum: 65535 maximum: 65535
minimum: 1 minimum: 1
type: integer type: integer
Mode: Mode:
description: Mode is the interface type, either 'server', 'client' or 'any'. description: Mode is the interface type, either 'server', 'client' or 'any'. The mode specifies how WireGuard Portal handles peers for this interface.
The mode specifies how WireGuard Portal handles peers for this interface.
enum: enum:
- server - server
- client - client
@ -119,8 +110,7 @@ definitions:
minimum: 1 minimum: 1
type: integer type: integer
PeerDefAllowedIPs: PeerDefAllowedIPs:
description: PeerDefAllowedIPs specifies the default allowed IP addresses description: PeerDefAllowedIPs specifies the default allowed IP addresses for a new peer.
for a new peer.
example: example:
- 10.11.12.0/24 - 10.11.12.0/24
items: items:
@ -134,8 +124,7 @@ definitions:
type: string type: string
type: array type: array
PeerDefDnsSearch: PeerDefDnsSearch:
description: PeerDefDnsSearch specifies the default dns search options for description: PeerDefDnsSearch specifies the default dns search options for a new peer.
a new peer.
example: example:
- wg.local - wg.local
items: items:
@ -146,64 +135,52 @@ definitions:
example: wg.example.com:51820 example: wg.example.com:51820
type: string type: string
PeerDefFirewallMark: PeerDefFirewallMark:
description: PeerDefFirewallMark specifies the default firewall mark for a description: PeerDefFirewallMark specifies the default firewall mark for a new peer.
new peer.
type: integer type: integer
PeerDefMtu: PeerDefMtu:
description: PeerDefMtu specifies the default device MTU for a new peer. description: PeerDefMtu specifies the default device MTU for a new peer.
example: 1420 example: 1420
type: integer type: integer
PeerDefNetwork: PeerDefNetwork:
description: PeerDefNetwork specifies the default subnets from which new peers description: PeerDefNetwork specifies the default subnets from which new peers will get their IP addresses. The subnet is specified in CIDR format.
will get their IP addresses. The subnet is specified in CIDR format.
example: example:
- 10.11.12.0/24 - 10.11.12.0/24
items: items:
type: string type: string
type: array type: array
PeerDefPersistentKeepalive: PeerDefPersistentKeepalive:
description: PeerDefPersistentKeepalive specifies the default persistent keep-alive description: PeerDefPersistentKeepalive specifies the default persistent keep-alive value in seconds for a new peer.
value in seconds for a new peer.
example: 25 example: 25
type: integer type: integer
PeerDefPostDown: PeerDefPostDown:
description: PeerDefPostDown specifies the default action that is executed description: PeerDefPostDown specifies the default action that is executed after the device is down for a new peer.
after the device is down for a new peer.
type: string type: string
PeerDefPostUp: PeerDefPostUp:
description: PeerDefPostUp specifies the default action that is executed after description: PeerDefPostUp specifies the default action that is executed after the device is up for a new peer.
the device is up for a new peer.
type: string type: string
PeerDefPreDown: PeerDefPreDown:
description: PeerDefPreDown specifies the default action that is executed description: PeerDefPreDown specifies the default action that is executed before the device is down for a new peer.
before the device is down for a new peer.
type: string type: string
PeerDefPreUp: PeerDefPreUp:
description: PeerDefPreUp specifies the default action that is executed before description: PeerDefPreUp specifies the default action that is executed before the device is up for a new peer.
the device is up for a new peer.
type: string type: string
PeerDefRoutingTable: PeerDefRoutingTable:
description: PeerDefRoutingTable specifies the default routing table for a description: PeerDefRoutingTable specifies the default routing table for a new peer.
new peer.
type: string type: string
PostDown: PostDown:
description: PostDown is an optional action that is executed after the device description: PostDown is an optional action that is executed after the device is down.
is down.
example: echo 'Interface is down' example: echo 'Interface is down'
type: string type: string
PostUp: PostUp:
description: PostUp is an optional action that is executed after the device description: PostUp is an optional action that is executed after the device is up.
is up.
example: iptables -A FORWARD -i %i -j ACCEPT example: iptables -A FORWARD -i %i -j ACCEPT
type: string type: string
PreDown: PreDown:
description: PreDown is an optional action that is executed before the device description: PreDown is an optional action that is executed before the device is down.
is down.
example: iptables -D FORWARD -i %i -j ACCEPT example: iptables -D FORWARD -i %i -j ACCEPT
type: string type: string
PreUp: PreUp:
description: PreUp is an optional action that is executed before the device description: PreUp is an optional action that is executed before the device is up.
is up.
example: echo 'Interface is up' example: echo 'Interface is up'
type: string type: string
PrivateKey: PrivateKey:
@ -211,17 +188,14 @@ definitions:
example: gI6EdUSYvn8ugXOt8QQD6Yc+JyiZxIhp3GInSWRfWGE= example: gI6EdUSYvn8ugXOt8QQD6Yc+JyiZxIhp3GInSWRfWGE=
type: string type: string
PublicKey: PublicKey:
description: PublicKey is the public key of the server interface. The public description: PublicKey is the public key of the server interface. The public key is used by peers to connect to the server.
key is used by peers to connect to the server.
example: HIgo9xNzJMWLKASShiTqIybxZ0U3wGLiUeJ1PKf8ykw= example: HIgo9xNzJMWLKASShiTqIybxZ0U3wGLiUeJ1PKf8ykw=
type: string type: string
RoutingTable: RoutingTable:
description: RoutingTable is an optional routing table which is used to route description: RoutingTable is an optional routing table which is used to route interface traffic.
interface traffic.
type: string type: string
SaveConfig: SaveConfig:
description: SaveConfig is a flag that specifies if the configuration should description: SaveConfig is a flag that specifies if the configuration should be saved to the configuration file (wgX.conf in wg-quick format).
be saved to the configuration file (wgX.conf in wg-quick format).
example: false example: false
type: boolean type: boolean
TotalPeers: TotalPeers:
@ -252,8 +226,7 @@ definitions:
models.Peer: models.Peer:
properties: properties:
Addresses: Addresses:
description: Addresses is a list of IP addresses in CIDR format (both IPv4 description: Addresses is a list of IP addresses in CIDR format (both IPv4 and IPv6) for the peer.
and IPv6) for the peer.
example: example:
- 10.11.12.2/24 - 10.11.12.2/24
items: items:
@ -264,13 +237,11 @@ definitions:
- $ref: '#/definitions/models.ConfigOption-array_string' - $ref: '#/definitions/models.ConfigOption-array_string'
description: AllowedIPs is a list of allowed IP subnets for the peer. description: AllowedIPs is a list of allowed IP subnets for the peer.
CheckAliveAddress: CheckAliveAddress:
description: CheckAliveAddress is an optional ip address or DNS name that description: CheckAliveAddress is an optional ip address or DNS name that is used for ping checks.
is used for ping checks.
example: 1.1.1.1 example: 1.1.1.1
type: string type: string
Disabled: Disabled:
description: Disabled is a flag that specifies if the peer is enabled or not. description: Disabled is a flag that specifies if the peer is enabled or not. Disabled peers are not able to connect.
Disabled peers are not able to connect.
example: false example: false
type: boolean type: boolean
DisabledReason: DisabledReason:
@ -285,13 +256,11 @@ definitions:
Dns: Dns:
allOf: allOf:
- $ref: '#/definitions/models.ConfigOption-array_string' - $ref: '#/definitions/models.ConfigOption-array_string'
description: Dns is a list of DNS servers that should be set if the peer interface description: Dns is a list of DNS servers that should be set if the peer interface is up.
is up.
DnsSearch: DnsSearch:
allOf: allOf:
- $ref: '#/definitions/models.ConfigOption-array_string' - $ref: '#/definitions/models.ConfigOption-array_string'
description: DnsSearch is the dns search option string that should be set description: DnsSearch is the dns search option string that should be set if the peer interface is up, will be appended to Dns servers.
if the peer interface is up, will be appended to Dns servers.
Endpoint: Endpoint:
allOf: allOf:
- $ref: '#/definitions/models.ConfigOption-string' - $ref: '#/definitions/models.ConfigOption-string'
@ -301,28 +270,23 @@ definitions:
- $ref: '#/definitions/models.ConfigOption-string' - $ref: '#/definitions/models.ConfigOption-string'
description: EndpointPublicKey is the endpoint public key. description: EndpointPublicKey is the endpoint public key.
ExpiresAt: ExpiresAt:
description: ExpiresAt is the expiry date of the peer in YYYY-MM-DD format. description: ExpiresAt is the expiry date of the peer in YYYY-MM-DD format. An expired peer is not able to connect.
An expired peer is not able to connect.
type: string type: string
ExtraAllowedIPs: ExtraAllowedIPs:
description: ExtraAllowedIPs is a list of additional allowed IP subnets for description: ExtraAllowedIPs is a list of additional allowed IP subnets for the peer. These allowed IP subnets are added on the server side.
the peer. These allowed IP subnets are added on the server side.
items: items:
type: string type: string
type: array type: array
FirewallMark: FirewallMark:
allOf: allOf:
- $ref: '#/definitions/models.ConfigOption-uint32' - $ref: '#/definitions/models.ConfigOption-uint32'
description: FirewallMark is an optional firewall mark which is used to handle description: FirewallMark is an optional firewall mark which is used to handle peer traffic.
peer traffic.
Identifier: Identifier:
description: Identifier is the unique identifier of the peer. It is always description: Identifier is the unique identifier of the peer. It is always equal to the public key of the peer.
equal to the public key of the peer.
example: xTIBA5rboUvnH4htodjb6e697QjLERt1NAB4mZqp8Dg= example: xTIBA5rboUvnH4htodjb6e697QjLERt1NAB4mZqp8Dg=
type: string type: string
InterfaceIdentifier: InterfaceIdentifier:
description: InterfaceIdentifier is the identifier of the interface the peer description: InterfaceIdentifier is the identifier of the interface the peer is linked to.
is linked to.
example: wg0 example: wg0
type: string type: string
Mode: Mode:
@ -344,28 +308,23 @@ definitions:
PersistentKeepalive: PersistentKeepalive:
allOf: allOf:
- $ref: '#/definitions/models.ConfigOption-int' - $ref: '#/definitions/models.ConfigOption-int'
description: PersistentKeepalive is the optional persistent keep-alive interval description: PersistentKeepalive is the optional persistent keep-alive interval in seconds.
in seconds.
PostDown: PostDown:
allOf: allOf:
- $ref: '#/definitions/models.ConfigOption-string' - $ref: '#/definitions/models.ConfigOption-string'
description: PostDown is an optional action that is executed after the device description: PostDown is an optional action that is executed after the device is down.
is down.
PostUp: PostUp:
allOf: allOf:
- $ref: '#/definitions/models.ConfigOption-string' - $ref: '#/definitions/models.ConfigOption-string'
description: PostUp is an optional action that is executed after the device description: PostUp is an optional action that is executed after the device is up.
is up.
PreDown: PreDown:
allOf: allOf:
- $ref: '#/definitions/models.ConfigOption-string' - $ref: '#/definitions/models.ConfigOption-string'
description: PreDown is an optional action that is executed before the device description: PreDown is an optional action that is executed before the device is down.
is down.
PreUp: PreUp:
allOf: allOf:
- $ref: '#/definitions/models.ConfigOption-string' - $ref: '#/definitions/models.ConfigOption-string'
description: PreUp is an optional action that is executed before the device description: PreUp is an optional action that is executed before the device is up.
is up.
PresharedKey: PresharedKey:
description: PresharedKey is the optional pre-shared Key of the peer. description: PresharedKey is the optional pre-shared Key of the peer.
example: yAnz5TF+lXXJte14tji3zlMNq+hd2rYUIgJBgB3fBmk= example: yAnz5TF+lXXJte14tji3zlMNq+hd2rYUIgJBgB3fBmk=
@ -381,8 +340,7 @@ definitions:
RoutingTable: RoutingTable:
allOf: allOf:
- $ref: '#/definitions/models.ConfigOption-string' - $ref: '#/definitions/models.ConfigOption-string'
description: RoutingTable is an optional routing table which is used to route description: RoutingTable is an optional routing table which is used to route peer traffic.
peer traffic.
UserIdentifier: UserIdentifier:
description: UserIdentifier is the identifier of the user that owns the peer. description: UserIdentifier is the identifier of the user that owns the peer.
example: uid-1234567 example: uid-1234567
@ -430,18 +388,15 @@ definitions:
models.ProvisioningRequest: models.ProvisioningRequest:
properties: properties:
InterfaceIdentifier: InterfaceIdentifier:
description: InterfaceIdentifier is the identifier of the WireGuard interface description: InterfaceIdentifier is the identifier of the WireGuard interface the peer should be linked to.
the peer should be linked to.
example: wg0 example: wg0
type: string type: string
PresharedKey: PresharedKey:
description: PresharedKey is the optional pre-shared key of the peer. If no description: PresharedKey is the optional pre-shared key of the peer. If no pre-shared key is set, a new key is generated.
pre-shared key is set, a new key is generated.
example: yAnz5TF+lXXJte14tji3zlMNq+hd2rYUIgJBgB3fBmk= example: yAnz5TF+lXXJte14tji3zlMNq+hd2rYUIgJBgB3fBmk=
type: string type: string
PublicKey: PublicKey:
description: PublicKey is the optional public key of the peer. If no public description: PublicKey is the optional public key of the peer. If no public key is set, a new key pair is generated.
key is set, a new key pair is generated.
example: xTIBA5rboUvnH4htodjb6e697QjLERt1NAB4mZqp8Dg= example: xTIBA5rboUvnH4htodjb6e697QjLERt1NAB4mZqp8Dg=
type: string type: string
UserIdentifier: UserIdentifier:
@ -456,14 +411,12 @@ definitions:
models.User: models.User:
properties: properties:
ApiEnabled: ApiEnabled:
description: If this field is set, the user is allowed to use the RESTful description: If this field is set, the user is allowed to use the RESTful API. This field is read-only.
API. This field is read-only.
example: false example: false
readOnly: true readOnly: true
type: boolean type: boolean
ApiToken: ApiToken:
description: The API token of the user. This field is never populated on bulk description: The API token of the user. This field is never populated on bulk read operations.
read operations.
example: "" example: ""
maxLength: 64 maxLength: 64
minLength: 32 minLength: 32
@ -502,8 +455,7 @@ definitions:
example: Muster example: Muster
type: string type: string
Locked: Locked:
description: If this field is set, the user is locked and thus unable to log description: If this field is set, the user is locked and thus unable to log in to WireGuard Portal.
in to WireGuard Portal.
example: false example: false
type: boolean type: boolean
LockedReason: LockedReason:
@ -515,8 +467,7 @@ definitions:
example: some sample notes example: some sample notes
type: string type: string
Password: Password:
description: The password of the user. This field is never populated on read description: The password of the user. This field is never populated on read operations.
operations.
example: "" example: ""
maxLength: 64 maxLength: 64
minLength: 16 minLength: 16
@ -567,39 +518,33 @@ definitions:
example: My iPhone example: My iPhone
type: string type: string
Identifier: Identifier:
description: Identifier is the unique identifier of the peer. It equals the description: Identifier is the unique identifier of the peer. It equals the public key of the peer.
public key of the peer.
example: peer-1234567 example: peer-1234567
type: string type: string
InterfaceIdentifier: InterfaceIdentifier:
description: InterfaceIdentifier is the unique identifier of the WireGuard description: InterfaceIdentifier is the unique identifier of the WireGuard Portal device the peer is connected to.
Portal device the peer is connected to.
example: wg0 example: wg0
type: string type: string
IpAddresses: IpAddresses:
description: IPAddresses is a list of IP addresses in CIDR format assigned description: IPAddresses is a list of IP addresses in CIDR format assigned to the peer.
to the peer.
example: example:
- 10.11.12.2/24 - 10.11.12.2/24
items: items:
type: string type: string
type: array type: array
IsDisabled: IsDisabled:
description: IsDisabled is a flag that specifies if the peer is enabled or description: IsDisabled is a flag that specifies if the peer is enabled or not. Disabled peers are not able to connect.
not. Disabled peers are not able to connect.
example: true example: true
type: boolean type: boolean
type: object type: object
models.UserMetrics: models.UserMetrics:
properties: properties:
BytesReceived: BytesReceived:
description: The total number of bytes received by the user. This is the sum description: The total number of bytes received by the user. This is the sum of all bytes received by the peers linked to the user.
of all bytes received by the peers linked to the user.
example: 123456789 example: 123456789
type: integer type: integer
BytesTransmitted: BytesTransmitted:
description: The total number of bytes transmitted by the user. This is the description: The total number of bytes transmitted by the user. This is the sum of all bytes transmitted by the peers linked to the user.
sum of all bytes transmitted by the peers linked to the user.
example: 123456789 example: 123456789
type: integer type: integer
PeerCount: PeerCount:
@ -607,8 +552,7 @@ definitions:
example: 2 example: 2
type: integer type: integer
PeerMetrics: PeerMetrics:
description: PeerMetrics represents the metrics of the peers linked to the description: PeerMetrics represents the metrics of the peers linked to the user.
user.
items: items:
$ref: '#/definitions/models.PeerMetrics' $ref: '#/definitions/models.PeerMetrics'
type: array type: array
@ -970,8 +914,7 @@ paths:
tags: tags:
- Peers - Peers
get: get:
description: Normal users can only access their own records. Admins can access description: Normal users can only access their own records. Admins can access all records.
all records.
operationId: peers_handleByIdGet operationId: peers_handleByIdGet
parameters: parameters:
- description: The peer identifier (public key). - description: The peer identifier (public key).
@ -1087,8 +1030,7 @@ paths:
- Peers - Peers
/peer/by-user/{id}: /peer/by-user/{id}:
get: get:
description: Normal users can only access their own records. Admins can access description: Normal users can only access their own records. Admins can access all records.
all records.
operationId: peers_handleAllForUserGet operationId: peers_handleAllForUserGet
parameters: parameters:
- description: The user identifier. - description: The user identifier.
@ -1163,8 +1105,7 @@ paths:
- Peers - Peers
/provisioning/data/peer-config: /provisioning/data/peer-config:
get: get:
description: Normal users can only access their own record. Admins can access description: Normal users can only access their own record. Admins can access all records.
all records.
operationId: provisioning_handlePeerConfigGet operationId: provisioning_handlePeerConfigGet
parameters: parameters:
- description: The peer identifier (public key) that should be queried. - description: The peer identifier (public key) that should be queried.
@ -1207,8 +1148,7 @@ paths:
- Provisioning - Provisioning
/provisioning/data/peer-qr: /provisioning/data/peer-qr:
get: get:
description: Normal users can only access their own record. Admins can access description: Normal users can only access their own record. Admins can access all records.
all records.
operationId: provisioning_handlePeerQrGet operationId: provisioning_handlePeerQrGet
parameters: parameters:
- description: The peer identifier (public key) that should be queried. - description: The peer identifier (public key) that should be queried.
@ -1251,17 +1191,14 @@ paths:
- Provisioning - Provisioning
/provisioning/data/user-info: /provisioning/data/user-info:
get: get:
description: Normal users can only access their own record. Admins can access description: Normal users can only access their own record. Admins can access all records.
all records.
operationId: provisioning_handleUserInfoGet operationId: provisioning_handleUserInfoGet
parameters: parameters:
- description: The user identifier that should be queried. If not set, the authenticated - description: The user identifier that should be queried. If not set, the authenticated user is used.
user is used.
in: query in: query
name: UserId name: UserId
type: string type: string
- description: The email address that should be queried. If UserId is set, this - description: The email address that should be queried. If UserId is set, this is ignored.
is ignored.
in: query in: query
name: Email name: Email
type: string type: string
@ -1299,8 +1236,7 @@ paths:
- Provisioning - Provisioning
/provisioning/new-peer: /provisioning/new-peer:
post: post:
description: Normal users can only create new peers if self provisioning is description: Normal users can only create new peers if self provisioning is allowed. Admins can always add new peers.
allowed. Admins can always add new peers.
operationId: provisioning_handleNewPeerPost operationId: provisioning_handleNewPeerPost
parameters: parameters:
- description: Provisioning request model. - description: Provisioning request model.
@ -1406,8 +1342,7 @@ paths:
tags: tags:
- Users - Users
get: get:
description: Normal users can only access their own record. Admins can access description: Normal users can only access their own record. Admins can access all records.
all records.
operationId: users_handleByIdGet operationId: users_handleByIdGet
parameters: parameters:
- description: The user identifier. - description: The user identifier.