Skip to content

container/id

Identifies the target container for the generic containerStop and containerExec actions.

The container to operate on, for containerStop and containerExec.

This accepts either the container engine id returned in the Id field of containerStart's response, or the name the container was started with (container/name). Both work equally well: container inspect itself accepts either an id or a name, so the generic actions pass this value through unchanged rather than requiring a caller to look up one from the other.

Accepted values are constrained to ^[A-Za-z0-9][A-Za-z0-9_.-]{0,127}$ -- a leading letter or digit, then letters, digits, _, . or -. Anything else is rejected with a 422 before the container engine is invoked. This is deliberate and must not be relaxed: the value reaches the engine's argument list, and podman (which the plugin prefers over docker) reads --all and -l as flags on both container stop and container rm, so an unvalidated value of --all would remove every container on the host.

Never set this on the global profile. Action parameters aggregate from the global profile the same way plugin Config parameters do, so a container/id set there is silently supplied to every containerStop or containerExec call that does not pass one explicitly -- stopping, or running a command in, a container the caller never named. Always pass this per call.

Objects that Reference container/id

Not used in current content packs

Objects used by container/id

Not used in current content packs