Link Search Menu Expand Document

Logging users out

If the session is valid, returns an ok signal. Ae example is below:

  "result": {
      "code": 1,
      "status": "ok"
  "results": {
      "result_type": "logout",
      "username": ""
  • Call name: logout
  • Endpoint URL:
  • Request methods: DELETE
  • Response Content-Type: application/json
  • Auth required: yes

Calling this API with a valid session (in HTTP headers) causes the session for that user to be destroyed, effectively logging the user out.

HTTP Parameters

No specific parameters required.


This API call requires no specific permissions. Unless there’s been a security failure, only the user or the backend user is in possession of the session key, which means the session can only be validated if the validator is in possession of the key.