Simply viewing the help UI does not require a username or password. However, all access through a web service endpoint (running queries, for example) must be authenticated using HTTP basic access authentication. This requires the HTTP user agent, such as a web browser, to provide a username and password. The username and password is authenticated by the authentication realm associated with the web service.

By default, web service authentication uses the node's local administration realm. You can also change authentication per web service using the WebServiceBinding configuration object (see Web Server and Web Services Configuration) in a node deploy configuration. Additionally, the execution of the REST API command depends on the Trusted Hosts configuration being enabled in the node's local administration realm (which it is by default).


Starting with release 10.6.0, users do not need to run commands from a machine in the Trusted Hosts list when querying the admin web service.

Authentication consists of the following:

  • A username and password are sent from the client user agent.

  • The username and password are authenticated using the web service authentication realm.

  • Web services can be assigned to authentication realms when contained within a web service binding.

  • When using the admin web service to execute a command on a remote node (that is, a web service running on node A and you want to execute a command on node B) you must start both nodes.