Stopping Restore Sessions

In this article

    You can stop a restore session with the specified ID.

    Request

    POST https://<hostname>:4443/v5/RestoreSessions/{restoreSessionId}/action

    Request Headers

    The request header must contain an authorization token of the current session.

    Request Parameters

    The following parameter must be specified in the URL of the request:

    Parameter

    Type

    Description

    restoreSessionId

    string

    Specifies the identification number of the restore session. For more information on how to get this parameter, see Getting Restore Sessions.

    Request Body

    To stop a restore session, the request body must contain the following line:

    Request Body:

    {

     "stop": null

    }

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns a response code 200 OK.

    Response Headers

    The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

    Header

    Description

    Content-length

    The length of the response body.

    Content-type

    The media type and syntax of the response body message: application/json; charset=utf-8

    Response Body

    None.

    Examples

    Example 1

    The example shows how to stop a restore session with the ID 0800471b-d0e2-422b-9d7c-35d15661c3fb.

    Request:

    POST https://abc.tech.local:4443/v5/RestoreSessions/0800471b-d0e2-422b-9d7c-35d15661c3fb/action

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

     "stop": null

    }

     

    Response:

    200 OK