Last updated on 1st April 2026

Create a new project via API

This method allows you to create a new project.

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

URL

/projects

HTTP Method

POST

Supported Parameters

  • name - The name of the project (required)
  • zone_id - The region/zone that this project will be located in
    • 3 - UK (default)
    • 6 - US East
    • 9 - US West

Example cURL Request

curl -H "Content-type: application/json" \
-H "Accept: application/json" \
--user adam@atechmedia.com:my-api-key \ 
-X POST \ 
-d '{ \
  "project":{ \
    "name":"My Project" \
  } \
}' \
https://test.deployhq.com/projects/

Example Response

{
    "name": "My Project",
    "permalink": "my-project",
    "identifier": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "zone": "uk",
    "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAA...",
    "repository": null,
    "repository_url": null,
    "last_deployed_at": null,
    "auto_deploy_url": "https://test.deployhq.com/deploy/my-project/abc123",
    "url": "https://test.deployhq.com/projects/my-project",
    "app_url": "https://test.deployhq.com/projects/my-project",
    "servers_url": "https://test.deployhq.com/projects/my-project/servers",
    "deployments_url": "https://test.deployhq.com/projects/my-project/deployments",
    "config_files_url": "https://test.deployhq.com/projects/my-project/config_files",
    "environment_variables_url": "https://test.deployhq.com/projects/my-project/environment_variables",
    "build_commands_url": "https://test.deployhq.com/projects/my-project/build_commands"
}