app.image.delete

Delete docker image image_id.

options.force when set will force delete the image regardless of the state of containers and should be used cautiously.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: image_id

image_id

Type: string

Container image ID or reference to delete.
Parameter 2: options

options

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

Deletion options controlling force removal behavior.

 No Additional Properties

Force

Type: boolean Default: false

Whether to force deletion even if the image is in use by containers.

Result

Type: const

Returns true when the container image is successfully deleted.

Must be one of:
  • true
Specific value: true


Required roles: APPS_WRITE