Function settings_requires_https_put

app/api.py:672–696

Stores whether the server should require the client to connect via HTTPS. Expects a JSON data structure in the request body that contains the new setting `requiresHttps` as bool. Example: { "requiresHttps": true } Returns: Empty response on success, error object

()

@api_blueprint.route('/settings/requiresHttps', methods=['PUT'])
@required_auth(auth.Role.ADMIN)
def settings_requires_https_put():
    """Stores whether the server should require the client to connect via HTTPS.

    Expects a JSON data structure in the request body that contains the new
    setting `requiresHttps` as bool. Example:
    {
        "requiresHttps": true
    }

    Returns:
        Empty response on success, error object otherwise.
    """
    try:
        should_be_required = request_parsers.requires_https.parse(flask.request)
    except request_parsers.errors.Error as e:
        return json_response.error(e), 400
    db.settings.Settings().set_requires_https(should_be_required)

    # Configure cookie security.
    is_session_cookie_secure = (not flask.current_app.debug and
                                should_be_required)
    flask.current_app.config.update(
        SESSION_COOKIE_SECURE=is_session_cookie_secure)

    return json_response.success()


@api_blueprint.route('/settings/video', methods=['GET'])