NEnetxms
Authentication

Create REST API session

Changed on

Creates a new session and returns session credentials. On success, the server sets a session_handle cookie and returns a JSON object with session GUID and server information.

For subsequent requests, provide the session GUID either:

  • In the Session-Id request header
  • Via the session_handle cookie

Authentication can also be provided via HTTP Basic Authentication header instead of JSON body.

post/sessions

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/sessions
  • Auth
    none required

Request body

loginstring

Username

passwordstring

Password

attachNotificationHandlerboolean

If true, attaches notification handler to receive alarm notifications

Response

Session created successfully

sessionHandlestring uuid

Session GUID for use in Session-Id header

Changes

  • 32f48ec94aecRevision changes
    • info

      added the new optional request property

    • info

      request body became optional

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 910d3ad08e09Revision changes
    • info

      api operation id createSession was added

    • info

      added the non-success response with the status