Resource guide

Sharing and publishing cross different boundaries

A share sends an email-addressed request for read or write collaboration on a path. The recipient chooses the destination workspace and mount path when accepting. A publish exposes a file or folder at a public slug. Do not model one as a visibility setting for the other.

A publish is a read-only public viewer, not hosting. Its URL opens an anonymous file/folder browser that shows source: text-like files — including HTML and SVG — are always presented as plain text and never rendered or executed, while images, audio, video, and PDF play in their native viewers. Publishing a folder publishes everything in it — dotfiles included — except an unremovable floor that is never served: .env* files, .git, node_modules, and Duet's own anchor marker. The viewer hides dotfiles by default with a show-hidden toggle. To serve a running site or app, use a workspace app instead. The viewer fetches bytes and listings through the reserved ?raw and ?list query selectors on the same URL, and a published folder can be downloaded whole through the reserved ?zip selector — the same visible files the viewer shows, as one archive; everything else about the publish URL is the viewer page.

Share creation and resharing require editor access. A reshare may preserve or narrow its parent's mode, never widen it. Creating either request sends the recipient a plaintext email with a seven-day deep link. Delivery is rate-limited per sharer, and a failed delivery revokes the pending request instead of leaving an unreachable share behind. Declining is private to the recipient; unlinking keeps received files and turns replica apps into ordinary local apps. Revocation removes replicas and cascades through every downstream reshare.

Either participant may pause an active share. Pause is folder-global: both drives stop transferring without unlinking the folder or changing its peers, paths, or permissions, and queued edits flow after either participant resumes it. Setting the same pause state again is idempotent and returns the current perspective-specific share projection; pending and ended links cannot be paused.

The workspace share list is perspective-specific. Incoming rows name the sharer and the local mount path. Outgoing rows name the source path and recipient email, but never reveal the recipient's private mount path. For active links, each row reports whether both workspace VMs have applied their current sync configuration. “Up to date” describes that configuration convergence; it is not a byte-for-byte file comparison. A paused link reports paused only after both drives have applied the paused configuration.

Only one live offer may exist for the same folder and recipient. A repeated offer returns 409 already_shared, so clients should direct the sharer to manage the existing share instead of retrying creation.

{
  "path": "projects/field-notes",
  "toEmail": "collaborator@example.com",
  "mode": "read"
}

Keep secrets out of public output

Publish paths are inspected for environment-like segments, but callers should also choose narrow source folders and review their contents. A public slug is a durable address; changing or deleting it is an intentional URL break.

Creating, renaming, and deleting publishes require editor access. Listing is available to viewers. The server detects whether the source path is a file or folder; clients do not declare the kind. Pausing captures a durable snapshot before the paused state becomes public; every viewer, raw, listing, and zip request then reads that snapshot until resumed. A warmed public edge response may take up to 30 seconds to reflect either pause or resume.

{
  "path": "reports/q2.md",
  "slug": "q2-review"
}

{
  "paused": true
}

6 operations

GET/v1/ws/{workspaceSlug}/shares

List incoming and outgoing shares for a workspace

