apps

Put Source

Changed on

Change a git-sourced app's pinned ref/ref_kind, applied by the next update (design doc 3.2).

Raises: PortalError: 404 app_not_found; 409 app_job_in_progress while an install/update/delete job targets this app; 409 source_update_git_only for a zip-sourced app.

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

Request

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

Path parameters

namestring required

Request body

refstring required
ref_kind'branch' | 'tag' 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