Skip to main content

Addons API Reference

Manage addons that bundle multiple applications and jobs together for coordinated deployment and management. Addons provide a way to deploy complex multi-component systems as a single unit.

Endpoints Overview

Addon Management

List All Addons

Response:

Create Addon

Request Body (JSON):
Response:

Get Addon Details

Parameters:
  • addonName (path): Name of the addon
Response:

Deployment Management

Deploy Addon

Request Body (JSON):
Response:

Rerun Addon Deployment

Request Body (JSON):
Response:

Uninstall Addon

Request Body (JSON):
Response:

Advanced Addon Features

Job Management

Addons can include scheduled jobs that run on the target node:

Component Dependencies

Addons can define dependencies between components:

Error Responses

Common error responses for Addons API:

Best Practices

Addon Design

  • Keep addons focused on specific functionality
  • Use clear naming conventions
  • Document component dependencies
  • Test addon deployments thoroughly

Variable Management

  • Use descriptive variable names
  • Provide sensible defaults
  • Validate variable values
  • Document variable usage

Deployment Strategy

  • Test addon deployments in isolation
  • Monitor component dependencies
  • Implement proper rollback procedures
  • Set up comprehensive monitoring

Job Management

  • Use appropriate scheduling for jobs
  • Implement proper error handling
  • Monitor job execution and results
  • Set up notifications for critical jobs
For detailed schema definitions, refer to the OpenAPI specification published alongside the backend service.