Web proxy service v1.0

Resource: global_config

Global Web proxy configuration

http://{device}/api/cmc.web-proxy/1.0/global_config

JSON

{
  "enabled": boolean,
  "https_enabled": boolean,
  "audit_log": {
    "audit_log_enabled": boolean,
    "format": string,
    "remote_address": hostname,
    "remote_port": integer
  }
}

{
  "enabled": boolean,
  "https_enabled": boolean,
  "audit_log": {
    "audit_log_enabled": boolean,
    "format": string,
    "remote_address": hostname,
    "remote_port": integer
  }
}

Property Name	Type	Description	Notes
global_config	<object>	Global Web proxy configuration	Required properties: [enabled, https_enabled, audit_log];
global_config.enabled	<boolean>	Enable Web proxy.
global_config.https_enabled	<boolean>	Enable HTTPS optimization for Web proxy.
global_config.audit_log	<object>	Audit log (syslog) settings	Required properties: [audit_log_enabled];
global_config.audit_log. audit_log_enabled	<boolean>	Enable/disable remote logging for the HTTP/S traffic.	Default is False;
global_config.audit_log.format	<string>	The log format for HTTP/S traffic	Optional; Values: CLF;
global_config.audit_log.remote_address	<hostname>	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]))?$';
global_config.audit_log.remote_port	<integer>	Remote port	Optional; Range: 0 to 65535; Default is 514;

Links

global_config: get

GET http://{device}/api/cmc.web-proxy/1.0/global_config

Response Body

Returns a global_config data object.

global_config: set

PUT http://{device}/api/cmc.web-proxy/1.0/global_config

Request Body

Provide a global_config data object.

Response Body

Returns a global_config data object.

Resource: ssl_domain

Domain in ssl_domains

http://{device}/api/cmc.web-proxy/1.0/ssl_domains/items/{id}

JSON

{
  "id": integer,
  "name": domain_name,
  "state": domain_state
}

{
  "id": integer,
  "name": domain_name,
  "state": domain_state
}

Property Name	Type	Description	Notes
ssl_domain	<object>	Domain in ssl_domains	Required properties: [name, state];
id	<integer>	Generic numeric identifier	Read-only; Minimum 1;
ssl_domain.name	<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.state	<domain_state>	Optimization state of the domain	Values: white, black, grey;

Links

ssl_domain: get

GET http://{device}/api/cmc.web-proxy/1.0/ssl_domains/items/{id}

Response Body

Returns a ssl_domain data object.

ssl_domain: set

PUT http://{device}/api/cmc.web-proxy/1.0/ssl_domains/items/{id}

Request Body

Provide a ssl_domain data object.

Response Body

Returns a ssl_domain data object.

ssl_domain: delete

DELETE http://{device}/api/cmc.web-proxy/1.0/ssl_domains/items/{id}

Response Body

On success, the server does not provide any body in the responses.

Relations

ssl_domain: instances

Related resource

ssl_domains

Resource: ssl_domains

List of domains associated with SSL optimization

http://{device}/api/cmc.web-proxy/1.0/ssl_domains{?state,name}

JSON

[
  {
    "id": integer,
    "name": domain_name,
    "state": domain_state
  }
]

[
  {
    "id": integer,
    "name": domain_name,
    "state": domain_state
  }
]

Property Name	Type	Description	Notes
ssl_domains	<array of <items>>	List of domains associated with SSL optimization
items	<object>	Domain in ssl_domains	Required properties: [name, state];
id	<integer>	Generic numeric identifier	Read-only; Minimum 1;
items.name	<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;

Links

ssl_domains: get

GET http://{device}/api/cmc.web-proxy/1.0/ssl_domains{?state,name}

Response Body

Returns a ssl_domains data object.

ssl_domains: create

POST http://{device}/api/cmc.web-proxy/1.0/ssl_domains{?state,name}

Request Body

Provide a ssl_domain data object.

Response Body

Returns a ssl_domain data object.

ssl_domains: set

PUT http://{device}/api/cmc.web-proxy/1.0/ssl_domains{?state,name}

Request Body

Provide a ssl_domains data object.

Response Body

Returns a ssl_domains data object.

Resource: site_configs

List of site_configs

http://{device}/api/cmc.web-proxy/1.0/site_configs{?site_type_id,site_id}

