End of Life Products and Features

1 Versioning Notes
2 Description
3 Arguments
4 Example Requests & Responses
- 4.1 Example One
  - 4.1.1 Request
  - 4.1.2 Response

Versioning Notes

This object and method were part of system_reboot.save until version 1.1. For versions lower than this, use the system_reboot.save method and send an additional parameter named 'action' with value 'shutdown' or 'reboot' to indicate the action to take.

Description

Initiate a shutdown of the gateway.

Arguments

name	Required	value type	default value

name	Required	value type	default value
confirm	yes	"yes"	none

Example Requests & Responses

Example One

Request

Initiate a shutdown of the gateway.

{
    'method' => 'system_shutdown.save',
    'parameters' => {
          'confirm' => 'yes',
        }

Response

{
          'result' => 'success'
 }

Or

{
          'result' => 'error',
          'error' => 'An Error String',
          'error_key' => 'AN_ERROR_LANGUAGE_KEY',
 }

End of Life Products and Features - system_shutdown.save