Skip to content
aerandil.com
GitHub

Validate Allocate privacy budget account (dry-run)

POST
/v1/actions/hospitality.action.allocate_privacy_budget/validate
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.allocate_privacy_budget/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "account_scope": "tenant_program", "alert_thresholds": [ "example" ], "composition_group": "example", "composition_strategy": "basic", "definition_api_name": "example", "delta_total": "example", "epsilon_total": "example", "mechanism_family": "central_dp", "period_end": "2026-04-15T12:00:00Z", "period_kind": "run", "period_start": "2026-04-15T12:00:00Z" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.federated_intelligence_program" } }'

Dry-run of apply_hospitality_action_allocate_privacy_budget’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
account_scope
required
Account scope
string
Allowed values: tenant_program property_program definition composition_group output_recipient
alert_thresholds
Optional thresholds for operator warnings
Array<string>
composition_group
Optional
string
composition_strategy
required
Composition strategy
string
Allowed values: basic advanced rdp zcdp operator_supplied_reviewed
definition_api_name
Optional
string
delta_total
Required when delta applies
string format: decimal
epsilon_total
Required for DP accounts
string format: decimal
mechanism_family
required
Mechanism family
string
Allowed values: central_dp local_dp dp_sgd dp_clean_room none_threshold_only
period_end
Required unless lifetime
string format: date-time
period_kind
required
Period kind
string
Allowed values: run day month quarter year lifetime
period_start
required
Period start
string format: date-time
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_intelligence_program

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"
}