Jobs

List jobs

GET /api/v1/project/{projectId}/v1/job

Credentials: API token or dashboard sign-in.

The project's jobs, newest first by default. Filter with jobType, one or more of INVENTORY_SURVEY, RUNTIME_SURVEY, REPORT, UPLOAD, INSTANCE_STARTUP, PORTFOLIO_SNAPSHOT and PORTFOLIO_BACKFILL, comma separated, and status, one of PENDING, RUNNING, COMPLETED, FAILED or SKIPPED. topLevel=true returns one row per survey with its steps nested, and deleted surveys are left out unless showDeleted=true. sortBy accepts only createdAt, the default, and sortDir is asc or desc (default desc). Page with limit, 1 to 10000 and 1000 by default, and the cursors after or before, taking pagination.lastId or pagination.firstId from the previous page. Requires project:view.

Parameters

Responses

Example

curl -X GET "https://api.spicelabs.io/api/v1/project/<projectId>/v1/job" \
  -H "Authorization: Bearer $SPICE_API_TOKEN"

Get a job

GET /api/v1/project/{projectId}/v1/job/{jobId}

Credentials: API token or dashboard sign-in.

One job by id: its type, status, progress, message, timestamps and metadata. A survey includes its steps in steps; a deleted survey carries deleted_at. Requires project:view.

Parameters

Responses

Example

curl -X GET "https://api.spicelabs.io/api/v1/project/<projectId>/v1/job/<jobId>" \
  -H "Authorization: Bearer $SPICE_API_TOKEN"

Stream job updates

GET /api/v1/project/{projectId}/v1/job/stream

Credentials: API token or dashboard sign-in.

A text/event-stream of this project's job changes. Each job-update event carries the changed job in the same shape as GET .../v1/job/{jobId}. The stream opens with a connected comment, sends a heartbeat comment every 25 seconds, and closes after one hour; reconnect to keep listening. Requires project:view.

Parameters

Responses

Example

curl -X GET "https://api.spicelabs.io/api/v1/project/<projectId>/v1/job/stream" \
  -H "Authorization: Bearer $SPICE_API_TOKEN"

Render a report again

POST /api/v1/project/{projectId}/v1/report/{jobId}/render

Credentials: API token or dashboard sign-in.

Produces a report's documents again from the results it already has, without a new upload, analysis or report version: use it when only the document formatting changed. jobId is a completed report: a survey's REPORT step or a posture report. The answer lists the new render steps by format in renderSubJobIds; follow them as jobs. Requires project:edit.

Parameters

Responses

Example

curl -X POST "https://api.spicelabs.io/api/v1/project/<projectId>/v1/report/<jobId>/render" \
  -H "Authorization: Bearer $SPICE_API_TOKEN"

Delete a survey

DELETE /api/v1/project/{projectId}/v1/survey/{jobId}

What it changes: The survey and its reports leave the default job list, and bringing them back with Restore a survey needs `project:admin`.

Credentials: API token or dashboard sign-in.

Hides a survey from the default job listing and stamps it with deleted_at. Nothing is erased: the survey and its steps stay readable by id and with showDeleted=true, and POST .../v1/survey/{jobId}/restore, which requires project:admin, brings it back. Only a survey can be deleted, not one of its steps. Deleting an already deleted survey changes nothing. Requires project:edit.

Parameters

Responses

Example

curl -X DELETE "https://api.spicelabs.io/api/v1/project/<projectId>/v1/survey/<jobId>" \
  -H "Authorization: Bearer $SPICE_API_TOKEN"

Restore a survey

POST /api/v1/project/{projectId}/v1/survey/{jobId}/restore

Credentials: API token or dashboard sign-in.

Undoes a delete: clears the survey's deleted_at so it appears in the default job listing again. Restoring a survey that is not deleted changes nothing. Requires project:admin.

Parameters

Responses

Example

curl -X POST "https://api.spicelabs.io/api/v1/project/<projectId>/v1/survey/<jobId>/restore" \
  -H "Authorization: Bearer $SPICE_API_TOKEN"