Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ilyama.golain.io/llms.txt

Use this file to discover all available pages before exploring further.

Base path:
/core/api/v1/projects/{project_id}/edge/...
Fleet-scoped registry routes also exist under:
/core/api/v1/projects/{project_id}/fleets/{fleet_id}/edge/...

Authentication

  • Authorization: Bearer — user OIDC token (same as console)
  • ORG-ID header — active organization
  • Mutations require Idempotency-Key header (forwarded to integration worker RPC)

Permissions

OperationPermission
GET lineages, reviews, staged/mirror rowsAuthorized SQL read (device→project join)
POST claim/approve/reject, DELETE lineage, reset materialization, PATCH policyPROJECT_CAN_MANAGE_DEVICES
OpenAPI source: ilyama.v1.yaml (~line 5766+).

Lineages

MethodPathDescription
GET/edge/lineagesList lineages. Query: device_id, fleet_id, status, pagination
GET/edge/lineages/{lineage_id}Detail + schema versions + bindings
GET/edge/lineages/{lineage_id}/staged-rowsStaged row payloads
GET/edge/lineages/{lineage_id}/mirror-rowsMaterialized mirror rows
POST/edge/lineages/{lineage_id}/reset-materializationClear materialization CB; may resume downlink
DELETE/edge/lineages/{lineage_id}Remove sync state for device+table

Example — list paused lineages

curl -s -H "Authorization: Bearer $TOKEN" -H "ORG-ID: $ORG_ID" \
  "$API/core/api/v1/projects/$PROJECT_ID/edge/lineages?status=paused"

Device schema reviews

MethodPathDescription
GET/edge/schema-reviewsList reviews. Filter: status, lineage_id, …
GET/edge/schema-reviews/{review_id}Review detail
POST/edge/schema-reviews/{review_id}/claimBody: { "action_version": N }
POST/edge/schema-reviews/{review_id}/approveBody: { "action_version", "column_actions": [...] }
POST/edge/schema-reviews/{review_id}/rejectBody: { "action_version", "reason"?: string }
Schema review workflow

Registry and coalescing (project scope)

MethodPath
GET/edge/registry
GET/edge/registry/{registry_id}
GET/edge/registry-reviews
GET/edge/registry-reviews/{review_id}
POST/edge/registry-reviews/{review_id}/claim
POST/edge/registry-reviews/{review_id}/approve
POST/edge/registry-reviews/{review_id}/reject
POST/edge/registry-reviews/{review_id}/abandon
GET/edge/coalesced-mirrors
GET/edge/coalesced-mirrors/{mirror_id}
POST/edge/coalesced-mirrors/{source_table}/consolidate
Registry coalescing

Policy

MethodPathDescription
PATCH/edge/policySet schema_coalescing_mode, backlog caps, additive policy flags
Example:
{
  "schema_coalescing_mode": "fleet",
  "max_pending_rows_per_lineage": 100000,
  "max_pending_bytes_per_lineage": 1073741824,
  "resume_threshold_percent": 80
}

RPC mapping (internal)

HTTP mutations call integration worker RPCs on platform_exchange / integration_rpc_queue:
RPCHTTP
integration.edge_schema_review.claimPOST …/claim
integration.edge_schema_review.approvePOST …/approve
integration.edge_schema_review.rejectPOST …/reject
integration.edge_table_lineage.reset_materializationPOST …/reset-materialization
integration.edge_table_lineage.deleteDELETE lineage
integration.edge_replication_policy.set_coalescing_modePATCH …/policy
integration.edge_coalesced_mirror.consolidatePOST …/consolidate

Response envelopes

Follow standard ilyama HTTP JSON envelopes — list endpoints return pagination meta; single resources wrap the object. Errors use core/errs public messages.