API

Issues and health

Read authorized issues, inspect workload health, and request fresh checks.

Issues combine deployment problems, incidents, domain failures, component health, and update advisories. Results are filtered to resources the caller can see.

List issues

const result = await ship.issues.list({ status: "open" });
console.log(result.issues, result.counts);
curl "$OPENSHIP_URL/api/issues?status=open" \
  -H "Authorization: Bearer $OPENSHIP_TOKEN"

status is open or resolved. The result contains issues, counts, and the selected status. Each issue includes its severity, source, target, message, and any supported resolution action. Counts are grouped as outage, actionRequired, advisory, and total.

Inspect workload health

const health = await ship.issues.health();
console.log(health.workloads, health.currentScan);
curl "$OPENSHIP_URL/api/issues/health" \
  -H "Authorization: Bearer $OPENSHIP_TOKEN"

The health snapshot includes workload observations, scan timing, and watcher capabilities. It does not start a continuous watcher. scanHealth() requests a fresh one-time check where the host supports it; native scheduling remains disabled unless explicitly configured.

Refresh issue sources

rescan() starts the broader rescan pipeline and requires job-write access. rescanStatus() reads the latest scan's stage statuses, summaries, and failures. Check the returned state before treating a scan as complete.

Operations

OperationSDKREST API
Read visible active or resolved issues and their suggested actions.issues.list(input?)GET /api/issues
project:list
Read issue counts by severity.issues.summary()GET /api/issues/summary
project:list
Read cached workload health snapshots.issues.health()GET /api/issues/health
project:list · Self-hosted
Refresh current workload health without enabling the scheduler.issues.scanHealth()POST /api/issues/health/scan
project:list · Self-hosted
Run applicable issue checkers immediately.issues.rescan()POST /api/issues/rescan
job:write · Self-hosted
Read the status of an issue rescan.issues.rescanStatus()GET /api/issues/rescan/status
job:read · Self-hosted

On this page