View an existing project via API
This method allows you to view an existing project.
Tip: You can explore and test this endpoint interactively using our OpenAPI documentation.
URL
/projects/<project>
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/hgtest
Example Response
{
"name": "hgtest",
"permalink": "hgtest",
"identifier": "b8811674-79a7-4f1d-8bcc-935aab74f6e2",
"zone": "us_east",
"public_key": "ssh-rsa AAAB3NzaC1yc2EAAAADAQAN DeployHQ.com Key for hgtest",
"repository": {
"scm_type": "mercurial",
"url": "ssh://hg@codebasehq.com/adamw/test/hgtest.hg",
"port": null,
"username": null,
"branch": "default",
"cached": true,
"hosting_service": {
"name": "Codebase",
"url": "http://www.codebasehq.com",
"tree_url": "https://adamw.codebasehq.com/projects/test/repositories/hgtest/tree/default",
"commits_url": "https://adamw.codebasehq.com/projects/test/repositories/hgtest/commits/default"
}
},
"repository_url": "ssh://hg@codebasehq.com/adamw/test/hgtest.hg",
"last_deployed_at": null,
"auto_deploy_url": "https://test.deployhq.com/deploy/hgtest/abc123",
"url": "https://test.deployhq.com/projects/hgtest",
"app_url": "https://test.deployhq.com/projects/hgtest",
"servers_url": "https://test.deployhq.com/projects/hgtest/servers",
"deployments_url": "https://test.deployhq.com/projects/hgtest/deployments",
"config_files_url": "https://test.deployhq.com/projects/hgtest/config_files",
"environment_variables_url": "https://test.deployhq.com/projects/hgtest/environment_variables",
"build_commands_url": "https://test.deployhq.com/projects/hgtest/build_commands",
"capabilities": [
{ "name": "servers", "enabled": true, "url": "https://test.deployhq.com/projects/hgtest/servers" },
{ "name": "deployments", "enabled": true, "url": "https://test.deployhq.com/projects/hgtest/deployments" },
{ "name": "config_files", "enabled": true, "url": "https://test.deployhq.com/projects/hgtest/config_files" },
{ "name": "environment_variables", "enabled": true, "url": "https://test.deployhq.com/projects/hgtest/environment_variables" },
{ "name": "build_commands", "enabled": false, "url": "https://test.deployhq.com/projects/hgtest/build_commands" },
{ "name": "excluded_files", "enabled": false, "url": "https://test.deployhq.com/projects/hgtest/excluded_files" },
{ "name": "notifications", "enabled": false, "url": "https://test.deployhq.com/projects/hgtest/integrations" },
{ "name": "server_groups", "enabled": false, "url": "https://test.deployhq.com/projects/hgtest/server_groups" }
],
"starred": false
}
The capabilities array is only included in the project show response (not in the list). Each capability includes enabled (whether the project has any configured) and a direct url to the API endpoint.