SPspice
Projects

Pause a project

The org is orgId in the path. Pauses the project's running spicepod. The runtime is torn down and the spicepod record is marked as paused. Settings and configuration are preserved. Resume with POST /v1/projects/{projectId}/resume. Requires apps:write.

post/v1/orgs/{orgId}/projects/{projectId}/pause

Request

  • Base URL
    https://api.spice.ai
  • Auth
    HTTP bearer

Path parameters

orgIdinteger required

The org id from GET /v1/orgs

projectIdinteger required

The ID of the project to pause

Headers

X-Org-Namestring

When present, X-Org-Name must name the same org as orgId. Otherwise the request returns org_path_mismatch (400).

Response

Project paused

idinteger required

The project ID

namestring required

The project name

paused_atstring date-time required

Timestamp when the project was paused

Changes

No recorded changes to this operation across all 1 revision of this API.