Deployments

Link a GitHub repository via the Square Cloud GitHub App

Associates the application with a GitHub repository + branch installed through the Square Cloud GitHub App. The branch must be ≤256 chars and the (repository, branch) pair must not already be linked to another application owned by the caller.

Requires a session token. Rate limited to 3 calls per 60s per user.

post/v2/apps/{appId}/deploy/github-app

Path parameters

appIdstring required

Application identifier. Optionally suffixed with -<workspaceId> to act on a workspace-shared application.

Request body

repositoryNamestring required

Full repository name (e.g. octocat/hello-world).

repositoryBranchstring required

Response

Repository linked.

status'success' required

Changes

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