GoDoxy API

GoDoxy API

GoDoxy Docs

Informations

Version

1.0

License

MIT

Contact

Yusing https://github.com/yusing/godoxy/issues

Terms Of Service

https://github.com/yusing/godoxy/blob/main/LICENSE

Content negotiation

URI Schemes

• http

Consumes

• application/json
• text/plain
• application/yaml

Produces

• image/png
• image/svg+xml
• image/webp
• image/x-icon
• application/json
• text/plain
• application/godoxy+yaml

All endpoints

agent

Method	URI	Name	Summary
GET	/api/v1/agent/list	get agent list	List agents
POST	/api/v1/agent/create	post agent create	Create a new agent
POST	/api/v1/agent/verify	post agent verify	Verify a new agent

auth

Method	URI	Name	Summary
GET	/api/v1/auth/logout	get auth logout	Logout
HEAD	/api/v1/auth/check	head auth check	Check authentication status
POST	/api/v1/auth/callback	post auth callback	Auth Callback
POST	/api/v1/auth/login	post auth login	Login
POST	/api/v1/auth/logout	post auth logout	Logout

cert

Method	URI	Name	Summary
GET	/api/v1/cert/info	get cert info	Get cert info
GET	/api/v1/cert/renew	get cert renew	Renew cert

docker

Method	URI	Name	Summary
GET	/api/v1/docker/container/	get docker container ID	Get container
GET	/api/v1/docker/containers	get docker containers	Get containers
GET	/api/v1/docker/info	get docker info	Get docker info
GET	/api/v1/docker/logs/	get docker logs ID	Get docker container logs
GET	/api/v1/docker/stats/	get docker stats ID	Get container stats
POST	/api/v1/docker/restart	post docker restart	Restart container
POST	/api/v1/docker/start	post docker start	Start container
POST	/api/v1/docker/stop	post docker stop	Stop container

file

Method	URI	Name	Summary
GET	/api/v1/file/content	get file content	Get file content
GET	/api/v1/file/list	get file list	List files
POST	/api/v1/file/validate	post file validate	Validate file
PUT	/api/v1/file/content	put file content	Set file content

homepage

Method	URI	Name	Summary
GET	/api/v1/homepage/categories	get homepage categories	List homepage categories
GET	/api/v1/homepage/items	get homepage items	Homepage items
POST	/api/v1/homepage/item_click	post homepage item click	Increment item click
POST	/api/v1/homepage/set/category_order	post homepage set category order	Set homepage category order
POST	/api/v1/homepage/set/item	post homepage set item	Override single homepage item
POST	/api/v1/homepage/set/item_all_sort_order	post homepage set item all sort order	Set homepage item all sort order
POST	/api/v1/homepage/set/item_fav_sort_order	post homepage set item fav sort order	Set homepage item fav sort order
POST	/api/v1/homepage/set/item_favorite	post homepage set item favorite	Set homepage item favorite
POST	/api/v1/homepage/set/item_sort_order	post homepage set item sort order	Set homepage item sort order
POST	/api/v1/homepage/set/item_visible	post homepage set item visible	Set homepage item visibility
POST	/api/v1/homepage/set/items_batch	post homepage set items batch	Override multiple homepage items

metrics

Method	URI	Name	Summary
GET	/api/v1/metrics/all_system_info	get metrics all system info	Get system info
GET	/api/v1/metrics/system_info	get metrics system info	Get system info
GET	/api/v1/metrics/uptime	get metrics uptime	Get uptime

proxmox

Method	URI	Name	Summary
GET	/api/v1/proxmox/journalctl	get proxmox journalctl	Get journalctl output
GET	/api/v1/proxmox/journalctl/	get proxmox journalctl node	Get journalctl output
GET	/api/v1/proxmox/journalctl/{node}/	get proxmox journalctl node vmid	Get journalctl output
GET	/api/v1/proxmox/journalctl/{node}/{vmid}/	get proxmox journalctl node vmid service	Get journalctl output
GET	/api/v1/proxmox/stats/	get proxmox stats node	Get proxmox node stats
GET	/api/v1/proxmox/stats/{node}/	get proxmox stats node vmid	Get proxmox VM stats
GET	/api/v1/proxmox/tail	get proxmox tail	Get tail output
POST	/api/v1/proxmox/lxc/:node/:vmid/restart	post proxmox lxc node vmid restart	Restart LXC container
POST	/api/v1/proxmox/lxc/:node/:vmid/start	post proxmox lxc node vmid start	Start LXC container
POST	/api/v1/proxmox/lxc/:node/:vmid/stop	post proxmox lxc node vmid stop	Stop LXC container

route

Method	URI	Name	Summary
GET	/api/v1/route/by_provider	get route by provider	List routes by provider
GET	/api/v1/route/list	get route list	List routes
GET	/api/v1/route/providers	get route providers	List route providers
GET	/api/v1/route/validate	get route validate	Validate route
GET	/api/v1/route/	get route which	List route
POST	/api/v1/route/playground	post route playground	Rule Playground
POST	/api/v1/route/validate	post route validate	Validate route

version1

Method	URI	Name	Summary
GET	/api/v1/events	get events	Get events history
GET	/api/v1/favicon	get favicon	Get favicon
GET	/api/v1/health	get health	Get routes health info
GET	/api/v1/icons	get icons	List icons
GET	/api/v1/stats	get stats	Get GoDoxy stats
GET	/api/v1/version	get version	Get version

Paths

List agents (GetAgentList)

GET /api/v1/agent/list

List agents

Consumes

• application/json

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
403	Forbidden	Forbidden		schema

Responses

200 - OK

Status: OK

Schema

[]Agent

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

Logout (GetAuthLogout)

GET /api/v1/auth/logout

Logs out the user by invalidating the token

Produces

• text/plain

All responses

Code	Status	Description	Has headers	Schema
302	Found	Redirects to home page		schema

Responses

302 - Redirects to home page

Status: Found

Schema

Get cert info (GetCertInfo)

GET /api/v1/cert/info

Get cert info

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
403	Forbidden	Unauthorized		schema
404	Not Found	No certificates found or autocert is not enabled		schema
500	Internal Server Error	Internal server error		schema

Responses

200 - OK

Status: OK

Schema

[]CertInfo

403 - Unauthorized

Status: Forbidden

Schema

ErrorResponse

404 - No certificates found or autocert is not enabled

Status: Not Found

Schema

ErrorResponse

500 - Internal server error

Status: Internal Server Error

Schema

ErrorResponse

Renew cert (GetCertRenew)

GET /api/v1/cert/renew

Renew cert

Produces

• text/plain

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
403	Forbidden	Forbidden		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

SuccessResponse

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Get container (GetDockerContainerID)

GET /api/v1/docker/container/{id}

Get container by container id

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
id	path	string	string		✓		Container ID

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
400	Bad Request	ID is required		schema
403	Forbidden	Forbidden		schema
404	Not Found	Container not found		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

ContainerResponse

400 - ID is required

Status: Bad Request

Schema

ErrorResponse

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

404 - Container not found

Status: Not Found

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Get containers (GetDockerContainers)

GET /api/v1/docker/containers

Get containers

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
403	Forbidden	Forbidden		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

[]ContainerResponse

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Get docker info (GetDockerInfo)

GET /api/v1/docker/info

Get docker info

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
403	Forbidden	Forbidden		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

ServerInfo

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Get docker container logs (GetDockerLogsID)

GET /api/v1/docker/logs/{id}

Get docker container logs by container id

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
id	path	string	string		✓		container id
from	query	string	string				from timestamp
levels	query	string	string				levels
limit	query	integer	int64				limit
stderr	query	boolean	bool				show stderr
stdout	query	boolean	bool				show stdout
to	query	string	string				to timestamp

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
400	Bad Request	Bad Request		schema
403	Forbidden	Forbidden		schema
404	Not Found	server not found or container not found		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

400 - Bad Request

Status: Bad Request

Schema

ErrorResponse

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

404 - server not found or container not found

Status: Not Found

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Get container stats (GetDockerStatsID)

GET /api/v1/docker/stats/{id}

Get container stats by container id

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
id	path	string	string		✓		Container ID or route alias

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
400	Bad Request	Invalid request: id is required or route is not a docker container		schema
403	Forbidden	Forbidden		schema
404	Not Found	Container not found		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

