Package org.zaproxy.clientapi.gen

Class Network

  • public class Network
extends java.lang.Object
    This file was automatically generated.

    • Constructor Detail

    • Method Detail

      • getRootCaCertValidity

        public ApiResponse getRootCaCertValidity()
                                  throws ClientApiException
        Gets the Root CA certificate validity, in days. Used when generating a new Root CA certificate.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • getServerCertValidity

        public ApiResponse getServerCertValidity()
                                  throws ClientApiException
        Gets the server certificate validity, in days. Used when generating server certificates.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • getAliases

        public ApiResponse getAliases()
                       throws ClientApiException
        Gets the aliases used to identify the local servers/proxies.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • getPassThroughs

        public ApiResponse getPassThroughs()
                            throws ClientApiException
        Gets the authorities that will pass-through the local proxies.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • getConnectionTimeout

        public ApiResponse getConnectionTimeout()
                                 throws ClientApiException
        Gets the connection timeout, in seconds.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • getDnsTtlSuccessfulQueries

        public ApiResponse getDnsTtlSuccessfulQueries()
                                       throws ClientApiException
        Gets the TTL (in seconds) of successful DNS queries.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • getHttpProxyExclusions

        public ApiResponse getHttpProxyExclusions()
                                   throws ClientApiException
        Gets the HTTP proxy exclusions.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • isHttpProxyAuthEnabled

        public ApiResponse isHttpProxyAuthEnabled()
                                   throws ClientApiException
        Tells whether or not the HTTP proxy authentication is enabled.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • isHttpProxyEnabled

        public ApiResponse isHttpProxyEnabled()
                               throws ClientApiException
        Tells whether or not the HTTP proxy is enabled.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • isSocksProxyEnabled

        public ApiResponse isSocksProxyEnabled()
                                throws ClientApiException
        Tells whether or not the SOCKS proxy is enabled.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • isUseGlobalHttpState

        public ApiResponse isUseGlobalHttpState()
                                 throws ClientApiException
        Tells whether or not to use global HTTP state.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • generateRootCaCert

        public ApiResponse generateRootCaCert()
                               throws ClientApiException
        Generates a new Root CA certificate, used to issue server certificates.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • importRootCaCert

        public ApiResponse importRootCaCert​(java.lang.String filepath)
                             throws ClientApiException
        Imports a Root CA certificate to be used to issue server certificates.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • setRootCaCertValidity

        public ApiResponse setRootCaCertValidity​(java.lang.String validity)
                                  throws ClientApiException
        Sets the Root CA certificate validity. Used when generating a new Root CA certificate.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • setServerCertValidity

        public ApiResponse setServerCertValidity​(java.lang.String validity)
                                  throws ClientApiException
        Sets the server certificate validity. Used when generating server certificates.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • addAlias

        public ApiResponse addAlias​(java.lang.String name,
                            java.lang.String enabled)
                     throws ClientApiException
        Adds an alias for the local servers/proxies.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • addLocalServer

        public ApiResponse addLocalServer​(java.lang.String address,
                                  java.lang.String port,
                                  java.lang.String api,
                                  java.lang.String proxy,
                                  java.lang.String behindnat,
                                  java.lang.String decoderesponse,
                                  java.lang.String removeacceptencoding)
                           throws ClientApiException
        Adds a local server/proxy.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • addPassThrough

        public ApiResponse addPassThrough​(java.lang.String authority,
                                  java.lang.String enabled)
                           throws ClientApiException
        Adds an authority to pass-through the local proxies.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • removeLocalServer

        public ApiResponse removeLocalServer​(java.lang.String address,
                                     java.lang.String port)
                              throws ClientApiException
        Removes a local server/proxy.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • removePassThrough

        public ApiResponse removePassThrough​(java.lang.String authority)
                              throws ClientApiException
        Removes a pass-through.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • setAliasEnabled

        public ApiResponse setAliasEnabled​(java.lang.String name,
                                   java.lang.String enabled)
                            throws ClientApiException
        Sets whether or not an alias is enabled.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • setPassThroughEnabled

        public ApiResponse setPassThroughEnabled​(java.lang.String authority,
                                         java.lang.String enabled)
                                  throws ClientApiException
        Sets whether or not a pass-through is enabled.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • setConnectionTimeout

        public ApiResponse setConnectionTimeout​(java.lang.String timeout)
                                 throws ClientApiException
        Sets the timeout, for reads and connects.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • setDefaultUserAgent

        public ApiResponse setDefaultUserAgent​(java.lang.String useragent)
                                throws ClientApiException
        Sets the default user-agent.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • setDnsTtlSuccessfulQueries

        public ApiResponse setDnsTtlSuccessfulQueries​(java.lang.String ttl)
                                       throws ClientApiException
        Sets the TTL of successful DNS queries.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • addHttpProxyExclusion

        public ApiResponse addHttpProxyExclusion​(java.lang.String host,
                                         java.lang.String enabled)
                                  throws ClientApiException
        Adds a host to be excluded from the HTTP proxy.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • removeHttpProxyExclusion

        public ApiResponse removeHttpProxyExclusion​(java.lang.String host)
                                     throws ClientApiException
        Removes an HTTP proxy exclusion.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • setHttpProxy

        public ApiResponse setHttpProxy​(java.lang.String host,
                                java.lang.String port,
                                java.lang.String realm,
                                java.lang.String username,
                                java.lang.String password)
                         throws ClientApiException
        Sets the HTTP proxy configuration.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • setHttpProxyAuthEnabled

        public ApiResponse setHttpProxyAuthEnabled​(java.lang.String enabled)
                                    throws ClientApiException
        Sets whether or not the HTTP proxy authentication is enabled.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • setHttpProxyEnabled

        public ApiResponse setHttpProxyEnabled​(java.lang.String enabled)
                                throws ClientApiException
        Sets whether or not the HTTP proxy is enabled.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • setHttpProxyExclusionEnabled

        public ApiResponse setHttpProxyExclusionEnabled​(java.lang.String host,
                                                java.lang.String enabled)
                                         throws ClientApiException
        Sets whether or not an HTTP proxy exclusion is enabled.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • setSocksProxy

        public ApiResponse setSocksProxy​(java.lang.String host,
                                 java.lang.String port,
                                 java.lang.String version,
                                 java.lang.String usedns,
                                 java.lang.String username,
                                 java.lang.String password)
                          throws ClientApiException
        Sets the SOCKS proxy configuration.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • setSocksProxyEnabled

        public ApiResponse setSocksProxyEnabled​(java.lang.String enabled)
                                 throws ClientApiException
        Sets whether or not the SOCKS proxy is enabled.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • setUseGlobalHttpState

        public ApiResponse setUseGlobalHttpState​(java.lang.String use)
                                  throws ClientApiException
        Sets whether or not to use the global HTTP state.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • addPkcs12ClientCertificate

        public ApiResponse addPkcs12ClientCertificate​(java.lang.String filepath,
                                              java.lang.String password,
                                              java.lang.String index)
                                       throws ClientApiException
        Adds a client certificate contained in a PKCS#12 file, the certificate is automatically set as active and used.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • setUseClientCertificate

        public ApiResponse setUseClientCertificate​(java.lang.String use)
                                    throws ClientApiException
        Sets whether or not to use the active client certificate.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • addRateLimitRule

        public ApiResponse addRateLimitRule​(java.lang.String description,
                                    java.lang.String enabled,
                                    java.lang.String matchregex,
                                    java.lang.String matchstring,
                                    java.lang.String requestspersecond,
                                    java.lang.String groupby)
                             throws ClientApiException
        Adds a rate limit rule

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • removeRateLimitRule

        public ApiResponse removeRateLimitRule​(java.lang.String description)
                                throws ClientApiException
        Remove a rate limit rule

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • setRateLimitRuleEnabled

        public ApiResponse setRateLimitRuleEnabled​(java.lang.String description,
                                           java.lang.String enabled)
                                    throws ClientApiException
        Set enabled state for a rate limit rule.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • proxypac

        public byte[] proxypac()
                throws ClientApiException
        Provides a PAC file, proxying through the main proxy.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • setProxy

        public byte[] setProxy​(java.lang.String proxy)
                throws ClientApiException
        Sets the HTTP proxy configuration.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • rootCaCert

        public byte[] rootCaCert()
                  throws ClientApiException
        Gets the Root CA certificate used to issue server certificates. Suitable to import into client applications (e.g. browsers).

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException