Skip to content

sp app

Phase: v1
When agents use this: First step in diagnosis — discover appId and agent connectivity.

Synopsis

List and manage SoftProbe applications.

Subcommands

SubcommandDescription
listApplications visible to the user
create <appId>Register a new application
status <appId>Agent online/offline and instances
replays <appId>Recent replay test runs (--limit)

Examples

bash
sp app list --json
sp app status my-app --json
sp app replays my-app --limit 5 --json
sp app create my-new-app --json

JSON output (list)

json
{
  "ok": true,
  "command": "app list",
  "data": {
    "items": [
      {
        "appId": "my-app",
        "appName": "My App",
        "agentStatus": "online",
        "onlineInstanceCount": 2,
        "totalInstanceCount": 3
      }
    ]
  }
}

JSON output (status)

json
{
  "ok": true,
  "command": "app status",
  "data": {
    "appId": "my-app",
    "status": "online",
    "instances": [
      { "host": "10.0.0.1", "lastSeen": "2026-05-18T10:00:00Z" }
    ]
  }
}

REST mapping

SubcommandMethodPath
listGET/api/applications/list
createPOST/api/applications/create
statusGET/api/applications/{appId}/agent-status
replaysGET/api/applications/{appId}/replays/recent

Header: access-token: <JWT> on all except where server allows anonymous list (deployment-specific).

Replaces sp_api

sp_api endpointsp command
list_applicationssp app list
agent_statussp app status
recent_replayssp app replays