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

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

Changes

Changed in 3 of the 91 revisions of this API.213

  • 43ad1ce9a1522See the full diff
    • ○

      the endpoint scheme security bearer was added to the API

      api-security-added

    • ○

      the endpoint scheme security rootKey was removed from the API

      api-security-removed

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 7815bad876c821See the full diff
    • ▲

      the slug request property's maxLength was decreased to 255

      request-property-max-length-decreased

    • ▲

      the slug request property's minLength was increased from 1 to 3

      request-property-min-length-increased

    • ●

      changed the pattern of the request property slug from ^[a-z0-9]+(-[a-z0-9]+)*$ to ^[a-zA-Z0-9_-]+$

      request-property-pattern-changed

  • 355070211f9e1See the full diff
    • ○

      endpoint added

      endpoint-added