Appearance
API mapping
Authoritative REST ↔ CLI reference for sp-boot (default port 8090). Header access-token required on console APIs unless noted.
Legend: CLI phase v1 | v2 | — (not exposed)
Auth
| Method | Path | CLI | Phase |
|---|---|---|---|
| GET | /api/login/getVerificationCode/{userName} | (precursor to login) | v1 |
| POST | /api/login/verify | sp auth login | v1 |
| GET | /api/login/refresh/{userName} | sp auth refresh | v1 |
| POST | /api/login/loginAsGuest | sp auth login --guest | v1 |
| POST | /api/login/oauthLogin | — | — |
| GET | /api/login/userProfile/{userName} | sp auth whoami (future) | v2 |
Applications
| Method | Path | CLI | Phase |
|---|---|---|---|
| GET | /api/applications/list | sp app list | v1 |
| POST | /api/applications/create | sp app create | v1 |
| GET | /api/applications/{appId}/agent-status | sp app status | v1 |
| GET | /api/applications/{appId}/replays/recent | sp app replays | v1 |
| GET | /api/applications/{appId}/extraction-rules | sp extraction-rule list | v2 |
| PUT | /api/applications/{appId}/extraction-rules | sp extraction-rule apply | v2 |
| POST | /api/extraction-rules/preview | sp extraction-rule preview | v2 |
| GET | /api/agent/extraction-rules | — (agent) | — |
Policies
| Method | Path | CLI | Phase |
|---|---|---|---|
| GET | /api/recording-policies/policies | sp policy recording list | v1 |
| GET | /api/recording-policies/policies/{id} | sp policy recording get | v1 |
| POST | /api/recording-policies/policies | sp policy recording apply | v1 |
| POST | /api/recording-policies/policies/yaml | sp policy recording apply -f | v1 |
| DELETE | /api/recording-policies/policies/{id} | sp policy recording delete | v1 |
| POST | /api/recording-policies/policies/validate | sp policy recording validate | v1 |
| GET | /api/recording-policies/policies/{id}/yaml | sp policy recording export | v1 |
| * | /api/mock-policies/* | sp policy mock … | v1 |
| * | /api/compare-rules/* | sp policy compare … | v1 |
Replay control (schedule)
| Method | Path | CLI | Phase |
|---|---|---|---|
| POST | /api/createPlan | sp replay run | v1 |
| GET | /api/createPlan | — (webhook only) | — |
| GET | /progress | sp replay status | v1 |
| GET | /api/stopPlan | sp replay stop | v1 |
| POST | /api/reRunPlan | sp replay rerun | v1 |
| POST | /api/createRealTimePlan | sp replay realtime create | v2 |
| GET | /api/queue/control/* | sp replay realtime queue … | v2 |
| POST | /api/compareCase | sp replay compare | v2 |
| GET | /api/queryNoise | sp replay noise query | v2 |
| POST | /api/excludeNoise | sp replay noise exclude | v2 |
Traces
| Method | Path | CLI | Phase |
|---|---|---|---|
| POST | /api/traces/find-by-attr | sp trace find | v2 |
| GET | /api/traces/{traceId}/summary | sp trace get | v2 |
| POST | /api/traces/attr-rule-statistics | sp trace stats | v2 |
Storage record (read)
| Method | Path | CLI | Phase |
|---|---|---|---|
| POST | /api/storage/record/query | sp record query | v2 |
| GET | /api/storage/record/trace/{traceId} | sp record trace | v2 |
| GET | /api/storage/record/completeness | sp record completeness | v2 |
| POST | /api/storage/record/save | — | — |
| * | /api/storage/replay/query/* | sp replay case list (partial) | v2 |
| GET | /api/storage/replay-mock-tree/{replayId} | sp replay mock-tree | v2 |
Logs
| Method | Path | CLI | Phase |
|---|---|---|---|
| GET | /api/record-logs/overview | sp record logs overview | v2 |
| GET | /api/record-logs/download | sp record logs download | v2 |
| GET | /api/replay-logs/overview | sp replay logs overview | v2 |
| GET | /api/replay-logs/download | sp replay logs download | v2 |
Reports (subset)
| Method | Path | CLI | Phase |
|---|---|---|---|
| GET | /api/report/queryDiffMsgById/{id} | sp replay diff get | v2 |
| POST | /api/report/queryReplayCase | sp replay case list | v2 |
| POST | /api/report/init | sp replay report init | v2 |
| * | /api/report/* (others) | partial / future | v2 |
Agent config
| Method | Path | CLI | Phase |
|---|---|---|---|
| POST | /api/config/agent/load | sp config agent load | v2 |
| POST | /api/config/agent/agentStatus | — or sp app status | v2 |
Legacy config
| Method | Path | CLI | Phase |
|---|---|---|---|
| GET/POST | /api/config/{resource}/* | sp config legacy … | v2 |
Workspace
| Method | Path | CLI | Phase |
|---|---|---|---|
| POST | /api/filesystem/* | sp workspace … | v2 |
| POST | /api/environment/* | sp workspace env … | v2 |
User groups
| Method | Path | CLI | Phase |
|---|---|---|---|
| * | /api/userGroup/* | sp group … | v2 |
| * | /api/appGrant/* | sp grant … | v2 |
Health & ops
| Method | Path | CLI | Phase |
|---|---|---|---|
| GET | /vi/health | sp health | v1 |
| GET | /vi/storage/* | sp ops storage … | v2 |
| GET | /vi/schedule/monitor | sp ops schedule monitor | v2 |
Not exposed
| Method | Path | Reason |
|---|---|---|
| POST | /v1/traces | OTLP |
| POST | /api/storage/record/save | Agent write |
| * | /api/replay/local/* | Local runner |
Controller source: sp-tr-api/sp-web-api, sp-storage/sp-storage-web-api, sp-replay-schedule/sp-schedule-web-api.