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

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/callback	get auth callback	Auth Callback
HEAD	/api/v1/auth/check	head auth check	Check authentication status
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/containers	get docker containers	Get containers
GET	/api/v1/docker/info	get docker info	Get docker info
GET	/api/v1/docker/logs/{server}/	get docker logs server container	Get docker container logs

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/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_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/system_info	get metrics system info	Get system info
GET	/api/v1/metrics/uptime	get metrics uptime	Get uptime

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/	get route which	List route

version1

Method	URI	Name	Summary
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
POST	/api/v1/reload	post reload	Reload config

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
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

[]Agent

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

500 - Internal Server Error

Status: Internal Server Error

Schema

ErrorResponse

Auth Callback (GetAuthCallback)

GET /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

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	Forbidden		schema
404	Not Found	Not Found		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - OK

Status: OK

Schema

CertInfo

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

404 - Not Found

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 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 (GetDockerLogsServerContainer)

GET /api/v1/docker/logs/{server}/{container}

Get docker container logs

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
container	path	string	string		✓		container id
server	path	string	string		✓		server name
from	query	string	string				from timestamp
levels	query	string	string				levels
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	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 - Not Found

Status: Not Found

Schema

ErrorResponse

500 - Internal Server 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

[]HomepageFetchResult

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

Responses

200 - OK

Status: OK

Schema

[]string

403 - Forbidden

Status: Forbidden

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

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

HomepageItems

400 - Bad Request

Status: Bad Request

Schema

ErrorResponse

403 - Forbidden

Status: Forbidden

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

[]HomepageIconMetaSearch

400 - Bad Request

Status: Bad Request

Schema

ErrorResponse

403 - Forbidden

Status: Forbidden

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
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

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

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
403	Forbidden	Forbidden: use X-Redirect-To header to redirect to login page		schema

Responses

200 - OK

Status: OK

Schema

403 - Forbidden: use X-Redirect-To header to redirect to login page

Status: Forbidden

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

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
403	Forbidden	Forbidden(webui): follow X-Redirect-To header		schema
429	Too Many Requests	Too Many Requests		schema

Responses

302 - Redirects to login page or IdP

Status: Found

Schema

403 - Forbidden(webui): follow X-Redirect-To header

Status: Forbidden

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

Validate file (PostFileValidate)

POST /api/v1/file/validate

Validate file

Consumes

• text/plain

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

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 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

Reload config (PostReload)

POST /api/v1/reload

Reload config

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

SuccessResponse

403 - Forbidden

Status: Forbidden

Schema

ErrorResponse

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
is_nerdctl	boolean	bool
name	string	string
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	Agent	Agent
aliases	[]string	[]string
container_id	string	string
container_name	string	string
docker_host	string	string
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

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	ContainerState	ContainerState

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

ContainerStopMethod

Name	Type	Go type	Default	Description	Example
ContainerStopMethod	string	string

DockerConfig

Properties

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

ErrorResponse

Properties

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

FileType

Name	Type	Go type	Default	Description	Example
FileType	string	string

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: 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{}

HealthJSON

Properties

Name	Type	Go type	Required	Default	Description	Example
config	HealthCheckConfig	HealthCheckConfig
detail	string	string
extra	HealthJSON	HealthJSON
lastSeen	integer	int64
lastSeenStr	string	string
latency	number	float64
latencyStr	string	string
name	string	string
started	integer	int64
startedStr	string	string
status	string	string
uptime	number	float64
uptimeStr	string	string
url	string	string

HealthMap

HealthMap

HomepageItems

HomepageItem

HomepageOverrideCategoryOrderParams

Properties

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

HomepageOverrideItemParams

Properties

Name	Type	Go type	Required	Default	Description	Example
value	HomepageItemConfig	HomepageItemConfig
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

IdlewatcherConfig

Properties

Name	Type	Go type	Required	Default	Description	Example
depends_on	[]string	[]string
docker	DockerConfig	DockerConfig
idle_timeout	IdlewatcherConfig	IdlewatcherConfig			0: no idle watcher.Positive: idle watcher with idle timeout.Negative: idle watcher as a dependency. IdleTimeout time.Duration json:"idle_timeout" json_ext:"duration"
proxmox	ProxmoxConfig	ProxmoxConfig
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

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{}
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

