Stopping Synchronization Session

In this article

    You can stop a synchronization session.

    Request

    POST https://<hostname>:4443/v6/RepositorySynchronizeSessions/{sessionId}/StopSynchronize

    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.

    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

    Example

    This example shows how to stop a synchronization session with the ID c6d1fc1b-1aef-411f-9a7f-de35e546c615.

    Request:

    POST https://abc.tech.local:4443/v6/RepositorySynchronizeSessions/c6d1fc1b-1aef-411f-9a7f-de35e546c615/StopSynchronize

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK