Skip to main content
POST
/
applications
/
deployments
Start deployment
curl --request POST \
  --url https://api.sevalla.com/v2/applications/deployments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "app_id": "fb5e5168-4281-4bec-94c5-0d1584e9e657",
  "branch": "main",
  "docker_image": "my-image:latest",
  "is_restart": false
}
'
{
  "deployment": {
    "id": "fb5e5168-4281-4bec-94c5-0d1584e9e657"
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication. Pass your API key as a Bearer token in the Authorization header.

Body

application/json
​
app_id
string<uuid>
required

Application ID to deploy

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"fb5e5168-4281-4bec-94c5-0d1584e9e657"

​
branch
string

Git branch to deploy

Example:

"main"

​
docker_image
string

Docker image to deploy

Example:

"my-image:latest"

​
is_restart
boolean
default:false

Whether this is a restart deployment

Example:

false

Response

Default Response

​
deployment
object
required