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

ShareService

View Markdown

ShareService manages snapshot sharing. Snapshots can be shared with specific users or made public. Users can create new workspaces from shared snapshots.

POST /spin.v1.ShareService/ListSharedSnapshots

List snapshots shared with the current user (or public)

Request

FieldTypeWhat it is
includePublicbooleanfalse: only what was shared with the caller
pagePageRequest

Response

FieldTypeWhat it is
snapshotslist of SnapshotUses Snapshot from workspace.proto
pagePageResponse

POST /spin.v1.ShareService/ListSnapshotShares

List users who have access to a snapshot

Request

FieldTypeWhat it is
snapshotIdstring
pagePageRequest

Response

FieldTypeWhat it is
shareslist of SnapshotShare
pagePageResponse
outsideTeamOutsideShareStateoutside_team is the snapshot’s share outside its team: what a clone by somebody of another team stands on, made when the snapshot is first shared outside the team or made public. A clone of it outside the team is refused until it is ready.

POST /spin.v1.ShareService/SetSnapshotVisibility

Set snapshot visibility (public/private)

Request

FieldTypeWhat it is
snapshotIdstring
publicboolean
acknowledgeFindingsbooleanAs ShareSnapshotRequest’s: making a snapshot public gives everybody a copy of its files.

Response

FieldTypeWhat it is
publicboolean

POST /spin.v1.ShareService/ShareSnapshot

Share a snapshot with a specific user

Request

FieldTypeWhat it is
snapshotIdstring
emailstringEmail of user to share with
acknowledgeFindingsbooleanacknowledge_findings shares a snapshot whose files hold what looks like credentials. Without it such a share is refused, FAILED_PRECONDITION with the SecretFindings as a detail: whoever it is shared with gets a copy of those files.

Response

No fields: {}.

POST /spin.v1.ShareService/UnshareSnapshot

Remove a user’s access to a snapshot

Request

FieldTypeWhat it is
snapshotIdstring
userIdstring

Response

No fields: {}.

Generated by task reference from spin/internal/controlplane/apidocs/spin.v1.openapi.json at 8eee32b9d.

Documents Spinbox v20261019.02. This page as Markdown, for a model or a terminal.