ContainerStatsResponse

400 - Invalid request: id is required or route is not a docker container

Status: Bad Request

Schema

ErrorResponse

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

404 - Container not found

Status: Not Found

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Get events history (GetEvents)

GET /api/v1/events

Consumes

• application/json

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
403	Forbidden	Forbidden: unauthorized		schema
500	Internal Server Error	Internal Server Error: internal error		schema

Responses

200 - OK

Status: OK

Schema

[]Event

403 - Forbidden: unauthorized

Status: Forbidden

Schema

ErrorResponse

500 - Internal Server Error: internal error

Status: Internal Server Error

Schema

ErrorResponse

Get favicon (GetFavicon)

GET /api/v1/favicon

Get favicon

Consumes

• application/json

Produces

• image/svg+xml
• image/x-icon
• image/png
• image/webp

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
alias	query	string	string				Alias of the route
url	query	string	string				URL of the route

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
400	Bad Request	Bad Request: alias is empty or route is not HTTPRoute		schema
403	Forbidden	Forbidden: unauthorized		schema
404	Not Found	Not Found: route or icon not found		schema
500	Internal Server Error	Internal Server Error: internal error		schema

Responses

200 - OK

Status: OK

Schema

[]IconFetchResult

400 - Bad Request: alias is empty or route is not HTTPRoute

Status: Bad Request

Schema

ErrorResponse

403 - Forbidden: unauthorized

Status: Forbidden

Schema

ErrorResponse

404 - Not Found: route or icon not found

Status: Not Found

Schema

ErrorResponse

500 - Internal Server Error: internal error

Status: Internal Server Error

Schema

ErrorResponse

Get file content (GetFileContent)

GET /api/v1/file/content

Get file content

Consumes

• application/json

Produces

• application/json
• application/godoxy+yaml

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
filename	query	filename (formatted string)	string		✓
type	query	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
400	Bad Request	Bad Request		schema
403	Forbidden	Forbidden		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

400 - Bad Request

Status: Bad Request

Schema

ErrorResponse

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

List files (GetFileList)

GET /api/v1/file/list

List files

Consumes

• application/json

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
403	Forbidden	Forbidden		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

ListFilesResponse

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Get routes health info (GetHealth)

GET /api/v1/health

Get health info by route name

Consumes

• application/json

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	Health info by route name		schema
403	Forbidden	Forbidden		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - Health info by route name

Status: OK

Schema

HealthMap

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

List homepage categories (GetHomepageCategories)

GET /api/v1/homepage/categories

List homepage categories

Consumes

• application/json

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
403	Forbidden	Forbidden		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

[]string

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Homepage items (GetHomepageItems)

GET /api/v1/homepage/items

Homepage items

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
category	query	string	string				Category filter
provider	query	string	string				Provider filter
search	query	string	string				Search query
sort_method	query	string	string			"alphabetical"	Sort method

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
400	Bad Request	Bad Request		schema
403	Forbidden	Forbidden		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

[]HomepageCategory

400 - Bad Request

Status: Bad Request

Schema

ErrorResponse

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

List icons (GetIcons)

GET /api/v1/icons

List icons

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
keyword	query	string	string				Keyword
limit	query	integer	int64				Limit

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
400	Bad Request	Bad Request		schema
403	Forbidden	Forbidden		schema

Responses

200 - OK

Status: OK

Schema

[]IconMetaSearch

400 - Bad Request

Status: Bad Request

Schema

ErrorResponse

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

Get system info (GetMetricsAllSystemInfo)

GET /api/v1/metrics/all_system_info

Get system info

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
aggregate	query	string	string
interval	query	duration (formatted string)	strfmt.Duration
period	query	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	period specified, aggregated system info by agent name		schema
400	Bad Request	Bad Request		schema
403	Forbidden	Forbidden		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - period specified, aggregated system info by agent name

Status: OK

Schema

map of SystemInfoAggregate

400 - Bad Request

Status: Bad Request

Schema

ErrorResponse

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Get system info (GetMetricsSystemInfo)

GET /api/v1/metrics/system_info

Get system info

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
agentAddr	query	string	string
agentName	query	string	string
aggregate	query	string	string
period	query	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	period specified		schema
400	Bad Request	Bad Request		schema
403	Forbidden	Forbidden		schema
404	Not Found	Not Found		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - period specified

Status: OK

Schema

SystemInfoAggregate

400 - Bad Request

Status: Bad Request

Schema

ErrorResponse

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

404 - Not Found

Status: Not Found

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Get uptime (GetMetricsUptime)

GET /api/v1/metrics/uptime

Get uptime

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
interval	query	string	string
keyword	query	string	string
limit	query	integer	int64
offset	query	integer	int64

All responses

Code	Status	Description	Has headers	Schema
200	OK	period specified		schema
204	No Content	No Content		schema
400	Bad Request	Bad Request		schema
403	Forbidden	Forbidden		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - period specified

Status: OK

Schema

UptimeAggregate

204 - No Content

Status: No Content

Schema

ErrorResponse

400 - Bad Request

Status: Bad Request

Schema

ErrorResponse

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Get journalctl output (GetProxmoxJournalctl)

GET /api/v1/proxmox/journalctl

Get journalctl output for node or LXC container. If vmid is not provided, streams node journalctl.

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
limit	query	integer	int64			100	Limit output lines (1-1000)
node	query	string	string		✓		Node name
service	query	[]string	[]string	csv			Service names
vmid	query	integer	int64				Container VMID (optional - if not provided, streams node journalctl)

All responses

Code	Status	Description	Has headers	Schema
200	OK	Journalctl output		schema
400	Bad Request	Invalid request		schema
403	Forbidden	Unauthorized		schema
404	Not Found	Node not found		schema
500	Internal Server Error	Internal server error		schema

Responses

200 - Journalctl output

Status: OK

Schema

400 - Invalid request

Status: Bad Request

Schema

ErrorResponse

403 - Unauthorized

Status: Forbidden

Schema

ErrorResponse

404 - Node not found

Status: Not Found

Schema

ErrorResponse

500 - Internal server error

Status: Internal Server Error

Schema

ErrorResponse

Get journalctl output (GetProxmoxJournalctlNode)

GET /api/v1/proxmox/journalctl/{node}

Get journalctl output for node or LXC container. If vmid is not provided, streams node journalctl.

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
node	path	string	string		✓		Node name
limit	query	integer	int64			100	Limit output lines (1-1000)
node	query	string	string		✓		Node name
service	query	[]string	[]string	csv			Service names
vmid	query	integer	int64				Container VMID (optional - if not provided, streams node journalctl)

All responses

Code	Status	Description	Has headers	Schema
200	OK	Journalctl output		schema
400	Bad Request	Invalid request		schema
403	Forbidden	Unauthorized		schema
404	Not Found	Node not found		schema
500	Internal Server Error	Internal server error		schema

Responses

200 - Journalctl output

Status: OK

Schema

400 - Invalid request

Status: Bad Request

Schema

ErrorResponse

403 - Unauthorized

Status: Forbidden

Schema

ErrorResponse

404 - Node not found

Status: Not Found

Schema

ErrorResponse

500 - Internal server error

Status: Internal Server Error

Schema

ErrorResponse

Get journalctl output (GetProxmoxJournalctlNodeVmid)

GET /api/v1/proxmox/journalctl/{node}/{vmid}

Get journalctl output for node or LXC container. If vmid is not provided, streams node journalctl.

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
node	path	string	string		✓		Node name
vmid	path	integer	int64				Container VMID (optional - if not provided, streams node journalctl)
limit	query	integer	int64			100	Limit output lines (1-1000)
node	query	string	string		✓		Node name
service	query	[]string	[]string	csv			Service names
vmid	query	integer	int64				Container VMID (optional - if not provided, streams node journalctl)

All responses

Code	Status	Description	Has headers	Schema
200	OK	Journalctl output		schema
400	Bad Request	Invalid request		schema
403	Forbidden	Unauthorized		schema
404	Not Found	Node not found		schema
500	Internal Server Error	Internal server error		schema

Responses

200 - Journalctl output

Status: OK

Schema

400 - Invalid request

