Sign in
Projects

Create a new project from a template

Changed on

Image-backed service templates are created directly from their pinned image. Source-backed starter templates can either use their public repository or create a repository under the selected Git provider account.

post/projects/from-template

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/projects/from-template
  • Auth: HTTP bearer

Request body

automatic_deployboolean

Enable automatic deployment on push (defaults to true). Only honoured in fork mode; public-repo deploys cannot receive push webhooks.

cloudflare_enabledboolean nullable

Override the Cloudflare default for this new project.

commandstring[] nullable

Optional image entrypoint arguments. An empty list explicitly uses the image's own default command instead of the template command.

cpu_limitinteger nullable

CPU limit override in microcores. Zero means uncapped.

cpu_requestinteger nullable

CPU request override in microcores (1_000_000 = one CPU core).

delivery_providerstring nullable
exposed_portinteger nullable

Public container port override.

git_provider_connection_idinteger nullable

Git provider connection ID. When omitted, the project deploys directly from the template's public source repository instead of forking it.

health_check_pathstring nullable

Relative HTTP health-check path override.

imagestring nullable

Optional prebuilt-image override. Curated template values remain the default when this is omitted. Accepted only for image templates.

memory_limitinteger nullable

Memory limit override in MiB. Zero means uncapped.

memory_requestinteger nullable

Memory request override in MiB.

privateboolean

Whether to make the repository private (defaults to true)

project_namestring required

Name for the new project

repository_namestring nullable

Name for the new repository to create. Required in fork mode; ignored in one-click public-repo mode.

repository_ownerstring nullable

Owner/organization for the new repository (defaults to authenticated user)

storage_service_idsinteger[]

External storage service IDs to attach to the project

template_slugstring required

Template slug to use as the base

Response

Project created successfully

deployment_errorstring nullable

Actionable retry guidance when project creation succeeded but deployment dispatch did not. Internal queue errors are never exposed.

deployment_queuedboolean nullable

Whether the initial deployment was successfully queued. This is set for native image service templates; Git-backed modes use their pipeline flow.

messagestring required

Message with additional info

project_idinteger required

ID of the created project

project_namestring required

Name of the created project

project_slugstring required

Slug of the created project

repository_urlstring required

URL of the created repository

template_slugstring required

Template that was used

Changes

  • 4b228ebed583Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the non-success response with the status

  • 1dc3e6788214Revision changes
    • warning

      removed the request property

    • warning

      removed the request property

    • info

      removed the non-success response with the status