Scope: ws:{workspaceSlug}:share
Request: No JSON request body
Response: Response JSON schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "incoming": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "anchorId": { "type": "string" }, "originWorkspaceId": { "type": "string" }, "fromWorkspaceId": { "type": "string" }, "toEmail": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "toUserId": { "type": "string" }, "toWorkspaceId": { "type": "string" }, "mode": { "type": "string", "enum": [ "read", "write" ] }, "ignorePatterns": { "type": "array", "items": { "type": "string" } }, "parentShareId": { "type": "string" }, "state": { "type": "string", "enum": [ "pending", "active", "expired", "revoked", "unlinked" ] }, "createdByUserId": { "type": "string" }, "createdAt": { "type": "number" }, "expiresAt": { "type": "number" }, "acceptedAt": { "type": "number" }, "pausedAt": { "type": "number" }, "revokedAt": { "type": "number" }, "unlinkedAt": { "type": "number" }, "mountPath": { "type": "string" }, "sharerName": { "type": "string", "minLength": 1 }, "sourceWorkspaceName": { "type": "string", "minLength": 1 }, "syncStatus": { "type": "object", "properties": { "origin": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "applying", "ready", "paused", "error" ] }, "matchesCurrentGeneration": { "type": "boolean" }, "errorCode": { "type": "string" }, "updatedAt": { "type": "number" } }, "required": [ "state", "matchesCurrentGeneration", "updatedAt" ], "additionalProperties": false }, "recipient": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "applying", "ready", "paused", "error" ] }, "matchesCurrentGeneration": { "type": "boolean" }, "errorCode": { "type": "string" }, "updatedAt": { "type": "number" } }, "required": [ "state", "matchesCurrentGeneration", "updatedAt" ], "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "id", "anchorId", "originWorkspaceId", "fromWorkspaceId", "toEmail", "mode", "ignorePatterns", "state", "createdByUserId", "createdAt", "expiresAt", "sharerName", "sourceWorkspaceName" ], "additionalProperties": false } }, "outgoing": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "anchorId": { "type": "string" }, "originWorkspaceId": { "type": "string" }, "fromWorkspaceId": { "type": "string" }, "toEmail": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "toUserId": { "type": "string" }, "toWorkspaceId": { "type": "string" }, "mode": { "type": "string", "enum": [ "read", "write" ] }, "ignorePatterns": { "type": "array", "items": { "type": "string" } }, "parentShareId": { "type": "string" }, "state": { "type": "string", "enum": [ "pending", "active", "expired", "revoked", "unlinked" ] }, "createdByUserId": { "type": "string" }, "createdAt": { "type": "number" }, "expiresAt": { "type": "number" }, "acceptedAt": { "type": "number" }, "pausedAt": { "type": "number" }, "revokedAt": { "type": "number" }, "unlinkedAt": { "type": "number" }, "tokenPrefix": { "type": "string" }, "sourcePath": { "type": "string" }, "syncStatus": { "type": "object", "properties": { "origin": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "applying", "ready", "paused", "error" ] }, "matchesCurrentGeneration": { "type": "boolean" }, "errorCode": { "type": "string" }, "updatedAt": { "type": "number" } }, "required": [ "state", "matchesCurrentGeneration", "updatedAt" ], "additionalProperties": false }, "recipient": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "applying", "ready", "paused", "error" ] }, "matchesCurrentGeneration": { "type": "boolean" }, "errorCode": { "type": "string" }, "updatedAt": { "type": "number" } }, "required": [ "state", "matchesCurrentGeneration", "updatedAt" ], "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "id", "anchorId", "originWorkspaceId", "fromWorkspaceId", "toEmail", "mode", "ignorePatterns", "state", "createdByUserId", "createdAt", "expiresAt", "tokenPrefix", "sourcePath" ], "additionalProperties": false } } }, "required": [ "incoming", "outgoing" ], "additionalProperties": false }
Delivery: Standard response
Retry: Not declared idempotent

POST/v1/ws/{workspaceSlug}/shares

Offer a workspace path to an email address

