Files
rustdesk-api/docs/admin/admin_swagger.yaml
T
thomasandClaude Opus 4.8 16e97c8efa i18n: Translate all Chinese to English across the codebase
Translate Chinese comments, log/error messages, validator labels and
Swagger annotations to English throughout the source code, generated
Swagger docs, config files and CI workflows.

Make the English README primary: README.md now holds the English docs
and README_EN.md holds the Chinese version, with cross-language links
updated accordingly.

Note: the generated docs/ swagger files were translated in place; run
`go generate ./...` (swag init) to regenerate them from the now-English
annotations when a Go toolchain is available.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-27 12:17:04 +02:00

4024 lines
94 KiB
YAML

basePath: /api
definitions:
admin.AddressBookForm:
properties:
alias:
type: string
collection_id:
type: integer
forceAlwaysRelay:
type: boolean
hash:
type: string
hostname:
type: string
id:
type: string
loginName:
type: string
online:
type: boolean
password:
type: string
platform:
type: string
rdpPort:
type: string
rdpUsername:
type: string
row_id:
type: integer
sameServer:
type: boolean
tags:
items:
type: string
type: array
user_id:
type: integer
user_ids:
items:
type: integer
type: array
username:
type: string
required:
- id
type: object
admin.AuditConnLogIds:
properties:
ids:
items:
type: integer
type: array
required:
- ids
type: object
admin.AuditFileLogIds:
properties:
ids:
items:
type: integer
type: array
required:
- ids
type: object
admin.ChangeCurPasswordForm:
properties:
new_password:
maxLength: 32
minLength: 4
type: string
old_password:
maxLength: 32
minLength: 4
type: string
required:
- new_password
- old_password
type: object
admin.DeviceGroupForm:
properties:
id:
type: integer
name:
type: string
required:
- name
type: object
admin.GroupForm:
properties:
id:
type: integer
name:
type: string
type:
type: integer
required:
- name
type: object
admin.LoginLogIds:
properties:
ids:
items:
type: integer
type: array
required:
- ids
type: object
admin.LoginPayload:
properties:
avatar:
type: string
email:
type: string
nickname:
type: string
route_names:
items:
type: string
type: array
token:
type: string
username:
type: string
type: object
admin.OauthForm:
properties:
auto_register:
type: boolean
client_id:
type: string
client_secret:
type: string
id:
type: integer
issuer:
type: string
oauth_type:
type: string
op:
type: string
pkce_enable:
type: boolean
pkce_method:
type: string
scopes:
type: string
required:
- client_id
- client_secret
- oauth_type
type: object
admin.PeerBatchDeleteForm:
properties:
row_ids:
items:
type: integer
type: array
required:
- row_ids
type: object
admin.PeerForm:
properties:
cpu:
type: string
group_id:
type: integer
hostname:
type: string
id:
type: string
memory:
type: string
os:
type: string
row_id:
type: integer
username:
type: string
uuid:
type: string
version:
type: string
type: object
admin.PeerShareRecordBatchDeleteForm:
properties:
ids:
items:
type: integer
type: array
required:
- ids
type: object
admin.ShareByWebClientForm:
properties:
expire:
type: integer
id:
type: string
password:
type: string
password_type:
description: can only be once,fixed
enum:
- once
- fixed
type: string
required:
- id
- password
- password_type
type: object
admin.ShareRecordForm:
properties:
id:
type: integer
user_id:
type: integer
type: object
admin.TagForm:
properties:
collection_id:
type: integer
color:
type: integer
id:
type: integer
name:
type: string
user_id:
type: integer
required:
- color
- name
type: object
admin.UserForm:
properties:
avatar:
type: string
email:
description: validate:"required,email" emailnot enforced
type: string
group_id:
type: integer
id:
type: integer
is_admin:
type: boolean
nickname:
description: Password string `json:"password" validate:"required,gte=4,lte=20"`
type: string
status:
allOf:
- $ref: '#/definitions/model.StatusCode'
minimum: 0
username:
maxLength: 32
minLength: 2
type: string
required:
- group_id
- status
- username
type: object
admin.UserOauthItem:
properties:
op:
type: string
status:
type: integer
type: object
admin.UserPasswordForm:
properties:
id:
type: integer
password:
maxLength: 32
minLength: 4
type: string
required:
- id
- password
type: object
admin.UserTokenBatchDeleteForm:
properties:
ids:
items:
type: integer
type: array
required:
- ids
type: object
github_com_lejianwen_rustdesk-api_v2_http_request_admin.Login:
properties:
captcha:
type: string
captcha_id:
type: string
password:
type: string
platform:
type: string
username:
type: string
required:
- password
- username
type: object
model.AddressBook:
properties:
alias:
type: string
collection:
$ref: '#/definitions/model.AddressBookCollection'
collection_id:
type: integer
created_at:
type: string
forceAlwaysRelay:
type: boolean
hash:
type: string
hostname:
type: string
id:
type: string
loginName:
type: string
online:
type: boolean
password:
type: string
platform:
type: string
rdpPort:
type: string
rdpUsername:
type: string
row_id:
type: integer
sameServer:
type: boolean
tags:
items:
type: string
type: array
updated_at:
type: string
user_id:
type: integer
username:
type: string
type: object
model.AddressBookCollection:
properties:
created_at:
type: string
id:
type: integer
name:
type: string
updated_at:
type: string
user_id:
type: integer
required:
- name
type: object
model.AddressBookCollectionList:
properties:
list:
items:
$ref: '#/definitions/model.AddressBookCollection'
type: array
page:
type: integer
page_size:
type: integer
total:
type: integer
type: object
model.AddressBookCollectionRule:
properties:
collection_id:
type: integer
created_at:
type: string
id:
type: integer
rule:
description: '0: none 1: read 2: read-write 3: full control'
maximum: 3
minimum: 1
type: integer
to_id:
type: integer
type:
description: '1: personal 2: group'
maximum: 2
minimum: 1
type: integer
updated_at:
type: string
user_id:
type: integer
required:
- collection_id
- rule
- to_id
- type
type: object
model.AddressBookList:
properties:
list:
items:
$ref: '#/definitions/model.AddressBook'
type: array
page:
type: integer
page_size:
type: integer
total:
type: integer
type: object
model.AuditConn:
properties:
action:
type: string
close_time:
type: integer
conn_id:
type: integer
created_at:
type: string
from_name:
type: string
from_peer:
type: string
id:
type: integer
ip:
type: string
peer_id:
type: string
session_id:
type: string
type:
type: integer
updated_at:
type: string
uuid:
type: string
type: object
model.AuditConnList:
properties:
list:
items:
$ref: '#/definitions/model.AuditConn'
type: array
page:
type: integer
page_size:
type: integer
total:
type: integer
type: object
model.AuditFile:
properties:
created_at:
type: string
from_name:
type: string
from_peer:
type: string
id:
type: integer
info:
type: string
ip:
type: string
is_file:
type: boolean
num:
type: integer
path:
type: string
peer_id:
type: string
type:
type: integer
updated_at:
type: string
uuid:
type: string
type: object
model.AuditFileList:
properties:
list:
items:
$ref: '#/definitions/model.AuditFile'
type: array
page:
type: integer
page_size:
type: integer
total:
type: integer
type: object
model.DeviceGroup:
properties:
created_at:
type: string
id:
type: integer
name:
type: string
updated_at:
type: string
type: object
model.Group:
properties:
created_at:
type: string
id:
type: integer
name:
type: string
type:
type: integer
updated_at:
type: string
type: object
model.GroupList:
properties:
list:
items:
$ref: '#/definitions/model.Group'
type: array
page:
type: integer
page_size:
type: integer
total:
type: integer
type: object
model.LoginLog:
properties:
client:
description: webadmin,webclient,app,
type: string
created_at:
type: string
device_id:
type: string
id:
type: integer
ip:
type: string
is_deleted:
type: integer
platform:
description: windows,linux,mac,android,ios
type: string
type:
description: account,oauth
type: string
updated_at:
type: string
user_id:
type: integer
user_token_id:
type: integer
uuid:
type: string
type: object
model.LoginLogList:
properties:
list:
items:
$ref: '#/definitions/model.LoginLog'
type: array
page:
type: integer
page_size:
type: integer
total:
type: integer
type: object
model.Oauth:
properties:
auto_register:
type: boolean
client_id:
type: string
client_secret:
type: string
created_at:
type: string
id:
type: integer
issuer:
type: string
oauth_type:
type: string
op:
type: string
pkce_enable:
type: boolean
pkce_method:
type: string
scopes:
type: string
updated_at:
type: string
type: object
model.OauthList:
properties:
list:
items:
$ref: '#/definitions/model.Oauth'
type: array
page:
type: integer
page_size:
type: integer
total:
type: integer
type: object
model.Peer:
properties:
cpu:
type: string
created_at:
type: string
group_id:
type: integer
hostname:
type: string
id:
type: string
last_online_ip:
type: string
last_online_time:
type: integer
memory:
type: string
os:
type: string
row_id:
type: integer
updated_at:
type: string
user:
$ref: '#/definitions/model.User'
user_id:
type: integer
username:
type: string
uuid:
type: string
version:
type: string
type: object
model.PeerList:
properties:
list:
items:
$ref: '#/definitions/model.Peer'
type: array
page:
type: integer
page_size:
type: integer
total:
type: integer
type: object
model.StatusCode:
enum:
- 1
- 2
type: integer
x-enum-comments:
COMMON_STATUS_DISABLED: common status disable
COMMON_STATUS_ENABLE: common status enable
x-enum-varnames:
- COMMON_STATUS_ENABLE
- COMMON_STATUS_DISABLED
model.Tag:
properties:
collection:
$ref: '#/definitions/model.AddressBookCollection'
collection_id:
type: integer
color:
description: color is flutter's color value,from 0x00000000 to 0xFFFFFFFF; the first two digits represent transparency, the following 6 digits represent the color,
can be converted to rgba
type: integer
created_at:
type: string
id:
type: integer
name:
type: string
updated_at:
type: string
user_id:
type: integer
type: object
model.TagList:
properties:
list:
items:
$ref: '#/definitions/model.Tag'
type: array
page:
type: integer
page_size:
type: integer
total:
type: integer
type: object
model.User:
properties:
avatar:
type: string
created_at:
type: string
email:
type: string
group_id:
type: integer
id:
type: integer
is_admin:
type: boolean
nickname:
type: string
status:
$ref: '#/definitions/model.StatusCode'
updated_at:
type: string
username:
type: string
type: object
model.UserList:
properties:
list:
items:
$ref: '#/definitions/model.User'
type: array
page:
type: integer
page_size:
type: integer
total:
type: integer
type: object
model.UserToken:
properties:
created_at:
type: string
device_id:
type: string
device_uuid:
type: string
expired_at:
type: integer
id:
type: integer
token:
type: string
updated_at:
type: string
user_id:
type: integer
type: object
model.UserTokenList:
properties:
list:
items:
$ref: '#/definitions/model.UserToken'
type: array
page:
type: integer
page_size:
type: integer
total:
type: integer
type: object
response.ErrorResponse:
properties:
error:
type: string
type: object
response.Response:
properties:
code:
type: integer
data: {}
message:
type: string
type: object
info:
contact: {}
description: API
title: management systemAPI
version: "1.0"
paths:
/admin/address_book/batchCreate:
post:
consumes:
- application/json
description: batch create address books
parameters:
- description: address book info
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.AddressBookForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.AddressBook'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: batch create address books
tags:
- address book
/admin/address_book/create:
post:
consumes:
- application/json
description: create address book
parameters:
- description: address book info
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.AddressBookForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.AddressBook'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: create address book
tags:
- address book
/admin/address_book/delete:
post:
consumes:
- application/json
description: delete address book
parameters:
- description: address book info
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.AddressBookForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: delete address book
tags:
- address book
/admin/address_book/detail/{id}:
get:
consumes:
- application/json
description: address book details
parameters:
- description: ID
in: path
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.AddressBook'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: address book details
tags:
- address book
/admin/address_book/list:
get:
consumes:
- application/json
description: address book list
parameters:
- description: page number
in: query
name: page
type: integer
- description: page size
in: query
name: page_size
type: integer
- description: userid
in: query
name: user_id
type: integer
- description: whether it is mine
in: query
name: is_my
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.AddressBookList'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: address book list
tags:
- address book
/admin/address_book/share:
post:
consumes:
- application/json
description: share address book
parameters:
- description: address book info
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.ShareByWebClientForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: share address book
tags:
- address book
/admin/address_book/update:
post:
consumes:
- application/json
description: edit address book
parameters:
- description: address book info
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.AddressBookForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.AddressBook'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: edit address book
tags:
- address book
/admin/address_book_collection/create:
post:
consumes:
- application/json
description: create address book name
parameters:
- description: address book name info
in: body
name: body
required: true
schema:
$ref: '#/definitions/model.AddressBookCollection'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.AddressBookCollection'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: create address book name
tags:
- address book name
/admin/address_book_collection/delete:
post:
consumes:
- application/json
description: delete address book name
parameters:
- description: address book name info
in: body
name: body
required: true
schema:
$ref: '#/definitions/model.AddressBookCollection'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: delete address book name
tags:
- address book name
/admin/address_book_collection/detail/{id}:
get:
consumes:
- application/json
description: address book name details
parameters:
- description: ID
in: path
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.AddressBookCollection'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: address book name details
tags:
- address book name
/admin/address_book_collection/list:
get:
consumes:
- application/json
description: address book name list
parameters:
- description: page number
in: query
name: page
type: integer
- description: page size
in: query
name: page_size
type: integer
- description: whether it is mine
in: query
name: is_my
type: integer
- description: userid
in: query
name: user_id
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.AddressBookCollectionList'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: address book name list
tags:
- address book name
/admin/address_book_collection/update:
post:
consumes:
- application/json
description: edit address book name
parameters:
- description: address book name info
in: body
name: body
required: true
schema:
$ref: '#/definitions/model.AddressBookCollection'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.AddressBookCollection'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: edit address book name
tags:
- address book name
/admin/address_book_collection_rule/create:
post:
consumes:
- application/json
description: create address book rule
parameters:
- description: address book rule info
in: body
name: body
required: true
schema:
$ref: '#/definitions/model.AddressBookCollectionRule'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.AddressBookCollection'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: create address book rule
tags:
- address book rules
/admin/address_book_collection_rule/delete:
post:
consumes:
- application/json
description: delete address book rule
parameters:
- description: address book rule info
in: body
name: body
required: true
schema:
$ref: '#/definitions/model.AddressBookCollectionRule'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: delete address book rule
tags:
- address book rules
/admin/address_book_collection_rule/detail/{id}:
get:
consumes:
- application/json
description: address book rule details
parameters:
- description: ID
in: path
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.AddressBookCollectionRule'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: address book rule details
tags:
- address book rules
/admin/address_book_collection_rule/list:
get:
consumes:
- application/json
description: address book rule list
parameters:
- description: page number
in: query
name: page
type: integer
- description: page size
in: query
name: page_size
type: integer
- description: whether it is mine
in: query
name: is_my
type: integer
- description: userid
in: query
name: user_id
type: integer
- description: address book collectionid
in: query
name: collection_id
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.AddressBookCollectionList'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: address book rule list
tags:
- address book rules
/admin/address_book_collection_rule/update:
post:
consumes:
- application/json
description: edit address book rule
parameters:
- description: address book rule info
in: body
name: body
required: true
schema:
$ref: '#/definitions/model.AddressBookCollectionRule'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.AddressBookCollection'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: edit address book rule
tags:
- address book rules
/admin/audit_conn/batchDelete:
post:
consumes:
- application/json
description: batch delete connection logs
parameters:
- description: connection log
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.AuditConnLogIds'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: batch delete connection logs
tags:
- connection log
/admin/audit_conn/delete:
post:
consumes:
- application/json
description: delete connection log
parameters:
- description: connection log info
in: body
name: body
required: true
schema:
$ref: '#/definitions/model.AuditConn'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: delete connection log
tags:
- connection log
/admin/audit_conn/list:
get:
consumes:
- application/json
description: connection log list
parameters:
- description: page number
in: query
name: page
type: integer
- description: page size
in: query
name: page_size
type: integer
- description: target device
in: query
name: peer_id
type: integer
- description: source device
in: query
name: from_peer
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.AuditConnList'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: connection log list
tags:
- connection log
/admin/audit_file/batchDelete:
post:
consumes:
- application/json
description: batch delete file logs
parameters:
- description: file log
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.AuditFileLogIds'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: batch delete file logs
tags:
- file log
/admin/audit_file/delete:
post:
consumes:
- application/json
description: delete file log
parameters:
- description: file log info
in: body
name: body
required: true
schema:
$ref: '#/definitions/model.AuditFile'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: delete file log
tags:
- file log
/admin/audit_file/list:
get:
consumes:
- application/json
description: file log list
parameters:
- description: page number
in: query
name: page
type: integer
- description: page size
in: query
name: page_size
type: integer
- description: target device
in: query
name: peer_id
type: integer
- description: source device
in: query
name: from_peer
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.AuditFileList'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: file log list
tags:
- file log
/admin/config/admin:
get:
consumes:
- application/json
description: ADMINservice config
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: ADMINservice config
tags:
- ADMIN
/admin/config/app:
get:
consumes:
- application/json
description: APPservice config
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: APPservice config
tags:
- ADMIN
/admin/config/server:
get:
consumes:
- application/json
description: service config, provides an api-server for the webclient
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: RUSTDESKservice config
tags:
- ADMIN
/admin/device_group/create:
post:
consumes:
- application/json
description: create device group
parameters:
- description: device group info
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.DeviceGroupForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.DeviceGroup'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: create device group
tags:
- device group
/admin/device_group/delete:
post:
consumes:
- application/json
description: delete device group
parameters:
- description: group info
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.DeviceGroupForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: delete device group
tags:
- device group
/admin/device_group/detail/{id}:
get:
consumes:
- application/json
description: device group details
parameters:
- description: ID
in: path
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.Group'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: device group details
tags:
- device group
/admin/device_group/list:
get:
consumes:
- application/json
description: group list
parameters:
- description: page number
in: query
name: page
type: integer
- description: page size
in: query
name: page_size
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.GroupList'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: group list
tags:
- group
/admin/device_group/update:
post:
consumes:
- application/json
description: edit device group
parameters:
- description: group info
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.DeviceGroupForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.Group'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: edit device group
tags:
- device group
/admin/file/oss_token:
get:
consumes:
- application/json
description: getossToken
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: getossToken
tags:
- file
/admin/file/upload:
post:
consumes:
- multipart/form-data
description: upload file to local
parameters:
- description: file upload example
in: formData
name: file
required: true
type: file
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: upload file to local
tags:
- file
/admin/group/create:
post:
consumes:
- application/json
description: create group
parameters:
- description: group info
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.GroupForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.Group'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: create group
tags:
- group
/admin/group/delete:
post:
consumes:
- application/json
description: delete group
parameters:
- description: group info
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.GroupForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: delete group
tags:
- group
/admin/group/detail/{id}:
get:
consumes:
- application/json
description: group details
parameters:
- description: ID
in: path
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.Group'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: group details
tags:
- group
/admin/group/list:
get:
consumes:
- application/json
description: group list
parameters:
- description: page number
in: query
name: page
type: integer
- description: page size
in: query
name: page_size
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.GroupList'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: group list
tags:
- group
/admin/group/update:
post:
consumes:
- application/json
description: edit group
parameters:
- description: group info
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.GroupForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.Group'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: edit group
tags:
- group
/admin/login:
post:
consumes:
- application/json
description: login
parameters:
- description: login info
in: body
name: body
required: true
schema:
$ref: '#/definitions/github_com_lejianwen_rustdesk-api_v2_http_request_admin.Login'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/admin.LoginPayload'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: login
tags:
- login
/admin/login-options:
post:
consumes:
- application/json
description: login options
produces:
- application/json
responses:
"200":
description: OK
schema:
items:
type: string
type: array
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.ErrorResponse'
summary: login options
tags:
- login
/admin/login_log/batchDelete:
post:
consumes:
- application/json
description: batch delete login logs
parameters:
- description: login log
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.LoginLogIds'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: batch delete login logs
tags:
- login log
/admin/login_log/delete:
post:
consumes:
- application/json
description: delete login log
parameters:
- description: login log info
in: body
name: body
required: true
schema:
$ref: '#/definitions/model.LoginLog'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: delete login log
tags:
- login log
/admin/login_log/detail/{id}:
get:
consumes:
- application/json
description: login log details
parameters:
- description: ID
in: path
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.LoginLog'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: login log details
tags:
- login log
/admin/login_log/list:
get:
consumes:
- application/json
description: login log list
parameters:
- description: page number
in: query
name: page
type: integer
- description: page size
in: query
name: page_size
type: integer
- description: userID
in: query
name: user_id
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.LoginLogList'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: login log list
tags:
- login log
/admin/logout:
post:
consumes:
- application/json
description: logout
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
summary: logout
tags:
- login
/admin/my/address_book/create:
post:
consumes:
- application/json
description: create address book
parameters:
- description: address book info
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.AddressBookForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.AddressBook'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: create address book
tags:
- my address book
/admin/my/address_book/delete:
post:
consumes:
- application/json
description: delete address book
parameters:
- description: address book info
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.AddressBookForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: delete address book
tags:
- my address book
/admin/my/address_book/list:
get:
consumes:
- application/json
description: address book list
parameters:
- description: page number
in: query
name: page
type: integer
- description: page size
in: query
name: page_size
type: integer
- description: userid
in: query
name: user_id
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.AddressBookList'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: address book list
tags:
- my address book
/admin/my/address_book/update:
post:
consumes:
- application/json
description: edit address book
parameters:
- description: address book info
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.AddressBookForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.AddressBook'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: edit address book
tags:
- my address book
/admin/my/address_book_collection/create:
post:
consumes:
- application/json
description: create address book name
parameters:
- description: address book name info
in: body
name: body
required: true
schema:
$ref: '#/definitions/model.AddressBookCollection'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.AddressBookCollection'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: create address book name
tags:
- my address book name
/admin/my/address_book_collection/delete:
post:
consumes:
- application/json
description: delete address book name
parameters:
- description: address book name info
in: body
name: body
required: true
schema:
$ref: '#/definitions/model.AddressBookCollection'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: delete address book name
tags:
- my address book name
/admin/my/address_book_collection/list:
get:
consumes:
- application/json
description: address book name list
parameters:
- description: page number
in: query
name: page
type: integer
- description: page size
in: query
name: page_size
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.AddressBookCollectionList'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: address book name list
tags:
- my address book name
/admin/my/address_book_collection/update:
post:
consumes:
- application/json
description: edit address book name
parameters:
- description: address book name info
in: body
name: body
required: true
schema:
$ref: '#/definitions/model.AddressBookCollection'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.AddressBookCollection'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: edit address book name
tags:
- my address book name
/admin/my/address_book_collection_rule/create:
post:
consumes:
- application/json
description: create address book rule
parameters:
- description: address book rule info
in: body
name: body
required: true
schema:
$ref: '#/definitions/model.AddressBookCollectionRule'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.AddressBookCollection'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: create address book rule
tags:
- my address book rules
/admin/my/address_book_collection_rule/delete:
post:
consumes:
- application/json
description: delete address book rule
parameters:
- description: address book rule info
in: body
name: body
required: true
schema:
$ref: '#/definitions/model.AddressBookCollectionRule'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: delete address book rule
tags:
- my address book rules
/admin/my/address_book_collection_rule/list:
get:
consumes:
- application/json
description: address book rule list
parameters:
- description: page number
in: query
name: page
type: integer
- description: page size
in: query
name: page_size
type: integer
- description: whether it is mine
in: query
name: is_my
type: integer
- description: userid
in: query
name: user_id
type: integer
- description: address book collectionid
in: query
name: collection_id
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.AddressBookCollectionList'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: address book rule list
tags:
- my address book rules
/admin/my/address_book_collection_rule/update:
post:
consumes:
- application/json
description: edit address book rule
parameters:
- description: address book rule info
in: body
name: body
required: true
schema:
$ref: '#/definitions/model.AddressBookCollectionRule'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.AddressBookCollection'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: edit address book rule
tags:
- my address book rules
/admin/my/login_log/batchDelete:
post:
consumes:
- application/json
description: batch delete login logs
parameters:
- description: login log
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.LoginLogIds'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: batch delete login logs
tags:
- my login logs
/admin/my/login_log/delete:
post:
consumes:
- application/json
description: delete login log
parameters:
- description: login log info
in: body
name: body
required: true
schema:
$ref: '#/definitions/model.LoginLog'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: delete login log
tags:
- my login logs
/admin/my/login_log/list:
get:
consumes:
- application/json
description: login log list
parameters:
- description: page number
in: query
name: page
type: integer
- description: page size
in: query
name: page_size
type: integer
- description: userID
in: query
name: user_id
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.LoginLogList'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: login log list
tags:
- my login logs
/admin/my/peer/list:
get:
consumes:
- application/json
description: device list
parameters:
- description: page number
in: query
name: page
type: integer
- description: page size
in: query
name: page_size
type: integer
- description: time
in: query
name: time_ago
type: integer
- description: ID
in: query
name: id
type: string
- description: hostname
in: query
name: hostname
type: string
- description: uuids separated by commas
in: query
name: uuids
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.PeerList'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: device list
tags:
- my devices
/admin/my/share_record/batchDelete:
post:
consumes:
- application/json
description: batch delete my share records
parameters:
- description: id
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.PeerShareRecordBatchDeleteForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: batch delete my share records
tags:
- my
/admin/my/share_record/delete:
post:
consumes:
- application/json
description: delete share record
parameters:
- description: share record info
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.ShareRecordForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: delete share record
tags:
- my share records
/admin/my/share_record/list:
get:
consumes:
- application/json
description: share record list
parameters:
- description: page number
in: query
name: page
type: integer
- description: page size
in: query
name: page_size
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: share record list
tags:
- my share records
/admin/my/tag/create:
post:
consumes:
- application/json
description: create tag
parameters:
- description: tag info
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.TagForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.Tag'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: create tag
tags:
- my tags
/admin/my/tag/delete:
post:
consumes:
- application/json
description: delete tag
parameters:
- description: tag info
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.TagForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: delete tag
tags:
- tag
/admin/my/tag/list:
get:
consumes:
- application/json
description: tag list
parameters:
- description: page number
in: query
name: page
type: integer
- description: page size
in: query
name: page_size
type: integer
- description: whether it is mine
in: query
name: is_my
type: integer
- description: userid
in: query
name: user_id
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.TagList'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: tag list
tags:
- my tags
/admin/my/tag/update:
post:
consumes:
- application/json
description: edit tag
parameters:
- description: tag info
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.TagForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.Tag'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: edit tag
tags:
- my tags
/admin/oauth/create:
post:
consumes:
- application/json
description: createOauth
parameters:
- description: Oauthinfo
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.OauthForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.Oauth'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: createOauth
tags:
- Oauth
/admin/oauth/delete:
post:
consumes:
- application/json
description: Oauthdelete
parameters:
- description: Oauthinfo
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.OauthForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: Oauthdelete
tags:
- Oauth
/admin/oauth/detail/{id}:
get:
consumes:
- application/json
description: Oauthdetails
parameters:
- description: ID
in: path
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.Oauth'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: Oauthdetails
tags:
- Oauth
/admin/oauth/list:
get:
consumes:
- application/json
description: Oauthlist
parameters:
- description: page number
in: query
name: page
type: integer
- description: page size
in: query
name: page_size
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.OauthList'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: Oauthlist
tags:
- Oauth
/admin/oauth/update:
post:
consumes:
- application/json
description: Oauthedit
parameters:
- description: Oauthinfo
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.OauthForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.OauthList'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: Oauthedit
tags:
- Oauth
/admin/oidc/auth:
post:
consumes:
- application/json
description: OidcAuth
produces:
- application/json
responses: {}
summary: OidcAuth
tags:
- Oauth
/admin/oidc/auth-query:
get:
consumes:
- application/json
description: OidcAuthQuery
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/admin.LoginPayload'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
summary: OidcAuthQuery
tags:
- Oauth
/admin/peer/batchDelete:
post:
consumes:
- application/json
description: batch delete devices
parameters:
- description: deviceid
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.PeerBatchDeleteForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: batch delete devices
tags:
- device
/admin/peer/create:
post:
consumes:
- application/json
description: create device
parameters:
- description: device info
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.PeerForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.Peer'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: create device
tags:
- device
/admin/peer/delete:
post:
consumes:
- application/json
description: delete device
parameters:
- description: device info
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.PeerForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: delete device
tags:
- device
/admin/peer/detail/{id}:
get:
consumes:
- application/json
description: device details
parameters:
- description: ID
in: path
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.Peer'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: device details
tags:
- device
/admin/peer/list:
get:
consumes:
- application/json
description: device list
parameters:
- description: page number
in: query
name: page
type: integer
- description: page size
in: query
name: page_size
type: integer
- description: time
in: query
name: time_ago
type: integer
- description: ID
in: query
name: id
type: string
- description: hostname
in: query
name: hostname
type: string
- description: uuids separated by commas
in: query
name: uuids
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.PeerList'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: device list
tags:
- device
/admin/peer/update:
post:
consumes:
- application/json
description: edit device
parameters:
- description: device info
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.PeerForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.Peer'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: edit device
tags:
- device
/admin/share_record/batchDelete:
post:
consumes:
- application/json
description: batch share records
parameters:
- description: id
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.PeerShareRecordBatchDeleteForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: batch share records
tags:
- share record
/admin/share_record/delete:
post:
consumes:
- application/json
description: delete share record
parameters:
- description: share record info
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.ShareRecordForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: delete share record
tags:
- share record
/admin/share_record/list:
get:
consumes:
- application/json
description: share record list
parameters:
- description: userID
in: query
name: user_id
type: integer
- description: page number
in: query
name: page
type: integer
- description: page size
in: query
name: page_size
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: share record list
tags:
- share record
/admin/tag/create:
post:
consumes:
- application/json
description: create tag
parameters:
- description: tag info
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.TagForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.Tag'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: create tag
tags:
- tag
/admin/tag/delete:
post:
consumes:
- application/json
description: delete tag
parameters:
- description: tag info
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.TagForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: delete tag
tags:
- tag
/admin/tag/detail/{id}:
get:
consumes:
- application/json
description: tag details
parameters:
- description: ID
in: path
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.Tag'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: tag details
tags:
- tag
/admin/tag/list:
get:
consumes:
- application/json
description: tag list
parameters:
- description: page number
in: query
name: page
type: integer
- description: page size
in: query
name: page_size
type: integer
- description: whether it is mine
in: query
name: is_my
type: integer
- description: userid
in: query
name: user_id
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.TagList'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: tag list
tags:
- tag
/admin/tag/update:
post:
consumes:
- application/json
description: edit tag
parameters:
- description: tag info
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.TagForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.Tag'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: edit tag
tags:
- tag
/admin/user/changeCurPwd:
post:
consumes:
- application/json
description: change the current user's password
parameters:
- description: user info
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.ChangeCurPasswordForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: change the current user's password
tags:
- user
/admin/user/create:
post:
consumes:
- application/json
description: create administrator
parameters:
- description: administrator info
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.UserForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.User'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: create administrator
tags:
- user
/admin/user/current:
get:
consumes:
- application/json
description: current user
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/admin.LoginPayload'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: current user
tags:
- user
/admin/user/delete:
post:
consumes:
- application/json
description: delete administrator
parameters:
- description: user info
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.UserForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: delete administrator
tags:
- user
/admin/user/detail/{id}:
get:
consumes:
- application/json
description: administrator details
parameters:
- description: ID
in: path
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.User'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: administrator details
tags:
- user
/admin/user/list:
get:
consumes:
- application/json
description: administrator list
parameters:
- description: page number
in: query
name: page
type: integer
- description: page size
in: query
name: page_size
type: integer
- description: account
in: query
name: username
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.UserList'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: administrator list
tags:
- user
/admin/user/myOauth:
get:
consumes:
- application/json
description: my authorizations
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
items:
$ref: '#/definitions/admin.UserOauthItem'
type: array
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: my authorizations
tags:
- user
/admin/user/update:
post:
consumes:
- application/json
description: edit administrator
parameters:
- description: user info
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.UserForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.User'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: edit administrator
tags:
- user
/admin/user/updatePassword:
post:
consumes:
- application/json
description: change password
parameters:
- description: user info
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.UserPasswordForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: change password
tags:
- user
/admin/user_token/batchDelete:
post:
consumes:
- application/json
description: batch delete login credentials
parameters:
- description: login credential info
in: body
name: body
required: true
schema:
$ref: '#/definitions/admin.UserTokenBatchDeleteForm'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: batch delete login credentials
tags:
- login credential
/admin/user_token/delete:
post:
consumes:
- application/json
description: delete login credential
parameters:
- description: login credential info
in: body
name: body
required: true
schema:
$ref: '#/definitions/model.UserToken'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: delete login credential
tags:
- login credential
/admin/user_token/list:
get:
consumes:
- application/json
description: login credential list
parameters:
- description: page number
in: query
name: page
type: integer
- description: page size
in: query
name: page_size
type: integer
- description: userID
in: query
name: user_id
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/model.UserTokenList'
type: object
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: login credential list
tags:
- login credential
securityDefinitions:
BearerAuth:
in: header
name: Authorization
type: apiKey
token:
in: header
name: api-token
type: apiKey
swagger: "2.0"