SPspice
Projects

Pause a project

Legacy alias of /v1/projects/{projectId}/pause. Projects were previously called apps. 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/apps/{appId}/pause

Request

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

Path parameters

appIdinteger required

The ID of the project to pause

Headers

X-Org-Namestring

The organization to act on, by handle. Omit it to act on the organization the credential is bound to; sending it blank is a 400, not the same as omitting it. A user credential may name any organization its owner belongs to; a machine credential is pinned to its own. A portal session token is bound to none, so it must send this header on every route but GET /v1/orgs (400 org_assertion_required otherwise).

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.