Scope: ws:{workspaceSlug}:share
Request: Request JSON schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "path": { "type": "string" }, "toEmail": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "mode": { "type": "string", "enum": [ "read", "write" ] }, "ignorePatterns": { "type": "array", "items": { "type": "string" } } }, "required": [ "path", "toEmail", "mode" ] }
Response: Response JSON schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "share": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "anchorId": { "type": "string" }, "originWorkspaceId": { "type": "string" }, "fromWorkspaceId": { "type": "string" }, "toEmail": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "toUserId": { "type": "string" }, "toWorkspaceId": { "type": "string" }, "mode": { "type": "string", "enum": [ "read", "write" ] }, "ignorePatterns": { "type": "array", "items": { "type": "string" } }, "parentShareId": { "type": "string" }, "state": { "type": "string", "enum": [ "pending", "active", "expired", "revoked", "unlinked" ] }, "createdByUserId": { "type": "string" }, "createdAt": { "type": "number" }, "expiresAt": { "type": "number" }, "acceptedAt": { "type": "number" }, "pausedAt": { "type": "number" }, "revokedAt": { "type": "number" }, "unlinkedAt": { "type": "number" }, "mountPath": { "type": "string" } }, "required": [ "id", "anchorId", "originWorkspaceId", "fromWorkspaceId", "toEmail", "mode", "ignorePatterns", "state", "createdByUserId", "createdAt", "expiresAt" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "anchorId": { "type": "string" }, "originWorkspaceId": { "type": "string" }, "fromWorkspaceId": { "type": "string" }, "toEmail": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "toUserId": { "type": "string" }, "toWorkspaceId": { "type": "string" }, "mode": { "type": "string", "enum": [ "read", "write" ] }, "ignorePatterns": { "type": "array", "items": { "type": "string" } }, "parentShareId": { "type": "string" }, "state": { "type": "string", "enum": [ "pending", "active", "expired", "revoked", "unlinked" ] }, "createdByUserId": { "type": "string" }, "createdAt": { "type": "number" }, "expiresAt": { "type": "number" }, "acceptedAt": { "type": "number" }, "pausedAt": { "type": "number" }, "revokedAt": { "type": "number" }, "unlinkedAt": { "type": "number" }, "tokenPrefix": { "type": "string" } }, "required": [ "id", "anchorId", "originWorkspaceId", "fromWorkspaceId", "toEmail", "mode", "ignorePatterns", "state", "createdByUserId", "createdAt", "expiresAt", "tokenPrefix" ], "additionalProperties": false } ] } }, "required": [ "share" ], "additionalProperties": false }
Errors: Error body JSON schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "object", "properties": { "error": { "type": "string", "const": "already_shared" } }, "required": [ "error" ], "additionalProperties": false }, { "type": "object", "properties": { "error": { "type": "string", "const": "rate_limited" }, "retryAfterSeconds": { "type": "number" } }, "required": [ "error", "retryAfterSeconds" ], "additionalProperties": false }, { "type": "object", "properties": { "error": { "type": "string", "enum": [ "forbidden", "invalid_request", "not_found", "share_not_active" ] } }, "required": [ "error" ], "additionalProperties": false } ] }
Delivery: Standard response
Retry: Not declared idempotent

POST/v1/ws/{workspaceSlug}/shares/{shareId}/reshares

Offer an incoming share onward without widening its access mode

Scope: ws:{workspaceSlug}:share
Request: Request JSON schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "toEmail": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "mode": { "type": "string", "enum": [ "read", "write" ] }, "ignorePatterns": { "type": "array", "items": { "type": "string" } } }, "required": [ "toEmail", "mode" ] }
Response: Response JSON schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "share": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "anchorId": { "type": "string" }, "originWorkspaceId": { "type": "string" }, "fromWorkspaceId": { "type": "string" }, "toEmail": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "toUserId": { "type": "string" }, "toWorkspaceId": { "type": "string" }, "mode": { "type": "string", "enum": [ "read", "write" ] }, "ignorePatterns": { "type": "array", "items": { "type": "string" } }, "parentShareId": { "type": "string" }, "state": { "type": "string", "enum": [ "pending", "active", "expired", "revoked", "unlinked" ] }, "createdByUserId": { "type": "string" }, "createdAt": { "type": "number" }, "expiresAt": { "type": "number" }, "acceptedAt": { "type": "number" }, "pausedAt": { "type": "number" }, "revokedAt": { "type": "number" }, "unlinkedAt": { "type": "number" }, "mountPath": { "type": "string" } }, "required": [ "id", "anchorId", "originWorkspaceId", "fromWorkspaceId", "toEmail", "mode", "ignorePatterns", "state", "createdByUserId", "createdAt", "expiresAt" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "anchorId": { "type": "string" }, "originWorkspaceId": { "type": "string" }, "fromWorkspaceId": { "type": "string" }, "toEmail": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "toUserId": { "type": "string" }, "toWorkspaceId": { "type": "string" }, "mode": { "type": "string", "enum": [ "read", "write" ] }, "ignorePatterns": { "type": "array", "items": { "type": "string" } }, "parentShareId": { "type": "string" }, "state": { "type": "string", "enum": [ "pending", "active", "expired", "revoked", "unlinked" ] }, "createdByUserId": { "type": "string" }, "createdAt": { "type": "number" }, "expiresAt": { "type": "number" }, "acceptedAt": { "type": "number" }, "pausedAt": { "type": "number" }, "revokedAt": { "type": "number" }, "unlinkedAt": { "type": "number" }, "tokenPrefix": { "type": "string" } }, "required": [ "id", "anchorId", "originWorkspaceId", "fromWorkspaceId", "toEmail", "mode", "ignorePatterns", "state", "createdByUserId", "createdAt", "expiresAt", "tokenPrefix" ], "additionalProperties": false } ] } }, "required": [ "share" ], "additionalProperties": false }
Delivery: Standard response
Retry: Not declared idempotent

