---
title: "Create a project"
method: POST
path: "/projects"
tags: ["Projects"]
---

# Create a project

`POST /projects`

## Request

- Base URL: `https://sg.deployhq.com`
- URL: `https://sg.deployhq.com/projects`
- Auth: HTTP basic

Creates a new project in the account. Optionally applies a template to pre-populate servers, config files, and other settings.

## Request body

- ProjectObject
  - `project` object, required
    - `name` string
    - `keypair_identifier` string
    - `zone_id` string
    - `template_id` string

## Response `200`

Success

- Project
  - `name` string
  - `permalink` string
  - `identifier` string
  - `public_key` string
  - `repository` object
    - `scm_type` string
    - `url` string
    - `port` integer, nullable
    - `username` string, nullable
    - `branch` string
    - `cached` boolean
    - `hosting_service` object
      - `name` string
      - `url` string
      - `tree_url` string
      - `commits_url` string
  - `repository_url` string
  - `zone` string
  - `last_deployed_at` string
  - `folder` string, nullable
  - `auto_deploy_url` string

## Other responses

- `401`: You are not authorized to access this resource. You need to authenticate yourself first.
- `403`: You are not allowed to access this resource. You do not have the necessary permissions.
- `422`: Unprocessable Entity
- `500`: An unexpected error occurred on the server. The server was unable to process the request.

---

[API](https://skmtc.dev/deployhq/apis/deployhq-api-interactive-documentation.md) · [All operations](https://skmtc.dev/deployhq/apis/deployhq-api-interactive-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/deployhq/apis/deployhq-api-interactive-documentation/revisions/830264ae58be?raw)