app.delete

Delete app_name app.

force_remove_ix_volumes should be set when the ix-volumes were created by the system for apps which were migrated from k8s to docker and the user wants to remove them. This is to prevent accidental deletion of the original ix-volumes which were created in dragonfish and before for kubernetes based apps. When this is set, it will result in the deletion of ix-volumes from both docker based apps and k8s based apps and should be carefully set.

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 user had an invalid yaml in his 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.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: app_name

app_name

Type: string

Must be at least 1 characters long

Parameter 2: options

options

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

No Additional Properties

Remove Images

Type: boolean Default: true

Remove Ix Volumes

Type: boolean Default: false

Force Remove Ix Volumes

Type: boolean Default: false

Force Remove Custom App

Type: boolean Default: false

Result

Type: const
Must be one of:
  • true
Specific value: true


Required roles: APPS_WRITE