Skip to main content
POST

Authorizations

Authorization
string
header
required

Send your API token as Authorization: Bearer <api-token>.

Path Parameters

project_id
string
required

The app's name.

Query Parameters

teamID
string

Run the request in the context of a team you belong to, instead of your personal account. 24-character hexadecimal ID.

Pattern: ^[0-9a-fA-F]{24}$

Body

application/json
type
enum<string>
required

The app's platform.

Available options:
node,
next,
react,
vue,
angular,
static,
laravel,
php,
django,
flask,
python,
netcore,
dotnet,
go,
docker
port
integer
required

The port your app listens on. For static, react, vue, angular, laravel, php, django and flask it's always 80, and for next always 3000, whatever you send.

Required range: x >= 1
sourceID
string

From POST /v2/projects/{project_id}/sources.

image
string

Only for docker apps. A container image to deploy instead of source code.

envs
object

If not empty, replaces all of the app's environment variables.

args
string[]

Arguments to start the app with.

cron
string[]

Scheduled jobs, each a cron schedule followed by a command. Only for next, laravel, php, python, django, flask and go.

disks
object[]
Maximum array length: 8
healthCheck
object

Command that checks whether the app is healthy. Times are in milliseconds.

message
string

A note about the release. Longer text is cut off.

Maximum string length: 50
gitInfo
object

Information about the commit being deployed, shown with the release.

platformConfig
object

Platform-specific build settings. The allowed fields depend on type:

mirror (and npmMirror / composerMirror) download packages through Liara's package mirrors.

build
object

Response

The release was created.

releaseID
string