workspace

apply a workspace settings document

Changed on

Applies a settings document, each setting through the endpoint that owns it. Admin only.

post/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

Request body

documentobject required

The settings to apply, in the layout of the document. A secret given as __SENSITIVE_AND_UNCHANGED__ keeps its stored value; one prefixed with $encrypted: is decrypted with the workspace key.

replaceboolean

Clear the settings wmill sync push clears when settings.yaml omits them. Otherwise a setting the document omits is left as it is.

dry_runboolean

Only compute the changes, without applying them.

Response

the changes, applied unless dry_run

appliedboolean required
warningsstring[]

Changes