The Login call is used to initially login to DeployHub and must be the first call issued before any other API calls are attempted.

If the call succeeds, a JSON string is returned with the “success” attribute set to “true”. A cookie (JSESSIONID) is also returned which must be set in any subsequent call to the API in order to associate the call with the correct login session.

API Call





Is the hostname and port of the DeployHub Server (e.g.: hostname:8080).


Is the username of the DeployHub user who you are going to login as.


Is the password of this user.

Example Result:


       "success": true


If successful login, or:


       "success": false,

       "error": "Login failed",


If not successful.