Header

View an existing deployment

This method will return information about a specific deployment.

URL

/projects/<project>/deployments/<identifier>
  • Replace <project> with the permalink of the project.
  • Replace <identifier> with the identifier of the deployment.

Supported Parameters

None

Example cURL Request

curl -H "Content-type: application/json" \
-H "Accept: application/json" \
--user adam@atechmedia.com:my-api-key \
https://atech.deployhq.com/projects/react-project/deployments/43fe84f1-67a6-778f-25c4-2b211b52b5b4/

Example Response

{
  "identifier":"43fe84f1-67a6-778f-25c4-2b211b52b5b4",
  "servers":[
    {
      "id":194194,
      "identifier":"40da9bf1-8668-5aad-a8f4-5af413ba0cae",
      "name":"Live",
      "protocol_type":"ftp",
      "server_path":"/public_html",
      "auto_deploy_url":"https://atech.deployhq.com/projects/react-project/deployments/server/webhook-url/",
      "last_revision":"3b531a8ee7e65ae62e2c1d394f7eb50ba75dfe86",
       "preferred_branch":"master",
       "notify_email":"",
       "server_group_identifier":null,
       "hostname":"127.0.0.1",
       "username":"deploy",
       "port":"21",
       "passive":true,
       "force_hidden_files":false
     }],
   "project":
     {
       "name":"Project",
       "permalink":"project",
       "public_key":"ssh-rsa 123123123123123123123123123 DeployHQ.com Key for project",
       "repository":
       {
         "scm_type":"git",
         "url":"git@codebasehq.com:adamw/test/site.git",
         "port":null,
         "username":"adamw",
         "branch":"master",
         "cached":true,
         "hosting_service":{
         "name":"Codebase",
         "url":"http://www.codebasehq.com",
         "tree_url":"https://adamw.codebasehq.com/projects/test/site/tree/master",
         "commits_url":"https://adamw.codebasehq.com/projects/test/site/tree/master"
       }
     }
   },
   "deployer":"Adam West",
   "start_revision":
     {
       "ref":"3b531a8ee7e65ae62e2c1d394f7eb50ba75dfe86",
       "author":"Adam West",
       "email":"adamw@atechmedia.com",
       "timestamp":"2016-06-04T15:18:19.000+01:00",
       "message":"Initial Commit",
       "short_message":"Initial Commit"
     },
   "end_revision":
     {
       "ref":"3b531a8ee7e65ae62e2c1d394f7eb50ba75dfe86",
       "author":"Adam West",
       "email":"adamw@atechmedia.com",
       "timestamp":"2016-06-04T15:18:19.000+01:00",
       "message":"Initial Commit",
       "short_message":"Initial Commit"
     },
   "status":"completed",
   "timestamps":
     {
       "queued_at":"2016-07-12T15:27:55.000+01:00",
       "started_at":"2016-07-12T15:27:56.000+01:00",
       "completed_at":"2016-07-12T15:28:04.000+01:00",
       "duration":null
     },
   "files":
     {
       "40da9bf1-8668-5aad-a8f4-5af413ba0cae":
       {
         "changed":[],
         "removed":[]
       }
     },
   "configuration":
     {
       "copy_config_files":false,
       "notification_addresses":null
     },
   "legacy": false
 }