Docker

Containers, the Docker daemon configuration, events and container files. Generated from the `notploy` command surface.

Containers, the Docker daemon configuration, events and container files.

notploy docker exposes 20 commands. They map one-to-one onto the docker.* API operations, so anything reachable from the dashboard is reachable from here.

Run notploy docker --help to list these commands in your terminal, or notploy docker <command> --help for a single command.

Commands

`notploy docker delete-container-file`

Calls POST /api/trpc/docker.deleteContainerFile.

notploy docker delete-container-file --containerId <value> --path <value> [options]

Option	Type	Required	Allowed values
`--containerId <value>`	string	Yes	—
`--path <value>`	string	Yes	—
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy docker get-config`

Calls GET /api/trpc/docker.getConfig.

notploy docker get-config --containerId <value> [options]

Option	Type	Required	Allowed values
`--containerId <value>`	string	Yes	—
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy docker get-containers`

Calls GET /api/trpc/docker.getContainers.

notploy docker get-containers [options]

Option	Type	Required	Allowed values
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy docker get-containers-by-app-label`

Calls GET /api/trpc/docker.getContainersByAppLabel.

notploy docker get-containers-by-app-label --appName <value> --type <value> [options]

Option	Type	Required	Allowed values
`--appName <value>`	string	Yes	—
`--serverId <value>`	string	No	—
`--type <value>`	string	Yes	`standalone`, `swarm`
`--profile <name>`	string	No	—

`notploy docker get-containers-by-app-name-match`

Calls GET /api/trpc/docker.getContainersByAppNameMatch.

notploy docker get-containers-by-app-name-match --appName <value> [options]

Option	Type	Required	Allowed values
`--appType <value>`	string	No	`stack`, `docker-compose`
`--appName <value>`	string	Yes	—
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy docker get-engine-info`

Calls GET /api/trpc/docker.getEngineInfo.

notploy docker get-engine-info [options]

Option	Type	Required	Allowed values
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy docker get-events`

Calls GET /api/trpc/docker.getEvents.

notploy docker get-events [options]

Option	Type	Required	Allowed values
`--serverId <value>`	string	No	—
`--minutes <value>`	number	No	—
`--profile <name>`	string	No	—

`notploy docker get-fleet-containers`

Calls GET /api/trpc/docker.getFleetContainers.

notploy docker get-fleet-containers [options]

Option	Type	Required	Allowed values
`--profile <name>`	string	No	—

`notploy docker get-server-health`

Calls GET /api/trpc/docker.getServerHealth.

notploy docker get-server-health [options]

Option	Type	Required	Allowed values
`--serverId <value>`	string	No	—
`--sinceHours <value>`	number	No	—
`--profile <name>`	string	No	—

`notploy docker get-service-containers-by-app-name`

Calls GET /api/trpc/docker.getServiceContainersByAppName.

notploy docker get-service-containers-by-app-name --appName <value> [options]

Option	Type	Required	Allowed values
`--appName <value>`	string	Yes	—
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy docker get-stack-containers-by-app-name`

Calls GET /api/trpc/docker.getStackContainersByAppName.

notploy docker get-stack-containers-by-app-name --appName <value> [options]

Option	Type	Required	Allowed values
`--appName <value>`	string	Yes	—
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy docker kill-container`

Calls POST /api/trpc/docker.killContainer.

notploy docker kill-container --containerId <value> [options]

Option	Type	Required	Allowed values
`--containerId <value>`	string	Yes	—
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy docker list-container-files`

Calls GET /api/trpc/docker.listContainerFiles.

notploy docker list-container-files --containerId <value> --path <value> [options]

Option	Type	Required	Allowed values
`--containerId <value>`	string	Yes	—
`--path <value>`	string	Yes	—
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy docker read-container-file`

Calls GET /api/trpc/docker.readContainerFile.

notploy docker read-container-file --containerId <value> --path <value> [options]

Option	Type	Required	Allowed values
`--containerId <value>`	string	Yes	—
`--path <value>`	string	Yes	—
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy docker remove-container`

Calls POST /api/trpc/docker.removeContainer.

notploy docker remove-container --containerId <value> [options]

Option	Type	Required	Allowed values
`--containerId <value>`	string	Yes	—
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy docker restart-container`

Calls POST /api/trpc/docker.restartContainer.

notploy docker restart-container --containerId <value> [options]

Option	Type	Required	Allowed values
`--containerId <value>`	string	Yes	—
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy docker start-container`

Calls POST /api/trpc/docker.startContainer.

notploy docker start-container --containerId <value> [options]

Option	Type	Required	Allowed values
`--containerId <value>`	string	Yes	—
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy docker stop-container`

Calls POST /api/trpc/docker.stopContainer.

notploy docker stop-container --containerId <value> [options]

Option	Type	Required	Allowed values
`--containerId <value>`	string	Yes	—
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy docker upload-file-to-container`

Calls POST /api/trpc/docker.uploadFileToContainer.

notploy docker upload-file-to-container [options]

Option	Type	Required	Allowed values
`--profile <name>`	string	No	—

`notploy docker write-container-file`

Calls POST /api/trpc/docker.writeContainerFile.

notploy docker write-container-file --containerId <value> --path <value> --content <value> [options]

Option	Type	Required	Allowed values
`--containerId <value>`	string	Yes	—
`--path <value>`	string	Yes	—
`--content <value>`	string	Yes	—
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

On this page