1.1. Description
Free a host currently assigned to a user. Hosts must be in the Allocated state to be freed. A user can only free hosts already assigned to them, although Project Admins and Domain Admins can free hosts in their project which are currently allocated.
1.2. URL
/cubit_api/1/free_host
1.3. Authentication
This method requires authentication using an API key.
1.4. Parameters
force ( zero or once )
If the machine being freed does not belong to the user initiating the request, the force
option is required. Only Project Admins and Domain Admins can free hosts which do not
belong to them. The only valid value for this parameter is True.
Type: String
host ( Required, once )
Fully qualified hostname to free. Hosts must be in the Allocated state to be freed.
Type: String
sig ( Required, once )
API authentication hash signature.
Type: String
userid ( Required, once )
The login name of the user initiating the request.
Type: String
1.5. Example Response
Successful freeing of host:
<?xml version='1.0'?>
<cubit version='1'>
<status>OK</status>
</cubit>
If the user is unauthorized, or the host does not exist:
<?xml version='1.0'?>
<cubit version='1'>
<error>You are not authorized to free this host.</error>
</cubit>
1.6. Response Codes
- 200 - ok
- 400 - Login failed / Insufficient permissions
