workspace

get the workspace settings document

Changed on

The workspace's settings in the layout of the settings.yaml that wmill sync writes. Admin only.

get/w/{workspace}/workspaces/settings_document

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/w/{workspace}/workspaces/settings_document
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Path parameters

workspacestring required

Query parameters

secrets'redacted' | 'encrypted'

How secrets are written: redacted (the default) replaces each set secret with __SENSITIVE_AND_UNCHANGED__; encrypted writes it encrypted with the workspace key, prefixed with $encrypted:.

Response

the settings document

object required

Changes