POST https://<address>/wsapis/[v1.2.0|v2.0.0]/auth/logout
This command is available on the following appliances:
Central Management System
Malware Analysis
Email Security — Server
File Protect
Network Security
Required headers:
X-FeApi-Token: [API-Token] X-FeClient-Token: [Client-Token]
Parameters
address—The IP address of the appliance running the Web Services API.
API-Token—This token authenticates the session. By default, the session times out after 15 minutes of inactivity.
Client-Token—(Optional) This client token is provided by Trellix . For more information about the client token, contact your sales representative.
Example
https://xxx.xxx.xxx.xxx:443/wsapis/v2.0.0/auth/logout
Request headers:
X-FeApi-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx X-FeClient-Token: BigDataInc
Log out response
HTTP/1.1 [Response Code] [Response Message] Date: [Date]
Response fields
Response Code—A standard HTML response code.
204—Logout successful.
304—Request unsuccessful because the session token was missing.
Response Message—A standard HTML response message.
No Content—Logout successful.
Not Modified—Request unsuccessful because the session token was missing.
Date—Standard ISO-8601 date format.
Example
HTTP/1.1 200 OK Date: Fri, 20 Sep 2015 08:00:00 GMT
cURL code sample: logging out
The following code sample can be copied and executed from any command-line interface that includes the cURL library. This sample builds on the authentication cURL code sample.
Note
In this sample, line breaks are added for readability. These line breaks must be removed before you paste the code sample into your command-line tool.
curl -qgsSkH --no-progress-bar --header "X-FeApi-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -F form=:https://xxx.xxx.xxx.xxx:443/wsapis/v2.0.0/logout
This cURL sample performs the following tasks:
-q—This option specifies that thecurlrcconfig file is not read or used. Although this is an optional setting, Trellix recommends that you include this option.-g—This option turns off the URL globbing parser. Although this is an optional setting, Trellix recommends that you include this option.-s—This option turns off the progress meter and error message. Although this is an optional setting, Trellix recommends that you include this option.-S—When used with the-soption, this option shows error messages if your cURL switch fails. Although this is an optional setting, Trellix recommends that you include this option.-k—This option explicitly allows cURL to perform insecure SSL connections and transfers. This allows you to test your SSL connection without installing a CA certificate.-H—This header allows you to specify a custom header with the--headerswitch.--no-progress-bar—No progress bar suppresses the cURL download progress bar, which can interfere with the request.--header "X-FeApi-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"—This custom header provides the API-Token that was returned during the authentication request. In the authentication cURL code sample, this token was included in theauth.txtfile. Replace the token value in the code sample with the token value received in response to your authentication request.Note
By default, the X-FeApi-Token times out after 15 minutes of inactivity.
-F form=:— The -F switch and the subsequent empty form force cURL to use the HTTP POST request.https://xxx.xxx.xxx.xxx:443/wsapis/v2.0.0/logout—The logout request URL. Replace the IP addressxxx.xxx.xxx.xxxwith the IP address of your appliance.
Results
If executed properly, this code will log you off your appliance. You will not see any response from your appliance. However, if you attempt to use the session key again to perform a new request, you will get the following message:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <fireeyeapis version="v1.2.0"> <description>Please check if the cookie has expired and retry</description> <errorCode>FEAUTH1001</errorCode> <httpStatus>401</httpStatus> <message>Unauthorized</message> </fireeyeapis>