Status: Bad Request

Schema

ErrorResponse

403 - Unauthorized

Status: Forbidden

Schema

ErrorResponse

404 - Node not found

Status: Not Found

Schema

ErrorResponse

500 - Internal server error

Status: Internal Server Error

Schema

ErrorResponse

Get journalctl output (GetProxmoxJournalctlNodeVmidService)

GET /api/v1/proxmox/journalctl/{node}/{vmid}/{service}

Get journalctl output for node or LXC container. If vmid is not provided, streams node journalctl.

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
node	path	string	string		✓		Node name
service	path	[]string	[]string	csv			Service names
vmid	path	integer	int64				Container VMID (optional - if not provided, streams node journalctl)
limit	query	integer	int64			100	Limit output lines (1-1000)
node	query	string	string		✓		Node name
service	query	[]string	[]string	csv			Service names
vmid	query	integer	int64				Container VMID (optional - if not provided, streams node journalctl)

All responses

Code	Status	Description	Has headers	Schema
200	OK	Journalctl output		schema
400	Bad Request	Invalid request		schema
403	Forbidden	Unauthorized		schema
404	Not Found	Node not found		schema
500	Internal Server Error	Internal server error		schema

Responses

200 - Journalctl output

Status: OK

Schema

400 - Invalid request

Status: Bad Request

Schema

ErrorResponse

403 - Unauthorized

Status: Forbidden

Schema

ErrorResponse

404 - Node not found

Status: Not Found

Schema

ErrorResponse

500 - Internal server error

Status: Internal Server Error

Schema

ErrorResponse

Get proxmox node stats (GetProxmoxStatsNode)

GET /api/v1/proxmox/stats/{node}

Get proxmox node stats in json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
node	path	string	string		✓		Node name

All responses

Code	Status	Description	Has headers	Schema
200	OK	Stats output		schema
400	Bad Request	Invalid request		schema
403	Forbidden	Unauthorized		schema
404	Not Found	Node not found		schema
500	Internal Server Error	Internal server error		schema

Responses

200 - Stats output

Status: OK

Schema

ProxmoxNodeStats

400 - Invalid request

Status: Bad Request

Schema

ErrorResponse

403 - Unauthorized

Status: Forbidden

Schema

ErrorResponse

404 - Node not found

Status: Not Found

Schema

ErrorResponse

500 - Internal server error

Status: Internal Server Error

Schema

ErrorResponse

Get proxmox VM stats (GetProxmoxStatsNodeVmid)

GET /api/v1/proxmox/stats/{node}/{vmid}

Get proxmox VM stats in format of "STATUS|CPU%%|MEM USAGE/LIMIT|MEM%%|NET I/O|BLOCK I/O"

Produces

• text/plain

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
node	path	string	string		✓
vmid	path	integer	int64		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Stats output		schema
400	Bad Request	Invalid request		schema
403	Forbidden	Unauthorized		schema
404	Not Found	Node not found		schema
500	Internal Server Error	Internal server error		schema

Responses

200 - Stats output

Status: OK

Schema

400 - Invalid request

Status: Bad Request

Schema

ErrorResponse

403 - Unauthorized

Status: Forbidden

Schema

ErrorResponse

404 - Node not found

Status: Not Found

Schema

ErrorResponse

500 - Internal server error

Status: Internal Server Error

Schema

ErrorResponse

Get tail output (GetProxmoxTail)

GET /api/v1/proxmox/tail

Get tail output for node or LXC container. If vmid is not provided, streams node tail.

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
file	query	[]string	[]string	csv	✓		File paths
limit	query	integer	int64			100	Limit output lines (1-1000)
node	query	string	string		✓		Node name
vmid	query	integer	int64				Container VMID (optional - if not provided, streams node journalctl)

All responses

Code	Status	Description	Has headers	Schema
200	OK	Tail output		schema
400	Bad Request	Invalid request		schema
403	Forbidden	Unauthorized		schema
404	Not Found	Node not found		schema
500	Internal Server Error	Internal server error		schema

Responses

200 - Tail output

Status: OK

Schema

400 - Invalid request

Status: Bad Request

Schema

ErrorResponse

403 - Unauthorized

Status: Forbidden

Schema

ErrorResponse

404 - Node not found

Status: Not Found

Schema

ErrorResponse

500 - Internal server error

Status: Internal Server Error

Schema

ErrorResponse

List routes by provider (GetRouteByProvider)

GET /api/v1/route/by_provider

List routes by provider

Consumes

• application/json

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
403	Forbidden	Forbidden		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

RouteAPIRoutesByProvider

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

List routes (GetRouteList)

GET /api/v1/route/list

List routes

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
provider	query	string	string				Provider

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
403	Forbidden	Forbidden		schema

Responses

200 - OK

Status: OK

Schema

[]Route

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

List route providers (GetRouteProviders)

GET /api/v1/route/providers

List route providers

Consumes

• application/json

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
403	Forbidden	Forbidden		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

[]RouteProvider

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Validate route (GetRouteValidate)

GET /api/v1/route/validate

Validate route,

Consumes

• application/yaml

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
route	body	Route	models.Route		✓		Route

All responses

Code	Status	Description	Has headers	Schema
200	OK	Route validated		schema
400	Bad Request	Bad request		schema
403	Forbidden	Forbidden		schema
417	Expectation Failed	Validation failed		schema
500	Internal Server Error	Internal server error		schema

Responses

200 - Route validated

Status: OK

Schema

SuccessResponse

400 - Bad request

Status: Bad Request

Schema

ErrorResponse

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

417 - Validation failed

Status: Expectation Failed

Schema

any

500 - Internal server error

Status: Internal Server Error

Schema

ErrorResponse

List route (GetRouteWhich)

GET /api/v1/route/{which}

List route

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
which	path	string	string		✓		Route name

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
400	Bad Request	Bad Request		schema
403	Forbidden	Forbidden		schema
404	Not Found	Not Found		schema

Responses

200 - OK

Status: OK

Schema

Route

400 - Bad Request

Status: Bad Request

Schema

ErrorResponse

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

404 - Not Found

Status: Not Found

Schema

ErrorResponse

Get GoDoxy stats (GetStats)

GET /api/v1/stats

Get stats

Consumes

• application/json

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
403	Forbidden	Forbidden		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

StatsResponse

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Get version (GetVersion)

GET /api/v1/version

Get the version of the GoDoxy

Consumes

• application/json

Produces

• text/plain

All responses

Code	Status	Description	Has headers	Schema
200	OK	version		schema

Responses

200 - version

Status: OK

Schema

Check authentication status (HeadAuthCheck)

HEAD /api/v1/auth/check

Checks if the user is authenticated by validating their token

Produces

• text/plain

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
302	Found	Redirects to login page or IdP		schema

Responses

200 - OK

Status: OK

Schema

302 - Redirects to login page or IdP

Status: Found

Schema

Create a new agent (PostAgentCreate)

POST /api/v1/agent/create

Create a new agent and return the docker compose file, encrypted CA and client PEMs The returned PEMs are encrypted with a random key and will be used for verification when adding a new agent

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
request	body	NewAgentRequest	models.NewAgentRequest		✓		Request

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
400	Bad Request	Bad Request		schema
403	Forbidden	Forbidden		schema
409	Conflict	Conflict		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

NewAgentResponse

400 - Bad Request

Status: Bad Request

Schema

ErrorResponse

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

409 - Conflict

Status: Conflict

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Verify a new agent (PostAgentVerify)

POST /api/v1/agent/verify

Verify a new agent and return the number of routes added

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
request	body	VerifyNewAgentRequest	models.VerifyNewAgentRequest		✓		Request

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
400	Bad Request	Bad Request		schema
403	Forbidden	Forbidden		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

SuccessResponse

400 - Bad Request

Status: Bad Request

Schema

ErrorResponse

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Auth Callback (PostAuthCallback)

POST /api/v1/auth/callback

Handles the callback from the provider after successful authentication

Produces

• text/plain

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
body	body	AuthUserPassAuthCallbackRequest	models.AuthUserPassAuthCallbackRequest		✓		Userpass only

All responses

