Deleting a Specified Session
Function
This interface is used to delete a specified session.
Syntax
Operation type: DELETE
URL:https://device_ip/redfish/v1/SessionService/Sessions/index
Request header:
X-Auth-Token: auth_value
Request message body: None
Parameters
Parameter |
Description |
Value |
|---|---|---|
device_ip |
IP address for logging in to a device |
An IPv4 or IPv6 address |
index |
ID of a session to be deleted |
The returned information of the session list contains session_id of each session, which can be used to delete a specified session. |
auth_value |
Authentication parameter contained in the request |
You can obtain the value from the session created by using /redfish/v1/SessionService/Sessions. |
Usage Guidelines
None
Example
Example request:
DELETE https://10.10.10.10/redfish/v1/SessionService/Sessions/d0f0593601de6483
Request header:
X-Auth-Token: 6599174c38c36838737d9749179e1ee1
Request message body: None
Response example:
{
"error": {
"code": "Base.1.0.GeneralError",
"message": "A general error has occurred. See ExtendedInfo for more information.",
"@Message.ExtendedInfo": [
{
"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",
"MessageId": "Base.1.0.Success",
"RelatedProperties": [],
"Message": "Successfully Completed Request",
"MessageArgs": [],
"Severity": "OK",
"Resolution": "None"
}
]
}
}
Response code: 200
Output Description
Attribute |
Type |
Description |
|---|---|---|
code |
Character string |
A string indicating the specific message ID in the message registry |
message |
Character string |
A human-readable error message corresponding to the message in the message registry |
@odata.type |
Character string |
Type of a session resource |
MessageId |
Character string |
Message ID |
RelatedProperties |
Array |
Properties related to the message |
Message |
Character string |
Details |
MessageArgs |
Array |
Message parameters |
Severity |
Character string |
Severity. The severities defined by Redfish include OK, Warning, and Critical. |
Resolution |
Character string |
Solution |