POST/v1/ws/{workspaceSlug}/shares/{shareId}/pause

Pause or resume an active share on both participant workspaces

Scope: ws:{workspaceSlug}:share
Request: Request JSON schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "paused": { "type": "boolean" } }, "required": [ "paused" ] }
Response: Response JSON schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "share": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "anchorId": { "type": "string" }, "originWorkspaceId": { "type": "string" }, "fromWorkspaceId": { "type": "string" }, "toEmail": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "toUserId": { "type": "string" }, "toWorkspaceId": { "type": "string" }, "mode": { "type": "string", "enum": [ "read", "write" ] }, "ignorePatterns": { "type": "array", "items": { "type": "string" } }, "parentShareId": { "type": "string" }, "state": { "type": "string", "enum": [ "pending", "active", "expired", "revoked", "unlinked" ] }, "createdByUserId": { "type": "string" }, "createdAt": { "type": "number" }, "expiresAt": { "type": "number" }, "acceptedAt": { "type": "number" }, "pausedAt": { "type": "number" }, "revokedAt": { "type": "number" }, "unlinkedAt": { "type": "number" }, "mountPath": { "type": "string" } }, "required": [ "id", "anchorId", "originWorkspaceId", "fromWorkspaceId", "toEmail", "mode", "ignorePatterns", "state", "createdByUserId", "createdAt", "expiresAt" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "anchorId": { "type": "string" }, "originWorkspaceId": { "type": "string" }, "fromWorkspaceId": { "type": "string" }, "toEmail": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "toUserId": { "type": "string" }, "toWorkspaceId": { "type": "string" }, "mode": { "type": "string", "enum": [ "read", "write" ] }, "ignorePatterns": { "type": "array", "items": { "type": "string" } }, "parentShareId": { "type": "string" }, "state": { "type": "string", "enum": [ "pending", "active", "expired", "revoked", "unlinked" ] }, "createdByUserId": { "type": "string" }, "createdAt": { "type": "number" }, "expiresAt": { "type": "number" }, "acceptedAt": { "type": "number" }, "pausedAt": { "type": "number" }, "revokedAt": { "type": "number" }, "unlinkedAt": { "type": "number" }, "tokenPrefix": { "type": "string" } }, "required": [ "id", "anchorId", "originWorkspaceId", "fromWorkspaceId", "toEmail", "mode", "ignorePatterns", "state", "createdByUserId", "createdAt", "expiresAt", "tokenPrefix" ], "additionalProperties": false } ] } }, "required": [ "share" ], "additionalProperties": false }
Errors: Error body JSON schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "object", "properties": { "error": { "type": "string", "const": "already_shared" } }, "required": [ "error" ], "additionalProperties": false }, { "type": "object", "properties": { "error": { "type": "string", "const": "rate_limited" }, "retryAfterSeconds": { "type": "number" } }, "required": [ "error", "retryAfterSeconds" ], "additionalProperties": false }, { "type": "object", "properties": { "error": { "type": "string", "enum": [ "forbidden", "invalid_request", "not_found", "share_not_active" ] } }, "required": [ "error" ], "additionalProperties": false } ] }
Delivery: Standard response
Retry: Declared idempotent

POST/v1/ws/{workspaceSlug}/shares/{shareId}/unlink

Unlink a received share while retaining its files and apps

Scope: ws:{workspaceSlug}:share
Request: Request JSON schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": {} }
Response: Response JSON schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "unlinkedShareIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "ok", "unlinkedShareIds" ], "additionalProperties": false }
Delivery: Standard response
Retry: Not declared idempotent

