Stop Session Processing

You can stop processing of a session with the specifies ID.

Request

To stop session execution, send the HTTP POST request to the /jpbSessions/{sessionId}/stop endpoint.

HTTP Request

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

Query Parameters

To control the amount and order of data in the response, you can use the following query parameters:

Query Parameter

Value

Description

instanceId

string

Stops session for the specified Azure VM. For more information, see Filter Parameters.

Request Headers

The request contains the following headers.

Header

Required

Value

Description

Authorization

Required

Bearer <Access-Token>

Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 204 (No Content).

Response Headers

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

Header

Value

Description

Content-length

integer

Identifies the length of the response body message, in bytes.

Content-type

  • application/json
  • application/problem+json

Identifies the media type of the response body message.

Stop Session ProcessingExample

The following request stops a session with the ID 22a8ab36-40e0-41df-9034-5ba9e9a652fe.

Request:

POST https://51.11.247.127/api/v2/jobSessions/22a8ab36-40e0-41df-9034-5ba9e9a652fe/stop

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

204

I want to report a typo

There is a misspelling right here:

 

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