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.

The Golain Platform API is the HTTP surface for orgs, projects, fleets, devices, integrations, edge replication, OTA, and more. It is implemented by ilyama (services/apis).

​
Base URL

EnvironmentBase URL
Productionhttps://api.ilyama.golain.io/core/api/v1
Self-hostedhttps://api.<your-domain>/core/api/v1
Local vm-edgehttp://localhost:19090/core/api/v1
Paths in this reference are relative to /core/api/v1. Endpoints are grouped by resource (Organizations, Projects, Devices, Edge replication, Integrations, OTA, and more) in the sidebar — all 336 operations from the mounted ilyama route surface are included.

​
OpenAPI specification

Interactive endpoint pages below are generated from api-reference/ilyama.v1.json, synced from ilyama/services/apis/openapi/ilyama.v1.yaml. To refresh after API changes in ilyama: 
cd ../ilyama/services/apis
go run ./openapi/cmd/sync
cp openapi/ilyama.v1.json ../../docs/api-reference/ilyama.v1.json

Authentication

Bearer token, ORG-ID header, idempotency keys.

Edge sync API

Operator-focused summary of /edge/* routes.

​
Response format

Successful JSON responses follow the ilyama v1 envelope conventions (resource wrappers, list pagination meta). Errors use structured core/errs payloads with stable error codes. See the platform CLI and console guides for user-facing workflows that call these endpoints.