Skip to content

CLI reference — Organizations

Generated by bun run generate:cli-reference from spec/admin-api-openapi.json. Do not hand-edit — regenerate after refreshing the spec.

Every operation below is documented CLI-first (nayaone-admin api <operationId>) per PRD-407/DO-7. The REST /admin-api/* method+path is the fallback/alternative integration option.

4 operations in this area.

Get an organisation’s plan + resolved entitlement matrix (Admin only)

CLI (preferred):

Terminal window
nayaone-admin api adminGetOrgPlan --param id=<id>

REST fallback: GET /admin-api/organizations/{id}/plan

List all organizations (Admin only)

CLI (preferred):

Terminal window
nayaone-admin api adminListOrganizations

REST fallback: GET /admin-api/organizations

Get aggregated resources for all boxes in an org (Admin only)

CLI (preferred):

Terminal window
nayaone-admin api adminListOrgResources --param id=<id>

REST fallback: GET /admin-api/organizations/{id}/resources

Set an organisation’s plan (Admin only)

CLI (preferred):

Terminal window
nayaone-admin api adminPatchOrgPlan --param id=<id> --body '{}'

REST fallback: PATCH /admin-api/organizations/{id}/plan