Skip to main content
Use this endpoint to retrieve information about the current deployment configuration for your application, including the auto-deploy webhook URL. You can register this webhook URL in your GitHub, GitLab, or any other Git provider’s repository settings to trigger automatic deployments whenever you push new code. This is the same URL you would configure in the Webhooks setup flow.

Endpoint

GET https://api.virtuscloud.app/v2/apps/{app_id}/deployments/current

Authorization

Include your API key in the request header:
Authorization: <api_key>

Path Parameters

app_id
string
required
The unique identifier of your application. You can find this in the URL of your application’s dashboard.

Response

status
string
Indicates the outcome of the request. Returns "success" when the operation completes without errors.
response
object
An object containing the current deployment configuration.

Examples

curl --request GET \
  --url "https://api.virtuscloud.app/v2/apps/{app_id}/deployments/current" \
  --header "Authorization: <api_key>"

Response Example

{
  "status": "success",
  "response": {
    "webhook": "https://api.virtuscloud.app/v2/git/webhook/69ce71f11974f2cc21d47cd0a8bcbafdaacbc3c9924b23ca40e0e2032705f6391eb89b40983338e0f2415e9331d602ccc"
  }
}
Keep your webhook URL confidential — it acts as a shared secret between Virtus Cloud and your Git provider. Anyone with the URL can trigger a deployment.