This is an archive version of the document. To get the most up-to-date information, see the current version.

Stopping Backup Session by Session ID

This section explains how to stop a running session.

Request

POST https://<hostname>/api/v1/jobSessions/{sessionId}/stop

Request Headers

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

Request Parameters

The following parameters must be posted as URL.

Parameter

Description

sessionId

The identification number of the session. Can be obtained as described in Getting Sessions.

Request Body

None.

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.

Example

Request:

POST https://<hostname>/api/v1/jobSessions/19/stop

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.