/
/container-compose API
DocsSign in
Sign in
  • APIs
  • Generators
  • Stacks
  • Projects
  • Docs
  • History
  • Schema
Checked 1h ago · Updated 1mo ago
  • getDaemon liveness probe
  • getReturn daemon version metadata
  • getReturn daemon info and container counts
  • getList containers
  • postCreate a container
  • getInspect a container
  • deleteRemove a container
  • postStart a container
  • postStop a container
  • postRestart a container
  • postSend a signal to a container
  • postWait for a container to exit
  • postExecute a command in a container
  • getList container processes
  • getStream container logs (NDJSON)
  • getStream container stats (NDJSON)
  • getList networks
  • postCreate a network
  • deleteRemove a network
  • getList volumes
  • postCreate a volume
  • deleteRemove a volume
  • getList secret metadata
  • postCreate a secret
  • deleteRemove a secret
  • getStream lifecycle events (NDJSON)
  • postPush an image from the runtime host
  • getList compose projects
  • getGet project detail (ingested or synthesized)
  • postIngest a compose YAML document
  • getList services in a project
  • postBring up a project
  • postTake down a project
  • postRestart a project
  • postBuild project images (NDJSON streaming)
  • postPull project images (NDJSON streaming)
  • postScale a service
  • getPrometheus metrics exposition
  • getThis OpenAPI specification

Execute a command in a container

post/containers/{id}/exec

Path parameters

idstring required

Request body

commandstring[] required
detachboolean nullable
interactiveboolean nullable
ttyboolean nullable
environmentstring[]
userstring nullable
workingDirectorystring nullable

Response

Command result

stdoutstring[] required
stderrstring[] required
exitCodeinteger required

Changes