Documentation

Comprehensive guides and technical references to help you master our deployment platform.

Getting Started Configuration CI/CD Setup API Reference

Getting Started

Welcome to Deployments. This documentation will help you understand how to efficiently manage your deployment workflows. Begin by creating an account and connecting your version control system.

Step-by-Step Guide

Sign up for a free account
Connect your GitHub/GitLab/Bitbucket repo
Create deployment pipelines with YAML
Monitor builds in the dashboard

Configuration

Deployment Config File


# .deployment/deploy.yml
pipeline:
  stages:
    - name: Build
      commands:
        - npm install
        - npm run build

    - name: Test
      commands:
        - npm test

    - name: Production Deploy
      env: production
      commands:
        - ./deploy.sh

All configuration files must be committed to the .deployment directory in your repository. See the format reference docs below for full syntax details.

CI/CD Integration

Supported Systems

GitHub

Full commit history and PR workflow integration

GitLab

Project pipelines and protected branches

Bitbucket

Smart pipelines with code quality checks

API Reference

All API endpoints use Bearer authentication and require the `application/json` content type.

Get Deployment Status


                                GET /v1/deployments/{id}/status
                                

                                Authorization: Bearer YOUR_API_TOKEN
                                

                                Accept: application/json

Returns the current status of a specific deployment including logs, environment details, and completion state.