apps

Put Params

Changed on

Save an app's param values (design doc 1.2 validation, applied at next start).

Raises: PortalError: 404 app_not_found; 409 app_job_in_progress while an install/update/delete job targets this app; 422 params_invalid (with every violation) if a value fails its declared type/min/max/pattern/choices.

put/api/v1/apps/{name}/params

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

namestring required

Request body

paramsobject required

Response

Successful Response

autostartboolean required
bindingsobject required
broken_reasonstring nullable required
descriptionstring required
devicesstring[] required
exit_codeinteger nullable
idstring required
installed_atnumber nullable required
namestring required
paramsobject required
reasonstring nullable
status'stopped' | 'broken' | 'installing' | 'updating' | 'deleting' | 'running' | 'starting' | 'stopping' | 'failed' | 'needs_repair' required
urlstring nullable

Changes