Cancel federated run

POST

/v1/actions/hospitality.action.cancel_federated_run/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.cancel_federated_run/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "reason": "example" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.federated_run" } }'

• Production API

Operator-initiated cancellation of a federated run before output publication. Transitions run status to cancelled and releases the reserved privacy budget — except when the run uses local DP and has already accepted at least one contribution, in which case the local spend is non-recoverable (proposal 0021 §9) and the operator must instead drive record_federated_aggregation_result with aggregation_status = failed to commit the spend. The 4-clause observation gate (Rogers et al. 2016, Privacy Odometers and Filters, Theorem 3.4; Dwork-Roth, Algorithmic Foundations §3.5 Prop 2.1) is enforced before release: (1) no commit event for the run’s correlation_id, (2) run status ∈ {queued, privacy_review, approved, collecting, aggregating} (pre-output_review), (3) mechanism_family ≠ local_dp OR participants_accepted = 0, (4) idempotent on the run’s correlation_id (the partial unique index on privacy_budget_event enforces single-flight release).

Effects: modify hospitality.federated_run; create hospitality.privacy_budget_event; modify hospitality.privacy_budget_account.

Authorizations

• aerandil_oauth
  actions:apply
• aerandil_oauth
  actions:hospitality.action.cancel_federated_run:apply

Request Body^required

Media typeapplication/json

object

branch

Apply against an open branch’s overlay view instead of the canonical (main) plane. The action’s writes land in the branch’s copy-on-first-write overlay, its events in the branch’s own stream, and the invocation is journaled for merge-by-replay. Branch writes are action-only, so this is the write-side entry point to a branch (POST /v1/branches forks one).

string format: uuid

params

required

object

reason

Free-text operator justification (recorded as failure_reason on the run and as the audit-row reason on the release event)

string

return_modified

When true, the response carries modified_objects and modified_links projections — the engine reads the event log inside the same transaction so the projection observes the handler’s own writes.

boolean

target

required

object

id

required

string format: uuid

object_type

required

Allowed value: hospitality.federated_run

Responses

200

Action applied. modified_objects and modified_links populated when return_modified: true was supplied.

Media typeapplication/json

ApplyActionResponse

Envelope returned by the Aerandil action engine. correlation_id ties every event emitted by this invocation; modified_objects and modified_links project the events the handler emitted (per the action’s declared effects); warnings carries any non-blocking soft-validator observations.

object

correlation_id

required

Per-invocation correlation id; matches events.correlation_id for every event this action appended.

string format: uuid

modified_links

required

Links established or removed by this invocation. Empty when the caller did not request return_modified.

Array<object>

object

from_id

required

string format: uuid

from_type

required

string

kind

required

Allowed values: linked unlinked properties_updated end_dated

link_type

required

string

to_id

required

string format: uuid

to_type

required

string

modified_objects

required

Objects created, modified, or soft-deleted by this invocation. Empty when the caller did not request return_modified.

Array<object>

object

id

required

string format: uuid

kind

required

Allowed values: modified created

object_type

required

Allowed values: hospitality.federated_run hospitality.privacy_budget_event hospitality.privacy_budget_account

warnings

Non-blocking soft-validator observations emitted during this invocation (e.g. comp-authority over-limit, recipe pour-cost over sell-price). Absent when no warnings were emitted.

Array<object>

object

message

required

Human-readable summary, suitable for logging or operator-UI surfacing.

string

object_type

required

Object type the warning was raised against.

string

property

Property the warning anchors to, when a single field is the locus. Absent for multi-field rules.

string

rule

required

Stable kebab-case rule identifier (e.g. comp-authority-over-limit).

string

Example

{
  "modified_links": [
    {
      "kind": "linked"
    }
  ],
  "modified_objects": [
    {
      "kind": "modified",
      "object_type": "hospitality.federated_run"
    }
  ]
}

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.