Desktop and API coverage
Use this map to find the guide and API family for a Desktop task. Some routes appear only after opening a record or starting an action.
The /network and /network/new routes exist in Desktop, but the current sidebar and scope detail do not link to them. To register network links through a documented path, use the execution-scope API procedure.
Workflows and execution
| Desktop route | Purpose | API family | Guide |
|---|---|---|---|
/workflows | List versioned workflow definitions | /workflow-definitions/ | Workflow definitions |
/workflows/new | Create or import a workflow | /workflow-definitions/, /workflow-definitions/import/ | Workflow definitions |
/workflows/:id | Inspect activities, dependencies, plans, and runs | Workflow, plan, and execution reads | Workflow definitions |
/workflows/:id/plans/new | Generate candidates or define a manual plan | /planning-sessions/, /schedule-plans/ | Plan a workflow |
/planning-sessions | List algorithm comparison sessions | /planning-sessions/ | Plan a workflow |
/planning-sessions/:id | Follow algorithms and compare candidates | Planning session and candidate endpoints | Plan a workflow |
/plans | Aggregate plan index | /schedule-plans/ | Plan a workflow |
/plans/:id | Inspect a saved plan | /schedule-plans/:planId/ | Plan a workflow |
/workflows/:workflowId/plans/:id | Inspect one plan and its predicted Gantt | /schedule-plans/:planId/ | Plan a workflow |
/executions | Filter workflow, standalone, and interactive runs | /execution-runs/ | Execute and monitor |
/executions/:id | Inspect a run outside the workflow-specific path | /execution-runs/:runId/ | Execute and monitor |
/executions/:id/activities/:activityId | Inspect an activity from that run | Execution context returned with the run detail | Execute and monitor |
/workflows/:workflowId/plans/:planId/executions/:id | Compare the selected plan with observed execution | /execution-runs/:runId/ | Execute and monitor |
/workflows/:workflowId/plans/:planId/executions/:id/activities/:activityId | Inspect one activity attempt | Execution context returned with the run detail | Execute and monitor |
/executions/new | Start a run from a plan | POST /execution-runs/ | Execute and monitor |
Infrastructure
| Desktop route | Purpose | API family | Guide |
|---|---|---|---|
/environments | List connected and simulated environments | /environments/ | Environments |
/environments/new | Connect real infrastructure or define simulation infrastructure | Environments, connection tests, SSH keys, Kubernetes tokens | Environments |
/environments/:id | Inspect one environment and its ownership hierarchy | /environments/:environmentId/ | Environments |
/environments/:id/edit | Replace an environment definition or connection | Environment and connection updates | Environments |
/environments/:id/inventory | Inspect discovered compute, partitions, nodes, and filesystems | Environment discovery and /resources/ | Environments |
/environments/:id/storages | Browse approved storage roots | /storages/ | Storage |
/resources | Aggregate compute inventory | /resources/ | Execution scopes |
/resources/:id | Inspect capacity, bindings, snapshots, and provisioning | /resources/:resourceId/ | Execution scopes |
/execution-scopes | List planning boundaries | /execution-scopes/ | Execution scopes |
/execution-scopes/new | Combine environment versions | POST /execution-scopes/ | Execution scopes |
/execution-scopes/:id | Inspect a saved scope | /execution-scopes/:scopeId/ | Execution scopes |
/network | List network topologies | /network-topologies/ | Execution scopes |
/network/new | Create topology metadata and links | POST /network-topologies/ | Execution scopes |
/network/:id | Inspect a saved topology | /network-topologies/:topologyId/ | Execution scopes |
/machine-configurations | Validate and version configuration playbooks | /machine-configurations/ | Machine configurations |
/environments/:id/cloud-capacity | Refresh provider catalog and configure capacity targets | Cloud catalog and capacity-target endpoints | Cloud capacity |
/environments/:id/provisioning | List environment provisioning operations | /cloud-operations/ | Cloud capacity |
/environments/:id/provisioning/:instanceId | Follow an instance from its environment | Cloud instance and operation endpoints | Cloud capacity |
/resources/:resourceId/provisioning/:instanceId | Follow a resource-owned operation and logs | Cloud instance and operation endpoints | Cloud capacity |
Artifacts, evidence, and operations
| Desktop route | Purpose | API family | Guide |
|---|---|---|---|
/artifacts | List executable artifact definitions | /artifacts/ | Build an executable |
/artifacts/new | Register an OCI artifact or start a build | Artifact and build endpoints | Build an executable |
/artifacts/:id | Inspect versions, locations, builds, and materializations | Artifact detail families | Artifact locations |
/artifact-locations | Compatibility/aggregate location catalog | /artifact-locations/ | Artifact locations |
/materializations | Compatibility/aggregate materialization catalog | /artifact-materializations/ | Artifact locations |
/data | Generated scientific data grouped by workflow | Provenance data projections | Trace a result |
/provenance | Query local evidence with read-only SQL | /provenance/sql/ | Trace a result |
/audit | Inspect recorded connection, discovery, and console events | /audit-events/ | Inspect audit events |
/console | Open interactive terminal sessions | /console-commands/, /console-sessions/ | Interactive console |
/settings | Manage identity, appearance, instance archives, and reset | Instance and preference endpoints | Instance management, Personal preferences |
/settings/ssh-keys | Generate or import daemon-owned SSH keys | /ssh-keys/ | SSH service keys |
Redirects and compatibility routes
/plans/newredirects to workflow selection because a plan must belong to a workflow./buildsredirects to the artifact catalog because builds belong to artifacts./ssh-keysredirects to/settings/ssh-keys.- Environment-level provisioning is an aggregate index; an individual provisioning operation belongs to its resource.