API
Authorization
Header X-Api-Key:{apikey}
Parameter ?apikey={apikey}
Example
curl -H "X-Api-Key:{apikey}" "http://{host}:9999/api/database/containers"
Responses
All responses are JSON with possible response codes:
Success
Missing required param(s)
Invalid apikey
Invalid endpoint or method for the used endpoint
Success example:
{
"code": 200,
"response": {
"result": ....
}
}
Error example:
{
"code": 405,
"error": "Invalid GET request (endpoint=database/fake-endpoint)"
}
/api/database/* - 25
container/add
Endpoint: /api/database/container/add
Usage: Add a containers settings to the database
| Parameter | Type | Required |
|---|---|---|
hash |
str | yes |
updates |
int | no |
frequency |
str | no |
restartUnhealthy |
int | no |
disableNotifications |
int | no |
shutdownDelay |
int | no |
shutdownDelaySeconds |
int | no |
container/group/add
Endpoint: /api/database/container/group/add
Usage: Add a new container group to the database
| Parameter | Type | Required |
|---|---|---|
name |
str | yes |
container/group/delete
Endpoint: /api/database/container/group/delete
Usage: Remove a container group from the database
| Parameter | Type | Required |
|---|---|---|
id |
int | yes |
container/hash
Endpoint: /api/database/container/hash
Usage: Get a container from the database using its hash
| Parameter | Type | Required |
|---|---|---|
hash |
str | yes |
container/update
Endpoint: /api/database/container/update
Usage: Get a container from the database using its hash
| Parameter | Type | Required |
|---|---|---|
hash |
str | yes |
updates |
int | no |
frequency |
str | no |
restartUnhealthy |
int | no |
disableNotifications |
int | no |
shutdownDelay |
int | no |
shutdownDelaySeconds |
int | no |
containers
Endpoint: /api/database/containers
Usage: Return a list of containers that have settings in the database
No parameters
group/container/link/add
Endpoint: /api/database/group/container/link/add
Usage: Add a container to a group
| Parameter | Type | Required |
|---|---|---|
groupId |
int | yes |
containerId |
int | yes |
group/container/link/remove
Endpoint: /api/database/group/container/link/remove
Usage: Remove a container from a group
| Parameter | Type | Required |
|---|---|---|
groupId |
int | yes |
containerId |
int | yes |
group/container/links
Endpoint: /api/database/group/container/links
Usage: Return a list of containers linked to a group using its id
| Parameter | Type | Required |
|---|---|---|
group |
int | yes |
group/container/update
Endpoint: /api/database/group/container/update
Usage: Update the container group
| Parameter | Type | Required |
|---|---|---|
name |
str | yes |
id |
int | yes |
group/hash
Endpoint: /api/database/group/hash
Usage: Get a group from the database using its hash
| Parameter | Type | Required |
|---|---|---|
hash |
str | yes |
group/links
Endpoint: /api/database/group/links
Usage: Return a list of group/container links from the database
No parameters
groups
Endpoint: /api/database/groups
Usage: Return a list of groups from the database
No parameters
migrations
Endpoint: /api/database/migrations
Usage: Trigger a migration check
No parameters
links
Endpoint: /api/database/links
Usage: Return a list of notification/platform links
No parameters
notification/link/add
Endpoint: /api/database/notification/link/add
Usage: Add a new notification notifier to the database
| Parameter | Type | Required |
|---|---|---|
platformId |
int | yes |
triggerIds |
list | yes |
platformParameters |
object | yes |
senderName |
str | yes |
notification/link/delete
Endpoint: /api/database/notification/link/delete
Usage: Remove a notification notifier from the database
| Parameter | Type | Required |
|---|---|---|
linkId |
str | yes |
notification/link/platform/name
Endpoint: /api/database/notification/link/platform/name
Usage: Get a notification link using its name
| Parameter | Type | Required |
|---|---|---|
name |
str | yes |
notification/link/update
Endpoint: /api/database/notification/link/update
Usage: Update an existing notification notifier in the database
| Parameter | Type | Required |
|---|---|---|
linkId |
int | yes |
platformId |
int | yes |
triggerIds |
list | yes |
platformParameters |
object | yes |
senderName |
str | yes |
notification/platforms
Endpoint: /api/database/notification/platforms
Usage: Return a list of notification platforms
No parameters
notification/triggers
Endpoint: /api/database/notification/triggers
Usage: Return a list of notification triggers
No parameters
notification/trigger/enabled
Endpoint: /api/database/notification/trigger/enabled
Usage: Get enabled status for a specific notification using its id
| Parameter | Type | Required |
|---|---|---|
trigger |
int | yes |
servers
Endpoint: /api/database/servers
Usage: Get/set a list of linked servers (other Dockwatch instances)
No parameters
| Parameter | Type | Required |
|---|---|---|
serverList |
object | yes |
setting
Endpoint: /api/database/setting
Usage: U&pdate a setting
| Parameter | Type | Required |
|---|---|---|
setting |
str | yes |
value |
any | yes |
settings
Endpoint: /api/database/settings
Usage: Get/set a list of Dockwatch settings
No parameters
| Parameter | Type | Required |
|---|---|---|
newSettings |
object | yes |
/api/docker/* - 24
container/create
Endpoint: /api/docker/container/create
Usage: Create a container from an inspect object
| Parameter | Type | Required |
|---|---|---|
inspect |
object | yes |
container/inspect
Endpoint: /api/docker/container/inspect
Usage: Return information about a container
| Parameter | Type | Required |
|---|---|---|
name |
str | yes |
container/kill
Endpoint: /api/docker/container/kill
Usage: Kill a container
| Parameter | Type | Required |
|---|---|---|
name |
str | yes |
container/logs
Endpoint: /api/docker/container/logs
Usage: Return the logs from a container
No parameters
container/pull
Endpoint: /api/docker/container/pull
Usage: Pull a container
| Parameter | Type | Required |
|---|---|---|
name |
str | yes |
container/ports
Endpoint: /api/docker/container/ports
Usage: Return a list of ports used by a container
| Parameter | Type | Required |
|---|---|---|
name |
str | yes |
container/remove
Endpoint: /api/docker/container/remove
Usage: Remove a container
| Parameter | Type | Required |
|---|---|---|
name |
str | yes |
container/restart
Endpoint: /api/docker/container/restart
Usage: Restart a container
| Parameter | Type | Required |
|---|---|---|
name |
str | yes |
container/start
Endpoint: /api/docker/container/start
Usage: Start a container
| Parameter | Type | Required |
|---|---|---|
name |
str | yes |
container/stop
Endpoint: /api/docker/container/stop
Usage: Stop a container
| Parameter | Type | Required |
|---|---|---|
name |
str | yes |
create/compose
Endpoint: /api/docker/create/compose
Usage: Genertate a compose file for a container
| Parameter | Type | Required |
|---|---|---|
name |
str | yes |
create/run
Endpoint: /api/docker/create/run
Usage: Genertate a docker run command for a container
| Parameter | Type | Required |
|---|---|---|
name |
str | yes |
image/remove
Endpoint: /api/docker/image/remove
Usage: Remove an image
| Parameter | Type | Required |
|---|---|---|
image |
str | yes |
images/sizes
Endpoint: /api/docker/images/sizes
Usage: Return a list of image sizes
No parameters
network/remove
Endpoint: /api/docker/network/remove
Usage: Remove a network
| Parameter | Type | Required |
|---|---|---|
name |
str | yes |
networks
Endpoint: /api/docker/networks
Usage: Return a list of the docker networks
No parameters
orphans/containers
Endpoint: /api/docker/orphans/containers
Usage: Return a list of containers
No parameters
orphans/networks
Endpoint: /api/docker/orphans/networks
Usage: Return a list of orphaned networks
No parameters
orphans/volumes
Endpoint: /api/docker/orphans/volumes
Usage: Return a list of orphaned volumes
No parameters
permissions
Endpoint: /api/docker/permissions
Usage: Check if the user:group has access to the docker sock
No parameters
processList
Endpoint: /api/docker/processList
Usage: Return the current docker processlist
No parameters
stats
Endpoint: /api/docker/stats
Usage: Returns the cached information used in the UI
No parameters
unused/containers
Endpoint: /api/docker/unused/containers
Usage: Return a list of unused containers
No parameters
volume/remove
Endpoint: /api/docker/volume/remove
Usage: Remove a volume
| Parameter | Type | Required |
|---|---|---|
id |
str | yes |
/api/dockerAPI/* - 1
container/create
Endpoint: /api/dockerAPI/container/create
Usage: Recreate a container based on its inspect using the docker API
| Parameter | Type | Required |
|---|---|---|
name |
str | yes |
/api/file/* - 5
dependency
Endpoint: /api/file/dependency
Usage: Get/set the contents of the dependency json file
No parameters
| Parameter | Type | Required |
|---|---|---|
contents |
json object | yes |
pull
Endpoint: /api/file/pull
Usage: Get/set the contents of the pull json file
No parameters
| Parameter | Type | Required |
|---|---|---|
contents |
json object | yes |
sse
Endpoint: /api/file/sse
Usage: Get/set the contents of the sse json file
No parameters
| Parameter | Type | Required |
|---|---|---|
contents |
json object | yes |
state
Endpoint: /api/file/state
Usage: Get/set the contents of the state json file
No parameters
| Parameter | Type | Required |
|---|---|---|
contents |
json object | yes |
stats
Endpoint: /api/file/stats
Usage: Get/set the contents of the stats json file
No parameters
| Parameter | Type | Required |
|---|---|---|
contents |
json object | yes |
/api/notification/* - 1
notification/test
Endpoint: /api/notification/test
Usage: Send a test notification to a specific trigger
| Parameter | Type | Required |
|---|---|---|
linkId |
int | yes |
name |
str | yes |
/api/server/* - 5
log
Endpoint: /api/server/log
Usage: Return a specific log contents
| Parameter | Type | Required |
|---|---|---|
name |
str | yes |
log/delete
Endpoint: /api/server/log/delete
Usage: Delete a Specific log
| Parameter | Type | Required |
|---|---|---|
log |
str | yes |
log/purge
Endpoint: /api/server/log/purge
Usage: Delete all logs in a group
| Parameter | Type | Required |
|---|---|---|
group |
str | yes |
ping
Endpoint: /api/server/ping
Usage: Check if the instance is online
No parameters
task/run
Endpoint: /api/server/task/run
Usage: Trigger a task to run
| Parameter | Type | Required |
|---|---|---|
task |
str | yes |
/api/stats/* - 2
containers
Endpoint: /api/stats/containers
Usage: Returns the container list used by dashboard apps
No parameters
overview
Endpoint: /api/stats/overview
Usage: Returns the overview list used by dashboard apps
No parameters