API management

To authenticate, use the Superuser ID and the authentication (auth) target.

Authentication

Use the authentication command target (auth) to authenticate using the POST method. In this process, you provide a username and password through the X-Auth-Username and X-Auth­Password header fields. The beginning of the session is the only instance where you must enter the username and password. Upon successfully entering the username and password, an authentication token is displayed. This token is a 32-digit, hexadecimal code that you include in future commands using the X-Auth-Token header. The X-Auth-Token header in combination with the authentication token replaces the username and password for each action. The token remains authorized only for one hour even if the token is unused. After one hour, an error code of 403 occurs that indicate the loss of authorization. Use the /auth command target to reauthenticate with the user name and password.

For more information on system authentication, see Authentication overview.