Skip to content
aerandil.com
GitHub

Validate Enable agent installation (dry-run)

POST
/v1/actions/hospitality.action.enable_agent_installation/validate
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.enable_agent_installation/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "allowed_workflow_keys": [ "example" ], "approval_policy": "example", "auth_mode": "none", "credential_reference": "example", "enabled_action_scopes": [ "example" ], "enabled_data_classes": [ "public" ], "enabled_function_scopes": [ "example" ], "enabled_read_scopes": [ "example" ], "enablement_note": "example", "expires_at": "2026-04-15T12:00:00Z", "installed_scope": "tenant", "installed_scope_ref_object_id": "example", "installed_scope_ref_object_type": "example" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.agent_registry_entry" } }'

Dry-run of apply_hospitality_action_enable_agent_installation’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
allowed_workflow_keys
Optional workflow-key allowlist
Array<string>
approval_policy
Gates required for high-risk steps
auth_mode
required
How the installation authenticates at call time
string
Allowed values: none oauth_client_credentials oauth_delegated api_key_reference jwt_exchange mcp_oauth
credential_reference
Opaque pointer into an external secret manager
string
enabled_action_scopes
Subset of registry entry declared action scopes
Array<string>
enabled_data_classes
Subset of registry entry declared data classes
Array<string>
Allowed values: public operational guest_pii staff_pii payment_metadata regulated_health secrets
enabled_function_scopes
Subset of registry entry declared function scopes
Array<string>
enabled_read_scopes
Subset of registry entry declared read scopes; defaults to all of them
Array<string>
enablement_note
Free-text note
string
expires_at
Optional time-bound install
string format: date-time
installed_scope
required
Tenancy scope this installation grants access at
string
Allowed values: tenant brand portfolio property venue
installed_scope_ref_object_id
Required when installed_scope != tenant
string
installed_scope_ref_object_type
Required when installed_scope != tenant
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.agent_registry_entry

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