End Remote Debug Sessions

To end remote debug sessions:
  1. Log in to the REST API server using valid management user credentials.
    Note

    Note

    You must forward the auth_token as a cookie with each API call.
  2. Use the POST method to access the /act/end-remote-debug-sessions/ URI and end remote debug sessions.
    Note

    Note

    If no input data is provided, then all remote debug sessions are ended.

    Sample Requests

    curl -X POST  --cookie auth_token=$cookie http://172.16.0.24/rest/v1/act/end-remote-debug-sessions

    curl -X POST  --cookie auth_token=$cookie http://172.16.0.24/rest/v1/act/end-remote-debug-sessions 
    -d
        '{"session_name":"one-day"}'

    curl -X POST  --cookie auth_token=$cookie http://172.16.0.24/rest/v1/act/end-remote-debug-sessions 
    -d
        '{"user":"admin"}'
    Click to expand in new window

    Request Body Parameters

    Parameter Description Required/Optional Data Type
    user Name of the admin user who initiated the session Optional String
    session_name Name to identify this session Optional String

    Sample Response (200 OK)

    {    
    "data": {        
      "status": true,        
      "message": "success"    
      },    
    "return_code": 0
    }
    Click to expand in new window

    Response Definitions

    Response Item Description Data Type
    return_code A flag indicating success or failure of the operation Boolean
    data Data returned by the API server String
    errors List of errors, if any String