SQsquarecloud
Deployments

Get current Git deploy configuration

Changed on

Returns the GitHub App repository linkage and the deploy webhook URL configured for the application. The response is cached for 5 minutes per (owner, application).

The webhook URL is a deploy credential: it is returned whole only to a caller that may configure it: a session or a key with apps:deploy (or full access) and, on a workspace-shared application, the owner or a workspace Administrator. Anyone else gets it masked (.../webhook/********), which still tells that a webhook is configured.

Requires the workspace Manager or Administrator role (or ownership) when called against a workspace-shared application.

get/v2/apps/{appId}/deployments/current

Request

Path parameters

appIdstring required

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

Response

Current Git deploy configuration. Either app (GitHub App), webhook, or both may be present.

status'success' required

Changes

  • e363e004303cRevision changes
    • warning

      added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status

    • warning

      added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status

    • warning

      added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status

    • warning

      added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status

    • warning

      added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status

    • warning

      added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status

  • 4cf53a0d5577Revision changes
    • warning

      added the new WRITE_FAILED enum value to the //// response property for the response status

    • warning

      added the new WRITE_FAILED enum value to the //// response property for the response status

    • warning

      added the new WRITE_FAILED enum value to the //// response property for the response status

    • warning

      added the new WRITE_FAILED enum value to the //// response property for the response status

    • warning

      added the new WRITE_FAILED enum value to the //// response property for the response status

    • warning

      added the new WRITE_FAILED enum value to the //// response property for the response status

    • warning

      added the new WRONG_HOST enum value to the //// response property for the response status

    • warning

      added the new WRONG_HOST enum value to the //// response property for the response status

    • warning

      added the new WRONG_HOST enum value to the //// response property for the response status

    • warning

      added the new WRONG_HOST enum value to the //// response property for the response status

    • warning

      added the new WRONG_HOST enum value to the //// response property for the response status

    • warning

      added the new WRONG_HOST enum value to the //// response property for the response status