Code	Status	Description	Has headers	Schema
200	OK	Userpass: OK		schema
302	Found	OIDC: Redirects to home page		schema
400	Bad Request	Userpass: invalid request / credentials		schema
500	Internal Server Error	Internal server error		schema

Responses

200 - Userpass: OK

Status: OK

Schema

302 - OIDC: Redirects to home page

Status: Found

Schema

400 - Userpass: invalid request / credentials

Status: Bad Request

Schema

500 - Internal server error

Status: Internal Server Error

Schema

Login (PostAuthLogin)

POST /api/v1/auth/login

Initiates the login process by redirecting the user to the provider's login page

Produces

• text/plain

All responses

Code	Status	Description	Has headers	Schema
302	Found	Redirects to login page or IdP		schema
429	Too Many Requests	Too Many Requests		schema

Responses

302 - Redirects to login page or IdP

Status: Found

Schema

429 - Too Many Requests

Status: Too Many Requests

Schema

Logout (PostAuthLogout)

POST /api/v1/auth/logout

Logs out the user by invalidating the token

Produces

• text/plain

All responses

Code	Status	Description	Has headers	Schema
302	Found	Redirects to home page		schema

Responses

302 - Redirects to home page

Status: Found

Schema

Restart container (PostDockerRestart)

POST /api/v1/docker/restart

Restart container by container id

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
request	body	DockerapiRestartRequest	models.DockerapiRestartRequest		✓		Request

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
400	Bad Request	Invalid request		schema
403	Forbidden	Forbidden		schema
404	Not Found	Container not found		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

SuccessResponse

400 - Invalid request

Status: Bad Request

Schema

ErrorResponse

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

404 - Container not found

Status: Not Found

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Start container (PostDockerStart)

POST /api/v1/docker/start

Start container by container id

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
request	body	DockerapiStartRequest	models.DockerapiStartRequest		✓		Request

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
400	Bad Request	Invalid request		schema
403	Forbidden	Forbidden		schema
404	Not Found	Container not found		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

SuccessResponse

400 - Invalid request

Status: Bad Request

Schema

ErrorResponse

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

404 - Container not found

Status: Not Found

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Stop container (PostDockerStop)

POST /api/v1/docker/stop

Stop container by container id

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
request	body	DockerapiStopRequest	models.DockerapiStopRequest		✓		Request

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
400	Bad Request	Invalid request		schema
403	Forbidden	Forbidden		schema
404	Not Found	Container not found		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

SuccessResponse

400 - Invalid request

Status: Bad Request

Schema

ErrorResponse

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

404 - Container not found

Status: Not Found

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Validate file (PostFileValidate)

POST /api/v1/file/validate

Validate file

Consumes

• application/yaml

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
type	query	string	string		✓		Type
file	body	string	string		✓		File content

All responses

Code	Status	Description	Has headers	Schema
200	OK	File validated		schema
400	Bad Request	Bad request		schema
403	Forbidden	Forbidden		schema
417	Expectation Failed	Validation failed		schema
500	Internal Server Error	Internal server error		schema

Responses

200 - File validated

Status: OK

Schema

SuccessResponse

400 - Bad request

Status: Bad Request

Schema

ErrorResponse

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

417 - Validation failed

Status: Expectation Failed

Schema

any

500 - Internal server error

Status: Internal Server Error

Schema

ErrorResponse

Increment item click (PostHomepageItemClick)

POST /api/v1/homepage/item_click

Increment item click.

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
which	query	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
400	Bad Request	Bad Request		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

SuccessResponse

400 - Bad Request

Status: Bad Request

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Set homepage category order (PostHomepageSetCategoryOrder)

POST /api/v1/homepage/set/category_order

Set homepage category order.

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
request	body	HomepageOverrideCategoryOrderParams	models.HomepageOverrideCategoryOrderParams		✓		Override category order

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
400	Bad Request	Bad Request		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

SuccessResponse

400 - Bad Request

Status: Bad Request

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Override single homepage item (PostHomepageSetItem)

POST /api/v1/homepage/set/item

Override single homepage item.

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
request	body	HomepageOverrideItemParams	models.HomepageOverrideItemParams		✓		Override single item

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
400	Bad Request	Bad Request		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

SuccessResponse

400 - Bad Request

Status: Bad Request

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Set homepage item all sort order (PostHomepageSetItemAllSortOrder)

POST /api/v1/homepage/set/item_all_sort_order

Set homepage item all sort order.

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
request	body	HomepageOverrideItemAllSortOrderParams	models.HomepageOverrideItemAllSortOrderParams		✓		Set item all sort order

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
400	Bad Request	Bad Request		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

SuccessResponse

400 - Bad Request

Status: Bad Request

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Set homepage item fav sort order (PostHomepageSetItemFavSortOrder)

POST /api/v1/homepage/set/item_fav_sort_order

Set homepage item fav sort order.

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
request	body	HomepageOverrideItemFavSortOrderParams	models.HomepageOverrideItemFavSortOrderParams		✓		Set item fav sort order

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
400	Bad Request	Bad Request		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

SuccessResponse

400 - Bad Request

Status: Bad Request

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Set homepage item favorite (PostHomepageSetItemFavorite)

POST /api/v1/homepage/set/item_favorite

Set homepage item favorite.

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
request	body	HomepageOverrideItemFavoriteParams	models.HomepageOverrideItemFavoriteParams		✓		Set item favorite

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
400	Bad Request	Bad Request		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

SuccessResponse

400 - Bad Request

Status: Bad Request

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Set homepage item sort order (PostHomepageSetItemSortOrder)

POST /api/v1/homepage/set/item_sort_order

Set homepage item sort order.

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
request	body	HomepageOverrideItemSortOrderParams	models.HomepageOverrideItemSortOrderParams		✓		Set item sort order

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
400	Bad Request	Bad Request		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

SuccessResponse

400 - Bad Request

Status: Bad Request

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Set homepage item visibility (PostHomepageSetItemVisible)

POST /api/v1/homepage/set/item_visible

POST list of item ids and visibility value.

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
request	body	HomepageOverrideItemVisibleParams	models.HomepageOverrideItemVisibleParams		✓		Set item visibility

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
400	Bad Request	Bad Request		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

SuccessResponse

400 - Bad Request

Status: Bad Request

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Override multiple homepage items (PostHomepageSetItemsBatch)

POST /api/v1/homepage/set/items_batch

Override multiple homepage items.

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
request	body	HomepageOverrideItemsBatchParams	models.HomepageOverrideItemsBatchParams		✓		Override multiple items

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
400	Bad Request	Bad Request		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

SuccessResponse

400 - Bad Request

Status: Bad Request

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Restart LXC container (PostProxmoxLxcNodeVmidRestart)

POST /api/v1/proxmox/lxc/:node/:vmid/restart

Restart LXC container by node and vmid

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
node	path	string	string		✓
vmid	path	integer	int64		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
400	Bad Request	Invalid request		schema
404	Not Found	Node not found		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

SuccessResponse

400 - Invalid request

Status: Bad Request

Schema

ErrorResponse

404 - Node not found

Status: Not Found

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Start LXC container (PostProxmoxLxcNodeVmidStart)

POST /api/v1/proxmox/lxc/:node/:vmid/start

Start LXC container by node and vmid

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
node	path	string	string		✓
vmid	path	integer	int64		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
400	Bad Request	Invalid request		schema
404	Not Found	Node not found		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

SuccessResponse

400 - Invalid request

Status: Bad Request

Schema

ErrorResponse

404 - Node not found

Status: Not Found

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Stop LXC container (PostProxmoxLxcNodeVmidStop)

POST /api/v1/proxmox/lxc/:node/:vmid/stop

Stop LXC container by node and vmid

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
node	path	string	string		✓
vmid	path	integer	int64		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
400	Bad Request	Invalid request		schema
404	Not Found	Node not found		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

SuccessResponse

400 - Invalid request

Status: Bad Request

Schema

ErrorResponse

404 - Node not found

Status: Not Found

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Rule Playground (PostRoutePlayground)

POST /api/v1/route/playground

Test rules against mock request/response

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
request	body	PlaygroundRequest	models.PlaygroundRequest		✓		Playground request

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
400	Bad Request	Bad Request		schema
403	Forbidden	Forbidden		schema

Responses

200 - OK

Status: OK

Schema

PlaygroundResponse

