Module rest

Perform some action on a VM Feed.

URL Format:

   /rest/vmfeed/

Parameters:

• url (String) - The url of the feed.

Returns: Dictionary

A dictionary containing the result of the action.

Decorators:

• @register_extension("vmfeed", allowed_methods= ['GET', 'PUT'])

Raises:

• None - No exceptions are raised by this method.

Create new repo.

URL Format:

   /rest/vmfeed/repo/create/

Only POST method is allowed.

Parameters:

• url (String) - The url of the feed.

Returns: Dictionary

A dictionary containing the result of the action.

Decorators:

• @register_extension("vmfeed/repo/create", allowed_methods= ['POST'])

Raises:

• None - No exceptions are raised by this method.

Retrieves the package file as an archive (application/x-download).

URL Format:

   /rest/vmfeed/<UUID>/download/

Returns: File

The actual package.

Decorators:

• @register_extension("vmfeed/*/download", allowed_methods= ['GET'])

Raises:

• cherrypy.HTTPError - Raised when permission is denied.

If the method is GET, returns the package for the requested UUID. If the method is DELETE, deletes the package. If the method is POST, Renames or describes the package.

URL Format:

   /rest/vmfeed/<UUID>/

Parameters:

• name (String) - The name of the package.
• description (String) - The description of the package.

Returns: Dictionary

A dictionary containing the result of the command.

Decorators:

• @register_extension("vmfeed/*", allowed_methods= ['GET', 'DELETE', 'POST'])

Raises:

• cherrypy.HTTPError - Raised when permission is denied.

Tells the system to queue the retrieval of the package.

URL Format:

   /rest/vmfeed/repo/package/<UUID>/

Returns: Dictionary

A dictionary containing the result of the action.

Decorators:

• @register_extension("vmfeed/repo/package/*", allowed_methods= ['GET', 'DELETE', 'POST'])

Raises:

• cherrypy.HTTPError - Raised when permission is denied.

If the method is GET, returns the package for the requested UUID. If the method is DELETE, deletes the package. If the method is POST, Renames or describes the package.

URL Format:

   /rest/vmfeed/repo/<UUID>/

Parameters:

• action (String) - The action to perform.

Returns: Dictionary

A dictionary containing the result of the action.

Decorators:

• @register_extension("vmfeed/repo/*", allowed_methods= ['GET', 'DELETE', 'POST'])

Raises:

• cherrypy.HTTPError - Raised when permission is denied.

Reload the target feed.

Returns: Dictionary

A dictionary containing the result of the action.

Decorators:

• @register_extension("vmfeed/repo/*/reload", allowed_methods= ['GET', 'POST'])

Raises:

• None - No exceptions are raised by this method.