Skip to content

feat: update docker api #254

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
luboszima wants to merge 4 commits into
base: master
Choose a base branch
from
Draft

feat: update docker api #254

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f2d181f
feat: add method docker_log to retrieve event logs from Container Man…
Jun 26, 2025
beb1c6d
feat: add method clear_event_logs to remove event logs from Container…
Jun 26, 2025
c1c720f
Merge branch 'master' into feat/update_docker_api
luboszima Jun 28, 2025
2e49a94
Merge branch 'N4S4:master' into feat/update_docker_api
luboszima Jul 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 112 additions & 0 deletions synology_api/docker_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,126 @@ class Docker(base_api.BaseApi):
- Search for docker image in all available registries
- Get list of projects
- Get list of docker networks
- Get list of event logs from Container Manager

- Setters:

- Actions:
- Export container profile
- Export container profile and content
- Remove event logs from Container Manager
"""

def list_event_logs(self, limit : int = 1000, offset : int = 0, sort_by : str = "time", sort_dir : str = "DESC", loglevel : str = "", filter_content: str = "", datefrom : int = 0, dateto : int = 0) -> dict[str, object] | str:
"""Get list of event logs from Container Manager.
For example: \"Container started successfully.\", \"Container stopped successfully.\", \"Start project \'tsdproxy\' successfully.\"

Parameters
----------
limit : int, optional
Maximum number of event logs to return. Defaults 1000.

offset : int, optional
Offset for pagination. Defaults to 0.

sort_by : str, optional
Field to sort the logs by. Can be one of: 'time', 'level', 'user', 'event'. Defaults to 'time'.

sort_dir : str, optional
Direction to sort the logs. Can be either 'ASC' or 'DESC'. Defaults to 'DESC'.

loglevel : str, optional
Log level to filter by. Can be one of: '', 'information', 'warning', 'error'. Defaults to '' (no filtering).

filter_content : str, optional
Filter content to search in the logs. Defaults to an empty string (no filtering).

datefrom : int, optional
Datatime from which to start fetching logs, in Unix timestamp format. Defaults to 0 (no filtering).

datato : int, optional
Datatime until which to fetch logs, in Unix timestamp format. Defaults to 0 (no filtering).

Returns
-------
dict[str, object]
A dictionary containing the event logs.

Example return
--------------
```json
{
"data": {
"error_count": 0,
"info_count": 2,
"limit": 2,
"logs": [
{
"event": "Start project 'glance' successfully.",
"level": "info",
"log_type": "dockerlog",
"time": "2025\/06\/26 15\:29\:14",
"user": "devops"
},
{
"event": "Stop project \'glance\' successfully.",
"level": "info",
"log_type": "dockerlog",
"time": "2025\/06\/26 15\:29\:08",
"user": "devops"
}
],
"offset": 0,
"total": 2,
"warn_count": 0
},
"success": true
}
```
"""
if sort_dir not in ['ASC', 'DESC']:
raise ValueError("sort_dir must be either 'ASC' or 'DESC'")

if sort_by not in ['time', 'level', 'user', 'event']:
raise ValueError("sort_by must be one of: 'time', 'level', 'user', 'event'")

if loglevel not in ['', 'information', 'warning', 'error']:
raise ValueError("loglevel must be one of: '', 'information', 'warning', 'error'")


#
api_name = 'SYNO.Docker.Log'
info = self.gen_list[api_name]
api_path = info['path']
req_param = {'version': info['maxVersion'], 'method': 'list', 'action': 'load', 'limit': limit, 'offset': offset, 'sort_by': sort_by, 'sort_dir': sort_dir, 'filter_content': filter_content, 'datefrom': datefrom, 'dateto': dateto}

return self.request_data(api_name, api_path, req_param, method='post')

def clear_event_logs(self) -> dict[str, object] | str:
"""Remove event logs from Container Manager.

Returns
-------
dict[str, object]
A dictionary indicating the success of the operation.

Example return
--------------
```json
{
"data": {},
"success": true
}
```
"""

api_name = 'SYNO.Docker.Log'
info = self.gen_list[api_name]
api_path = info['path']
req_param = {'version': info['maxVersion'], 'method': 'clear'}

return self.request_data(api_name, api_path, req_param, method='post')

def containers(self) -> dict[str, object] | str:
"""
Get list of containers.
Expand Down
Loading