Skip to content
aerandil.com
GitHub

Validate Start federated run (dry-run)

POST
/v1/actions/hospitality.action.start_federated_run/validate
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.start_federated_run/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "aggregation_protocol": "plain_aggregate_reviewed", "clean_room_job_ref": "example", "cohort_id": "example", "deadline_at": "2026-04-15T12:00:00Z", "initiating_workflow_run_id": "example", "input_window_end": "2026-04-15T12:00:00Z", "input_window_start": "2026-04-15T12:00:00Z", "privacy_budget_account_id": "example", "run_key": "example", "secure_aggregation_session_ref": "example", "trigger_kind": "scheduled" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.federated_analysis_definition" } }'

Dry-run of apply_hospitality_action_start_federated_run’s parameter checks. No side effects, no idempotency reservation, no handler dispatch — just the schema pass plus action-level shape (target presence, target type, unknown-parameter rejection). return_modified is meaningless here and ignored.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
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
aggregation_protocol
required
Aggregation protocol
string
Allowed values: plain_aggregate_reviewed secure_aggregation clean_room_dp external_protocol
clean_room_job_ref
Required for third-party clean room
string
cohort_id
required
Approved cohort id
string
deadline_at
Contribution deadline
string format: date-time
initiating_workflow_run_id
Set when a proposal 0020 workflow started this run
string
input_window_end
required
Input window end
string format: date-time
input_window_start
required
Input window start
string format: date-time
privacy_budget_account_id
Privacy budget account to reserve from. Required when the definition's mechanism_family is a DP variant; the handler dispatches reserve_privacy_budget against this account keyed on the run's correlation_id (idempotent, atomic). Resolves to the (program, composition_group) account in practice; explicit reference avoids the multi-account ambiguity at the action boundary.
string
run_key
Optional caller-supplied idempotency key; otherwise derived
string
secure_aggregation_session_ref
Required for secure aggregation
string
trigger_kind
required
Scheduled / manual / workflow / agent / backfill
string
Allowed values: scheduled manual workflow agent_request backfill
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_analysis_definition

Responses

Section titled “Responses”

200

Section titled “200”

Validation outcome. result is valid or invalid; per-parameter diagnostics are always populated for every declared parameter so a UI can render the action’s full surface.

Media typeapplication/json
object
action
required
string
errors

Action-level errors not tied to a single parameter (missing target, target type mismatch, unknown parameter names). Absent when empty.

Array<string>
parameters
required

Per-parameter diagnostics keyed by api_name.

object
key
additional properties
object
errors
Array<string>
result
required
Allowed values: valid invalid
value
required

The serialised value the server interpreted, or null if the parameter was not supplied.

result
required
Allowed values: valid invalid
Example
{
  "parameters": {
    "additionalProperty": {
      "result": "valid"
    }
  },
  "result": "valid"
}