Get a surface's publish settings
Returns the surface's public-site configuration -- slug, SEO indexing, cover image, icon visibility, and theme -- or a disabled config when it has never been published. Requires view access to the surface and a signed-in session; API keys are not accepted. An unknown surface is reported as a not-publishable error.
Authorization
apiKey Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/workspaces/string/surfaces/string/publish"{ "data": { "enabled": true, "slug": "string", "seoIndexed": true, "coverImageUrl": "string", "showIcon": true, "theme": { "background": { "type": "none", "color": "string", "gradient": "string", "gradientFrom": "string", "gradientTo": "string", "gradientAngle": 0, "imageUrl": "string", "blur": 0 }, "accent": "string", "radius": 0, "pageWidth": "default", "colorScheme": "auto" }, "publishedAt": "string" }}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}Preview what deleting a workspace item would affect
Returns the dependency impact report for the item, separating dependents that block deletion from ones that are only warnings. Requires read access to the item. Use it before `delete` to decide whether the confirmation flag is needed.
Unpublish a surface
Disables public access for the surface while keeping its slug and settings, so republishing later reuses the same URL. Requires full access to the surface and a signed-in session, and is a no-op when the surface was never published.