API Methods

Application Management API Documentation

Application Management provides APIs for automating application lifecycle operations, managing hosted environments and integrating platform functionality with external systems. API access is divided into Public API methods for developers and Private API methods for cluster administrators.

Choose the appropriate API documentation according to the level of access and automation required.

Developers

Public API for Developers

The Public API is designed for users and application developers who need to manage hosted environments and automate application lifecycle operations.

  • Create and configure workloads.
  • Deploy applications.
  • Manage existing environments.
  • Automate common dashboard operations.
  • Integrate platform actions into external systems and workflows.
Open Public API Documentation
Cluster Admins

Private API for Cluster Administrators

The Private API provides full platform-level access for cluster administrators and is intended for managing sensitive cloud operations.

  • Manage infrastructure and platform services.
  • Administer accounts and cloud resources.
  • Work with billing and related platform operations.
  • Manage security-sensitive configuration.
  • Perform actions that can affect the entire installation.
Open Private API Documentation
✓

Select the correct API level

Use the Public API for application and environment automation. Private API methods should be used only by authorized cluster administrators because they can affect platform-wide infrastructure, billing, security and account management.

Public API Use Cases

Environment ManagementCreate, start, stop, restart, clone, scale or delete application environments programmatically.
Application DeploymentAutomate application deployment and integrate deployment actions with external CI/CD workflows.
Lifecycle AutomationPerform repeatable application-management tasks without manually using the dashboard.
External IntegrationsConnect platform capabilities with custom portals, billing systems, DevOps tools and other external services.

Private API Use Cases

Infrastructure AdministrationManage platform-level infrastructure and cloud resources.
Account ManagementPerform administrative operations that affect platform users and accounts.
Billing AdministrationAccess sensitive billing-related methods available only to authorized cluster administrators.
Security AdministrationManage security-sensitive settings and administrative operations that can influence the whole installation.
Application Management API automation
Use APIs to automate platform behavior and integrate Application Management with external solutions.

Important Notes

  • Use Public API methods for standard application and environment lifecycle automation.
  • Private API access is intended only for authorized cluster administrators.
  • Private methods can influence billing, security, infrastructure and account management across the installation.
  • Protect authentication tokens and administrative credentials used by API integrations.
  • Test automation scripts against non-production environments before applying them to critical workloads.

Related Documentation