WHM API 0 Functions - restartservice

Guide to WHM API 0

Return Data

Accounts

accountsummary

DNS

IP Addresses

Mail

deliver_messages_mail_queue

exim_configuration_check

fetch_doc_key

purge_mail_queue

remove_in_progress_exim_config_edit

remove_messages_mail_queue

unfreeze_messages_mail_queue

validate_current_installed_exim_config

validate_exim_configuration_syntax

Packages

Resellers

setresellernameservers

setresellerpackagelimit

Server Administration

SSL

Updates

Description

This function restarts a service, or daemon, on a server.

Examples

JSON API

https://hostname.example.com:2087/cpsess##########/json-api/restartservice?service=httpd

XML API

https://hostname.example.com:2087/cpsess##########/xml-api/restartservice?service=httpd

Command Line

whmapi0 restartservice service=httpd

Notes:

You must URI-encode values.
For more information and additional output options, read our Guide to WHM API 0 documentation or run the whmapi0 --help command.
If you run CloudLinux™, you must use the full path of the whmapi0 command:
```
/usr/local/cpanel/bin/whmapi0
```

Output (JSON)

{
   "restart":[
      {
         "result":1,
         "service":"httpd",
         "rawout":"Waiting for httpd to restart..............finished.\n\nhttpd 
(/usr/local/apache/bin/httpd -k start -DSSL) running as root with PID 21379\n
httpd (/usr/local/apache/bin/httpd -k start -DSSL) running as root with PID 21385
\n\nhttpd started ok\n",
         "servicename":"Apache Web Server"
      }
   ]
}

Output (XML)

<restartservice>
     <restart>
            <rawout>Waiting for httpd to restart..............finished.
            httpd (/usr/local/apache/bin/httpd -k start -DSSL) 
            running as root with PID 19446
            httpd (/usr/local/apache/bin/httpd -k start -DSSL) 
            running as root with PID 19452
            httpd started ok
            </rawout>
            <result>1</result>
            <service>httpd</service>
            <servicename>Apache Web Server</servicename>
      </restart>
</restartservice>

Parameters

Parameter Type Description Possible values Example

service

string

Required

The service to restart.

For a list of possible values, read our Service Manager documentation.

mysql

Returns

Return	Type	Description	Possible values	Example
`restart`	array of hashes	An array of hashes that contain service data.	This array of hashes includes the `rawout`, `result`, `service`, and `servicename` returns.
`rawout`	string	The `restartservice` function's raw HTTP output. The function returns this value in the `restart` hash.	A string of raw HTTP data.	Click to view `Waiting for httpd to restart..............finished.\n\nhttpd` `(/usr/local/apache/bin/httpd -k start -DSSL) running as root with PID 21379\n` `httpd (/usr/local/apache/bin/httpd -k start -DSSL) running as root with PID 21385` `\n\nhttpd started ok\n`
`result`	Boolean	The result of the function. The function returns this value in the `restart` hash.	`1` — The function succeeded. `0` — The function failed	`1`
`service`	string	The restarted service. The function returns this value in the `restart` hash.	For a list of possible values, read our Service Manager documentation.	`httpd`
`servicename`	string	The restarted service's full name. The function returns this value in the `restart` hash.	A string value.	`Apache Web Server`

Function information

API Version:

WHM API 0

WHM API 1 Equivalent:

restartservice

Important:

We strongly recommend that you use WHM API 1. WHM API 0 is deprecated.

Available in:

WHM 11.32+

Methods:

GET, POST

Required Parameters:

service

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 0

WHM API 0 performs functions and accesses data in WHM.

Warning:

WHM API 0 is deprecated. We strongly recommend that you use the equivalent WHM API 1 function instead.