This API has a deprecated equivalent from v7.0U1.
Restart Service
DescriptionRestarts a service
Request
URLURL
https://{api_host}/api/vcenter/services/{service}?action=restart
Path Parameters
Path Parameters
string
service
Required
identifier of the service to restart The parameter must be an identifier for the resource type: com.vmware.vcenter.services.Service.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.not_allowed_in_current_state : if the operation is denied in the current state of the service. If a stop or start operation is in progress, issuing a restart operation will lead to this error. if a restart operation is issued on a service which has startup type DISABLED
404
com.vmware.vapi.std.errors.not_found : if the service associated with service does not exist.
500
com.vmware.vapi.std.errors.timed_out : if any timeout occurs during the execution of the restart operation. | com.vmware.vapi.std.errors.error : if any other error occurs during the execution of the operation.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-RestartService -Service "MyService"
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/services/{service}?action=restart
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/vcenter/services/{service}/restart
x-vmw-doc-operation: restart
Availability
Added in 7.0U2
On This Page
Service Operations
get
patch
post
post
post
