mirror of
https://github.com/drakkan/sftpgo.git
synced 2025-12-06 14:20:55 +03:00
@@ -2,7 +2,7 @@
|
||||
// REST API allows to manage users and quota and to get real time reports for the active connections
|
||||
// with possibility of forcibly closing a connection.
|
||||
// The OpenAPI 3 schema for the exposed API can be found inside the source tree:
|
||||
// https://github.com/drakkan/sftpgo/tree/master/api/schema/openapi.yaml
|
||||
// https://github.com/drakkan/sftpgo/blob/master/httpd/schema/openapi.yaml
|
||||
// A basic Web interface to manage users and connections is provided too
|
||||
package httpd
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ openapi: 3.0.3
|
||||
info:
|
||||
title: SFTPGo
|
||||
description: SFTPGo REST API
|
||||
version: 2.2.2
|
||||
version: 2.2.3
|
||||
|
||||
servers:
|
||||
- url: /api/v1
|
||||
@@ -1371,26 +1371,70 @@ components:
|
||||
type: string
|
||||
fingerprint:
|
||||
type: string
|
||||
BaseServiceStatus:
|
||||
SSHBinding:
|
||||
type: object
|
||||
properties:
|
||||
address:
|
||||
type: string
|
||||
description: TCP address the server listen on
|
||||
port:
|
||||
type: integer
|
||||
description: the port used for serving requests
|
||||
apply_proxy_config:
|
||||
type: boolean
|
||||
description: apply the proxy configuration, if any
|
||||
WebDAVBinding:
|
||||
type: object
|
||||
properties:
|
||||
address:
|
||||
type: string
|
||||
description: TCP address the server listen on
|
||||
port:
|
||||
type: integer
|
||||
description: the port used for serving requests
|
||||
enable_https:
|
||||
type: boolean
|
||||
FTPDBinding:
|
||||
type: object
|
||||
properties:
|
||||
address:
|
||||
type: string
|
||||
description: TCP address the server listen on
|
||||
port:
|
||||
type: integer
|
||||
description: the port used for serving requests
|
||||
apply_proxy_config:
|
||||
type: boolean
|
||||
description: apply the proxy configuration, if any
|
||||
tls_mode:
|
||||
type: integer
|
||||
enum:
|
||||
- 0
|
||||
- 1
|
||||
- 2
|
||||
description: >
|
||||
* `0` - clear or explicit TLS
|
||||
* `1` - explicit TLS required
|
||||
* `2` - implicit TLS
|
||||
force_passive_ip:
|
||||
type: string
|
||||
description: External IP address to expose for passive connections
|
||||
SSHServiceStatus:
|
||||
type: object
|
||||
properties:
|
||||
is_active:
|
||||
type: boolean
|
||||
address:
|
||||
bindings:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/SSHBinding'
|
||||
host_keys:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/SSHHostKey'
|
||||
ssh_commands:
|
||||
type: string
|
||||
description: TCP address the server listen on in the form "host:port"
|
||||
SSHServiceStatus:
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/BaseServiceStatus'
|
||||
- type: object
|
||||
properties:
|
||||
host_keys:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/SSHHostKey'
|
||||
ssh_commands:
|
||||
type: string
|
||||
description: accepted SSH commands comma separated
|
||||
description: accepted SSH commands comma separated
|
||||
FTPPassivePortRange:
|
||||
type: object
|
||||
properties:
|
||||
@@ -1399,28 +1443,25 @@ components:
|
||||
end:
|
||||
type: integer
|
||||
FTPServiceStatus:
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/BaseServiceStatus'
|
||||
- type: object
|
||||
properties:
|
||||
passive_port_range:
|
||||
$ref: '#/components/schemas/FTPPassivePortRange'
|
||||
ftpes:
|
||||
type: string
|
||||
enum:
|
||||
- Disabled
|
||||
- Enabled
|
||||
- Required
|
||||
type: object
|
||||
properties:
|
||||
is_active:
|
||||
type: boolean
|
||||
bindings:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/FTPDBinding'
|
||||
passive_port_range:
|
||||
$ref: '#/components/schemas/FTPPassivePortRange'
|
||||
WebDAVServiceStatus:
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/BaseServiceStatus'
|
||||
- type: object
|
||||
properties:
|
||||
protocol:
|
||||
type: string
|
||||
enum:
|
||||
- HTTP
|
||||
- HTTPS
|
||||
type: object
|
||||
properties:
|
||||
is_active:
|
||||
type: boolean
|
||||
bindings:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/WebDAVBinding'
|
||||
DataProviderStatus:
|
||||
type: object
|
||||
properties:
|
||||
|
||||
Reference in New Issue
Block a user