Sign in
projects

Create project

Create a project to group deployments and applications under a workspace-scoped slug.

The slug you provide is the stable, caller-defined handle used to reference this project in subsequent operations (get, update, delete). It must be unique within your workspace.

Important: The slug cannot collide with an existing project in your workspace. A duplicate slug returns a 409 conflict.

Required Permissions

Your root key must have the following permission:

  • project.*.create_project (to create projects in your workspace)
post/v2/projects.createProject

Request body

namestring required

Human-readable name for this project. Use a descriptive name like 'Payments Service' to identify its purpose.

slugstring required

URL-safe handle you choose for this project, unique within your workspace. Pick a short identifier like 'payments-service'. It identifies the project when you deploy and is embedded in the generated deployment domains. Must be lowercase letters, numbers, and hyphens, starting and ending with a letter or number (no leading, trailing, or consecutive hyphens).

Example request

{
  "name": "Payments Service",
  "slug": "payments-service"
}

Response

Project created successfully. The response contains the project id used to reference it in subsequent operations.

Example response

{
  "meta": {
    "requestId": "req_123"
  },
  "data": {
    "id": "proj_1234abcd"
  }
}

Changes