Secure Mode

Enable Secure Mode and provision passwords

Open in Claude

Request

This endpoint expects an object.
reset_policyenumRequired
http_redirectbooleanOptionalDefaults to true

When true (default), HTTP :80 redirects to HTTPS while Secure Mode is active. When false, HTTP and HTTPS are both served so existing API clients are not broken.

generatebooleanOptional
Generate random passwords instead of using passwords below. Cannot be used together with a passwords object.
include_operatorbooleanOptionalDefaults to true
When generate is true, also generate an operator password
passwordsobjectOptional

Required when generate is false; must not be supplied when generate is true. Passwords must be at least 13 characters and include at least 3 of 4 character types (lowercase, uppercase, digits, special characters).

Response

Enabled
statusenum
generated_passwordsmap from strings to strings or nullOptional

Present when generate was true; returned once in plaintext

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error