Git

Update a source connection

Updates build defaults, branch behavior, and repository URLs. Close open source workspaces before you change repository URLs.

patch/v1/spaces/{spaceId}/source/connection

Request

  • Base URL: https://api.spacefast.com
  • URL: https://api.spacefast.com/v1/spaces/{spaceId}/source/connection
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.spacefast.com/v1/auth/oauth2/authorize, token URL https://api.spacefast.com/v1/auth/oauth2/token; client credentials, token URL https://api.spacefast.com/v1/auth/oauth2/token, scopes: spaces:write)

Path parameters

spaceIdstring required

Request body

connectionType'connected' | 'hosted'
productionBranchstring
credentialstring nullable
autoDeployProductionboolean
autoDeployPreviewsboolean
githubPreviewCommentsEnabledboolean nullable

Controls GitHub preview comments for this Space. Set null to use the team setting.

Response

Response for status 200

$schemastring uri

Canonical JSON Schema URL for this response body. The server also sends it in the Link: rel="describedby" response header.

Changes

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