Page Status: updated 2025-03-31
NLLPing
Page index
Definition
Invocations
URL: [base]/$ping
This operation does NOT change content
Return Values (Out)
| Name | Cardinality | Type | Documentation |
| result | 1..1 | string | Upon a successful call, you receive confirmation and information about the assigned role if the call included a valid authentication token. |
Can be invoked with a HTTP POST or GET. This operation can be used for two things:
- to check if there is a connection to the server by not including an authentication token in the authorization header.
- include an authentication token in the authorization header to verify the format of the token and get a list of all applicable user roles.
Examples
See Examples - NLLPing.