Sign in
Projects

Create a project

Creates a project linked to a GitHub repository in the caller's current workspace. The GitHub App must be installed for the repository's owner.

post/projects

Request

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

Request body

$schemastring uri

A URL to the JSON Schema for this object.

dockerfile_pathstring

Path to the Dockerfile, relative to the root directory. Defaults to Dockerfile.

github_repositorystring required

The linked GitHub repository in owner/repo format.

namestring required

The project name.

root_directorystring

Repository path the project builds from. Defaults to /.

Example request

{
  "$schema": "/v1/schemas/CreateProjectInputBody.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

created_atstring date-time required

When the project was created.

github_repositorystring required

Owner/repo of the linked GitHub repository.

idstring required

The project ID.

namestring required

The project name.

slugstring required

URL-safe project slug.

updated_atstring date-time required

When the project was last updated.

Example response

{
  "$schema": "/v1/schemas/ProjectResponse.json"
}

Changes

No recorded changes to this operation across all 1 revision of this API.