Resource /webmapi/sessionsExpand | Collapse

APIs for WebMAPI session management

Get session information.
Description

Get session information.

HTTP Example

GET /webmapi/sessions

Output

Reports successful result in ResponseContentType<SessionInfoType>

Errors

Reports errors in ResponseContentType<ErrorType>

Produces

application/json

Login and create web session.
Description

Login and create web session.

After successful login and session creation, the session token is returned in the response body.

The following conditions may cause a login failure and return a 401 unauthorized response:
- WEBUI_WEBAPI_ERROR_INVALID_USER_CREDENTIAL
- WEBUI_WEBAPI_ERROR_REACH_MAX_SESSIONS
- WEBUI_MARS_ERROR_NOTREACHABLE_MARSOS
- WEBUI_MARS_ERROR_NO_CLUSTER

HTTP Example

POST /webmapi/sessions

Input

Pass input arguments in LoginInfoType

Output

Reports successful result in ResponseContentType

Errors

Reports errors in ResponseContentType<ErrorType>

Produces

application/json

Consumes

application/json

Delete session.
Description

Delete session.

HTTP Example

DELETE /webmapi/sessions

Output

Reports successful result in ResponseContentType

Errors

Reports errors in ResponseContentType<ErrorType>

Produces

application/json

Keep session alive.
Description

Keep session alive.

HTTP Example

PUT /webmapi/sessions

Output

Reports successful result in ResponseContentType

Errors

Reports errors in ResponseContentType<ErrorType>

Produces

application/json