Methods

Table of Contents

• VMEmperor REST API methods
  • Login
    • POST /login
      • Arguments
      • Normal response
      • Errors
        • Wrong username/password
      • POST /adminauth

VMEmperor REST API methods

VMEmperor API is powered by GraphQL. See /voyager for API description. But you need to use REST API for login/logout.

Login

These methods should be used for authentication. They set a cookie.

POST /login

Performs authentication using external authentication source

Arguments

Name	Type	Required
username	string	Yes
password	string	Yes

Normal response

{"status": "success", "login": "provided username"}

return code 200

Errors

Wrong username/password

Return code 401, response:

{"status": "error", "message": "wrong credentials"}

POST /adminauth

Performs authentication using XenServer capabilities. To be an administrator, one should use a XenServer account.

Arguments & response identical to /login