Deployments

Queue, preview or schedule a deployment

Creates a new deployment for the project. Set mode to 'queue' to execute immediately or 'preview' to generate a preview of changes without deploying. If a schedule block is provided, the deployment is scheduled for future or recurring execution. Use parent_identifier to target a specific server or server group. The deployment status field can be: pending, running, completed, failed, preview_pending, preview_ready, or preview_failed.

post/projects/{project_id}/deployments

Request

  • Base URL: https://sg.deployhq.com
  • URL: https://sg.deployhq.com/projects/{project_id}/deployments
  • Auth: HTTP basic

Path parameters

project_idstring required

The identifier or permalink of the project

Request body

save_server_branchstring
deployment_overviewstring

Response

Queued Deployment

identifierstring
deployerstring nullable
deployer_avatarstring nullable
branchstring
statusstring
legacyboolean
deferredboolean
config_files_deploymentboolean
overviewstring nullable
metadataobject
archivedboolean
archived_atstring nullable
log_summarystring nullable

Changes

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