Important

The Nessus Package is currently a Technology Preview

Proxy

Methods described in this section relate to the proxy API. These methods can be accessed at Nessus.proxy.

class ProxyAPI(api: APISession)

details() → Dict

Retrieves the current proxy settings

Returns:

The current proxy settings

Return type:

Dict

Example

>>> nessus.proxy.details()

edit(proxy: str | None = None, proxy_auth: Literal['auto', 'basic', 'digest', 'none', 'ntlm'] | None = None, proxy_password: str | None = None, proxy_port: int | None = None, proxy_username: str | None = None, user_agent: str | None = None) → None

Updates the proxy settings

Parameters:

• proxy (str, optional) – The proxy host

• proxy_auth (str, optional) – The proxy auth method

• proxy_password (str, optional) – The auth password

• proxy_port (int, optional) – The proxy port

• proxy_username (str, optional) – The proxy auth username

• user_agent (str, optional) – The proxy user agent.

Example

>>> nessus.proxy.edit(proxy='proxy.company.com',
...                   proxy_auth='none',
...                   proxy_port=3128
...                   )