Documentation menu
Projects

Create a project

POST /api/v1/projects

Parameters

query

NameTypeRequiredDescription
organizationIdstringoptionalOrganization that owns the Projects. Required for session credentials. A credential scoped to one organization may omit it.

Request body

Required — Request body for: Create a project.

application/json

NameTypeRequiredDescription
slugstringrequired
namestringrequired
abcdReleaseIdstringoptional
templateIdstringoptional

Responses

StatusDescriptionBody
201Response for status 201application/json — object — type: "project" (required); id: string (required); organizationId: string (required); slug: string (required); name: string (required); status: "provisioning" | "active" | "paused" | "deleting" (required); operationTimeoutMs: integer; role: "admin" | "developer" | "viewer"; createdAt: string (required); updatedAt: string (required)
400The request is malformed or cannot be processed.application/json — PublicApiError — error: object (required)
401Authentication failed. The Authorization header is missing, or the credential is invalid or expired.application/json — PublicApiError — error: object (required)
403Access denied. The authenticated user does not have permission to perform this action.application/json — PublicApiError — error: object (required)
404Resource not found.application/json — PublicApiError — error: object (required)
409Request conflicts with current state of the resource, including safe deployment conflict classifications.application/json — PublicApiError — error: object (required)
422Request validation failed. Check the request body, query parameters, or path parameters.application/json — PublicApiError — error: object (required)
429Too many requests.application/json — PublicApiError — error: object (required)
500The server could not complete the request.application/json — PublicApiError — error: object (required)
503Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.application/json — PublicApiError — error: object (required)