Web proxy service v2.0
Created Dec 18, 2020 at 07:15 PM

Resource: profile

Site specific profile configuration for Web Proxy

http://{device}/api/cmc.web-proxy/2.0/profiles/items/{id}
  • JSON
  • {
      "profile_id": identifier,
      "profile_name": unrestricted_name,
      "enabled": boolean,
      "https_enabled": boolean,
      "audit_log": {
        "audit_log_enabled": boolean,
        "format": string,
        "remote_address": hostname,
        "remote_port": integer
      },
      "site_info": {
        "site_id": [
          integer
        ],
        "site_type_id": [
          integer
        ],
        <prop>: any
      }
    }
    Property Name Type Description Notes
    profile <object> Site specific profile configuration for Web Proxy
    profile.profile_id <identifier> Read-only;
    profile.profile_name <unrestricted_name> Pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]*$|^[a-zA-Z0-9_-][a-zA-Z0-9 _-]+[a-zA-Z0-9_-]$';
    profile.enabled <boolean> Enable Web proxy. Optional;
    profile.https_enabled <boolean> Enable HTTPS optimization for Web proxy. Optional;
    profile.audit_log <object> Audit log (syslog) settings Required properties: [audit_log_enabled]; Optional;
    profile.audit_log.audit_log_enabled <boolean> Enable/disable remote logging for the HTTP/S traffic. Default is False;
    profile.audit_log.format <string> The log format for HTTP/S traffic Optional; Values: CLF;
    profile.audit_log.remote_address <hostname> Pattern: '^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9]))?$';
    profile.audit_log.remote_port <integer> Remote port Optional; Range: 0 to 65535; Default is 514;
    profile.site_info <object> Optional;
    profile.site_info.site_id <array of <integer>> Optional;
    profile.site_info.site_id[items] <integer>
    profile.site_info.site_type_id <array of <integer>> Optional;
    profile.site_info.site_type_id[items] <integer>
    profile.site_info.<prop> <any> Optional;
    profile.site_info.oneOf[0] <object> Required properties: [site_id];
    profile.site_info.oneOf[0].<prop> <any> Optional;
    profile.site_info.oneOf[1] <object> Required properties: [site_type_id];
    profile.site_info.oneOf[1].<prop> <any> Optional;

    Relations

    profile: instances

    Related resource

    profiles

    Resource: profiles

    List of all profiles

    http://{device}/api/cmc.web-proxy/2.0/profiles
  • JSON
  • [
      {
        "profile_id": identifier,
        "profile_name": unrestricted_name,
        "enabled": boolean,
        "https_enabled": boolean,
        "audit_log": {
          "audit_log_enabled": boolean,
          "format": string,
          "remote_address": hostname,
          "remote_port": integer
        },
        "site_info": {
          "site_id": [
            integer
          ],
          "site_type_id": [
            integer
          ],
          <prop>: any
        }
      }
    ]
    Property Name Type Description Notes
    profiles <array of <items>> List of all profiles
    items <object> Site specific profile configuration for Web Proxy
    items.profile_id <identifier> Read-only;
    items.profile_name <unrestricted_name> Pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]*$|^[a-zA-Z0-9_-][a-zA-Z0-9 _-]+[a-zA-Z0-9_-]$';
    items.enabled <boolean> Enable Web proxy. Optional;
    items.https_enabled <boolean> Enable HTTPS optimization for Web proxy. Optional;
    items.audit_log <object> Audit log (syslog) settings Required properties: [audit_log_enabled]; Optional;
    items.audit_log.audit_log_enabled <boolean> Enable/disable remote logging for the HTTP/S traffic. Default is False;
    items.audit_log.format <string> The log format for HTTP/S traffic Optional; Values: CLF;
    items.audit_log.remote_address <hostname> Pattern: '^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9]))?$';
    items.audit_log.remote_port <integer> Remote port Optional; Range: 0 to 65535; Default is 514;
    items.site_info <object> Optional;
    items.site_info.site_id <array of <integer>> Optional;
    items.site_info.site_id[items] <integer>
    items.site_info.site_type_id <array of <integer>> Optional;
    items.site_info.site_type_id[items] <integer>
    items.site_info.<prop> <any> Optional;
    items.site_info.oneOf[0] <object> Required properties: [site_id];
    items.site_info.oneOf[0].<prop> <any> Optional;
    items.site_info.oneOf[1] <object> Required properties: [site_type_id];
    items.site_info.oneOf[1].<prop> <any> Optional;

    Resource: profile_ssl_domain

    SSL Domains associated with profile.

    http://{device}/api/cmc.web-proxy/2.0/profile_ssl_domains/items/{id}
  • JSON
  • {
      "id": identifier,
      "profile_id": identifier,
      "domain_name": domain_name,
      "state": domain_state
    }
    Property Name Type Description Notes
    profile_ssl_domain <object> SSL Domains associated with profile.
    profile_ssl_domain.id <identifier> Read-only;
    profile_ssl_domain.profile_id <identifier> Read-only;
    profile_ssl_domain.domain_name <domain_name> Pattern: '^(\*\.)?[0-9A-Za-z](([0-9A-Za-z]|-){0,61}[0-9A-Za-z])?(\.[0-9A-Za-z](([0-9A-Za-z]|-){0,61}[0-9A-Za-z])?)*\.?$';
    profile_ssl_domain.state <domain_state> Optimization state of the domain Values: white, black, grey;

    Resource: profile_ssl_domains

    SSL Domains Plurals

    http://{device}/api/cmc.web-proxy/2.0/profile_ssl_domains{?profile_id}
  • JSON
  • [
      {
        "id": identifier,
        "profile_id": identifier,
        "domain_name": domain_name,
        "state": domain_state
      }
    ]
    Property Name Type Description Notes
    profile_ssl_domains <array of <items>> SSL Domains Plurals
    items <object> SSL Domains associated with profile.
    items.id <identifier> Read-only;
    items.profile_id <identifier> Read-only;
    items.domain_name <domain_name> Pattern: '^(\*\.)?[0-9A-Za-z](([0-9A-Za-z]|-){0,61}[0-9A-Za-z])?(\.[0-9A-Za-z](([0-9A-Za-z]|-){0,61}[0-9A-Za-z])?)*\.?$';
    items.state <domain_state> Optimization state of the domain Values: white, black, grey;

    Resource: parent_proxy_exclude_domain

    Settings for domains that need to bypass the parent proxy

    http://{device}/api/cmc.web-proxy/2.0/parent_proxy_exclude_domains/items/{id}
  • JSON
  • {
      "id": identifier,
      "profile_id": identifier,
      "domain_name": hostname
    }
    Property Name Type Description Notes
    parent_proxy_exclude_domain <object> Settings for domains that need to bypass the parent proxy
    parent_proxy_exclude_domain.id <identifier> Read-only;
    parent_proxy_exclude_domain.profile_id <identifier> Read-only;
    parent_proxy_exclude_domain.domain_name <hostname> Pattern: '^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9]))?$';

    Relations

    parent_proxy_exclude_domain: instances

    Related resource

    parent_proxy_exclude_domains

    Resource: parent_proxy_exclude_domains

    List of all profiles

    http://{device}/api/cmc.web-proxy/2.0/parent_proxy_exclude_domains{?profile_id}
  • JSON
  • [
      {
        "id": identifier,
        "profile_id": identifier,
        "domain_name": hostname
      }
    ]
    Property Name Type Description Notes
    parent_proxy_exclude_domains <array of <items>> List of all profiles
    items <object> Settings for domains that need to bypass the parent proxy
    items.id <identifier> Read-only;
    items.profile_id <identifier> Read-only;
    items.domain_name <hostname> Pattern: '^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9]))?$';

    Resource: proxy_chain

    Profile specific list of Proxy servers

    http://{device}/api/cmc.web-proxy/2.0/proxy_chain{?profile_id}
  • JSON
  • {
      "profile_id": identifier,
      "http": [
        {
          "address": remote_address,
          "port": remote_port
        }
      ],
      "https": [
        {
          "address": remote_address,
          "port": remote_port
        }
      ],
      "chaining_mode": chaining_mode
    }
    Property Name Type Description Notes
    proxy_chain <object> Profile specific list of Proxy servers
    proxy_chain.profile_id <identifier> Read-only;
    proxy_chain.http <array of <object>> List of HTTP servers Optional;
    proxy_chain.http[items] <object> Required properties: [address, port];
    proxy_chain.http[items].address <remote_address> Remote address/IP Pattern: '^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$';
    proxy_chain.http[items].port <remote_port> Remote port
    proxy_chain.https <array of <object>> Optional;
    proxy_chain.https[items] <object> Required properties: [address, port];
    proxy_chain.https[items].address <remote_address> Remote address/IP Pattern: '^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$';
    proxy_chain.https[items].port <remote_port> Remote port
    proxy_chain.chaining_mode <chaining_mode> Values: off, automatic, manual;

    Resource: poller

    Temporary callback for statistics poll requests.

    http://{device}/api/cmc.web-proxy/2.0/poller_callback
  • JSON
  • {
      <prop>: any
    }
    Property Name Type Description Notes
    poller <object> Temporary callback for statistics poll requests. Required properties: [poll_req_id, serial, poll_time, resp_data];
    poller.<prop> <any> Optional;

    Type: identifier

  • JSON
  • integer
    Property Name Type Description Notes
    identifier <integer> Read-only; Minimum 1;

    Type: unrestricted_name

  • JSON
  • string
    Property Name Type Description Notes
    unrestricted_name <string> Pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]*$|^[a-zA-Z0-9_-][a-zA-Z0-9 _-]+[a-zA-Z0-9_-]$';

    Type: hostname

  • JSON
  • string
    Property Name Type Description Notes
    hostname <string> Pattern: '^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9]))?$';

    Type: remote_address

    Remote address/IP

  • JSON
  • string
    Property Name Type Description Notes
    remote_address <string> Remote address/IP Pattern: '^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$';

    Type: remote_port

    Remote port

  • JSON
  • integer
    Property Name Type Description Notes
    remote_port <integer> Remote port Range: 0 to 65535;

    Type: domain_name

  • JSON
  • string
    Property Name Type Description Notes
    domain_name <string> Pattern: '^(\*\.)?[0-9A-Za-z](([0-9A-Za-z]|-){0,61}[0-9A-Za-z])?(\.[0-9A-Za-z](([0-9A-Za-z]|-){0,61}[0-9A-Za-z])?)*\.?$';

    Type: domain_state

    Optimization state of the domain

  • JSON
  • string
    Property Name Type Description Notes
    domain_state <string> Optimization state of the domain Values: white, black, grey;

    Type: chaining_mode

  • JSON
  • string
    Property Name Type Description Notes
    chaining_mode <string> Values: off, automatic, manual;

    Type: server_mode

  • JSON
  • string
    Property Name Type Description Notes
    server_mode <string> Values: http, https;

    Type: proxy_exception_set

  • JSON
  • {
      "row_id": identifier,
      "domain_name": hostname,
      <prop>: any
    }
    Property Name Type Description Notes
    proxy_exception_set <object> Required properties: [row_id, domain_name];
    proxy_exception_set.row_id <identifier> Read-only;
    proxy_exception_set.domain_name <hostname> Pattern: '^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9]))?$';
    proxy_exception_set.<prop> <any> Optional;

    Type: ssl_domain_set

  • JSON
  • {
      "row_id": identifier,
      "domain_name": domain_name,
      <prop>: any
    }
    Property Name Type Description Notes
    ssl_domain_set <object> Required properties: [row_id, domain_name];
    ssl_domain_set.row_id <identifier> Read-only;
    ssl_domain_set.domain_name <domain_name> Pattern: '^(\*\.)?[0-9A-Za-z](([0-9A-Za-z]|-){0,61}[0-9A-Za-z])?(\.[0-9A-Za-z](([0-9A-Za-z]|-){0,61}[0-9A-Za-z])?)*\.?$';
    ssl_domain_set.<prop> <any> Optional;

    Type: create_empty

  • JSON
  • {
      "profile_name": unrestricted_name,
      "site_info": {
        "site_id": [ identifier ],
        "site_type_id": [ identifier ],
        <prop>: any
      },
      <prop>: any
    }
    Property Name Type Description Notes
    create_empty <object> Required properties: [profile_name, site_info];
    create_empty.profile_name <unrestricted_name> Pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]*$|^[a-zA-Z0-9_-][a-zA-Z0-9 _-]+[a-zA-Z0-9_-]$';
    create_empty.site_info <object>
    create_empty.site_info.site_id <array of <identifier>> Optional;
    create_empty.site_info.site_id[items] <identifier> Read-only;
    create_empty.site_info.site_type_id <array of <identifier>> Optional;
    create_empty.site_info.site_type_id
    [items]
    <identifier> Read-only;
    create_empty.site_info.<prop> <any> Optional;
    create_empty.site_info.oneOf[0] <object> Required properties: [site_id];
    create_empty.site_info.oneOf[0].<prop> <any> Optional;
    create_empty.site_info.oneOf[1] <object> Required properties: [site_type_id];
    create_empty.site_info.oneOf[1].<prop> <any> Optional;
    create_empty.<prop> <any> Optional;

    Type: clone

  • JSON
  • {
      "source_profile": unrestricted_name,
      "profile_name": unrestricted_name,
      "site_info": {
        "site_id": [ identifier ],
        "site_type_id": [ identifier ],
        <prop>: any
      },
      <prop>: any
    }
    Property Name Type Description Notes
    clone <object> Required properties: [source_profile, profile_name, site_info];
    clone.source_profile <unrestricted_name> Pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]*$|^[a-zA-Z0-9_-][a-zA-Z0-9 _-]+[a-zA-Z0-9_-]$';
    clone.profile_name <unrestricted_name> Pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]*$|^[a-zA-Z0-9_-][a-zA-Z0-9 _-]+[a-zA-Z0-9_-]$';
    clone.site_info <object>
    clone.site_info.site_id <array of <identifier>> Optional;
    clone.site_info.site_id[items] <identifier> Read-only;
    clone.site_info.site_type_id <array of <identifier>> Optional;
    clone.site_info.site_type_id[items] <identifier> Read-only;
    clone.site_info.<prop> <any> Optional;
    clone.site_info.oneOf[0] <object> Required properties: [site_id];
    clone.site_info.oneOf[0].<prop> <any> Optional;
    clone.site_info.oneOf[1] <object> Required properties: [site_type_id];
    clone.site_info.oneOf[1].<prop> <any> Optional;
    clone.<prop> <any> Optional;

    Type: poller_response

  • JSON
  • {
      "poll_req_id": integer,
      "serial": string,
      "poll_time": integer,
      "resp_data": string,
      <prop>: any
    }
    Property Name Type Description Notes
    poller_response <object>
    poller_response.poll_req_id <integer> Request ID registered with poller Optional;
    poller_response.serial <string> Appliance from which response is received. Optional;
    poller_response.poll_time <integer> Time when resource was polled, in seconds since the UNIX epoch. Optional;
    poller_response.resp_data <string> Response from the polled request. Optional;
    poller_response.<prop> <any> Optional;