Skip to main content
PATCH
/
applications
/
{id}
Update application
curl --request PATCH \
  --url https://api.sevalla.com/v3/applications/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "My Application",
  "auto_deploy": true,
  "default_branch": "main",
  "hibernation_enabled": false,
  "hibernate_after_seconds": 3600,
  "build_type": "nixpacks",
  "build_path": ".",
  "dockerfile_path": "Dockerfile",
  "docker_context": ".",
  "build_cache_enabled": true,
  "docker_registry_credential_id": "fb5e5168-4281-4bec-94c5-0d1584e9e657",
  "pack_builder": "heroku/builder:22",
  "nixpacks_version": "1.29",
  "buildpacks": [
    {
      "order": 1,
      "source": "heroku/nodejs"
    }
  ],
  "allow_deploy_paths": [
    "src/**",
    "package.json"
  ],
  "ignore_deploy_paths": [
    "docs/**",
    "README.md"
  ],
  "source": "privateGit",
  "git_type": "github",
  "repo_url": "https://github.com/user/repo",
  "docker_image": "nginx:latest"
}
'
{
  "id": "fb5e5168-4281-4bec-94c5-0d1584e9e657",
  "company_id": "fb5e5168-4281-4bec-94c5-0d1584e9e657",
  "project_id": "fb5e5168-4281-4bec-94c5-0d1584e9e657",
  "name": "my-app",
  "namespace": "my-app-abc123",
  "display_name": "My Application",
  "source": "privateGit",
  "type": "app",
  "status": "deploymentSuccess",
  "build_cache_enabled": true,
  "hibernation_enabled": false,
  "hibernate_after_seconds": 3600,
  "auto_deploy": true,
  "wait_for_checks": false,
  "is_suspended": false,
  "git_type": "github",
  "repo_url": "https://github.com/user/repo",
  "default_branch": "main",
  "docker_image": "nginx:latest",
  "build_type": "nixpacks",
  "build_path": ".",
  "pack_builder": "heroku/builder:22",
  "nixpacks_version": "1.21.0",
  "dockerfile_path": "Dockerfile",
  "docker_context": ".",
  "allow_deploy_paths": [
    "src/**",
    "package.json"
  ],
  "ignore_deploy_paths": [
    "docs/**",
    "README.md"
  ],
  "created_by": "fb5e5168-4281-4bec-94c5-0d1584e9e657",
  "created_at": "2025-01-30T00:00:00.000Z",
  "updated_at": "2025-01-30T00:00:00.000Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid>
required

Application identifier

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"

Body

application/json
​
display_name
string

Human-readable name shown in the dashboard and API responses

Required string length: 1 - 64
Example:

"My Application"

​
auto_deploy
boolean

Enable or disable automatic deployments on every push to the default branch. Only works with privateGit applications - has no effect on publicGit or dockerImage applications.

Example:

true

​
default_branch
string

Git branch used for automatic and manual deployments when no branch is explicitly specified

Minimum string length: 1
Example:

"main"

​
hibernation_enabled
boolean

Enable or disable automatic hibernation. When enabled, the application scales down to zero after a period of inactivity.

Example:

false

​
hibernate_after_seconds
integer

Number of seconds of inactivity before the application is hibernated. Only applies when hibernation is enabled.

Required range: x <= 604800
Example:

3600

​
build_type
enum<string>

Build strategy to use. nixpacks - auto-detected build system. dockerfile - build using a Dockerfile. pack - build using Cloud Native Buildpacks.

Available options:
dockerfile,
pack,
nixpacks
Example:

"nixpacks"

​
build_path
string

Relative path to the build directory within the repository. Defaults to the repository root.

Example:

"."

​
dockerfile_path
string

Relative path to the Dockerfile within the repository. Only applies when build type is dockerfile.

Example:

"Dockerfile"

​
docker_context
string

Docker build context path relative to the repository root. Only applies when build type is dockerfile.

Example:

"."

​
build_cache_enabled
boolean

Enable or disable build caching. When enabled, build artifacts are cached between deployments.

Example:

true

​
docker_registry_credential_id
string<uuid>

Identifier of a Docker registry credential. Used for pulling private base images when build type is dockerfile, or for pulling the container image when source is dockerImage.

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"

​
pack_builder
enum<string>

Cloud Native Buildpacks builder image. heroku/builder:22 - Heroku-22 stack. heroku/builder:24 - Heroku-24 stack. Only applies when build type is pack.

Available options:
heroku/builder:22,
heroku/builder:24
Example:

"heroku/builder:22"

​
nixpacks_version
enum<string>

Pinned Nixpacks version. When not set, the platform default version is used. Only applies when build type is nixpacks.

Available options:
1.29,
1.39,
1.41
Example:

"1.29"

​
buildpacks
object[]

List of buildpacks to use during the build phase. Only applies when build type is pack.

​
allow_deploy_paths
string[]

Glob patterns for file paths that trigger a deployment. When set, only commits touching these paths trigger auto deploy. Mutually exclusive with ignore_deploy_paths.

Example:
["src/**", "package.json"]
​
ignore_deploy_paths
string[]

Glob patterns for file paths to exclude from deployment triggers. Commits that only touch ignored paths will not trigger auto deploy. Mutually exclusive with allow_deploy_paths.

Example:
["docs/**", "README.md"]
​
source
enum<string>

Where the application source code comes from. privateGit - private Git repository connected via OAuth. publicGit - public Git repository URL. dockerImage - Docker container image from a registry.

Available options:
privateGit,
publicGit,
dockerImage
Example:

"privateGit"

​
git_type
enum<string>

Git hosting provider for the repository. github - GitHub. bitbucket - Bitbucket. gitlab - GitLab. Only used when source is privateGit or publicGit.

Available options:
github,
bitbucket,
gitlab
Example:

"github"

​
repo_url
string

Full URL of the Git repository. Required when source is privateGit or publicGit.

Example:

"https://github.com/user/repo"

​
docker_image
string

Docker image reference including tag or digest. Required when source is dockerImage.

Example:

"nginx:latest"

Response

Default Response

​
id
string<uuid>
required

Unique identifier for the application

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"

​
company_id
string | null
required

Identifier of the company that owns this application

Example:

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

​
project_id
string<uuid> | null
required

Identifier of the project this application is grouped under

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"

​
name
string
required

Unique system name used in URLs and internal references. Auto-generated from the display name and cannot be changed after creation.

Required string length: 1 - 64
Example:

"my-app"

​
namespace
string | null
required

Kubernetes namespace where the application workloads run. Assigned automatically during creation.

Example:

"my-app-abc123"

​
display_name
string
required

Human-readable name shown in the dashboard and API responses

Required string length: 1 - 255
Example:

"My Application"

​
source
enum<string>
required

Where the application source code comes from. privateGit - private Git repository connected via OAuth. publicGit - public Git repository URL. dockerImage - Docker container image from a registry. app - internally created (cloned or preview apps).

Available options:
privateGit,
publicGit,
dockerImage,
app
Example:

"privateGit"

​
type
enum<string>
required

Application type. app - standard application. previewApp - ephemeral preview environment created from a pull request.

Available options:
app,
previewApp
Example:

"app"

​
status
enum<string> | null
required

Current status of the application reflecting the most recent deployment or lifecycle operation

Available options:
deploymentInProgress,
deploymentFailed,
deploymentSuccess,
deleting,
appDeletionFailed,
deploymentCancelled
Example:

"deploymentSuccess"

​
build_cache_enabled
boolean
required

When enabled, build artifacts are cached between deployments to speed up subsequent builds

Example:

true

​
hibernation_enabled
boolean
required

When enabled, the application automatically scales down to zero after a period of inactivity and wakes up on the next incoming request

Example:

false

​
hibernate_after_seconds
integer | null
required

Number of seconds of inactivity before the application is hibernated. Only applies when hibernation is enabled.

Required range: 0 < x <= 9007199254740991
Example:

3600

​
auto_deploy
boolean
required

When enabled, a new deployment is automatically triggered on every push to the default branch. Only applies to applications with a private Git connection (privateGit) - has no effect on publicGit or dockerImage applications.

Example:

true

​
wait_for_checks
boolean
required

When enabled along with auto deploy, the platform waits for all CI checks on the commit to pass before triggering a deployment

Example:

false

​
is_suspended
boolean
required

Whether the application is currently suspended. Suspended applications have all processes stopped but retain their configuration.

Example:

false

​
git_type
enum<string> | null
required

Git hosting provider for the repository. github - GitHub. bitbucket - Bitbucket. gitlab - GitLab. Null for non-git sources.

Available options:
github,
bitbucket,
gitlab
Example:

"github"

​
repo_url
string | null
required

Full URL of the Git repository. Null for Docker image source applications.

Example:

"https://github.com/user/repo"

​
default_branch
string | null
required

Git branch used for automatic and manual deployments when no branch is explicitly specified

Example:

"main"

​
docker_image
string | null
required

Docker image reference including tag or digest. Only set for applications with dockerImage source.

Example:

"nginx:latest"

​
build_type
enum<string>
required

Build strategy used to build the application. nixpacks - auto-detected build system. dockerfile - build using a Dockerfile. pack - build using Cloud Native Buildpacks.

Available options:
dockerfile,
pack,
nixpacks
Example:

"nixpacks"

​
build_path
string | null
required

Relative path to the build directory within the repository. Defaults to the repository root.

Example:

"."

​
pack_builder
string | null
required

Cloud Native Buildpacks builder image. Only applies when build type is pack.

Example:

"heroku/builder:22"

​
nixpacks_version
string | null
required

Pinned Nixpacks version. When null, the platform default version is used. Only applies when build type is nixpacks.

Example:

"1.21.0"

​
dockerfile_path
string | null
required

Relative path to the Dockerfile within the repository. Only applies when build type is dockerfile.

Example:

"Dockerfile"

​
docker_context
string | null
required

Docker build context path relative to the repository root. Only applies when build type is dockerfile.

Example:

"."

​
allow_deploy_paths
string[]
required

Glob patterns for file paths that trigger a deployment when changed. When set, only commits touching these paths will trigger auto deploy.

Example:
["src/**", "package.json"]
​
ignore_deploy_paths
string[]
required

Glob patterns for file paths to exclude from deployment triggers. Commits that only touch ignored paths will not trigger auto deploy.

Example:
["docs/**", "README.md"]
​
created_by
string | null
required

Identifier of the user who created the application

Example:

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

​
created_at
string<date-time>
required

Timestamp when the application was created, in ISO 8601 format

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Example:

"2025-01-30T00:00:00.000Z"

​
updated_at
string<date-time>
required

Timestamp when the application was last modified, in ISO 8601 format

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Example:

"2025-01-30T00:00:00.000Z"