Skip to main content
POST
/
api
/
v1
/
deploy
Deploy a GitHub repository to a new Vers project.
curl --request POST \
  --url https://api.example.com/api/v1/deploy \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "repo": "<string>",
  "branch": "<string>",
  "name": "<string>",
  "settings": {
    "build_command": "<string>",
    "install_command": "<string>",
    "run_command": "<string>",
    "working_directory": "<string>"
  }
}
'
{
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "vm_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Documentation Index

Fetch the complete documentation index at: https://docs.vers.sh/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body for POST /api/v1/deploy.

​
repo
string
required

GitHub repository in owner/repo format.

​
branch
string | null

Git branch to clone (defaults to repo default branch).

​
name
string | null

Optional project name (defaults to repo name).

​
settings
object

Build/run settings.

Response

Deploy initiated

Response body for POST /api/v1/deploy.

​
project_id
string<uuid>
required
​
status
string
required
​
vm_id
string<uuid>
required