Skip to Content
homemade
Dashboard

Create a project

POST
/api/projects

Creates a project from a GitHub repository your team connected (githubInstallationId + githubRepoId), from a starter (template), or empty. A new project starts its first VM on its own; welcomeVm says how that went.

Authorization

apiKey
headerAuthorizationBearer <hmk_…>

An API key from the dashboard or homemade api-key create.

Request Body

application/json
  1. body
config?
defaultBranch?string
githubInstallationId?integer
Range-9007199254740991 <= value <= 9007199254740991
githubRepoId?integer
Range-9007199254740991 <= value <= 9007199254740991
name?string
Length1 <= length <= 100
orgId?string
rootDirectory?|null
setupWithAgent?boolean
template?string
Length1 <= length <= 64

Response Body

The project.

application/json
  1. response
project*

A project: one repository (or starter) that VMs boot from.

welcomeVm*||||

The first VM a new project starts on its own.

Example Request
curl -X POST 'https://api.homemade.dev/api/projects' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "project": {    "createdAt": "2019-08-24T14:15:22Z",    "defaultBranch": "string",    "githubRepoFullName": "string",    "id": "string",    "name": "string",    "orgId": "string",    "rootDirectory": "string",    "slug": "string",    "status": "string",    "property1": null,    "property2": null  },  "welcomeVm": {    "status": "created",    "vmId": "string"  }}