/webapi/entry.cgi SYNO.API.Info
https://myds.com:port/webapi/entry.cgi?api=SYNO.API.Info&version=1&method=query
SYNO.API.Info SYNO.API.Info
SYNO.API.Info /webapi/entry.cgi
success
data
error
code
errors
https://myds.com:port/webapi/entry.cgi?api=SYNO.FileStation.Info&version=1
{
"success": false,
"error": {
"code": 101
}
}
https://myds.com:port/webapi/entry.cgi?
api=SYNO.FileStation.CreateFolder&method=create&version=1&folder_path=%2Ftest&name=%3A
{
"success":false,
"error":{
"code":1100,
"errors":[{
"code":408,
"path":"/test/:"
}]
}
}
https://myds.com:port/webapi/entry.cgi?api=SYNO.FileStation.Info&version=&method=get
{
"success":true,
"data": {
"enable_list_usergrp": false,
"hostname": "myds",
"is_manager": true,
"items": [
{
"gid": 100
},
{
"gid": 101
}
],
"support_file_request": true,
"support_sharing": true,
"support_vfs": true,
"support_virtual": {
"enable_iso_mount": true,
"enable_remote_mount": true
},
"support_virtual_protocol": [
"cifs",
"nfs",
"iso"
],
"system_codepage": "cht",
"uid": 1026
}
}
/webapi/entry.cgi SYNO.API.Info
https://myds.com:port/webapi/entry.cgi?
api=SYNO.API.Info&version=1&method=query&query=SYNO.API.Auth,SYNO.FileStation.
{
"data":{
"SYNO.API.Auth": {
"path": "entry.cgi",
"minVersion": 1,
"maxVersion": 7
},
"SYNO.FileStation.List": {
"path": "entry.cgi",
"requestFormat":"JSON"
"minVersion": 1,
"maxVersion": 2
},
"SYNO.VideoStation.Info": {
"path": "VideoStation/info.cgi",
"minVersion": 1,
"maxVersion": 1
},
…
},
"success": true
}
SYNO.API.Auth
SYNO.API.Auth /webapi/entry.cgi
https://myds.com:port/webapi/entry.cgi?
api=SYNO.API.Auth&version=6&method=login&account=<USERNAME>&passwd=
<PASSWORD>&enable_syno_token=yes
{
"data": {
"did": "8nC0nhJjgiE1XTqM6aKOS6-K1IIs6r-vHNpH72eUe-
XNSWs9OtF5c48EjaqXygEgvnEoARJJDWskZ656CVWl2w",
"is_portal_port": false,
"sid": "K5LlN6r-zkpxg61He2eSS2zIRrPf1aG7L7eGBjAsU8gd7gbtDEuYCtdOH1Y5Kgr-
F3_rl86kYyzCzSxzwHGH90",
"synotoken": "03yhfxW4syRQw"
},
"success": true
}
synotoken
SYNO.API.Info SynoToken
SYNO.FileStation.List
offset limit
https://myds.com:port/webapi/entry.cgi?
api=SYNO.FileStation.List&version=1&method=list_share&SynoToken=03yhfxW4syRQw
{
"data": {
"offset": 0,
"shares": [{
"isdir": true,
"name": "video",
"path": "/video"
},{
"isdir": true,
"name": "photo",
"path": "/photo"
}],
"total": 2
},
"success": true
}
logout SYNO.API.Auth
_sid
https://myds.com:port/webapi/entry.cgi?
api=SYNO.API.Auth&version=6&method=logout[&_sid=K5LlN6r-
zkpxg61He2eSS2zIRrPf1aG7L7eGBjAsU8gd7gbtDEuYCtdOH1Y5Kgr-F3_rl86kYyzCzSxzwHGH90]
SYNO.API.Info
SYNO.API.Auth
query
GET /webapi/entry.cgi?api=SYNO.API.Info&version=1&method=query
key
path
minVersion
maxVersion
requestFormat
{
"data":{
"SYNO.API.Auth": {
"path": "entry.cgi",
"minVersion": 1,
"maxVersion": 7
},
"SYNO.FileStation.List": {
"path": "entry.cgi",
"requestFormat":"JSON"
"minVersion": 1,
"maxVersion": 2
},
"SYNO.VideoStation.Info": {
"path": "VideoStation/info.cgi",
"minVersion": 1,
"maxVersion": 1
},
…
},
"success": true
}
account
passwd
session
format
cookie
cookie
sid
otp_code
enable_syno_tok
en
SynoToken
enable_device_t
oken
device_name
device_id
GET /webapi/entry.cgi?api=SYNO.API.Auth&version=6&method=login&account=
<USERNAME>&passwd=<PASSWORD>&session=FileStation&format=cookie
GET /webapi/entry.cgi?api=SYNO.API.Auth&version=6&method=login&account=
<USERNAME>&passwd=<PASSWORD>&otp_code=<OTP_CODE>
GET /webapi/entry.cgi?api=SYNO.API.Auth&version=6&method=login&account=
<USERNAME>&passwd=<PASSWORD>&otp_code=
<OTP_CODE>&enable_device_token=yes&device_name=<DEVICE_NAME>
GET /webapi/entry.cgi?api=SYNO.API.Auth&version=6&method=login&account=
<USERNAME>&passwd=<PASSWORD>&device_name=<DEVICE_NAME>&device_id=<DID>
sid
format=sid
_sid=<sid>
did
is_portal_port
synotoken
SynoToken=<synotoken>
{
"data": {
"did": "8nC0nhJjgiE1XTqM6aKOS6-K1IIs6r-vHNpH72eUe-
XNSWs9OtF5c48EjaqXygEgvnEoARJJDWskZ656CVWl2w",
"is_portal_port": false,
"sid": "K5LlN6r-zkpxg61He2eSS2zIRrPf1aG7L7eGBjAsU8gd7gbtDEuYCtdOH1Y5Kgr-
F3_rl86kYyzCzSxzwHGH90",
"synotoken": "03yhfxW4syRQw"
},
"success": true
}
GET /webapi/entry.cgi?api=SYNO.API.Auth&version=6&method=logout
SynoToken
SynoToken
GET /webapi/entry.cgi?api=SYNO.API.Auth&version=6&method=token
is_portal_port
synotoken
SynoToken=<synotoken>
