Last updated on 23rd March 2026

List automatic deployment settings via API

This method returns the automatic deployment configuration for a project, including the webhook URL and the auto-deploy status for each server and server group.

Tip: You can explore and test this endpoint interactively using our OpenAPI documentation.

URL

/projects/<project>/auto_deployments

Replace <project> with either the permalink or identifier of the project.

HTTP Method

GET

Supported Parameters

None

Example cURL Request

curl -H "Content-type: application/json" \
-H "Accept: application/json" \
--user adam@atechmedia.com:my-api-key \
https://test.deployhq.com/projects/my-project/auto_deployments

Example Response

{
  "webhook_url": "https://test.deployhq.com/deploy/my-project/MOTWPXHS7PRNBAXxVjXpEckLGLZQXzb8",
  "deployables": [
    {
      "identifier": "79c6a008-c7fa-4648-82fc-692f546d6c76",
      "name": "Production Server",
      "type": "server",
      "auto_deploy": true,
      "preferred_branch": "main"
    },
    {
      "identifier": "49d23a7d-322e-4714-81d4-a159dca5c2a7",
      "name": "Staging Group",
      "type": "server_group",
      "auto_deploy": false,
      "preferred_branch": "develop"
    }
  ]
}

The type field indicates whether the deployable is a server or a server_group. The preferred_branch is the branch that triggers an automatic deployment when pushed.