400 - Bad Request

Status: Bad Request

Schema

ErrorResponse

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

Validate route (PostRouteValidate)

POST /api/v1/route/validate

Validate route,

Consumes

• application/yaml

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
route	body	Route	models.Route		✓		Route

All responses

Code	Status	Description	Has headers	Schema
200	OK	Route validated		schema
400	Bad Request	Bad request		schema
403	Forbidden	Forbidden		schema
417	Expectation Failed	Validation failed		schema
500	Internal Server Error	Internal server error		schema

Responses

200 - Route validated

Status: OK

Schema

SuccessResponse

400 - Bad request

Status: Bad Request

Schema

ErrorResponse

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

417 - Validation failed

Status: Expectation Failed

Schema

any

500 - Internal server error

Status: Internal Server Error

Schema

ErrorResponse

Set file content (PutFileContent)

PUT /api/v1/file/content

Set file content

Consumes

• text/plain

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
filename	query	string	string		✓		Filename
type	query	string	string		✓		Type
file	body	string	string		✓		File

All responses

Code	Status	Description	Has headers	Schema
200	OK	OK		schema
400	Bad Request	Bad Request		schema
403	Forbidden	Forbidden		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

SuccessResponse

400 - Bad Request

Status: Bad Request

Schema

ErrorResponse

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Models

Agent

Properties

Name	Type	Go type	Required	Default	Description	Example
addr	string	string
name	string	string
runtime	AgentContainerRuntime	AgentContainerRuntime
supports_tcp_stream	boolean	bool
supports_udp_stream	boolean	bool
version	string	string

CIDR

Properties

Name	Type	Go type	Required	Default	Description	Example
ip	[]int32 (formatted integer)	[]int32			network number
mask	[]int32 (formatted integer)	[]int32			network mask

CertInfo

Properties

Name	Type	Go type	Required	Default	Description	Example
dns_names	[]string	[]string
email_addresses	[]string	[]string
issuer	string	string
not_after	integer	int64
not_before	integer	int64
subject	string	string

Container

Properties

Name	Type	Go type	Required	Default	Description	Example
agent	AgentpoolAgent	AgentpoolAgent
aliases	[]string	[]string
container_id	string	string
container_name	string	string
docker_cfg	DockerProviderConfig	DockerProviderConfig
errors	string	string
idlewatcher_config	IdlewatcherConfig	IdlewatcherConfig
image	ContainerImage	ContainerImage
is_excluded	boolean	bool
is_explicit	boolean	bool
is_host_network_mode	boolean	bool
labels	map of string	map[string]string			for displaying in UI
mounts	map of string	map[string]string			source:destination
network	string	string
private_hostname	string	string
private_ports	Container	Container			privatePort:types.Port
public_hostname	string	string
public_ports	Container	Container			non-zero publicPort:types.Port
running	boolean	bool
state	ContainerContainerState	ContainerContainerState

ContainerImage

Properties

Name	Type	Go type	Required	Default	Description	Example
author	string	string
name	string	string
sha256	string	string
tag	string	string
version	string	string

ContainerResponse

Properties

Name	Type	Go type	Required	Default	Description	Example
id	string	string
image	string	string
name	string	string
server	string	string
state	ContainerResponse	ContainerResponse

ContainerState

Name	Type	Go type	Default	Description	Example
ContainerState	string	string

ContainerStats

Properties

Name	Type	Go type	Required	Default	Description	Example
paused	integer	int64
running	integer	int64
stopped	integer	int64
total	integer	int64

ContainerStatsResponse

Properties

Name	Type	Go type	Required	Default	Description	Example
blkio_stats	ContainerStatsResponse	ContainerStatsResponse			BlkioStats stores all IO service stats for data read and write.This type is Linux-specific and holds many fields that are specificto cgroups v1.On a cgroup v2 host, all fields other than "io_service_bytes_recursive"are omitted or "null".This type is only populated on Linux and omitted for Windows containers.
cpu_stats	ContainerStatsResponse	ContainerStatsResponse			CPUStats contains CPU related info of the container.
id	string	string			ID is the ID of the container for which the stats were collected.
memory_stats	ContainerStatsResponse	ContainerStatsResponse			MemoryStats aggregates all memory stats since container inception on Linux.Windows returns stats for commit and private working set only.
name	string	string			Name is the name of the container for which the stats were collected.
networks	map of ContainerNetworkStats	map[string]ContainerNetworkStats			Networks contains Nntwork statistics for the container per interface.This field is omitted if the container has no networking enabled.
num_procs	integer	int64			NumProcs is the number of processors on the system.This field is Windows-specific and always zero for Linux containers.
os_type	string	string			OSType is the OS of the container ("linux" or "windows") to allowplatform-specific handling of stats.
pids_stats	ContainerStatsResponse	ContainerStatsResponse			PidsStats contains Linux-specific stats of a container's process-IDs (PIDs).This field is Linux-specific and omitted for Windows containers.
precpu_stats	ContainerStatsResponse	ContainerStatsResponse			PreCPUStats contains the CPUStats of the previous sample.
preread	string	string			PreRead is the date and time at which this first sample was collected.This field is not propagated if the "one-shot" option is set. If the"one-shot" option is set, this field may be omitted, empty, or setto a default date (0001-01-01T00:00:00Z).
read	string	string			Read is the date and time at which this sample was collected.
storage_stats	ContainerStatsResponse	ContainerStatsResponse			StorageStats is the disk I/O stats for read/write on Windows.This type is Windows-specific and omitted for Linux containers.

ContainerStopMethod

Name	Type	Go type	Default	Description	Example
ContainerStopMethod	string	string

DockerProviderConfig

Properties

Name	Type	Go type	Required	Default	Description	Example
tls	DockerTLSConfig	DockerTLSConfig
url	string	string

DockerTLSConfig

Properties

Name	Type	Go type	Required	Default	Description	Example
ca_file	string	string	✓
cert_file	string	string
key_file	string	string

ErrorResponse

Properties

Name	Type	Go type	Required	Default	Description	Example
error	string	string
message	string	string

Event

Properties

Name	Type	Go type	Required	Default	Description	Example
action	string	string
category	string	string
data	interface{}	interface{}
level	EventsLevel	EventsLevel
timestamp	string	string
uuid	string	string

FileType

Name	Type	Go type	Default	Description	Example
FileType	string	string

FinalRequest

Properties

Name	Type	Go type	Required	Default	Description	Example
body	string	string
headers	map of []string	map[string][]string
host	string	string
method	string	string
path	string	string
query	map of []string	map[string][]string

FinalResponse

Properties

Name	Type	Go type	Required	Default	Description	Example
body	string	string
headers	map of []string	map[string][]string
statusCode	integer	int64

HTTPHeader

Properties

Name	Type	Go type	Required	Default	Description	Example
key	string	string
value	string	string

HealthCheckConfig

Properties

Name	Type	Go type	Required	Default	Description	Example
disable	boolean	bool
interval	integer	int64
path	string	string
retries	integer	int64			<0: immediate, 0: default, >0: threshold
timeout	integer	int64
use_get	boolean	bool

HealthExtra

Properties

Name	Type	Go type	Required	Default	Description	Example
config	LoadBalancerConfig	LoadBalancerConfig
pool	map of any	map[string]interface{}

HealthInfoWithoutDetail

Properties

Name	Type	Go type	Required	Default	Description	Example
latency	number	float64
status	string	string
uptime	number	float64

HealthJSON

Properties

Name	Type	Go type	Required	Default	Description	Example
config	HealthCheckConfig	HealthCheckConfig
detail	string	string
extra	HealthJSON	HealthJSON
lastSeen	integer	int64			unix timestamp in seconds
latency	integer	int64			latency in milliseconds
name	string	string
started	integer	int64			unix timestamp in seconds
status	HealthStatusString	HealthStatusString
uptime	number	float64			uptime in seconds
url	string	string

HealthMap

HealthMap

HealthStatusString

Name	Type	Go type	Default	Description	Example
HealthStatusString	string	string

HomepageCategory

Properties

Name	Type	Go type	Required	Default	Description	Example
items	[]HomepageItem	[]*HomepageItem
name	string	string

HomepageItem

Properties

