Logo

Command Palette

Search for a command to run...

Stack settings operations return async action responses that track the progress and result of configuration changes to your stack settings.

Model
idinteger

The unique identifier of the async action.

userstring

The email of the user who initiated the action.

resource_typestring

The type of resource being modified (typically "stack" for settings).

actionstring

The specific action being performed on the stack settings.

resource_idstring

The ID of the resource being modified (stack ID for stack settings).

started_viastring

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

started_atdatetime

The date and time when the action started, in ISO 8601 format.

finished_atdatetime

The date and time when the action completed, in ISO 8601 format.

finished_successboolean

Whether the action completed successfully.

finished_messagestring

A message describing the result of the action.

finished_resultobject

Detailed results of the completed action.

metadataobject

Additional metadata associated with the action.

Example

{
  "id": 78901,
  "user": "admin@example.com",
  "resource_type": "stack",
  "action": "update_settings",
  "resource_id": "stack-550e8400-e29b-41d4-a716",
  "started_via": "api",
  "started_at": "2024-02-15T10:30:00Z",
  "finished_at": "2024-02-15T10:32:45Z",
  "finished_success": true,
  "finished_message": "Stack settings updated successfully",
  "finished_result": {
    "updated_settings": [
      "maintenance_mode",
      "load_balancer_timeout"
    ],
    "values_changed": 2
  },
  "metadata": {
    "settings_updated": {
      "maintenance_mode": false,
      "load_balancer_timeout": 30
    }
  }
}