doServerRestart

post

/ccadmin/v1/servers/restart

Do Server Restart. Restarts the workers that belong to the extension server matched with this Oracle Commerce server.

Request

Supported Media Types
Query Parameters
  • If true, then the response will contain workRequestId which can be used to track the extension server restart status.
Body ()
Root Schema : doServerRestart_request
Type: object
Show Source
  • It specifies the environment where operation needs to be performed. Default value is live. (value: preview or live)
Example:
{
    "environmentType":"preview"
}
Back to Top

Response

Supported Media Types

202 Response

The following model is returned when track progress query parameter is passed as true.
Body ()
Root Schema : doServerRestart_response_accepted
Type: object
Show Source
Example Response (application/json)
{
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminx/custom/v1/servers/restart?trackProgress=true"
        }
    ],
    "message":"The extension server restart request has been accepted. Please use the workRequestId to track the restart status.",
    "workRequestId":"mblNhrQ2D2"
}

204 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : doServerRestart_response
Show Source

Default Response

The error response
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top