container.stop

Stop id container.

This method is a job.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

Container ID.
Parameter 2: options

options

Type: object
Default:
{ "force": false, "force_after_timeout": false }

Container stop options.

 No Additional Properties

Force

Type: boolean Default: false

Kill the container.

Force After Timeout

Type: boolean Default: false

Kill the container if it does not stop within the shutdown_timeout.

Result

Type: null


Required roles: CONTAINER_WRITE