/admin/offline

URL: http://GPUDB_IP_ADDRESS:GPUDB_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: true false
options	map of string to strings	Optional parameters. The default value is an empty map ( {} ). Supported Parameters (keys) Parameter Description flush_to_disk Flush to disk when going offline The supported values are: true false

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_request' 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: Name Type Description is_offline boolean Returns true if the system is offline, or false otherwise. Empty string in case of an error.