app.delete ========== Delete ``app_name`` app. ``force_remove_custom_app`` should be set when the app being deleted is a custom app and the user wants to forcefully remove the app. A use-case for this attribute is that the user had an invalid yaml in their custom app and there are no actual docker resources (network/containers/volumes) in place for the custom app, then docker compose down will fail as the yaml itself is invalid. In this case this flag can be set to proceed with the deletion of the custom app. However if this app had any docker resources in place, then this flag will have no effect. This method is a job. .. raw:: html
Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: app_name

app_name

Type: string

Name of the application to delete.

Must be at least 1 characters long

Parameter 2: options

options

Type: object
Default:
{ "remove_images": true, "remove_ix_volumes": false, "force_remove_custom_app": false }

Options controlling what gets removed along with the application.

 No Additional Properties

Remove Images

Type: boolean Default: true

Whether to remove Docker images associated with the application.

Remove Ix Volumes

Type: boolean Default: false

Whether to remove TrueNAS-managed storage volumes.

Force Remove Custom App

Type: boolean Default: false

Force removal of custom applications that might have important data or configurations.

Result

Type: const

Returns true when the application is successfully deleted.

Specific value: true


*Required roles:* APPS_WRITE