Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Web API

Web APIs provide a way to access data from AKIPS via HTTP.

To use the API, specific user accounts must be created with the correct permissions, depending on the required access level:

UsernamePermissions
api-roRead-only commands
api-rwAll commands

Users api-ro and api-rw need to be added in User Settings.

api-rw

Go to Admin > Users / Profiles > User Settings.

In the Username text field, type api-rw

Complete the remaining text fields.

Click Add.

api-ro

Go to Admin > Users / Profiles > User Settings.

In the Username text field, type api-ro

Complete the remaining text fields.

Click Add.