Note
This documentation is for a prior release of Kinetica. For the latest documentation, click here.
URL: http://<db.host>:<db.port>/admin/offline
Take the system offline. When the system is offline, no user operations can be performed with the exception of a system shutdown.
Input Parameter Description
| Name | Type | Description | ||||
|---|---|---|---|---|---|---|
| offline | boolean | Set to true if desired state is offline. The supported values are:
| ||||
| options | map of string to strings | Optional parameters. The default value is an empty map ( {} ).
|
Output Parameter Description
The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| status | String | 'OK' or 'ERROR' | |||||||||
| message | String | Empty if success or an error message | |||||||||
| data_type | String | 'admin_offline_response' or 'none' in case of an error | |||||||||
| data | String | Empty string | |||||||||
| data_str | JSON or String | This embedded JSON represents the result of the /admin/offline endpoint:
Empty string in case of an error. |
