View existing config file deployment via API

This method will return data about a specific config file deployment.

As the deployment only included config files, it will have some key differences from a standard deployment, such as the branch, start_revision and end_revision being null.

URL

[ACCOUNT_PERMALINK].deployhq.com/projects/[PROJECT_PERMALINK]/deployments/[DEPLOYMENT_ID]

Replace <project> with the permalink of the project.

HTTP Method

GET

Example output

{
  "identifier": "f1adfbc8-a454-41b7-ac83-4e60bf5ec4cb",
  "servers": [
    {
      "id": 1519233,
      "identifier": "68180695-e71f-4c09-afba-d0cc87b8e39b",
      "name": "Server-endpoint",
      "protocol_type": "ssh",
      "server_path": "/home/ubuntu/www",
      "last_revision": "0f236d21234c55191b5365f083495b3276d4e943",
      "preferred_branch": "main",
      "branch": "",
      "notify_email": "",
      "server_group_identifier": "72afe1be-359e-4aef-b851-a1107c162e2b",
      "auto_deploy": false,
      "environment": "",
      "hostname": "123.123.123.123",
      "username": "ubuntu",
      "port": "22",
      "use_ssh_keys": true,
      "host_key": "[HOST_KEY]",
      "unlink_before_upload": false
    }
  ],
  "project": {
    [...] 
  },
  "deployer": "Viktor",
  "branch": null,
  "start_revision": {
    "ref": null
  },
  "end_revision": {
    "ref": null
  },
  "status": "completed",
  "timestamps": {
    "queued_at": "2024-09-26T13:00:03.000+02:00",
    "started_at": "2024-09-26T13:00:05.000+02:00",
    "completed_at": "2024-09-26T13:00:08.000+02:00",
    "duration": 3,
    "runs_at": null
  },
  "files": {
    "68180695-e71f-4c09-afba-d0cc87b8e39b": {
      "changed": [],
      "removed": []
    }
  },
  "configuration": {
    "copy_config_files": true,
    "notification_addresses": null,
    "skip_project_files": true
  },
  "legacy": false,
  "deferred": false,
  "config_files_deployment": true,
  "steps": [
    {
      "step": "waiting_for_capacity",
      "stage": "preparing",
      "identifier": "39c1b782-4505-476d-b904-8bb85cd24f83",
      "server": null,
      "total_items": null,
      "completed_items": null,
      "description": "Waiting for an available deployment slot",
      "status": "completed",
      "logs": false,
      "deployment_started_at": "2024-09-26T13:00:05.000+02:00",
      "updated_at": "2024-09-26T13:00:05.000+02:00"
    },
    {
      "step": "preflight_checks",
      "stage": "preparing",
      "identifier": "d7c774aa-8a54-4e9d-93f7-378918941dd7",
      "server": null,
      "total_items": 3,
      "completed_items": 2,
      "description": "Performing pre-deployment checks",
      "status": "completed",
      "logs": true,
      "deployment_started_at": "2024-09-26T13:00:05.000+02:00",
      "updated_at": "2024-09-26T13:00:07.000+02:00"
    },
    {
      "step": "transfer_files",
      "stage": "transferring",
      "identifier": "6b241f78-ca02-4c15-b2b6-b6a79e5ff232",
      "server": 1519233,
      "total_items": null,
      "completed_items": null,
      "description": "Transferring changed files",
      "status": "completed",
      "logs": false,
      "deployment_started_at": "2024-09-26T13:00:05.000+02:00",
      "updated_at": "2024-09-26T13:00:08.000+02:00"
    },
    {
      "step": "upload_config_files",
      "stage": "transferring",
      "identifier": "99f8a49e-e893-464b-98d3-d5a25251b339",
      "server": 1519233,
      "total_items": 1,
      "completed_items": 1,
      "description": "Uploading config files",
      "status": "completed",
      "logs": true,
      "deployment_started_at": "2024-09-26T13:00:05.000+02:00",
      "updated_at": "2024-09-26T13:00:08.000+02:00"
    },
    {
      "step": "run_after_changes_command",
      "stage": "transferring",
      "identifier": "b2d0a756-0f78-4d10-a2bb-77bc9a8e6ba8",
      "server": 1519233,
      "total_items": null,
      "completed_items": null,
      "description": "Running SSH command #1",
      "status": "completed",
      "logs": true,
      "deployment_started_at": "2024-09-26T13:00:05.000+02:00",
      "updated_at": "2024-09-26T13:00:08.000+02:00"
    },
    {
      "step": "run_after_changes_command",
      "stage": "transferring",
      "identifier": "26879b97-f414-45b3-98c0-60aa88c38034",
      "server": 1519233,
      "total_items": null,
      "completed_items": null,
      "description": "Running SSH command #2",
      "status": "completed",
      "logs": true,
      "deployment_started_at": "2024-09-26T13:00:05.000+02:00",
      "updated_at": "2024-09-26T13:00:08.000+02:00"
    },
    {
      "step": "send_webhooks",
      "stage": "finishing",
      "identifier": "780bf210-4360-4900-8e90-61ebb12b3596",
      "server": null,
      "total_items": 0,
      "completed_items": null,
      "description": "Delivering webhook notifications",
      "status": "completed",
      "logs": false,
      "deployment_started_at": "2024-09-26T13:00:05.000+02:00",
      "updated_at": "2024-09-26T13:00:08.000+02:00"
    },
    {
      "step": "send_emails",
      "stage": "finishing",
      "identifier": "67a21adf-55c1-465e-964c-0c23c40536f5",
      "server": null,
      "total_items": null,
      "completed_items": null,
      "description": "Sending emails",
      "status": "completed",
      "logs": false,
      "deployment_started_at": "2024-09-26T13:00:05.000+02:00",
      "updated_at": "2024-09-26T13:00:08.000+02:00"
    },
    {
      "step": "fix_versions",
      "stage": "finishing",
      "identifier": "05f90d55-8dc0-4418-a251-f2ba058059fb",
      "server": null,
      "total_items": null,
      "completed_items": null,
      "description": "Saving build environment",
      "status": "completed",
      "logs": true,
      "deployment_started_at": "2024-09-26T13:00:05.000+02:00",
      "updated_at": "2024-09-26T13:00:08.000+02:00"
    }
  ]
}