NewAgentRequest

Properties

Name	Type	Go type	Required	Default	Description	Example
container_runtime	NewAgentRequest	NewAgentRequest
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

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

ProxmoxConfig

Properties

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

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
buffer_size	integer	int64			Deprecated: buffer size is adjusted dynamically
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
container	Route	Route			Docker only
disable_compression	boolean	bool
excluded	boolean	bool
health	Route	Route			for swagger
healthcheck	HealthCheckConfig	HealthCheckConfig
homepage	HomepageItemConfig	HomepageItemConfig
host	string	string
idlewatcher	Route	Route
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	RoutePort	RoutePort
provider	string	string			for backward compatibility
purl	string	string
response_header_timeout	integer	int64
root	string	string
rules	[]RulesRule	[]*RulesRule
scheme	RouteScheme	RouteScheme

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 RoutesHealthInfo	map[string]RoutesHealthInfo
timestamp	integer	int64

RouteUptimeAggregate

Properties

Name	Type	Go type	Required	Default	Description	Example
alias	string	string
avg_latency	number	float64
display_name	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	string	string

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

auth.UserPassAuthCallbackRequest

Properties

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

container.Port

Properties

Name	Type	Go type	Required	Default	Description	Example
IP	string	string			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: true

disk.IOCountersStat

Properties

Name	Type	Go type	Required	Default	Description	Example
iops	integer	int64			godoxy
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			godoxy
write_bytes	integer	int64
write_count	integer	int64
write_speed	number	float64			godoxy

disk.UsageStat

Properties

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

homepage.FetchResult

Properties

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

homepage.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	HomepageIconSource	HomepageIconSource
WebP	boolean	bool

homepage.IconSource

Name	Type	Go type	Default	Description	Example
homepage.IconSource	string	string

homepage.Item

Properties

Name	Type	Go type	Required	Default	Description	Example
alias	string	string
category	string	string
description	string	string
icon	string	string
name	string	string			display name
origin_url	string	string
provider	string	string
show	boolean	bool
sort_order	integer	int64
url	string	string
widget_config	HomepageItem	HomepageItem

homepage.ItemConfig

Properties

Name	Type	Go type	Required	Default	Description	Example
category	string	string
description	string	string
icon	string	string
name	string	string			display name
show	boolean	bool
sort_order	integer	int64
url	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.
free	integer	int64			This is the kernel's notion of free memory; RAM chips whose bits nobodycares about the value of right now. For a human consumable number,Available is what you really want.
total	integer	int64			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

route.Port

Properties

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

route.Route

Properties

Name	Type	Go type	Required	Default	Description	Example
access_log	RouteRoute	RouteRoute
agent	string	string
alias	string	string
container	RouteRoute	RouteRoute			Docker only
disable_compression	boolean	bool
excluded	boolean	bool
health	RouteRoute	RouteRoute			for swagger
healthcheck	HealthCheckConfig	HealthCheckConfig
homepage	HomepageItemConfig	HomepageItemConfig
host	string	string
idlewatcher	RouteRoute	RouteRoute
load_balance	RouteRoute	RouteRoute
lurl	string	string			private fields
middlewares	map of TypesLabelMap	map[string]TypesLabelMap
no_tls_verify	boolean	bool
path_patterns	[]string	[]string
port	RoutePort	RoutePort
provider	string	string			for backward compatibility
purl	string	string
response_header_timeout	integer	int64
root	string	string
rules	[]RulesRule	[]*RulesRule
scheme	RouteScheme	RouteScheme

route.Scheme

Name	Type	Go type	Default	Description	Example
route.Scheme	string	string

routeApi.RoutesByProvider

RouteRoute

routes.HealthInfo

Properties

Name	Type	Go type	Required	Default	Description	Example
detail	string	string
latency	number	float64			latency in microseconds
status	string	string
uptime	number	float64			uptime in milliseconds

rules.Command

interface{}

rules.Rule

Properties

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

rules.RuleOn

interface{}

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