logout

Purpose

Terminates the specified API session. This method should be called to explicitly end each Web API session. The output parameter is optional.

For REST APIs v1, you can authenticate with an API Key without calling the /login API or creating a session. However, calling the /login API with an API Key creates a user session and returns a sessionId.

A session stays active until terminated using the logout API. If the logout API is called without a sessionId but includes a valid API Key in the request header, the system terminates all active REST API sessions for that user.

HTTP Method

GET

URL

https://app.infiniteblue.com/rest/api/logout

URL Parameters

sessionId

The session ID obtained from the body of the response when calling login.

output

Optional parameter specifying the output format, one of: xml (default) or json.

Response

Standard success or failure output

Example

Sample XML response:

<?xml version="1.0" encoding="utf-8" ?>
<resp status="ok">
</resp>