v66

OpenAPI 3.1.0raw.githubusercontent.com2026-08-0174265626.3 KB

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

Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

Example request

{
  "name": "Payments Service",
  "slug": "proj_1234abcd"
}

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"
  }
}