Stopping Synchronization Session

In this article

    You can stop a synchronization session.

    Request

    POST https://<hostname>:4443/v5/RepositorySynchronizeSessions/{sessionId}/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

    sessionId

    string

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

    Request Example

    Request:

    POST https://abc.tech.local:4443/v5/RepositorySynchronizeSessions/08d2e6c0-89d5-49bf-8a9b-873f5064d9be/action

     

    Request Header:

    Authorization: Bearer <Access-Token>


    Request Body:

    {

     "stop": {}          

    }

    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