CLI reference — Boxes

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.

10 operations in this area.

adminGetBoxForgeNpmConsumeConfig

PRD-405 — operator debug view of a box’s SYSTEM Forge npm consume credential

CLI (preferred):

nayaone-admin api adminGetBoxForgeNpmConsumeConfig --param boxId=<boxId>

REST fallback: GET /admin-api/boxes/{boxId}/forge-npm-consume-config

adminGetBoxTunnelStatus

Get box tunnel status (Admin only)

CLI (preferred):

nayaone-admin api adminGetBoxTunnelStatus --param id=<id>

REST fallback: GET /admin-api/boxes/{id}/tunnel-status

adminInstallBoxCapability

Ensure a per-box capability subscription (platform admin or provision secret)

CLI (preferred):

nayaone-admin api adminInstallBoxCapability --param boxId=<boxId> --param catalogSlug=<catalogSlug> --body '{}'

REST fallback: POST /admin-api/boxes/{boxId}/capabilities/{catalogSlug}/install

adminListBoxEffectiveCapabilities

Debug: effective capabilities for a box (platform admin)

CLI (preferred):

nayaone-admin api adminListBoxEffectiveCapabilities --param boxId=<boxId>

REST fallback: GET /admin-api/boxes/{boxId}/effective-capabilities

adminListBoxEffectiveCredentials

Operator debug view of a box’s effective credentials

CLI (preferred):

nayaone-admin api adminListBoxEffectiveCredentials --param boxId=<boxId>

REST fallback: GET /admin-api/boxes/{boxId}/effective-credentials

adminListBoxJournalEvents

List recent journal events for a box (admin — PRD-234)

CLI (preferred):

nayaone-admin api adminListBoxJournalEvents --param boxId=<boxId>

REST fallback: GET /admin-api/boxes/{boxId}/journal-events

adminListBoxResources

Get box resources (Admin only)

CLI (preferred):

nayaone-admin api adminListBoxResources --param id=<id>

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

adminListBoxSshKeyHistory

List SSH-keypair rotation history for (boxId, roleName) (admin — PRD-263 Phase H)

CLI (preferred):

nayaone-admin api adminListBoxSshKeyHistory --param boxId=<boxId>

REST fallback: GET /admin-api/boxes/{boxId}/ssh-key-history

adminListDeletedBoxes

List every soft-deleted box (admin restore tab)

CLI (preferred):

nayaone-admin api adminListDeletedBoxes

REST fallback: GET /admin-api/boxes/deleted

adminRestoreBox

Restore a soft-deleted box

CLI (preferred):

nayaone-admin api adminRestoreBox --param boxId=<boxId> --body '{}'

REST fallback: POST /admin-api/boxes/{boxId}/restore