Skip to content

activity

The activity domain has 4 actions. On the meta surface they are all reached through arcane_activity; on the individual surface each one is its own tool; on the dynamic surface run them with arcane_execute_action and the canonical ID.

ActionTitleKind
activity.cancelCancel a background activitywrite
activity.clear_historyClear background activity historydestructive
activity.getGet background activityread
activity.listList background activitiesread

Cancel a background activity

Request cancellation of a running or queued background activity

  • Kind: write
  • Required parameters: activityId
  • Meta tool: arcane_activity with "action": "cancel"
  • Individual tool: arcane_activity_cancel
  • Arcane route: POST /api/environments/{id}/activities/{activityId}/cancel
  • Operation ID: cancel-activity
  • Usage: Cancels a queued or running activity (activityId from activity.list). A finished one, or any job_run activity (use job.cancel_run for those), is refused with ‘activity is not running’. When the work is still running in Arcane the returned activity is the snapshot from before the cancellation (still queued or running), so poll activity.get until it reaches a final status. The action that started it then fails with a cancellation, while orphaned work (e.g. after a restart) is marked cancelled directly and returned as cancelled. requestedBy only names the canceller when the caller has no user name of its own.
  • Related actions: activity.list, activity.get, job.cancel_run

Clear background activity history

Delete completed background activity history for an environment

  • Kind: destructive — requires confirm: true
  • Required parameters: none
  • Meta tool: arcane_activity with "action": "clear_history"
  • Individual tool: arcane_activity_clear_history
  • Arcane route: DELETE /api/environments/{id}/activities/history
  • Operation ID: clear-activity-history
  • Usage: Deletes the finished (success, failed, cancelled) activities of this one environment, with their messages, and returns the deleted count. For a remote environment it clears both the manager’s copies and the agent’s. Queued and running activities and the event log (event.list) are untouched.
  • Related actions: activity.list, event.list

Get background activity

Get a background activity with its recent output messages

  • Kind: read
  • Required parameters: activityId
  • Meta tool: arcane_activity with "action": "get"
  • Individual tool: arcane_activity_get
  • Arcane route: GET /api/environments/{id}/activities/{activityId}
  • Operation ID: get-activity
  • Usage: One activity (activityId from activity.list, or the activityId returned by long-running actions such as environment.sync) with its output messages in chronological order. limit keeps only the newest N messages (default and maximum 500). Poll it until activity.status is success, failed or cancelled to follow progress.
  • Related actions: activity.list, activity.cancel, environment.sync

List background activities

Get current and recent background activities for an environment

  • Kind: read
  • Required parameters: none
  • Meta tool: arcane_activity with "action": "list"
  • Individual tool: arcane_activity_list
  • Arcane route: GET /api/environments/{id}/activities
  • Operation ID: list-activities
  • Usage: Background tasks of one environment (image pulls, project deploys, container stops, update checks, scans, prunes, job runs), by default queued or running first, then finished ones newest first (sort overrides this), each with id, status, progress, step, latestMessage and resourceId/resourceName. Filter by status (queued, running, success, failed, cancelled), type (e.g. container_stop, image_pull, project_deploy) or resourceType. Search matches type, resource name, latest message, step and error. For the audit log of what happened use event.list.
  • Related actions: activity.get, activity.cancel, activity.clear_history, event.list