DELETE /logonSessions/{ID}

Deletes a logon session having the specified ID.

Request

To delete a logon session, send the DELETE HTTP request to the URL of the /logonSessions/{ID} resource.

HTTP Request

DELETE https://<Enterprise-Manager>:9398/api/logonSessions/{ID}

Request Header

The request contains the following headers:

Header

Required

Description

X-RestSvcSessionId

True

The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. For details, see Authentication and Security.

Accept

False

Identifies the format of the response. Possible values:

  • application/xml — the client can send this value in the header to accept response in the XML format.
  • application/json — the client must send this value in the header to accept the request in the JSON format.

If the request does not contain the header, the server will return the response in the XML format.

Request Body

None.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns 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

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the request body message. Possible values:

  • application/xml
  • application/json

Response Body

None.

Example

The example below deletes a logon session created for Veeam Backup Enterprise Manager REST API. The logon session has ID fffb65bd-0e7a-427a-bc35-915b0fdf17af:

Request:

DELETE https://localhost:9398/api/logonSessions/fffb65bd-0e7a-427a-bc35-915b0fdf17af

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

204 No Content

 

Response Body:

None

 

Page updated 1/25/2024

Page content applies to build 12.2.0.334