HTTP route reference
Generated file. Do not edit by hand. Regenerate from the repo root with
CGO_ENABLED=0 go run scripts/gen-routes-md.go.
One row per (method, path) each module’s router registers, walked from
the same chi trees the daemon flattens onto its listeners, so a route
appears here iff a router registers it. Paths under /internal/ are
cluster-peer RPC served only on the mTLS internal listener (default
:4003); the shared public mux (TCP + UDS) drops them, except
/internal/ws/forward, which mounts behind a transport gate that 404s
any non-UDS caller. The public TCP listener serves no /internal/
surface at all. Method WS marks WebSocket upgrades (registered
against chi as GET; the upgrade happens inside the handler).
The Permission column is the scope a route’s RequirePermissions
gate enforces, probed straight off each router’s live middleware chain,
so it cannot drift from the wiring. open marks a route left open to any
authenticated caller (the local CLI over the UDS resolves as the
synthetic admin). Multiple scopes carry OR semantics: any one grants
access.
Request semantics per endpoint live in the hand-maintained per-module pages in this directory; response models in the generated response model reference; error codes in the error code reference.
Total: 472 routes across 56 modules.
acme: 1 routeadapter: 1 routeapp: 49 routes · notesaudit: 3 routes · notesauth: 22 routesbackup: 61 routes · notesbackup_browse_router: 12 routesbackup_mount_router: 19 routesbranding: 5 routesca: 8 routescapabilities: 1 routecatalog: 3 routesclone: 7 routes · notescluster: 37 routes · notescondition: 2 routesconfig: 4 routes · notesconnections: 8 routesconsole: 3 routescontainerbroker: 1 routecron: 1 routedns: 8 routesdoctor: 4 routeseventpressure: 2 routesevents: 2 routes · notesexport: 3 routes · notesfence: 16 routesforward: 2 routeshealth: 5 routes · notesinternal_rpc: 3 routesjob: 7 routes · noteslauncher: 1 routeleader: 2 routeslicense: 6 routeslogs: 5 routes · notesmcp: 4 routesnetwork: 4 routesnode: 6 routes · notesnotification: 3 routesportal: 4 routesportforward: 2 routespurge: 1 routequota: 6 routes · notesrepo: 10 routes · notesretention: 5 routesscan: 1 routeschedule: 9 routes · notessearch: 1 route · notesshell: 3 routesstack: 10 routes · notesstorage: 31 routes · notessupportbundle: 2 routestask: 4 routes · notestelemetry: 2 routestenant: 5 routes · notesuser: 26 routesvault: 19 routes · notes
Source: modules/acme/
Count: 1
| Method | Path | Permission |
|---|---|---|
GET | /.well-known/acme-challenge/{token} | open |
adapter
Section titled “adapter”Source: modules/adapter/
Count: 1
| Method | Path | Permission |
|---|---|---|
GET | /api/method/shc.adapter.ls | tenant:read |
Source: modules/app/ · Notes: app.md
Count: 49
| Method | Path | Permission |
|---|---|---|
GET | /.well-known/cloud/v1 | open |
GET | /.well-known/cloud/v1/ca/{file} | open |
GET | /.well-known/shc/v1 | open |
GET | /api/health | open |
GET | /api/method/shc.app.detail | stack:read |
GET | /api/method/shc.app.icon | open |
POST | /api/method/shc.app.upload | stack:operate |
GET | /api/method/shc.cert.delivery | open |
GET | /api/method/shc.cert.edge | open |
POST | /api/method/shc.cluster.confirm_restore | open |
POST | /api/method/shc.cluster.host_set | open |
GET | /api/method/shc.cluster.host_show | open |
GET | /api/method/shc.ingress.cat | open |
GET | /api/method/shc.ingress.ls | open |
GET | /api/method/shc.integration.graph | stack:read |
GET | /api/method/shc.integration.list | stack:read |
POST | /api/method/shc.integration.provision | stack:manage |
GET | /api/method/shc.operation.list | stack:read |
GET | /api/method/shc.plug.list | stack:read |
GET | /api/method/shc.socket.list | stack:read |
POST | /api/method/shc.stack.install | stack:manage |
POST | /api/method/shc.stack.lease_clear | stack:operate |
POST | /api/method/shc.stack.lease_renew | stack:operate |
GET | /api/method/shc.stack.lease_show | stack:read |
POST | /api/method/shc.stack.protect | stack:manage |
GET | /api/method/shc.stack.protect_show | stack:read |
POST | /api/method/shc.stack.repoint | stack:manage |
GET | /api/method/shc.stack.services | stack:read |
GET | /api/method/shc.stack.status | stack:read |
POST | /api/method/shc.stack.uninstall | stack:manage |
POST | /api/method/shc.stack.unprotect | stack:manage |
POST | /api/method/shc.stack.update | stack:manage |
POST | /api/method/shc.stack.update_plan | stack:manage |
POST | /api/method/shc.stack.update_rollback | stack:manage |
GET | /api/method/shc.stack.usage | stack:read |
POST | /api/method/shc.system.complete | open |
POST | /api/method/shc.system.keycloak_reset_admin_password | open |
POST | /api/method/shc.system.openobserve_reset_admin_password | open |
POST | /api/method/shc.system.plan | open |
GET | /api/method/shc.system.ready | open |
GET | /api/resource/App | open |
GET | /api/resource/App/{name} | open |
GET | /api/resource/Deployment | platform:read or stack:read |
DELETE | /api/resource/Deployment/{name} | stack:manage |
GET | /api/resource/Deployment/{name} | stack:read |
GET | /api/resource/Environment | stack:read |
GET | /api/resource/Stack | stack:read |
GET | /api/status | open |
POST | /api/telemetry | open |
Source: modules/audit/ · Notes: audit.md
Count: 3
| Method | Path | Permission |
|---|---|---|
GET | /api/method/shc.audit.verify | platform:manage |
GET | /api/resource/Audit | audit:read |
GET | /api/resource/Audit/{audit_id} | audit:read |
Source: modules/auth/
Count: 22
| Method | Path | Permission |
|---|---|---|
POST | /api/auth/backchannel-logout | open |
GET | /api/auth/ca | open |
GET | /api/auth/forward-auth | open |
POST | /api/auth/identity-provider | platform:manage |
DELETE | /api/auth/identity-provider/{tenant}/{alias} | platform:manage |
GET | /api/auth/identity-provider/{tenant}/{alias} | platform:manage |
PUT | /api/auth/identity-provider/{tenant}/{alias} | platform:manage |
GET | /api/auth/lan-refusal | open |
POST | /api/auth/ldap-bind | platform:manage |
DELETE | /api/auth/ldap-bind/{tenant}/{name} | platform:manage |
GET | /api/auth/ldap-binds | platform:manage |
POST | /api/auth/oidc-client | platform:manage |
DELETE | /api/auth/oidc-client/{tenant}/{clientId} | platform:manage |
GET | /api/auth/oidc-client/{tenant}/{clientId} | platform:manage |
PUT | /api/auth/oidc-client/{tenant}/{clientId} | platform:manage |
GET | /api/auth/oidc/discovery | open |
GET | /api/auth/oidc/realm | open |
GET | /api/auth/oidc/realm-for-host | open |
POST | /api/auth/service-client | platform:manage |
DELETE | /api/auth/service-client/{name} | platform:manage |
GET | /api/auth/service-clients | platform:manage |
POST | /api/auth/session-revoke | open |
backup
Section titled “backup”Source: modules/backup/ · Notes: backup.md
Count: 61
| Method | Path | Permission |
|---|---|---|
POST | /api/method/shc.backup.create | stack:operate |
POST | /api/method/shc.backup.create_async | stack:operate |
POST | /api/method/shc.backup.detect_snapshot | platform:manage |
GET | /api/method/shc.backup.export/{backup_id} | stack:manage |
POST | /api/method/shc.backup.group | stack:operate |
GET | /api/method/shc.backup.group_manifest/{consistency_id} | stack:read |
POST | /api/method/shc.backup.import | platform:manage |
POST | /api/method/shc.backup.import_async | platform:manage |
POST | /api/method/shc.backup.import_store | platform:manage |
POST | /api/method/shc.backup.import_store_async | platform:manage |
GET | /api/method/shc.backup.key.ls | platform:manage |
POST | /api/method/shc.backup.key.rm | platform:manage |
POST | /api/method/shc.backup.key.rotate | platform:manage |
POST | /api/method/shc.backup.mirror | platform:manage |
POST | /api/method/shc.backup.mirror_async | platform:manage |
POST | /api/method/shc.backup.mount | platform:manage |
GET | /api/method/shc.backup.mounts | platform:manage |
GET | /api/method/shc.backup.orphan.list | stack:read |
POST | /api/method/shc.backup.orphan.scan | stack:operate |
POST | /api/method/shc.backup.prune | platform:manage |
POST | /api/method/shc.backup.recover | open |
POST | /api/method/shc.backup.recover_async | open |
POST | /api/method/shc.backup.relocate | platform:manage |
POST | /api/method/shc.backup.restore | stack:manage |
POST | /api/method/shc.backup.restore_as_new | stack:manage |
POST | /api/method/shc.backup.restore_async | stack:manage |
POST | /api/method/shc.backup.restore_from_file | platform:manage |
POST | /api/method/shc.backup.restore_from_file_async | platform:manage |
GET | /api/method/shc.backup.restore_from_file_check | platform:manage |
POST | /api/method/shc.backup.restore_group/{consistency_id} | stack:manage |
POST | /api/method/shc.backup.restore_group_async/{consistency_id} | stack:manage |
POST | /api/method/shc.backup.schedule.get | stack:read |
GET | /api/method/shc.backup.schedule.list | stack:read |
POST | /api/method/shc.backup.schedule.list | stack:read |
POST | /api/method/shc.backup.schedule.run | stack:operate |
POST | /api/method/shc.backup.schedule.set | stack:operate |
POST | /api/method/shc.backup.schedule.unset | stack:operate |
POST | /api/method/shc.backup.sync | stack:operate |
POST | /api/method/shc.backup.umount | platform:manage |
POST | /api/method/shc.backup.ungroup/{group_id} | stack:operate |
POST | /api/method/shc.backup.verify/{backup_id} | stack:operate |
POST | /api/method/shc.operation.cancel/{operation_id} | stack:manage |
GET | /api/method/shc.operation.state/{operation_id} | stack:read |
GET | /api/method/shc.operation.stream/{operation_id} | stack:read |
POST | /api/method/shc.pod.mount | platform:manage |
POST | /api/method/shc.stack.rollback | stack:manage |
POST | /api/method/shc.stack.rollback.list | stack:read |
POST | /api/method/shc.stack.rollback_async | stack:manage |
GET | /api/method/shc.volume.files.get | stack:manage |
GET | /api/method/shc.volume.files.ls | stack:read |
POST | /api/method/shc.volume.files.mv | stack:manage |
POST | /api/method/shc.volume.files.put | stack:manage |
POST | /api/method/shc.volume.files.rm | stack:manage |
GET | /api/method/shc.volume.files.volumes | stack:read |
POST | /api/method/shc.volume.mount | platform:manage |
GET | /api/method/shc.volume.mounts | platform:manage |
POST | /api/method/shc.volume.umount | platform:manage |
GET | /api/resource/Backup | stack:read |
DELETE | /api/resource/Backup/{backup_id} | stack:manage |
GET | /api/resource/Backup/{backup_id} | stack:read |
GET | /api/resource/Backup/{backup_id}/manifest | stack:read |
backup_browse_router
Section titled “backup_browse_router”Source: modules/backup/mount/
Count: 12
| Method | Path | Permission |
|---|---|---|
POST | /api/method/shc.backup.browse.open | tenant:manage |
DELETE | /api/method/shc.backup.browse.{session_id} | tenant:manage |
GET | /api/method/shc.backup.browse.{session_id}/changes | tenant:manage |
POST | /api/method/shc.backup.browse.{session_id}/commit | tenant:manage |
POST | /api/method/shc.backup.browse.{session_id}/discard | tenant:manage |
GET | /api/method/shc.backup.browse.{session_id}/download | tenant:manage |
DELETE | /api/method/shc.backup.browse.{session_id}/file | tenant:manage |
GET | /api/method/shc.backup.browse.{session_id}/file | tenant:manage |
PUT | /api/method/shc.backup.browse.{session_id}/file | tenant:manage |
POST | /api/method/shc.backup.browse.{session_id}/mkdir | tenant:manage |
GET | /api/method/shc.backup.browse.{session_id}/readdir | tenant:manage |
GET | /api/method/shc.backup.verify_derived/{backup_id} | tenant:manage |
backup_mount_router
Section titled “backup_mount_router”Source: modules/backup/mount/
Count: 19
| Method | Path | Permission |
|---|---|---|
POST | /api/method/shc.mount.create | platform:manage |
GET | /api/method/shc.mount.list | platform:manage |
POST | /api/method/shc.mount.ping/{session_id} | platform:manage |
GET | /api/method/shc.mount.subscribe/{session_id} | platform:manage |
DELETE | /api/method/shc.mount.{session_id} | platform:manage |
GET | /api/method/shc.mount.{session_id}/changes | platform:manage |
POST | /api/method/shc.mount.{session_id}/chmod | platform:manage |
POST | /api/method/shc.mount.{session_id}/commit | platform:manage |
POST | /api/method/shc.mount.{session_id}/create | platform:manage |
POST | /api/method/shc.mount.{session_id}/discard | platform:manage |
POST | /api/method/shc.mount.{session_id}/mkdir | platform:manage |
GET | /api/method/shc.mount.{session_id}/read | platform:manage |
GET | /api/method/shc.mount.{session_id}/readdir | platform:manage |
POST | /api/method/shc.mount.{session_id}/rename | platform:manage |
DELETE | /api/method/shc.mount.{session_id}/rmdir | platform:manage |
GET | /api/method/shc.mount.{session_id}/stat | platform:manage |
POST | /api/method/shc.mount.{session_id}/symlink | platform:manage |
DELETE | /api/method/shc.mount.{session_id}/unlink | platform:manage |
PUT | /api/method/shc.mount.{session_id}/write | platform:manage |
branding
Section titled “branding”Count: 5
| Method | Path | Permission |
|---|---|---|
DELETE | /api/method/shc.branding.brand/{name} | open |
PUT | /api/method/shc.branding.brand/{name} | open |
GET | /api/method/shc.branding.brands | open |
GET | /branding/brands/{name}/{file} | open |
HEAD | /branding/brands/{name}/{file} | open |
Source: modules/ca/
Count: 8
| Method | Path | Permission |
|---|---|---|
POST | /api/method/shc.ca.import | open |
POST | /api/method/shc.ca.provision | open |
POST | /api/method/shc.ca.reprovision | open |
POST | /api/method/shc.ca.reprovision_async | open |
GET | /api/method/shc.ca.root_cert | open |
GET | /api/method/shc.ca.show | open |
GET | /api/method/shc.cert.list | open |
GET | /api/method/shc.cert.node_leaves | platform:manage |
capabilities
Section titled “capabilities”Source: modules/capabilities/
Count: 1
| Method | Path | Permission |
|---|---|---|
GET | /api/capabilities | open |
catalog
Section titled “catalog”Source: modules/catalog/
Count: 3
| Method | Path | Permission |
|---|---|---|
POST | /api/method/shc.catalog.compile | open |
GET | /api/method/shc.catalog.list | open |
GET | /api/method/shc.catalog.updates | stack:read |
Source: modules/clone/ · Notes: clone.md
Count: 7
| Method | Path | Permission |
|---|---|---|
POST | /api/method/shc.stack.clone | stack:manage |
POST | /api/method/shc.stack.finish_forward | platform:manage |
POST | /api/method/shc.stack.interrupted | platform:manage |
POST | /api/method/shc.stack.reclaim | platform:manage |
POST | /api/method/shc.stack.relocate | stack:manage |
POST | /api/method/shc.stack.rename | stack:manage |
POST | /api/method/shc.stack.roll_back | platform:manage |
cluster
Section titled “cluster”Source: modules/cluster/ · Notes: cluster.md
Count: 37
| Method | Path | Permission |
|---|---|---|
POST | /api/method/shc.cluster.block.add | platform:manage |
GET | /api/method/shc.cluster.block.list | platform:manage |
GET | /api/method/shc.cluster.certs.list | platform:manage |
POST | /api/method/shc.cluster.certs.rotate | platform:manage |
POST | /api/method/shc.cluster.certs.rotate_now | platform:manage |
POST | /api/method/shc.cluster.cordon | platform:manage |
POST | /api/method/shc.cluster.drain | platform:manage |
GET | /api/method/shc.cluster.drain_plan | platform:manage |
GET | /api/method/shc.cluster.fabric.explain | platform:manage |
GET | /api/method/shc.cluster.fabric.status | platform:manage |
GET | /api/method/shc.cluster.fabric.vips | platform:manage |
POST | /api/method/shc.cluster.force_leader | platform:manage |
POST | /api/method/shc.cluster.forget | platform:manage |
POST | /api/method/shc.cluster.leave | platform:manage |
GET | /api/method/shc.cluster.logs | platform:manage |
POST | /api/method/shc.cluster.maintenance | platform:manage |
POST | /api/method/shc.cluster.mesh.client.enrol | platform:manage |
GET | /api/method/shc.cluster.mesh.client.ls | platform:manage |
GET | /api/method/shc.cluster.mesh.client.peers | platform:manage |
POST | /api/method/shc.cluster.mesh.client.revoke | platform:manage |
GET | /api/method/shc.cluster.mesh.diagnose | platform:manage |
POST | /api/method/shc.cluster.mesh.rotate | platform:manage |
GET | /api/method/shc.cluster.mesh.status | platform:manage |
GET | /api/method/shc.cluster.nodes | platform:manage |
GET | /api/method/shc.cluster.ping | platform:manage |
GET | /api/method/shc.cluster.preflight | platform:manage |
POST | /api/method/shc.cluster.prune_images | platform:manage |
POST | /api/method/shc.cluster.rebalance | platform:manage |
POST | /api/method/shc.cluster.repair | platform:manage |
DELETE | /api/method/shc.cluster.rm | platform:manage |
GET | /api/method/shc.cluster.status | tenant:read |
POST | /api/method/shc.cluster.token | platform:manage |
POST | /api/method/shc.cluster.uncordon | platform:manage |
POST | /api/method/shc.cluster.undrain | platform:manage |
GET | /api/method/shc.node.ls | platform:manage |
GET | /api/method/shc.node.status | platform:manage |
POST | /api/method/shc.node.update | platform:manage |
condition
Section titled “condition”Source: modules/condition/
Count: 2
| Method | Path | Permission |
|---|---|---|
GET | /api/conditions | platform:read |
GET | /api/conditions/catalog | platform:read |
config
Section titled “config”Source: modules/config/ · Notes: config.md
Count: 4
| Method | Path | Permission |
|---|---|---|
POST | /api/method/shc.config.get | open |
POST | /api/method/shc.config.list | open |
POST | /api/method/shc.config.set | platform:manage |
POST | /api/method/shc.config.unset | platform:manage |
connections
Section titled “connections”Source: modules/connections/
Count: 8
| Method | Path | Permission |
|---|---|---|
POST | /api/method/shc.provider.connect | open |
POST | /api/method/shc.provider.grant | open |
GET | /api/method/shc.provider.grants | open |
GET | /api/method/shc.provider.list | open |
POST | /api/method/shc.provider.revoke_grant | open |
POST | /api/method/shc.provider.rm | open |
GET | /api/method/shc.provider.show | open |
POST | /api/method/shc.provider.zones | open |
console
Section titled “console”Source: modules/console/
Count: 3
| Method | Path | Permission |
|---|---|---|
GET | /api/method/shc.console.config | open |
GET | /api/method/shc.console.gate | open |
GET | /api/method/shc.console.reach | open |
containerbroker
Section titled “containerbroker”Source: modules/containerbroker/
Count: 1
| Method | Path | Permission |
|---|---|---|
POST | /api/method/shc.container.run | tenant:manage |
Source: modules/cron/
Count: 1
| Method | Path | Permission |
|---|---|---|
GET | /api/method/shc.cron.list | platform:manage |
Source: modules/dns/
Count: 8
| Method | Path | Permission |
|---|---|---|
GET | /api/dns/inventory | tenant:read |
POST | /api/dns/reap | platform:manage |
DELETE | /api/dns/record | platform:manage |
GET | /api/dns/record | open |
POST | /api/dns/record | platform:manage |
GET | /api/dns/records | open |
POST | /api/dns/takeover | platform:manage |
GET | /api/dns/validate | open |
doctor
Section titled “doctor”Source: modules/doctor/
Count: 4
| Method | Path | Permission |
|---|---|---|
GET | /api/doctor/diagnoses | platform:manage |
POST | /api/doctor/origin-probe | platform:manage |
POST | /api/doctor/run | platform:manage |
POST | /api/doctor/run_async | platform:manage |
eventpressure
Section titled “eventpressure”Source: modules/events/
Count: 2
| Method | Path | Permission |
|---|---|---|
GET | /api/method/shc.events.pressure | events:read |
POST | /api/method/shc.events.prune | tenant:manage |
events
Section titled “events”Source: modules/events/ · Notes: events.md
Count: 2
| Method | Path | Permission |
|---|---|---|
GET | /api/method/shc.events.errors.stream | events:read |
GET | /api/method/shc.events.stream | events:read |
export
Section titled “export”Source: modules/export/ · Notes: export.md
Count: 3
| Method | Path | Permission |
|---|---|---|
POST | /api/method/shc.export.export_async | platform:manage |
POST | /api/method/shc.export.import_async | platform:manage |
POST | /api/method/shc.export.list | stack:read |
Source: modules/fence/
Count: 16
| Method | Path | Permission |
|---|---|---|
POST | /api/method/shc.constraint.clear | platform:manage or tenant:manage |
POST | /api/method/shc.constraint.explain | stack:read |
POST | /api/method/shc.constraint.follow | stack:read |
POST | /api/method/shc.constraint.get | stack:read |
POST | /api/method/shc.constraint.list | stack:read |
POST | /api/method/shc.constraint.set | platform:manage or tenant:manage |
POST | /api/method/shc.label.get | platform:manage |
POST | /api/method/shc.label.index | platform:manage |
POST | /api/method/shc.label.list | platform:manage |
POST | /api/method/shc.label.set | platform:manage |
POST | /api/method/shc.label.update | platform:manage |
POST | /api/method/shc.node.control-plane | platform:manage |
POST | /api/method/shc.selector.delete | platform:manage or tenant:manage |
POST | /api/method/shc.selector.get | open |
POST | /api/method/shc.selector.list | open |
POST | /api/method/shc.selector.set | platform:manage or tenant:manage |
forward
Section titled “forward”Source: modules/forward/
Count: 2
| Method | Path | Permission |
|---|---|---|
GET | /forward-auth | open |
HEAD | /forward-auth | open |
health
Section titled “health”Source: modules/health/ · Notes: health.md
Count: 5
| Method | Path | Permission |
|---|---|---|
POST | /api/method/shc.db.snapshot.create | platform:manage |
GET | /api/method/shc.db.snapshot.list | platform:manage |
GET | /api/method/shc.status.freeze | stack:read |
GET | /api/method/shc.status.get | stack:read |
POST | /api/method/shc.status.get | stack:read |
internal_rpc
Section titled “internal_rpc”Source: modules/internal_rpc/
Count: 3
| Method | Path | Permission |
|---|---|---|
POST | /api/join/{function_name} | open |
POST | /internal/rpc/{function_name} | open |
GET | /internal/transfer/{id} | open |
Source: modules/job/ · Notes: job.md
Count: 7
| Method | Path | Permission |
|---|---|---|
POST | /api/method/shc.job.cancel | stack:operate |
GET | /api/method/shc.job.get | stack:read |
GET | /api/method/shc.job.list | stack:read |
POST | /api/method/shc.job.run | stack:operate |
GET | /api/resource/Job/{job_name} | stack:read |
GET | /api/resource/JobRun | stack:read |
GET | /api/resource/JobRun/{name} | stack:read |
launcher
Section titled “launcher”Count: 1
| Method | Path | Permission |
|---|---|---|
GET | /api/method/shc.launcher.gate | open |
leader
Section titled “leader”Source: modules/leader/
Count: 2
| Method | Path | Permission |
|---|---|---|
GET | /api/method/shc.leader.health | platform:manage |
GET | /api/method/shc.leader.status | platform:manage |
license
Section titled “license”Source: modules/license/
Count: 6
| Method | Path | Permission |
|---|---|---|
GET | /.well-known/shc-license-challenge | open |
POST | /api/method/shc.license.activate | open |
POST | /api/method/shc.license.delink | open |
POST | /api/method/shc.license.refresh | open |
GET | /api/method/shc.license.status | open |
POST | /api/method/shc.license.trial | open |
Source: modules/logs/ · Notes: logs.md
Count: 5
| Method | Path | Permission |
|---|---|---|
GET | /api/method/shc.logs.get | open |
GET | /api/method/shc.stack.logs.stream | open |
WS | /internal/containers/{container_id}/logs/ws | open |
WS | /internal/stacks/{deployment_id}/logs/ws | open |
WS | /internal/ws/logs | open |
Source: modules/mcp/
Count: 4
| Method | Path | Permission |
|---|---|---|
DELETE | /api/mcp | open |
GET | /api/mcp | open |
POST | /api/mcp | open |
GET | /api/method/shc.mcp.gate | open |
network
Section titled “network”Source: modules/network/
Count: 4
| Method | Path | Permission |
|---|---|---|
POST | /api/method/shc.network.ensure_tenant | open |
GET | /api/method/shc.network.nic | platform:manage |
GET | /api/resource/HostMapping/{deployment_id} | open |
GET | /api/resource/PortMapping/{deployment_id} | open |
Source: modules/node/ · Notes: node.md
Count: 6
| Method | Path | Permission |
|---|---|---|
GET | /api/method/shc.node.deployments | platform:manage |
POST | /api/method/shc.node.health | platform:manage |
POST | /api/method/shc.node.inflight | platform:manage |
POST | /api/method/shc.node.prestop | platform:manage |
GET | /api/resource/Node | tenant:read |
GET | /api/resource/Node/{name} | tenant:read |
notification
Section titled “notification”Source: modules/notification/
Count: 3
| Method | Path | Permission |
|---|---|---|
POST | /api/method/shc.notification.emit | platform:manage |
GET | /api/method/shc.notification.list | platform:manage |
POST | /api/method/shc.notification.test | platform:manage |
portal
Section titled “portal”Count: 4
| Method | Path | Permission |
|---|---|---|
POST | /api/method/shc.portal.deregister | open |
GET | /api/method/shc.portal.idp-userinfo | open |
POST | /api/method/shc.portal.register | open |
GET | /api/method/shc.portal.status | open |
portforward
Section titled “portforward”Source: modules/portforward/
Count: 2
| Method | Path | Permission |
|---|---|---|
WS | /api/method/shc.stack.forward | open |
WS | /internal/ws/forward | open |
Source: modules/purge/
Count: 1
| Method | Path | Permission |
|---|---|---|
POST | /api/method/shc.db.purge | platform:manage |
Source: modules/quota/ · Notes: quota.md
Count: 6
| Method | Path | Permission |
|---|---|---|
GET | /api/method/shc.quota.limits | tenant:read |
POST | /api/method/shc.quota.scan_disk | platform:manage |
GET | /api/method/shc.quota.status | tenant:read |
GET | /api/method/shc.quota.usage | tenant:read |
GET | /api/resource/Usage | tenant:read |
GET | /api/resource/Usage/{usage_id} | tenant:read |
Source: modules/repo/ · Notes: repo.md
Count: 10
| Method | Path | Permission |
|---|---|---|
POST | /api/method/shc.repo.sync | tenant:manage |
POST | /api/method/shc.repo.sync_all | tenant:manage |
POST | /api/method/shc.repo.sync_wait | tenant:manage |
GET | /api/resource/Repo | tenant:read |
POST | /api/resource/Repo | tenant:manage |
DELETE | /api/resource/Repo/{name} | tenant:manage |
GET | /api/resource/Repo/{name} | tenant:read |
PATCH | /api/resource/Repo/{name} | tenant:manage |
GET | /api/resource/Repo/{name}/progress | tenant:read |
GET | /api/resource/Repo/{name}/rejected | tenant:read |
retention
Section titled “retention”Source: modules/retention/
Count: 5
| Method | Path | Permission |
|---|---|---|
POST | /api/method/shc.backup.retention.apply | open |
GET | /api/method/shc.backup.retention.get | open |
POST | /api/method/shc.backup.retention.preview | open |
POST | /api/method/shc.backup.retention.reset | open |
POST | /api/method/shc.backup.retention.set | open |
Count: 1
| Method | Path | Permission |
|---|---|---|
GET | /api/method/shc.scan.app | stack:read |
schedule
Section titled “schedule”Source: modules/schedule/ · Notes: schedule.md
Count: 9
| Method | Path | Permission |
|---|---|---|
POST | /api/method/shc.schedule.create | stack:operate |
POST | /api/method/shc.schedule.disable | stack:operate |
POST | /api/method/shc.schedule.enable | stack:operate |
GET | /api/method/shc.schedule.info | stack:read |
GET | /api/method/shc.schedule.list | stack:read |
POST | /api/method/shc.schedule.list | stack:read |
POST | /api/method/shc.schedule.remove | stack:operate |
POST | /api/method/shc.schedule.sync | stack:operate |
POST | /api/method/shc.schedule.update | stack:operate |
search
Section titled “search”Source: modules/search/ · Notes: search.md
Count: 1
| Method | Path | Permission |
|---|---|---|
GET | /api/method/shc.search | open |
Source: modules/shell/
Count: 3
| Method | Path | Permission |
|---|---|---|
WS | /api/method/shc.container.exec | open |
WS | /internal/containers/{container_id}/exec | open |
WS | /internal/ws/exec | open |
Source: modules/stack/ · Notes: stack.md
Count: 10
| Method | Path | Permission |
|---|---|---|
POST | /api/method/shc.container.restart | open |
GET | /api/method/shc.stack.config | stack:manage |
GET | /api/method/shc.stack.dry_run | stack:manage |
POST | /api/method/shc.stack.exec | stack:manage |
WS | /api/method/shc.stack.exec_stream | stack:manage |
GET | /api/method/shc.stack.inspect | stack:manage |
GET | /api/method/shc.stack.logs | stack:read |
POST | /api/method/shc.stack.restart | stack:operate |
POST | /api/method/shc.stack.start | stack:operate |
POST | /api/method/shc.stack.stop | stack:operate |
storage
Section titled “storage”Source: modules/storage/ · Notes: storage.md
Count: 31
| Method | Path | Permission |
|---|---|---|
POST | /api/method/shc.storage.add | platform:manage |
POST | /api/method/shc.storage.cephfs.disable | platform:manage |
POST | /api/method/shc.storage.cephfs.enable | platform:manage |
GET | /api/method/shc.storage.cephfs.health | platform:manage |
POST | /api/method/shc.storage.cephfs.health | platform:manage |
POST | /api/method/shc.storage.cephfs.join | platform:manage |
POST | /api/method/shc.storage.cephfs.leave | platform:manage |
GET | /api/method/shc.storage.cephfs.status | platform:manage |
POST | /api/method/shc.storage.cephfs.status | platform:manage |
POST | /api/method/shc.storage.get | platform:manage |
POST | /api/method/shc.storage.link | platform:manage |
GET | /api/method/shc.storage.logs.stream | platform:manage |
GET | /api/method/shc.storage.ls | platform:manage |
POST | /api/method/shc.storage.ls | platform:manage |
POST | /api/method/shc.storage.nfs.disable | platform:manage |
POST | /api/method/shc.storage.nfs.enable | platform:manage |
POST | /api/method/shc.storage.nfs.join | platform:manage |
POST | /api/method/shc.storage.nfs.leave | platform:manage |
GET | /api/method/shc.storage.nfs.status | platform:manage |
POST | /api/method/shc.storage.nfs.status | platform:manage |
GET | /api/method/shc.storage.pool.ls | platform:manage |
POST | /api/method/shc.storage.pool.ls | platform:manage |
POST | /api/method/shc.storage.rm | platform:manage |
POST | /api/method/shc.storage.unlink | platform:manage |
POST | /api/method/shc.storage.volume.assert-lease-lost | platform:manage |
GET | /api/method/shc.storage.volume.ls | stack:read |
POST | /api/method/shc.storage.volume.ls | stack:read |
POST | /api/method/shc.storage.volume.rebind | platform:manage |
POST | /api/method/shc.storage.volume.restore-snapshot | platform:manage |
POST | /api/method/shc.storage.volume.rm | platform:manage |
POST | /api/method/shc.storage.volume.snapshot | platform:manage |
supportbundle
Section titled “supportbundle”Count: 2
| Method | Path | Permission |
|---|---|---|
GET | /api/method/shc.stack.config.noref | open |
GET | /api/method/shc.support.bundle | open |
Source: modules/task/ · Notes: task.md
Count: 4
| Method | Path | Permission |
|---|---|---|
POST | /api/method/shc.task.cancel | platform:manage |
GET | /api/resource/Task | platform:manage |
GET | /api/resource/Task/{id} | platform:manage |
GET | /api/resource/Worker | platform:manage |
telemetry
Section titled “telemetry”Count: 2
| Method | Path | Permission |
|---|---|---|
GET | /api/method/shc.metrics.node | open |
GET | /api/method/shc.metrics.stack | open |
tenant
Section titled “tenant”Source: modules/tenant/ · Notes: tenant.md
Count: 5
| Method | Path | Permission |
|---|---|---|
GET | /api/method/shc.tenant.sign_in | open |
GET | /api/resource/Tenant | tenant:read |
POST | /api/resource/Tenant | platform:manage |
DELETE | /api/resource/Tenant/{name} | platform:manage |
GET | /api/resource/Tenant/{name} | tenant:read |
Source: modules/user/
Count: 26
| Method | Path | Permission |
|---|---|---|
GET | /api/user/apps | open |
GET | /api/user/console-tenant | open |
POST | /api/user/console-tenant | open |
POST | /api/user/create | open |
POST | /api/user/delete | open |
GET | /api/user/effective-apps | open |
POST | /api/user/grant | open |
POST | /api/user/group/create | open |
POST | /api/user/group/delete | open |
GET | /api/user/group/list | open |
POST | /api/user/join | open |
GET | /api/user/launcher-layout | open |
POST | /api/user/launcher-layout | open |
POST | /api/user/leave | open |
GET | /api/user/list | open |
POST | /api/user/logout | open |
GET | /api/user/managed-apps | open |
GET | /api/user/realm | open |
POST | /api/user/realm/set | open |
POST | /api/user/rename | open |
POST | /api/user/reset-password | open |
POST | /api/user/revoke | open |
POST | /api/user/role/create | open |
POST | /api/user/role/delete | open |
GET | /api/user/role/list | open |
POST | /api/user/role/update | open |
Source: modules/vault/ · Notes: vault.md
Count: 19
| Method | Path | Permission |
|---|---|---|
POST | /api/method/shc.vault.coldstart.replant | platform:manage |
GET | /api/method/shc.vault.coldstart.status | platform:manage |
POST | /api/method/shc.vault.escrow.record | platform:manage |
GET | /api/method/shc.vault.escrow.status | platform:manage |
GET | /api/method/shc.vault.exists | tenant:read |
POST | /api/method/shc.vault.export | tenant:manage |
POST | /api/method/shc.vault.import | tenant:manage |
POST | /api/method/shc.vault.rotate | open |
GET | /api/method/shc.vault.status | open |
POST | /api/method/shc.vault.unlock | open |
GET | /api/method/shc.vault.write_scope | tenant:read |
GET | /api/resource/Secret | tenant:read |
POST | /api/resource/Secret | tenant:manage |
DELETE | /api/resource/Secret/* | tenant:manage |
GET | /api/resource/Secret/* | tenant:manage |
PUT | /api/resource/Secret/* | tenant:manage |
DELETE | /api/resource/Secret/{key:path} | tenant:manage |
GET | /api/resource/Secret/{key:path} | tenant:manage |
PUT | /api/resource/Secret/{key:path} | tenant:manage |