Skip to content
Spinbox is experimental: APIs change and data may be lost. Status lists what is built and what proves it.

ProjectService

View Markdown

ProjectService is the installation’s projects (spin#720): a repository and the shape of the. workspace that opens it (CreateWorkspaceRequest.project_id). Anybody signed in makes one where. the installation lets everybody (the setting project_creation), and is its first admin. A project is seen by everybody while it is shared with everyone, and otherwise by its admins and. whom it is shared with; the instance’s admins see and administer every one. Whoever sees one. opens workspaces from it, in a team of theirs.

POST /spin.v1.ProjectService/CreateProject

Request

FieldTypeWhat it is
namestring
slugstringMade from the name when empty
descriptionstring
repositorystring
refstring
imagestring
presetstring
networkTagslist of string
prebuildRefslist of string
prebuildRebaseEveryinteger (int32)Zero is the installation’s default
prebuildKeepinteger (int32)Zero is one: the newest of each ref

Response

FieldTypeWhat it is
projectProject

POST /spin.v1.ProjectService/DeleteProject

Request

FieldTypeWhat it is
idstring

Response

No fields: {}.

POST /spin.v1.ProjectService/GetPrebuild

One of them whole, with what its build’s create tasks wrote, to whoever sees the project.

Request

FieldTypeWhat it is
projectIdstring
prebuildIdstring

Response

FieldTypeWhat it is
prebuildPrebuild

POST /spin.v1.ProjectService/GetProject

Request

FieldTypeWhat it is
idstring
slugstring

Response

FieldTypeWhat it is
projectProject

POST /spin.v1.ProjectService/GetProjectCosts

What a project cost in the month in progress, to its admins and nobody else, as ListProjectWorkspaces: everybody’s workspaces of it summed, its prebuilds’ builds included, and a month of what its prebuilds keep. A sum, never by workspace: one workspace’s cost says how much its owner works, which a project’s admin who is not their team’s is not told. Read from the bill as the installation last read it, never from the cloud.

Request

FieldTypeWhat it is
projectIdstring

Response

FieldTypeWhat it is
monthTimestampThe month in progress: its first instant, UTC.
readAtTimestampWhen the bill was last read; unset where it never was - an installation with no bill scope - and then nothing below is known and nothing is to be drawn.
currencystringISO 4217; every amount here is in millionths of it.
workspacesCostShareIts workspaces’ shares summed, deleted ones and its prebuilds’ builds included: a workspace is the project’s it opened, whoever’s it was.
prebuildsPrebuildsKept

POST /spin.v1.ProjectService/ListPrebuilds

A project’s prebuilds, to whoever sees it; and a build of one of its refs now, by its admins, rather than at the next look.

Request

FieldTypeWhat it is
projectIdstring

Response

FieldTypeWhat it is
prebuildslist of PrebuildNewest first.
storageMeasuredAtTimestampWhen storage-gc last read the store, which each stored_bytes is as of; unset before it has.
retireUnusedDaysinteger (int32)The installation’s prebuild_retire_unused_days: a ready prebuild nobody opened a workspace from in this many days is retired, its ref’s newest included. Zero retires none for that.
refsNotFoundlist of PrebuildRefNotFoundThe refs the project prebuilds that its forge says the repository has not - a branch deleted since it was named - as the prebuilds job last found them: nothing is built of one until the forge has it again or the project names it no longer.

POST /spin.v1.ProjectService/ListProjectWorkspaces

Everybody’s workspaces open on a project, to its admins and nobody else: a person it is only shared with is refused, and reads their own with ListWorkspaces.

Request

FieldTypeWhat it is
projectIdstring

Response

FieldTypeWhat it is
workspaceslist of ProjectWorkspaceNewest first, and at most 500. Not a prebuild’s build, and not a deleted one.

POST /spin.v1.ProjectService/ListProjects

Request

No fields: {}.

Response

FieldTypeWhat it is
projectslist of Project

POST /spin.v1.ProjectService/RunPrebuild

Request

FieldTypeWhat it is
projectIdstring
refstringOne of the project’s prebuild refs.

Response

FieldTypeWhat it is
prebuildPrebuildThe build, or the one already running at that commit.

POST /spin.v1.ProjectService/ShareProject

Request

FieldTypeWhat it is
idstring
sharedWithEveryoneboolean
userIdslist of string
teamIdslist of string
adminIdslist of string

Response

FieldTypeWhat it is
projectProject

POST /spin.v1.ProjectService/UpdateProject

Changed, shared and deleted by its admins. A project with a workspace open on it is not deleted.

Request

FieldTypeWhat it is
idstring
namestring
slugstring
descriptionstring
repositorystring
refstring
imagestring
presetstring
networkTagslist of string
prebuildRefslist of string
prebuildRebaseEveryinteger (int32)
prebuildKeepinteger (int32)Zero is one, as at create

Response

FieldTypeWhat it is
projectProject

Generated by task reference from spin/internal/controlplane/apidocs/spin.v1.openapi.json at 51f7e0dea.

Installations run Spinbox v20261027.01; the reference is generated from spin v20261114.01 (51f7e0dea). This page as Markdown, for a model or a terminal.