Update Service
If vSphere APIs begin with /rest (vs /api), any maps are consumed/returned instead as arrays of objects, each containing a key and a value property field.
Updates the properties of a service.
Request
URLURL
https://{api_host}/rest/appliance/vmon/service/{service}
Parameters
Parameters
string
service
Required
identifier of the service whose state is being queried.
The parameter must be an identifier for the resource type: com.vmware.appliance.vmon.Service.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Example: b00db39f948d13ea1e59b4d6fce56389
Request Body
Request Body
VmonServiceUpdateRequestBody of type application/json (required){
"spec": {
"startup_type": "enum"
}
}cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"spec":{"startup_type":"enum"}}' https://{api_host}/rest/appliance/vmon/service/{service}
Errors
404
com.vmware.vapi.std.errors.not_found : if the service associated with service does not exist. | com.vmware.vapi.std.errors.error : if any other error occurs during the execution of the operation.
409
com.vmware.vapi.std.errors.not_allowed_in_current_state : if the operation is denied in the current state of the service. If a start, stop or restart operation is in progress, update operation will fail with this error.
if a request to set the Service.UpdateSpec.startup-type field of spec to DISABLED comes in for a service that is not in STOPPED state.
On This Page
Service Operations
get
patch
post
post
post
