Skip to main content

Applications API Reference

Deploy, manage, and monitor applications across your infrastructure with the Applications API. Supports Docker, binary/systemd, Kubernetes (Helm via basic-service), and dual-mode (Docker + binary) deployments with comprehensive lifecycle management.

Endpoints Overview

Application Management

List All Applications

Response:

Create Application

Request Body (JSON):
Response:

Get Application Details

Parameters:
  • applicationName (path): Name of the application
Response:

Deployment Management

Get Deployment Modes

Response:
For Kubernetes-only applications (setup_type: kubernetes), availableModes is ["kubernetes"] and the backend generates Helm values for the basic-service role (setup_mode: k8s). Example Kubernetes installation block:
Ensure the target node has kubectl access (KUBECONFIG / KUBE_CONTEXT as required by basic-service).

Deploy Application

Request Body (JSON):
Response:

Rerun Deployment

Request Body (JSON):
Response:

Uninstall Application

Request Body (JSON):
Response:

Deployment History & Monitoring

Get Deployment History

Response:

Advanced Features

Fetch Versions (Auto-detection)

Request Body (JSON):
Response:

Update Deployment Mode

Request Body (JSON):
Response:

Error Responses

Common error responses for Applications API:

Best Practices

Deployment Strategies

  • Use dual-mode applications when possible for flexibility
  • Test deployments in staging before production
  • Implement proper rollback procedures
  • Monitor deployment health and performance

Configuration Management

  • Use environment-specific variables
  • Implement proper secret management
  • Version control configuration files
  • Test configuration changes in isolation

Monitoring & Observability

  • Set up comprehensive logging
  • Implement health checks and monitoring
  • Monitor resource usage and performance
  • Set up alerting for critical issues
For detailed schema definitions, refer to the OpenAPI specification published alongside the backend service.