Sign in
Projects
Git Connections

Update a project's Git auto-deploy settings

Changed on

Full replace of the project's Git auto-deploy settings: what a push to the connected repo's production branch deploys.

Connecting a repository sets auto_deploy_enabled and deploy_functions to true for a project that has never called this endpoint, so a push deploys without any further setup. Once these settings have been saved here they are the project's own: connecting, rebinding, disconnecting and reconnecting all leave them untouched, including when they were saved before any repository was connected. Frontend settings are off until set here; the frontend need not exist when they are saved, since frontend_name is resolved at deploy time.

put/projects/{id}/git-deploy-settings

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/projects/{id}/git-deploy-settings
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring uuid required

Project ID

Request body

auto_deploy_enabledboolean required
deploy_functionsboolean required
frontend_namestring

Frontend to deploy on push. Omit or empty to deploy no frontend.

frontend_app_rootstring

App root the frontend builds from. Requires frontend_name; omit for the repo root.

Response

The project's updated Git auto-deploy settings

auto_deploy_enabledboolean required

Whether a production-branch push triggers a deployment.

deploy_functionsboolean required

Whether the repo's functions are deployed on push.

frontend_namestring

Name of the frontend to build and deploy on push. Omitted when no frontend is deployed. Resolved at deploy time; need not exist yet.

frontend_app_rootstring

App root (subdirectory) the frontend builds from. Omitted for the repo root.

updated_atstring date-time required

Changes

  • 23e7875e7c4cRevision changes
    • ○

      the endpoint scheme security ProjectAccessToken was added to the API

  • 3a6f365f3f35Revision changes
    • ▲

      added the new path request parameter id

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status