> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.sevalla.com/llms.txt > Use this file to discover all available pages before exploring further. # Trigger deployment > Trigger a new deployment for an application. By default, deploys the latest commit on the default branch. You can optionally specify a different branch, a Docker image, or restart from the last successful deployment. The deployment runs asynchronously - use the get deployment endpoint to track its progress. ## OpenAPI ````yaml https://api.sevalla.com/v3/openapi.json post /applications/{id}/deployments openapi: 3.1.0 info: title: Sevalla API docs version: 1.0.0 servers: - url: https://api.sevalla.com/v3 security: - bearerAuth: [] paths: /applications/{id}/deployments: post: tags: - Applications summary: Trigger deployment description: >- Trigger a new deployment for an application. By default, deploys the latest commit on the default branch. You can optionally specify a different branch, a Docker image, or restart from the last successful deployment. The deployment runs asynchronously - use the get deployment endpoint to track its progress. operationId: triggerDeploymentV3 parameters: - schema: type: string format: uuid 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 in: path name: id required: true description: Application identifier requestBody: required: true content: application/json: schema: type: object properties: branch: description: >- Git branch to deploy. When omitted, the application default branch is used. Only applies to Git-based applications. example: main type: string docker_image: description: >- Docker image reference to deploy (e.g., `nginx:latest`). Only applies to applications with `dockerImage` source. example: nginx:latest type: string is_restart: default: false description: >- When true, redeploys using the existing build artifact from the last successful deployment, skipping the build step. Useful when you have updated runtime-level configuration and do not need to rebuild the application. type: boolean responses: '200': description: Default Response content: application/json: schema: type: object properties: id: type: string format: uuid 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)$ description: Unique identifier for the deployment example: fb5e5168-4281-4bec-94c5-0d1584e9e657 app_id: anyOf: - type: string format: uuid 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)$ - type: 'null' description: Identifier of the application this deployment belongs to example: fb5e5168-4281-4bec-94c5-0d1584e9e657 status: anyOf: - type: string enum: - waiting - inProgress - success - failed - cancelled - skipped - type: 'null' description: Current status of the deployment in its lifecycle example: success type: anyOf: - type: string enum: - manual - automatic - type: 'null' description: >- How the deployment was initiated. `manual` - triggered by a user or API call. `automatic` - triggered automatically by a git push or webhook. example: manual trigger: anyOf: - type: string - type: 'null' description: >- Specific action that initiated the deployment, such as MANUAL_DEPLOY, ROLLBACK_DEPLOYMENT, AUTO_DEPLOY_ON_PUSH, or RESTART example: MANUAL_DEPLOY steps: type: array items: type: string enum: - checkout - build - rollout - syncConnections description: >- Ordered list of pipeline steps this deployment will execute. `checkout` - clone the repository. `build` - build the application image. `rollout` - deploy the image to the cluster. `syncConnections` - synchronize database and service connections. example: - rollout docker_image_url: anyOf: - type: string - type: 'null' description: >- Full URL of the Docker image built or used for this deployment, including the registry path and tag example: us-central1-docker.pkg.dev/project/repo/image:abc123 git_type: anyOf: - type: string enum: - github - bitbucket - gitlab - type: 'null' description: >- Git hosting provider for the source repository. `github` - GitHub. `bitbucket` - Bitbucket. `gitlab` - GitLab. Null for Docker image deployments. example: github repo_url: anyOf: - type: string - type: 'null' description: >- Full URL of the Git repository used for this deployment. Null for Docker image deployments. example: https://github.com/user/repo branch: anyOf: - type: string - type: 'null' description: >- Git branch that was deployed. Null for Docker image deployments. example: main commit_sha: anyOf: - type: string - type: 'null' description: Full SHA hash of the Git commit that was deployed example: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2 commit_message: anyOf: - type: string - type: 'null' description: >- Commit message of the deployed Git commit, truncated to 1000 characters example: 'feat: add new feature' author_login: anyOf: - type: string - type: 'null' description: Username of the Git commit author on the hosting provider example: octocat author_img: anyOf: - type: string - type: 'null' description: >- Avatar URL of the Git commit author on the hosting provider example: https://avatars.githubusercontent.com/u/583231 started_at: anyOf: - type: string format: date-time 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))$ - type: 'null' description: >- Timestamp when the deployment started executing, in ISO 8601 format. Null if still waiting. example: '2025-01-30T00:00:00.000Z' finished_at: anyOf: - type: string format: date-time 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))$ - type: 'null' description: >- Timestamp when the deployment finished (succeeded, failed, or was cancelled), in ISO 8601 format. Null if still in progress. example: '2025-01-30T00:05:00.000Z' created_at: type: string format: date-time 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))$ description: >- Timestamp when the deployment was created, in ISO 8601 format example: '2025-01-30T00:00:00.000Z' updated_at: type: string format: date-time 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))$ description: >- Timestamp when the deployment was last modified, in ISO 8601 format example: '2025-01-30T00:00:00.000Z' required: - id - app_id - status - type - trigger - steps - docker_image_url - git_type - repo_url - branch - commit_sha - commit_message - author_login - author_img - started_at - finished_at - created_at - updated_at additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: message: type: string description: Error message example: Bad request status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: HTTP status code example: 400 data: type: object properties: code: description: Error tracking code for support reference example: err-abc-123 type: string message: description: Additional error details or instructions example: >- If you need assistance, please contact support and provide this error code. type: string additionalProperties: false required: - message - status additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: message: type: string description: Error message example: Unauthorized status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: HTTP status code example: 401 data: type: object properties: code: description: Error tracking code for support reference example: err-abc-123 type: string message: description: Additional error details or instructions example: >- If you need assistance, please contact support and provide this error code. type: string additionalProperties: false required: - message - status additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: message: type: string description: Error message example: Forbidden status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: HTTP status code example: 403 data: type: object properties: code: description: Error tracking code for support reference example: err-abc-123 type: string message: description: Additional error details or instructions example: >- If you need assistance, please contact support and provide this error code. type: string additionalProperties: false required: - message - status additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: message: type: string description: Error message example: Not found status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: HTTP status code example: 404 data: type: object properties: code: description: Error tracking code for support reference example: err-abc-123 type: string message: description: Additional error details or instructions example: >- If you need assistance, please contact support and provide this error code. type: string additionalProperties: false required: - message - status additionalProperties: false '429': description: Default Response content: application/json: schema: type: object properties: message: type: string description: Error message example: Too many requests status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: HTTP status code example: 429 data: type: object properties: code: description: Error tracking code for support reference example: err-abc-123 type: string message: description: Additional error details or instructions example: >- If you need assistance, please contact support and provide this error code. type: string additionalProperties: false required: - message - status additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: message: type: string description: Error message example: Internal Server Error status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: HTTP status code example: 500 data: type: object properties: code: description: Error tracking code for support reference example: err-abc-123 type: string message: description: Additional error details or instructions example: >- If you need assistance, please contact support and provide this error code. type: string additionalProperties: false required: - message - status additionalProperties: false components: securitySchemes: bearerAuth: type: http scheme: bearer description: >- API key authentication. Pass your API key as a Bearer token in the Authorization header. ````