Login | Join Now
  • CUBiT API: HostRebuildCancel

    Product:
    CUBiT

    Component:
    CUBiT Web Services

    Summary:

    Cancel a rebuild for a host.



     

    1.1. Description

    Cancel a rebuild for a host. The host must be in Rebuild state for this method to work. In order to cancel a rebuild for a host, the user must have permission to rebuild the host, that is, they must either:

    1. Have the host allocated to them
    2. Be a CUBiT Project Admin in the project, or
    3. Be a CUBiT Domain Admin

    1.2. URL

    /cubit_api/1/rebuild_cancel

    1.3. Authentication

    This method requires authentication using an API key.

    1.4. Parameters

    	host ( Required, once )
    		Fully qualified hostname to cancel rebuild of. Hosts must be in the Rebuild state. 
    		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 host rebuild cancel:

    	<?xml version='1.0'?>
    	<cubit version='1'>
    		<status>OK</status>
    	</cubit>
    	
    	If the user is unauthorized:
    	<?xml version='1.0'?>
    	<cubit version='1'>
    		<error>You are not authorized to cancel a rebuild for this host.</error>
    	</cubit>
    

    1.6. Response Codes

    • 200 - ok
    • 400 - Login failed / Insufficient permissions