Update Channel

Change a channel's branch binding, whether it follows that branch, or both.

The scope and role are create_channel's: channel:* and a MEMBER. The branch does not have to exist in the repo yet. channels/service.py::set_binding validates the binding and journals the change.

Turning follows_branch on also takes deploy:*, because from then on each GitHub push deploys the channel. It needs a GitHub connection and a binding (channels/service.py::set_follows_branch). Turning it off is always accepted. A body that carries both fields applies the binding first, so one request can bind a branch and follow it.

patch/apps/{app_id}/channels/{channel_id}

Request

  • Base URL: https://api.xhostd.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.xhostd.com/apps/{app_id}/channels/{channel_id}
  • Auth: none declared

Path parameters

app_idstring uuid required
channel_idstring uuid required

Headers

authorizationstring nullable

Request body

git_ref_bindingstring nullable
follows_branchboolean nullable

Response

Successful Response

idstring uuid required
namestring required
hostnamestring required
git_ref_bindingstring nullable required
follows_branchboolean required
current_shastring nullable required
statusstring required

Changes

No recorded changes to this operation across all 1 revision of this API.