Name	Type	Go type	Required	Default	Description	Example
alias	string	string
all_sort_order	integer	int64			sort order in all
category	string	string
clicks	integer	int64
container_id	string	string
description	string	string
fav_sort_order	integer	int64			sort order in favorite
favorite	boolean	bool
icon	string	string
name	string	string			display name
origin_url	string	string
provider	string	string
show	boolean	bool
sort_order	integer	int64			sort order in category
url	string	string
widget_config	HomepageItem	HomepageItem
widgets	[]HomepageItemWidget	[]*HomepageItemWidget

HomepageItemConfig

Properties

Name	Type	Go type	Required	Default	Description	Example
category	string	string
description	string	string
favorite	boolean	bool
icon	string	string
name	string	string			display name
show	boolean	bool
url	string	string
widget_config	HomepageItemConfig	HomepageItemConfig

HomepageItemWidget

Properties

Name	Type	Go type	Required	Default	Description	Example
label	string	string
value	string	string

HomepageOverrideCategoryOrderParams

Properties

Name	Type	Go type	Required	Default	Description	Example
value	integer	int64
which	string	string

HomepageOverrideItemAllSortOrderParams

Properties

Name	Type	Go type	Required	Default	Description	Example
value	integer	int64
which	string	string

HomepageOverrideItemFavSortOrderParams

Properties

Name	Type	Go type	Required	Default	Description	Example
value	integer	int64
which	string	string

HomepageOverrideItemFavoriteParams

Properties

Name	Type	Go type	Required	Default	Description	Example
value	boolean	bool
which	[]string	[]string

HomepageOverrideItemParams

Properties

Name	Type	Go type	Required	Default	Description	Example
value	HomepageItemConfig	HomepageItemConfig
which	string	string

HomepageOverrideItemSortOrderParams

Properties

Name	Type	Go type	Required	Default	Description	Example
value	integer	int64
which	string	string

HomepageOverrideItemVisibleParams

Properties

Name	Type	Go type	Required	Default	Description	Example
value	boolean	bool
which	[]string	[]string

HomepageOverrideItemsBatchParams

Properties

Name	Type	Go type	Required	Default	Description	Example
value	map of HomepageItemConfig	map[string]HomepageItemConfig

IconFetchResult

Properties

Name	Type	Go type	Required	Default	Description	Example
icon	[]int32 (formatted integer)	[]int32
statusCode	integer	int64

IconMetaSearch

Properties

Name	Type	Go type	Required	Default	Description	Example
Dark	boolean	bool
Light	boolean	bool
PNG	boolean	bool
Ref	string	string
SVG	boolean	bool
Source	IconsSource	IconsSource
WebP	boolean	bool

IdlewatcherConfig

Properties

Name	Type	Go type	Required	Default	Description	Example
depends_on	[]string	[]string
docker	IdlewatcherDockerConfig	IdlewatcherDockerConfig
idle_timeout	IdlewatcherConfig	IdlewatcherConfig			0: no idle watcher.Positive: idle watcher with idle timeout.Negative: idle watcher as a dependency.
no_loading_page	boolean	bool
proxmox	IdlewatcherProxmoxNodeConfig	IdlewatcherProxmoxNodeConfig
start_endpoint	string	string			Optional path that must be hit to start container
stop_method	ContainerStopMethod	ContainerStopMethod
stop_signal	string	string
stop_timeout	TimeDuration	TimeDuration
wake_timeout	TimeDuration	TimeDuration

IdlewatcherDockerConfig

Properties

Name	Type	Go type	Required	Default	Description	Example
container_id	string	string	✓
container_name	string	string	✓
docker_cfg	DockerProviderConfig	DockerProviderConfig	✓

IdlewatcherProxmoxNodeConfig

Properties

Name	Type	Go type	Required	Default	Description	Example
node	string	string	✓
vmid	integer	int64	✓

ListFilesResponse

Properties

Name	Type	Go type	Required	Default	Description	Example
config	[]string	[]string
middleware	[]string	[]string
provider	[]string	[]string

LoadBalancerConfig

Properties

Name	Type	Go type	Required	Default	Description	Example
link	string	string
mode	LoadBalancerMode	LoadBalancerMode
options	map of any	map[string]interface{}
sticky	boolean	bool
sticky_max_age	TimeDuration	TimeDuration
weight	integer	int64

LoadBalancerMode

Name	Type	Go type	Default	Description	Example
LoadBalancerMode	string	string

LogFilter-CIDR

Properties

Name	Type	Go type	Required	Default	Description	Example
negative	boolean	bool
values	[]CIDR	[]*CIDR

LogFilter-HTTPHeader

Properties

Name	Type	Go type	Required	Default	Description	Example
negative	boolean	bool
values	[]HTTPHeader	[]*HTTPHeader

LogFilter-HTTPMethod

Properties

Name	Type	Go type	Required	Default	Description	Example
negative	boolean	bool
values	[]string	[]string

LogFilter-Host

Properties

Name	Type	Go type	Required	Default	Description	Example
negative	boolean	bool
values	[]string	[]string

LogFilter-StatusCodeRange

Properties

Name	Type	Go type	Required	Default	Description	Example
negative	boolean	bool
values	[]StatusCodeRange	[]*StatusCodeRange

LogRetention

Properties

Name	Type	Go type	Required	Default	Description	Example
days	integer	int64
keep_size	integer	int64
last	integer	int64

MetricsPeriod

Name	Type	Go type	Default	Description	Example
MetricsPeriod	string	string

MockCookie

Properties

Name	Type	Go type	Required	Default	Description	Example
name	string	string
value	string	string

MockRequest

Properties

Name	Type	Go type	Required	Default	Description	Example
body	string	string
cookies	[]MockCookie	[]*MockCookie
headers	map of []string	map[string][]string
host	string	string
method	string	string
path	string	string
query	map of []string	map[string][]string
remoteIP	string	string

MockResponse

Properties

Name	Type	Go type	Required	Default	Description	Example
body	string	string
headers	map of []string	map[string][]string
statusCode	integer	int64

NewAgentRequest

Properties

Name	Type	Go type	Required	Default	Description	Example
container_runtime	NewAgentRequest	NewAgentRequest		"docker"
host	string	string	✓
name	string	string	✓
nightly	boolean	bool
port	integer	int64	✓
type	string	string	✓

NewAgentResponse

Properties

Name	Type	Go type	Required	Default	Description	Example
ca	PEMPairResponse	PEMPairResponse
client	PEMPairResponse	PEMPairResponse
compose	string	string

PEMPairResponse

Properties

Name	Type	Go type	Required	Default	Description	Example
cert	base64 (formatted string)	string
key	base64 (formatted string)	string

ParsedRule

Properties

Name	Type	Go type	Required	Default	Description	Example
do	string	string
isResponseRule	boolean	bool
name	string	string
on	string	string
validationError	interface{}	interface{}			we need the structured error, not the plain string

PlaygroundRequest

Properties

Name	Type	Go type	Required	Default	Description	Example
mockRequest	MockRequest	MockRequest
mockResponse	MockResponse	MockResponse
rules	[]RouteAPIRawRule	[]*RouteAPIRawRule	✓

PlaygroundResponse

Properties

Name	Type	Go type	Required	Default	Description	Example
executionError	interface{}	interface{}			we need the structured error, not the plain string
finalRequest	FinalRequest	FinalRequest
finalResponse	FinalResponse	FinalResponse
matchedRules	[]string	[]string
parsedRules	[]ParsedRule	[]*ParsedRule
upstreamCalled	boolean	bool

Port

Properties

Name	Type	Go type	Required	Default	Description	Example
listening	integer	int64
proxy	integer	int64

ProviderStats

Properties

Name	Type	Go type	Required	Default	Description	Example
reverse_proxies	RouteStats	RouteStats
streams	RouteStats	RouteStats
total	integer	int64
type	ProviderType	ProviderType

ProviderType

Name	Type	Go type	Default	Description	Example
ProviderType	string	string

ProxmoxNodeConfig

Properties

Name	Type	Go type	Required	Default	Description	Example
files	[]string	[]string
node	string	string
services	[]string	[]string
vmid	integer	int64			unset: auto discover; explicit 0: node-level route; >0: lxc/qemu resource route
vmname	string	string

