Sandboxes

put/v1/sandboxes/{id}/preview-password

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/sandboxes/{id}/preview-password
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

passwordstring required

Plaintext password to protect the sandbox's preview URLs. Hashed server-side with argon2id — we never persist or echo this back. Must be between 8 and 256 characters.

Response

Preview password set or rotated

preview_password_hintstring required

Last 4 chars of the password we just stored. Surface in the UI so users can confirm which password is live without re-entering it.

Changes

No recorded changes to this operation across all 54 revisions of this API.