This API has a deprecated equivalent from v7.0U1.
Delete Session
Terminates the validity of a session token. This is the equivalent of log out. A session token is expected as part of the request.
Request
URLURL
https://{api_host}/api/session
Header Parameters
Header Parameters
string
Authorization
Required
Required basic authentication header. Takes in a Base64 encoded value of your username:password
Authorization example
"Basic dXNlcm5hbWU6cGFzc3dvcmQ="
Authentication
This operation uses the following authentication methods.
Errors
Errors
401
com.vmware.vapi.std.errors.unauthenticated : if the session id is missing from the request or the corresponding session object cannot be found.
503
com.vmware.vapi.std.errors.service_unavailable : if session deletion fails due to server specific issues, for example connection to a back end component is failing. Due to the security nature of this API further details will not be disclosed in the error. Please refer to component health information, administrative logs and product specific documentation for possible causes.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-DeleteSession -Server $serverConfiguration -Confirm:$false
$serverConfiguration | Remove-ServerConfiguration
cURL Command
curl -X DELETE -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=" https://{api_host}/api/session
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: delete
x-vmw-doc-deprecated-path: /rest/com/vmware/cis/session
x-vmw-doc-operation: delete
Availability
Added in 7.0U2