ProxyStats

Properties

Name	Type	Go type	Required	Default	Description	Example
providers	map of ProviderStats	map[string]ProviderStats
reverse_proxies	RouteStats	RouteStats
streams	RouteStats	RouteStats
total	integer	int64

RequestLoggerConfig

Properties

Name	Type	Go type	Required	Default	Description	Example
fields	AccesslogFields	AccesslogFields
filters	AccesslogFilters	AccesslogFilters
format	string	string
path	string	string
retention	LogRetention	LogRetention
rotate_interval	integer	int64
stdout	boolean	bool

Route

Properties

Name	Type	Go type	Required	Default	Description	Example
access_log	Route	Route
agent	string	string
alias	string	string
bind	string	string
container	Route	Route			Docker only
disable_compression	boolean	bool
excluded	boolean	bool
excluded_reason	string	string
health	Route	Route			for swagger
healthcheck	Route	Route			null on load-balancer routes
homepage	HomepageItemConfig	HomepageItemConfig
host	string	string
idlewatcher	Route	Route
index	string	string			Index file to serve for single-page app mode
load_balance	Route	Route
lurl	string	string			private fields
middlewares	map of TypesLabelMap	map[string]TypesLabelMap
no_tls_verify	boolean	bool
path_patterns	[]string	[]string
port	Port	Port
provider	string	string			for backward compatibility
proxmox	Route	Route
purl	string	string
response_header_timeout	integer	int64
root	string	string
rule_file	string	string
rules	[]RulesRule	[]*RulesRule
scheme	string	string
spa	boolean	bool			Single-page app mode: serves index for non-existent paths
ssl_certificate	string	string			Path to client certificate
ssl_certificate_key	string	string			Path to client certificate key
ssl_protocols	[]string	[]string			Allowed TLS protocols
ssl_server_name	string	string			SSL/TLS proxy options (nginx-like)
ssl_trusted_certificate	string	string			Path to trusted CA certificates

RouteProvider

Properties

Name	Type	Go type	Required	Default	Description	Example
full_name	string	string
short_name	string	string

RouteStats

Properties

Name	Type	Go type	Required	Default	Description	Example
error	integer	int64
healthy	integer	int64
napping	integer	int64
total	integer	int64
unhealthy	integer	int64
unknown	integer	int64

RouteStatus

Properties

Name	Type	Go type	Required	Default	Description	Example
latency	integer	int64
status	string	string
timestamp	integer	int64

RouteStatusesByAlias

Properties

Name	Type	Go type	Required	Default	Description	Example
statuses	map of HealthInfoWithoutDetail	map[string]HealthInfoWithoutDetail
timestamp	integer	int64

RouteUptimeAggregate

Properties

Name	Type	Go type	Required	Default	Description	Example
alias	string	string
avg_latency	number	float64
current_status	string	string
downtime	number	float64
idle	number	float64
statuses	[]RouteStatus	[]*RouteStatus
uptime	number	float64

ServerInfo

Properties

Name	Type	Go type	Required	Default	Description	Example
containers	ContainerStats	ContainerStats
images	integer	int64
memory	string	string
n_cpu	integer	int64
name	string	string
version	string	string

StatsResponse

Properties

Name	Type	Go type	Required	Default	Description	Example
proxies	ProxyStats	ProxyStats
uptime	integer	int64

StatusCodeRange

Properties

Name	Type	Go type	Required	Default	Description	Example
end	integer	int64
start	integer	int64

SuccessResponse

Properties

Name	Type	Go type	Required	Default	Description	Example
details	map of any	map[string]interface{}
message	string	string

SystemInfo

Properties

Name	Type	Go type	Required	Default	Description	Example
cpu_average	number	float64
disks	map of DiskUsageStat	map[string]DiskUsageStat			disk usage by partition
disks_io	map of DiskIOCountersStat	map[string]DiskIOCountersStat			disk IO by device
memory	MemVirtualMemoryStat	MemVirtualMemoryStat
network	NetIOCountersStat	NetIOCountersStat
sensors	[]SensorsTemperatureStat	[]*SensorsTemperatureStat			sensor temperature by key
timestamp	integer	int64

SystemInfoAggregate

Properties

Name	Type	Go type	Required	Default	Description	Example
data	[]map[string]interface{}	[]map[string]interface{}
total	integer	int64

SystemInfoAggregateMode

Name	Type	Go type	Default	Description	Example
SystemInfoAggregateMode	string	string

UptimeAggregate

Properties

Name	Type	Go type	Required	Default	Description	Example
data	[]RouteUptimeAggregate	[]*RouteUptimeAggregate
total	integer	int64

VerifyNewAgentRequest

Properties

Name	Type	Go type	Required	Default	Description	Example
ca	PEMPairResponse	PEMPairResponse
client	PEMPairResponse	PEMPairResponse
container_runtime	AgentContainerRuntime	AgentContainerRuntime
host	string	string

accesslog.FieldConfig

Properties

Name	Type	Go type	Required	Default	Description	Example
config	map of AccesslogFieldMode	map[string]AccesslogFieldMode
default	AccesslogFieldConfig	AccesslogFieldConfig

accesslog.FieldMode

Name	Type	Go type	Default	Description	Example
accesslog.FieldMode	string	string

accesslog.Fields

Properties

Name	Type	Go type	Required	Default	Description	Example
cookies	AccesslogFieldConfig	AccesslogFieldConfig
headers	AccesslogFieldConfig	AccesslogFieldConfig
query	AccesslogFieldConfig	AccesslogFieldConfig

accesslog.Filters

Properties

Name	Type	Go type	Required	Default	Description	Example
cidr	LogFilterCIDR	LogFilterCIDR
headers	AccesslogFilters	AccesslogFilters			header exists or header == value
host	LogFilterHost	LogFilterHost
method	LogFilterHTTPMethod	LogFilterHTTPMethod
status_codes	LogFilterStatusCodeRange	LogFilterStatusCodeRange

agent.ContainerRuntime

Name	Type	Go type	Default	Description	Example
agent.ContainerRuntime	string	string

agentpool.Agent

Properties

Name	Type	Go type	Required	Default	Description	Example
addr	string	string
name	string	string
runtime	AgentContainerRuntime	AgentContainerRuntime
supports_tcp_stream	boolean	bool
supports_udp_stream	boolean	bool
version	string	string

auth.UserPassAuthCallbackRequest

Properties

Name	Type	Go type	Required	Default	Description	Example
password	string	string
username	string	string

container.BlkioStatEntry

Properties

Name	Type	Go type	Required	Default	Description	Example
major	integer	int64
minor	integer	int64
op	string	string
value	integer	int64

container.BlkioStats

Properties

Name	Type	Go type	Required	Default	Description	Example
io_merged_recursive	[]ContainerBlkioStatEntry	[]*ContainerBlkioStatEntry
io_queue_recursive	[]ContainerBlkioStatEntry	[]*ContainerBlkioStatEntry
io_service_bytes_recursive	[]ContainerBlkioStatEntry	[]*ContainerBlkioStatEntry			number of bytes transferred to and from the block device
io_service_time_recursive	[]ContainerBlkioStatEntry	[]*ContainerBlkioStatEntry
io_serviced_recursive	[]ContainerBlkioStatEntry	[]*ContainerBlkioStatEntry
io_time_recursive	[]ContainerBlkioStatEntry	[]*ContainerBlkioStatEntry
io_wait_time_recursive	[]ContainerBlkioStatEntry	[]*ContainerBlkioStatEntry
sectors_recursive	[]ContainerBlkioStatEntry	[]*ContainerBlkioStatEntry

container.CPUStats

Properties

Name	Type	Go type	Required	Default	Description	Example
cpu_usage	ContainerCPUStats	ContainerCPUStats			CPU Usage. Linux and Windows.
online_cpus	integer	int64			Online CPUs. Linux only.
system_cpu_usage	integer	int64			System Usage. Linux only.
throttling_data	ContainerCPUStats	ContainerCPUStats			Throttling Data. Linux only.

container.CPUUsage

Properties

