Protocol
HTTP
protocol and supports both GET
and POST
request methods.JSON
(JavaScript Object Notation) as their primary data transport mechanism for both input and output. However the API server also supports URL encoded requests (application/x-www-form-urlencoded
).Port
apiport=xxxx
in your nexus.conf or starting your daemon with the -apiport=xxxx
parameter.Security
HTTP Basic
authentication scheme. This requires the caller to set an Authorization
HTTP header with the value Basic <credentials>
with the <credendtials>
portion set to apiuser:apipassword
and base64
encoded. On the API server side the authentication is configured by adding apiuser=<username>
and apipassword=<password>
to the nexus.conf.
NOTE: If you wish to disable authentication entirely, you can do so by setting apiauth=0
in your nexus.confSSL
encryption (HTTPS
). By default the API server is started with SSL disabled. To enable it, please add apissl=1
to your nexus.confMulti-user Sessions
multiuser=1
in your nexus.conf (default off). When multiuser is enabled, the initial login response will include a session ID value. This session ID must be then be included in all subsequent API calls to endpoints that require a user to be logged in.Endpoint
<api>/<verb>/<noun>
Error Handling