Skip to content

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

MethodPathCLIPhase
GET/api/login/getVerificationCode/{userName}(precursor to login)v1
POST/api/login/verifysp auth loginv1
GET/api/login/refresh/{userName}sp auth refreshv1
POST/api/login/loginAsGuestsp auth login --guestv1
POST/api/login/oauthLogin
GET/api/login/userProfile/{userName}sp auth whoami (future)v2

Applications

MethodPathCLIPhase
GET/api/applications/listsp app listv1
POST/api/applications/createsp app createv1
GET/api/applications/{appId}/agent-statussp app statusv1
GET/api/applications/{appId}/replays/recentsp app replaysv1
GET/api/applications/{appId}/extraction-rulessp extraction-rule listv2
PUT/api/applications/{appId}/extraction-rulessp extraction-rule applyv2
POST/api/extraction-rules/previewsp extraction-rule previewv2
GET/api/agent/extraction-rules— (agent)

Policies

MethodPathCLIPhase
GET/api/recording-policies/policiessp policy recording listv1
GET/api/recording-policies/policies/{id}sp policy recording getv1
POST/api/recording-policies/policiessp policy recording applyv1
POST/api/recording-policies/policies/yamlsp policy recording apply -fv1
DELETE/api/recording-policies/policies/{id}sp policy recording deletev1
POST/api/recording-policies/policies/validatesp policy recording validatev1
GET/api/recording-policies/policies/{id}/yamlsp policy recording exportv1
*/api/mock-policies/*sp policy mock …v1
*/api/compare-rules/*sp policy compare …v1

Replay control (schedule)

MethodPathCLIPhase
POST/api/createPlansp replay runv1
GET/api/createPlan— (webhook only)
GET/progresssp replay statusv1
GET/api/stopPlansp replay stopv1
POST/api/reRunPlansp replay rerunv1
POST/api/createRealTimePlansp replay realtime createv2
GET/api/queue/control/*sp replay realtime queue …v2
POST/api/compareCasesp replay comparev2
GET/api/queryNoisesp replay noise queryv2
POST/api/excludeNoisesp replay noise excludev2

Traces

MethodPathCLIPhase
POST/api/traces/find-by-attrsp trace findv2
GET/api/traces/{traceId}/summarysp trace getv2
POST/api/traces/attr-rule-statisticssp trace statsv2

Storage record (read)

MethodPathCLIPhase
POST/api/storage/record/querysp record queryv2
GET/api/storage/record/trace/{traceId}sp record tracev2
GET/api/storage/record/completenesssp record completenessv2
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-treev2

Logs

MethodPathCLIPhase
GET/api/record-logs/overviewsp record logs overviewv2
GET/api/record-logs/downloadsp record logs downloadv2
GET/api/replay-logs/overviewsp replay logs overviewv2
GET/api/replay-logs/downloadsp replay logs downloadv2

Reports (subset)

MethodPathCLIPhase
GET/api/report/queryDiffMsgById/{id}sp replay diff getv2
POST/api/report/queryReplayCasesp replay case listv2
POST/api/report/initsp replay report initv2
*/api/report/* (others)partial / futurev2

Agent config

MethodPathCLIPhase
POST/api/config/agent/loadsp config agent loadv2
POST/api/config/agent/agentStatus— or sp app statusv2

Legacy config

MethodPathCLIPhase
GET/POST/api/config/{resource}/*sp config legacy …v2

Workspace

MethodPathCLIPhase
POST/api/filesystem/*sp workspace …v2
POST/api/environment/*sp workspace env …v2

User groups

MethodPathCLIPhase
*/api/userGroup/*sp group …v2
*/api/appGrant/*sp grant …v2

Health & ops

MethodPathCLIPhase
GET/vi/healthsp healthv1
GET/vi/storage/*sp ops storage …v2
GET/vi/schedule/monitorsp ops schedule monitorv2

Not exposed

MethodPathReason
POST/v1/tracesOTLP
POST/api/storage/record/saveAgent 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.