DELETE/v1/ws/{workspaceSlug}/shares/{shareId}

Revoke a share and every downstream reshare

Scope: ws:{workspaceSlug}:share
Request: No JSON request body
Response: Response JSON schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "revokedShareIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "ok", "revokedShareIds" ], "additionalProperties": false }
Delivery: Standard response
Retry: Not declared idempotent

Publishes

5 operations

GET/v1/ws/{workspaceSlug}/publishes

List public file and folder addresses for a workspace

Scope: ws:{workspaceSlug}:publish
Request: No JSON request body
Response: Response JSON schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "publishes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "anchorId": { "type": "string" }, "anchorPath": { "type": "string" }, "slug": { "type": "string" }, "kind": { "type": "string", "enum": [ "file", "folder" ] }, "pausedAt": { "type": "number" }, "pauseGeneration": { "type": "string", "minLength": 1 }, "createdByUserId": { "type": "string" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "workspaceId", "anchorId", "anchorPath", "slug", "kind", "createdByUserId", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "required": [ "publishes" ], "additionalProperties": false }
Delivery: Standard response
Retry: Not declared idempotent

POST/v1/ws/{workspaceSlug}/publishes

Publish a workspace file or folder at a public slug

Scope: ws:{workspaceSlug}:publish
Request: Request JSON schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "path": { "type": "string", "minLength": 1 }, "slug": { "type": "string" } }, "required": [ "path" ] }
Response: Response JSON schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "publish": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "anchorId": { "type": "string" }, "anchorPath": { "type": "string" }, "slug": { "type": "string" }, "kind": { "type": "string", "enum": [ "file", "folder" ] }, "pausedAt": { "type": "number" }, "pauseGeneration": { "type": "string", "minLength": 1 }, "createdByUserId": { "type": "string" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "workspaceId", "anchorId", "anchorPath", "slug", "kind", "createdByUserId", "createdAt", "updatedAt" ], "additionalProperties": false } }, "required": [ "publish" ], "additionalProperties": false }
Delivery: Standard response
Retry: Not declared idempotent

PATCH/v1/ws/{workspaceSlug}/publishes/{slug}

Replace the public slug for a published path

Scope: ws:{workspaceSlug}:publish
Request: Request JSON schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "slug": { "type": "string" } }, "required": [ "slug" ] }
Response: Response JSON schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "publish": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "anchorId": { "type": "string" }, "anchorPath": { "type": "string" }, "slug": { "type": "string" }, "kind": { "type": "string", "enum": [ "file", "folder" ] }, "pausedAt": { "type": "number" }, "pauseGeneration": { "type": "string", "minLength": 1 }, "createdByUserId": { "type": "string" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "workspaceId", "anchorId", "anchorPath", "slug", "kind", "createdByUserId", "createdAt", "updatedAt" ], "additionalProperties": false } }, "required": [ "publish" ], "additionalProperties": false }
Delivery: Standard response
Retry: Not declared idempotent

DELETE/v1/ws/{workspaceSlug}/publishes/{slug}

Remove a public address without deleting its workspace content

Scope: ws:{workspaceSlug}:publish
Request: No JSON request body
Response: Response JSON schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": true } }, "required": [ "ok" ], "additionalProperties": false }
Delivery: Standard response
Retry: Not declared idempotent

POST/v1/ws/{workspaceSlug}/publishes/{slug}/pause

Freeze or resume a public publish

Scope: ws:{workspaceSlug}:publish
Request: Request JSON schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "paused": { "type": "boolean" } }, "required": [ "paused" ] }
Response: Response JSON schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "publish": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "anchorId": { "type": "string" }, "anchorPath": { "type": "string" }, "slug": { "type": "string" }, "kind": { "type": "string", "enum": [ "file", "folder" ] }, "pausedAt": { "type": "number" }, "pauseGeneration": { "type": "string", "minLength": 1 }, "createdByUserId": { "type": "string" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "workspaceId", "anchorId", "anchorPath", "slug", "kind", "createdByUserId", "createdAt", "updatedAt" ], "additionalProperties": false } }, "required": [ "publish" ], "additionalProperties": false }
Delivery: Standard response
Retry: Not declared idempotent