Discarding sessions

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
The following request discards the sessions that are no longer required. If a session is discarded, the lock obtained in that session is unlocked at the same time. For the Authorization header of the request, specify the token for a session to be discarded.

Execution permission

Storage Administrator (View Only)

Request line

DELETE base-URL/v1/objects/sessions/object-ID

Request message

Object ID

Specify the value of sessionId that was obtained when the session was generated. A user who belongs to the Administrator user group (built-in user group) can specify the value of sessionId that was obtained by the processing to get information about sessions.

Attribute

Type

Description

sessionId

int

(Required) Session ID

Query parameters
None.
Body
{
  "force": true
}

Attribute

Type

Description

force

boolean

Specify whether to force discarding of the session generated by other users, in addition to the session you generated. Only a user who belongs to the Administrator user group (built-in user group) can specify this attribute.
  • true: Forces discarding of the session generated by other users, in addition to the session you generated.
  • false: Forces discarding of only the session you generated.

If you omit this value, false is used.

Response message

Body
None.

Status codes

For details on the status codes of the request for this operation, see the description on HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X DELETE --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/sessions/1