SteelHead Optimization Service v1.0

Resource: optimization

Settings for the SteelHead optimization service

http://{device}/api/sh.optimization/1.0/optimization

JSON

{
  "service_state": string,
  "restart_needed": boolean,
  <prop>: any
}

{
  "service_state": string,
  "restart_needed": boolean,
  <prop>: any
}

Property Name	Type	Description	Notes
optimization	<object>	Settings for the SteelHead optimization service
optimization.service_state	<string>		Read-only; Optional; Values: running, stopped, stopping, unknown;
optimization.restart_needed	<boolean>	Some settings may not take effect until the optimization service is restarted.	Read-only; Optional;
optimization.<prop>	<any>		Optional;

GET http://{device}/api/sh.optimization/1.0/optimization

Response Body

Returns an optimization data object.

Stop the optimization service.

POST http://{device}/api/sh.optimization/1.0/optimization/stop

Request Body

Do not provide a request body.

Response Body

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

Start/Restart the optimization service. Can be used whether the optimization service is currently running or not.

POST http://{device}/api/sh.optimization/1.0/optimization/restart

Request Body

Provide a request body with the following structure:

JSON

{
  "clear_cache": boolean,
  <prop>: any
}

{
  "clear_cache": boolean,
  <prop>: any
}

Property Name	Type	Notes
optimization.links.restart.request	<object>
optimization.links.restart.request. clear_cache	<boolean>	Optional;
optimization.links.restart.request. <prop>	<any>	Optional;

Response Body

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