JSON

[
  {
    "id": integer,
    "site_id": integer,
    "site_type_id": integer,
    "enabled": boolean,
    "https_enabled": boolean
  }
]

[
  {
    "id": integer,
    "site_id": integer,
    "site_type_id": integer,
    "enabled": boolean,
    "https_enabled": boolean
  }
]

Property Name	Type	Description	Notes
site_configs	<array of <items>>	List of site_configs
items	<object>	Site specific Web proxy configuration	Required properties: [enabled, https_enabled];
id	<integer>	Generic numeric identifier	Read-only; Minimum 1;
items.site_id	<integer>	Site ID	Optional;
items.site_type_id	<integer>	Site type ID	Optional;
items.enabled	<boolean>	Enable Web proxy.
items.https_enabled	<boolean>	Enable HTTPS Web proxy.
items.oneOf[0]	<object>		Required properties: [site_id];
items.oneOf[0].<prop>	<any>		Optional;
items.oneOf[1]	<object>		Required properties: [site_type_id];
items.oneOf[1].<prop>	<any>		Optional;

Links

site_configs: create

POST http://{device}/api/cmc.web-proxy/1.0/site_configs{?site_type_id,site_id}

Request Body

Provide a site_config data object.

Response Body

Returns a site_config data object.

site_configs: get

GET http://{device}/api/cmc.web-proxy/1.0/site_configs{?site_type_id,site_id}

Response Body

Returns a site_configs data object.

Resource: site_config

Site specific Web proxy configuration

http://{device}/api/cmc.web-proxy/1.0/site_configs/items/{id}

JSON

{
  "id": integer,
  "site_id": integer,
  "site_type_id": integer,
  "enabled": boolean,
  "https_enabled": boolean
}

{
  "id": integer,
  "site_id": integer,
  "site_type_id": integer,
  "enabled": boolean,
  "https_enabled": boolean
}

Property Name	Type	Description	Notes
site_config	<object>	Site specific Web proxy configuration	Required properties: [enabled, https_enabled];
id	<integer>	Generic numeric identifier	Read-only; Minimum 1;
site_config.site_id	<integer>	Site ID	Optional;
site_config.site_type_id	<integer>	Site type ID	Optional;
site_config.enabled	<boolean>	Enable Web proxy.
site_config.https_enabled	<boolean>	Enable HTTPS Web proxy.
site_config.oneOf[0]	<object>		Required properties: [site_id];
site_config.oneOf[0].<prop>	<any>		Optional;
site_config.oneOf[1]	<object>		Required properties: [site_type_id];
site_config.oneOf[1].<prop>	<any>		Optional;

Links

site_config: get

GET http://{device}/api/cmc.web-proxy/1.0/site_configs/items/{id}

Response Body

Returns a site_config data object.

site_config: set

PUT http://{device}/api/cmc.web-proxy/1.0/site_configs/items/{id}

Request Body

Provide a site_config data object.

Response Body

Returns a site_config data object.

site_config: delete

DELETE http://{device}/api/cmc.web-proxy/1.0/site_configs/items/{id}

Response Body

On success, the server does not provide any body in the responses.

Relations

site_config: instances

Related resource

site_configs

Resource: poller

Temporary callback for statistics poll requests.

http://{device}/api/cmc.web-proxy/1.0/poller_callback

JSON

{
  <prop>: any
}

{
  <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;

Links

poller: callback

Callback to get polled response.

POST http://{device}/api/cmc.web-proxy/1.0/poller_callback

Request Body

Provide a poller_response data object.

Response Body

On success, the server does not provide any body in the responses.

Type: identifier

Generic numeric identifier

JSON

integer

integer

Property Name	Type	Description	Notes
identifier	<integer>	Generic numeric identifier	Read-only; Minimum 1;

Type: hostname

Hostname

JSON

string

string

Property Name	Type	Description	Notes
hostname	<string>	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]))?$';

Type: domain_name

Domain name

JSON

string

string

Property Name	Type	Description	Notes
domain_name	<string>	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])?)\.?$';

Type: domain_state

Optimization state of the domain

JSON

string

string

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

Type: poller_response

JSON

{
  "poll_req_id": integer,
  "serial": string,
  "poll_time": integer,
  "resp_data": string,
  <prop>: any
}

{
  "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;