Skip to content
aerandil.com
GitHub

Read Agent installation

GET
/v1/object-types/hospitality.agent_installation/objects/{id}
curl --request GET \
  --url https://api.aerandil.com/v1/object-types/hospitality.agent_installation/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

Tenant / property enablement of a registry entry. Permission-bearing — enabled installations are what enable_agent_installation issues per-tenant. enabled_action_scopes and enabled_function_scopes are subsets of the registry entry’s declared maxima. installed_scope_ref is required and type-checked for non-tenant scopes; the broad catch-all scopes (actions:apply, functions:invoke) and any internal:workflow:* scope are rejected at install time.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Object id (UUID v7, server-generated at create time).

Query Parameters

Section titled “Query Parameters”
branch
string format: uuid

Read through an open branch’s copy-on-first-write overlay view instead of the canonical (main) plane. Does not compose with as_of (422). The branch must exist under the caller’s tenant.

Responses

Section titled “Responses”

200

Section titled “200”

Object found.

Media typeapplication/json
object
created_at
required
string format: date-time
id
required
string format: uuid
object_type
required
Allowed value: hospitality.agent_installation
properties
required
object
allowed_workflow_keys
Optional workflow-key allowlist; empty/null means action/function scopes decide
Array<string>
approval_policy
Gates required before this agent can execute high-risk steps. Required when any enabled action / function / allowed workflow has a risk_tier in the high-risk set (per `agent_installation_high_risk_requires_policy`).
auth_mode
required
How the installation authenticates the agent 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. `credential_reference_no_secret_material` rejects obvious secret bodies (bearer tokens, API keys, PEM blocks).
string
dispatch_endpoint_url
Runtime-published URL the proposal 0022 dispatcher POSTs signed task envelopes to (§6.1 rules: https required, http admissible only for loopback receivers). Unset = this installation is not dispatch-taskable.
string
enabled_action_scopes
required
Subset of the registry entry's declared action scopes
Array<string>
enabled_at
Enablement time
string format: date-time
enabled_by
Principal stable id that approved enablement
string
enabled_data_classes
required
Subset of the registry entry's declared data classes
Array<string>
Allowed values: public operational guest_pii staff_pii payment_metadata regulated_health secrets
enabled_function_scopes
required
Subset of the registry entry's declared function scopes
Array<string>
enabled_read_scopes
Subset of the registry entry's declared read scopes. When present it is the installation's whole object-read grant: a token minted for it carries `objects:<type>:read` for exactly these types and never the broad `objects:read`. Absent, reads are not narrowed by the installation.
Array<string>
expires_at
Optional time-bound install
string format: date-time
id
required
Installation id
string
installation_status
required
Lifecycle status
string
Allowed values: requested enabled suspended revoked disabled expired
installed_by
Principal stable id of the installer
string
installed_scope
required
Tenancy scope this installation grants access at
string
Allowed values: tenant brand portfolio property venue
installed_scope_ref
Agent installation installed scope ref

Typed reference to the scoping object. Required for non-tenant scopes; forbidden for installed_scope = tenant. Type-checked by agent_installation_scope_ref_coherent.

object
object_id
required
string
object_type
required
string
last_used_at
Updated by agent-run attribution
string format: date-time
runner_identity_ref
Stable §8.3 identity URI the runtime presents in its signed acks/results (SPIFFE URI, JWK URL, or urn:aerandil form).
string
runner_public_keys
kid → base64 Ed25519 verification keys (RFC 8032 raw 32-byte) the receiver routes verify this installation's ack / result_submit envelope signatures against. Public key material only — rotation is additive (keep old + new kid during the window).
suspended_at
Suspension time
string format: date-time
suspension_reason
Required when suspended / revoked
string
provenance

Per-property source attribution and pins. An entry under properties means the property’s current value came from that source (on the source’s own clock, source_updated_at); an entry under pins is a human override protecting the property from sourced writes.

object
pins
object
key
additional properties
object
pinned_at
string format: date-time
pinned_by
object
reason
required
string
properties
object
key
additional properties
object
external_id
string
recorded_at
required
string format: date-time
source
required
string
source_updated_at
string format: date-time
stream
string
scope
required
One of: discriminator: level
object
level
required
string
Allowed value: tenant
Allowed values: tenant
tenant_id
required
string format: uuid
updated_at
required
string format: date-time
version
required
integer
>= 1
Example
{
  "object_type": "hospitality.agent_installation",
  "properties": {
    "auth_mode": "none",
    "enabled_data_classes": [
      "public"
    ],
    "installation_status": "requested",
    "installed_scope": "tenant"
  },
  "scope": {
    "level": "tenant"
  }
}

Headers

Section titled “Headers”
ETag
string
/^"\d+"$/

Quoted strong validator (RFC 7232 §2.3) carrying the object’s monotonic version. Informational on the read path — object mutation goes through typed actions on /v1/actions/{action}/apply, not raw CRUD.

404

Section titled “404”

No object with that id (or soft-deleted).