Logo

Command Palette

Search for a command to run...

AsyncActions track the progress and results of long-running background operations. They provide real-time status updates for operations like deployments, server reboots, database operations, and other asynchronous tasks.

Model
idinteger

The unique identifier of the async action.

userstring

The email address of the user who initiated the action.

resource_typestring

The type of resource being operated on (e.g., "Stack", "Server", "Database").

actionstring

The name of the action being performed (e.g., "deploy", "restart", "database_create").

resource_idinteger

The database ID of the target resource.

started_viastring

How the action was initiated (e.g., "api", "web", "hook").

started_atstring

The ISO 8601 timestamp when the action was started.

finished_atstring|null

The ISO 8601 timestamp when the action completed (null if still running).

finished_successboolean|null

Whether the action completed successfully (null if still running).

finished_messagestring|null

Human-readable completion message (null if still running).

finished_resultobject|null

Structured result data containing operation-specific details (null if still running).

metadataobject

Additional action-specific metadata and parameters.

Common Action Types:

  • deploy: Stack deployment operations
  • restart: Server restart operations
  • database_create: Database creation
  • database_delete: Database deletion
  • database_user_create: Database user creation
  • database_user_delete: Database user deletion
  • stack_reboot: Stack server reboot operations

Stack Action Types:

  • clear_caches: Clear all application caches for a stack
  • maintenance_mode: Enable or disable maintenance mode for a stack
  • promote_slave_db: Promote a slave database server to master
  • resync_slave_db: Re-sync a slave database server with its master
  • disable_replication_slave_db: Disable database replication for a slave server
  • container_restart: Restart a specific container
  • service_restart: Restart containers for a specific service
  • service_pause: Pause containers for a specific service
  • service_resume: Resume containers for a specific service
  • process_restart: Restart processes on stack servers
  • process_pause: Pause processes on stack servers
  • process_resume: Resume processes on stack servers
Related Models:StackServerDatabaseUser

Example

{
  "id": 98765,
  "user": "john@example.com",
  "resource_type": "Stack",
  "action": "deploy",
  "resource_id": 12345,
  "started_via": "api",
  "started_at": "2024-01-15T10:30:00Z",
  "finished_at": "2024-01-15T10:45:00Z",
  "finished_success": true,
  "finished_message": "Deployment completed successfully",
  "finished_result": {
    "deploy_session": "deploy-session-123",
    "git_hash": "a1b2c3d4e5f6",
    "servers_deployed": 3
  },
  "metadata": {
    "git_ref": "main",
    "deployment_strategy": "rolling"
  }
}
Edit this page