Control Web Service
Start or Stop Web Service
Controls the Web service. Allows starting or stopping of the Web service. The operation is synchronous and returns the final status after the action completes.
Request
URI
POST
https://{server}:9443/components/web
COPY
Query Parameters
string
action
Required
Action to perform on the Web Service
action example
start
Possible values are :
start,
stop,
Authentication
This operation uses the following authentication methods.
Responses
200
Service action completed successfully
Returns
ServiceControlResponse
of type(s)
application/json
{
"result": "string",
"operationStatus": "string"
}
string
result
Optional
Running Status
Possible values are :
RUNNING,
STOPPED,
STARTING,
string
operationStatus
Optional
Operation Status
Possible values are :
SUCCESS,
FAILED,
400
Bad request - Invalid action or unsupported operation
Returns
ServiceControlError
of type(s)
application/json
{
"message": "string"
}
string
message
Optional
Error message
500
Internal server error - Operation failed
Returns
ServiceControlResponse
of type(s)
application/json
{
"result": "string",
"operationStatus": "string"
}
string
result
Optional
Running Status
Possible values are :
RUNNING,
STOPPED,
STARTING,
string
operationStatus
Optional
Operation Status
Possible values are :
SUCCESS,
FAILED,
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' https://{api_host}/components/web