Name	Type	Go type	Required	Default	Description	Example
percpu_usage	[]integer	[]int64			Total CPU time consumed per core (Linux). Not used on Windows.Units: nanoseconds.
total_usage	integer	int64			Total CPU time consumed.Units: nanoseconds (Linux)Units: 100's of nanoseconds (Windows)
usage_in_kernelmode	integer	int64			Time spent by tasks of the cgroup in kernel mode (Linux).Time spent by all container processes in kernel mode (Windows).Units: nanoseconds (Linux).Units: 100's of nanoseconds (Windows). Not populated for Hyper-V Containers.
usage_in_usermode	integer	int64			Time spent by tasks of the cgroup in user mode (Linux).Time spent by all container processes in user mode (Windows).Units: nanoseconds (Linux).Units: 100's of nanoseconds (Windows). Not populated for Hyper-V Containers

container.ContainerState

Name	Type	Go type	Default	Description	Example
container.ContainerState	string	string

container.MemoryStats

Properties

Name	Type	Go type	Required	Default	Description	Example
commitbytes	integer	int64			committed bytes
commitpeakbytes	integer	int64			peak committed bytes
failcnt	integer	int64			number of times memory usage hits limits.
limit	integer	int64
max_usage	integer	int64			maximum usage ever recorded.
privateworkingset	integer	int64			private working set
stats	map of int64 (formatted integer)	map[string]int64			TODO(vishh): Export these as stronger types.all the stats exported via memory.stat.
usage	integer	int64			current res_counter usage for memory

container.NetworkStats

Properties

Name	Type	Go type	Required	Default	Description	Example
endpoint_id	string	string			Endpoint ID. Not used on Linux.
instance_id	string	string			Instance ID. Not used on Linux.
rx_bytes	integer	int64			Bytes received. Windows and Linux.
rx_dropped	integer	int64			Incoming packets dropped. Windows and Linux.
rx_errors	integer	int64			Received errors. Not used on Windows. Note that we don't omitempty thisfield as it is expected in the >=v1.21 API stats structure.
rx_packets	integer	int64			Packets received. Windows and Linux.
tx_bytes	integer	int64			Bytes sent. Windows and Linux.
tx_dropped	integer	int64			Outgoing packets dropped. Windows and Linux.
tx_errors	integer	int64			Sent errors. Not used on Windows. Note that we don't omitempty thisfield as it is expected in the >=v1.21 API stats structure.
tx_packets	integer	int64			Packets sent. Windows and Linux.

container.PidsStats

Properties

Name	Type	Go type	Required	Default	Description	Example
current	integer	int64			Current is the number of pids in the cgroup
limit	integer	int64			Limit is the hard limit on the number of pids in the cgroup.A "Limit" of 0 means that there is no limit.

container.PortSummary

Properties

Name	Type	Go type	Required	Default	Description	Example
IP	ContainerPortSummary	ContainerPortSummary			Host IP address that the container's port is mapped to
PrivatePort	integer	int64			Port on the containerRequired: true
PublicPort	integer	int64			Port exposed on the host
Type	string	string			typeRequired: trueEnum: ["tcp","udp","sctp"]

container.StorageStats

Properties

Name	Type	Go type	Required	Default	Description	Example
read_count_normalized	integer	int64
read_size_bytes	integer	int64
write_count_normalized	integer	int64
write_size_bytes	integer	int64

container.ThrottlingData

Properties

Name	Type	Go type	Required	Default	Description	Example
periods	integer	int64			Number of periods with throttling active
throttled_periods	integer	int64			Number of periods when the container hits its throttling limit.
throttled_time	integer	int64			Aggregate time the container was throttled for in nanoseconds.

disk.IOCountersStat

Properties

Name	Type	Go type	Required	Default	Description	Example
iops	integer	int64
name	string	string			ReadCount uint64 json:"readCount"MergedReadCount uint64 json:"mergedReadCount"WriteCount uint64 json:"writeCount"MergedWriteCount uint64 json:"mergedWriteCount"ReadBytes uint64 json:"readBytes"WriteBytes uint64 json:"writeBytes"ReadTime uint64 json:"readTime"WriteTime uint64 json:"writeTime"IopsInProgress uint64 json:"iopsInProgress"IoTime uint64 json:"ioTime"WeightedIO uint64 json:"weightedIO"
read_bytes	integer	int64			SerialNumber string json:"serialNumber"Label string json:"label"
read_count	integer	int64
read_speed	number	float64
write_bytes	integer	int64
write_count	integer	int64
write_speed	number	float64

disk.UsageStat

Properties

Name	Type	Go type	Required	Default	Description	Example
free	integer	int64
fstype	string	string
path	string	string
total	number	float64
used	integer	int64
used_percent	number	float64

dockerapi.RestartRequest

Properties

Name	Type	Go type	Required	Default	Description	Example
id	string	string	✓
signal	string	string			Signal (optional) is the signal to send to the container to (gracefully)stop it before forcibly terminating the container with SIGKILL after thetimeout expires. If no value is set, the default (SIGTERM) is used.
timeout	integer	int64			Timeout (optional) is the timeout (in seconds) to wait for the containerto stop gracefully before forcibly terminating it with SIGKILL.- Use nil to use the default timeout (10 seconds).- Use '-1' to wait indefinitely.- Use '0' to not wait for the container to exit gracefully, and immediately proceeds to forcibly terminating the container.- Other positive values are used as timeout (in seconds).

dockerapi.StartRequest

Properties

Name	Type	Go type	Required	Default	Description	Example
checkpointDir	string	string
checkpointID	string	string
id	string	string	✓

dockerapi.StopRequest

Properties

Name	Type	Go type	Required	Default	Description	Example
id	string	string	✓
signal	string	string			Signal (optional) is the signal to send to the container to (gracefully)stop it before forcibly terminating the container with SIGKILL after thetimeout expires. If no value is set, the default (SIGTERM) is used.
timeout	integer	int64			Timeout (optional) is the timeout (in seconds) to wait for the containerto stop gracefully before forcibly terminating it with SIGKILL.- Use nil to use the default timeout (10 seconds).- Use '-1' to wait indefinitely.- Use '0' to not wait for the container to exit gracefully, and immediately proceeds to forcibly terminating the container.- Other positive values are used as timeout (in seconds).

events.Level

Name	Type	Go type	Default	Description	Example
events.Level	string	string

icons.Source

Name	Type	Go type	Default	Description	Example
icons.Source	string	string

mem.VirtualMemoryStat

Properties

Name	Type	Go type	Required	Default	Description	Example
available	integer	int64			RAM available for programs to allocateThis value is computed from the kernel specific values.
total	number	float64			Total amount of RAM on this system
used	integer	int64			RAM used by programsThis value is computed from the kernel specific values.
used_percent	number	float64			Percentage of RAM used by programsThis value is computed from the kernel specific values.

net.IOCountersStat

Properties

Name	Type	Go type	Required	Default	Description	Example
bytes_recv	integer	int64			number of bytes received
bytes_sent	integer	int64			Name string json:"name" // interface name
download_speed	number	float64			godoxy
upload_speed	number	float64			godoxy

netip.Addr

interface{}

proxmox.NodeStats

Properties

Name	Type	Go type	Required	Default	Description	Example
cpu_model	string	string
cpu_usage	string	string
kernel_version	string	string
load_avg_15m	string	string
load_avg_1m	string	string
load_avg_5m	string	string
mem_pct	string	string
mem_total	string	string
mem_usage	string	string
pve_version	string	string
rootfs_pct	string	string
rootfs_total	string	string
rootfs_usage	string	string
uptime	string	string

routeApi.RawRule

Properties

Name	Type	Go type	Required	Default	Description	Example
do	string	string
name	string	string
on	string	string

routeApi.RoutesByProvider

Route

rules.Rule

Properties

Name	Type	Go type	Required	Default	Description	Example
do	string	string
name	string	string
on	string	string

sensors.TemperatureStat

Properties

Name	Type	Go type	Required	Default	Description	Example
critical	number	float64
high	number	float64
name	string	string
temperature	number	float64

time.Duration

Name	Type	Go type	Default	Description	Example
time.Duration	int64 (formatted integer)	int64

types.LabelMap

TypesLabelMap

types.PortMapping

TypesPortMapping

widgets.Config

Properties

Name	Type	Go type	Required	Default	Description	Example
config	interface{}	interface{}
provider	string	string