REST API Resources

Specifications

Download the RESTful webservice WADL specification file.

User

Resource Description
apiKey_createCreates an API Key for the specified User.
apiKey_deleteDeletes the API Key for the specified User.
apiKey_getAllReturns the API Keys for the specified User.
userCredAccountCert_createCreates a new certificate container object for a given Credential Account.
userCredAccountCert_deleteDeletes a certificate file from the specified Credential Account.
userCredAccountCert_getReturns a certificate file from the specified Credential Account.
userCredAccount_createCreates a Credential Account for the specified User.
userCredAccount_deleteDeletes the specified Credential Account for a given User.
userCredAccount_getReturns the information regarding the specified Credential Account for a given User.
userCredAccount_getAllReturns all or a subset of Credential Accounts for the specified User.
userCredAccount_updateUpdates any of the data in an existing Credential Account for the specified User.
userFormats_getAllReturns all the formats existing in an organization, highlighting whichof those formats are available for a particular user account.If an organization is not provided, then the formats for thedefault...
userGalleries_getGet all the galleries (or app stores) this user has access to.
userImages_getGet all the images the user has.
userOS_getAllReturns all the operating systems existing in an organization, highlighting whichof those formats are available for a particular user account.If an organization is not provided, then the operating sy...
userOrg_getAllReturns all or a subset of the Organizations a User is a member or an administrator of
userPassword_resetResets a user's password. A new random password is sent to the user's email account. The email account in the request must be the same as the email account currently stored in the user's account.
userPhoto_deleteDeletes a photo file from the Logo container of a specific User.
userPhoto_getReturns the photo for the specified User.
userPublishImages_getGet all the images the user has.
user_getReturns all the information regarding the specified User.
user_updateUpdates any of the information regarding the specified User.

Format

Resource Description
orgFormat_getAllReturns all formats belonging to to a particular Organization. The usermust be an administrator of the organization

My Software

Resource Description
mySoftwareAppliance_getAllReturns all the appliances that use the specified software component.
mySoftwareLicense_deleteDeletes the license file from the specified software component.
mySoftwareLicense_getReturns the license file of the specified software component.
mySoftwareLicense_uploadUploads a license to the specified software component.
mySoftwarePkgBinary_deleteDeletes a binary file from a specific package contained within a software component.
mySoftwarePkg_addAdds a new package to the user's existing software component. The package can include operating system packages, tar balls, zip files, scripts and other file types.
mySoftwarePkg_deleteAllDeletes all the package information for the specified software component.
mySoftwarePkg_getReturns the information of a specific package contained within a software component.
mySoftwarePkg_getAllReturns all the package information for the specified software component.
mySoftwarePkg_uploadUploads the binary file for a specific package contained within the software component.
mySoftware_createCreates a new "My Software" object. This object allows the user to upload software (open source or proprietary) and files that can then be used during the creation of appliances. The user can upload ...
mySoftware_deleteDeletes the User's specified software component.WARNING: If any of the User's appliances use this software component, then this component will be removed from the appliances also.
mySoftware_getReturns the information regarding a specific software component uploaded by the user, including associated packages, files and license information.
mySoftware_getAllReturns information regarding all the software components created by the User, including the packages, files and license information associated to each software component.
mySoftware_updateUpdates any of the information regarding the software component uploaded by the specified User.

Org

Resource Description
orgCompany_getAllReturns all the companies who are members of the specified Organization.
orgLicense_getReturns a license file contained in the specified Organization.
orgLicense_getAllReturns all the licenses in the specified Organization.
orgLogo_getReturns the logo binary file of the Organization.
orgOS_getAllReturns all or a subset of the Operating Systems belonging to to a particular OrganizationThe user must be an administrator of the organization
orgProject_getAllReturns all or a subset of the Projects in the specified Organization.
org_getReturns the information regarding the specified Organization.

OS

Resource Description
osLangGroup_getReturns the information of a particular language group for the specified operating system.
osLangGroup_getAllReturns all or a subset of language groups for a particular operating system.
osLicense_getReturns the license information for the specified operating system.
osLogo_getReturns the logo of the specified operating system.
osPkg_getAllReturns all or a subset of packages contained in an operating system.
osProfile_getReturns the information of the specified operating system profile, including a list of the associated packages.
osProfile_getAllReturns all or a subset of the pre-defined operating system profiles for the specified operating system.
osServicePkg_getAllReturns a list of the packages and package information for the specified service.
osService_getReturns the information regarding the specified service for a particular operating system.
osService_getAllReturns all or a subset of the services for the specified operating system.
os_getReturns the information regarding the specified operating system.
os_getAllReturns all or a subset of the available operating systems.

Project

Resource Description
projectLicense_deleteDeletes a license file from the specified Project.
projectLicense_getReturns the license file for the specified Project.
projectLicense_uploadUploads a license file to the specified Project.
projectLogo_getReturns the logo for the specified Project.
projectPkgBinary_uploadUploads a binary file into the package container object for the specified Project.
projectPkg_createCreates a new package container object for the Project. Package binary file are then added to this container.
projectPkg_deleteDeletes a package from a Project. This deletes the binary file or package file only. The project container remains.
projectPkg_deleteAllDeletes all the package information for a Project. This deletes the binary files or package files only. The project container remains.
projectPkg_getReturns the information of the specified package contained in a Project. This includes the package version and date.
projectPkg_getAllReturns all or a subset of packages belonging to the specified Project.
project_createCreates a new project container in the specified Organization.
project_deleteDeletes a project from the project catalog.Note that the project is not physically deleted from the database but marked as "obsolete". This ensures thatappliances currently using the project are not...
project_getReturns the information regarding the Project for the specified operating system.
project_getAllReturns all or a subset of the projects for the specified operating system.
project_updateUpdates information regarding the specified Project in a project catalog. This includes adding or deleting packages, logos and files. This can only be done by the project administrator.

Appliance

Resource Description
applianceBootScript_createAdds a new boot script object to the specified Appliance. You must then upload the boot script file.
applianceBootScript_deleteThis deletes the boot script information, including the binary files held on disk for the specified boot script.
applianceBootScript_deleteAllRemoves one or several boot scripts in the Appliance.
applianceBootScript_downloadReturns the boot script file used in the specified Appliance.
applianceBootScript_getReturns the information of a boot script contained in the specified Appliance.
applianceBootScript_getAllReturns all or a subset of the boot scripts contained in an Appliance.
applianceBootScript_updateUpdates a boot script in the Appliance. You must reupload the boot script binary file.
applianceBootScript_uploadAdds a boot script file to the specified Appliance. You must first create the boot script object.
applianceInstallProfile_getReturns the installation profile for the specified Appliance.
applianceInstallProfile_updateUpdates the installation profile for the specified Appliance.
applianceLog_deleteAllDeletes all of the specified Appliance's log information.
applianceLog_getAllReturns all or a subset of an Appliance's logs.
applianceLogo_deleteDeletes a logo file from the Logo container of the specified Appliance.
applianceLogo_getReturns the logo for the specified Appliance.
applianceLogo_uploadUploads a logo file for the specified Appliance.
applianceMySoftware_getAllReturns all the 3rd party software components that have been added to theAppliance from the User's "My Software" catalog.
applianceOASLicense_deleteDeletes the license file of the Open Appliance Studio (OAS) package contained within the Appliance.
applianceOASLicense_getReturns the license file of the Open Appliance Studio (OAS) package contained within the Appliance.
applianceOASLicense_uploadUploads a license file for the Open Appliance Studio (OAS) package contained within the Appliance.
applianceOAS_createCreates a new Open Appliance Studio (OAS) package container in the Appliance to allow the user to upload an OAS package file.
applianceOAS_deleteDeletes the Open Appliance Studio (OAS) package container from the specified Appliance.
applianceOAS_getReturns the Open Appliance Studio (OAS) package container information for the specified Appliance.
applianceOSProfileChosenServicePkg_getAllReturns all the package information for a particular service.This method is identical to:GET /users/{uid}/appliances/{aid}/osprofile/{osid}/services/{serviceId}/pkgs
applianceOSProfileChosenService_getReturns the information of a particular service. This method is identical to:GET /users/{uid}/appliances/{aid}/osprofile/{osid}/services/{serviceId}
applianceOSProfileChosenService_getAllReturns all the chosen services for a particular operating system profile.
applianceOSProfileChosenService_updateAllUpdates the list of services for the appliance operating system profile.All services that are not contained in the new list are removed from the operating system profile. All new services in the list...
applianceOSProfilePkg_getAllReturns all the packages contained in the operating system profile.
applianceOSProfilePkg_updateAllUpdates the package list contained in the operating system profile. All packages thatare not contained in the new package list are removed from the operating system profile. All new packages in the ...
applianceOSProfileServicePkg_getAllReturns all the package information for the specified service.
applianceOSProfileService_getReturns the information for the specified service.
applianceOSProfileService_getAllReturns all the services for the specified operating system profile.
applianceOSProfile_createAdds a new operating system profile to the specified Appliance.
applianceOSProfile_getReturns an operating system profile for the specified Appliance.
applianceOSUpdates_getReturns a list of possible operating system package updates for the OS profile of the specified Appliance.
applianceOSUpdates_saveUpdates the operating system package versions of the Appliance up to a specific date.
applianceProject_getAllReturns all the projects that have been added to the specified Appliance.
appliance_cloneClones the specified Appliance. Returns the new cloned Appliance.
appliance_createCreates a new Appliance in a user's "Appliance Library". The xmlSample illustrates the minimum information required to create a new Appliance successfully.
appliance_deleteDeletes the specified Appliance and everything associated it, including images.
appliance_getReturns the information regarding the specified Appliance created by a particular User.
appliance_getAllReturns a list of all or a subset of the appliances created by a particular user. It also returns all the information associated to each appliance listed.
appliance_updateUpdates the information regarding the specified Appliance.
imageGeneration_cancelCancels the generation of the image specified.
imagePublish_cancelCancels an on-going publish to an IaaS platform.
imageStatus_getReturns the status of an image generation.
imageStatus_getAllReturns the status of all the images for the specified Appliance.
image_deleteDeletes an image generated for the specified Appliance.
image_deleteAllDeletes all the images generated for the specified Appliance.
image_downloadReturns the generated image file for the specified Appliance. This is identical to GET /users/{uid}/appliances/{aid}/images/{itid}/downloads
image_generateGenerates an image from the Appliance. This creates a generation job to begin the generation. The image generation is done asynchronously. If the parameter simulated for the Image object is set to tr...
image_getReturns the information of an image generation.
image_getAllReturns all or a subset of generated images for the specified Appliance.
image_publishPublishes an image to a particular target IaaS platform. Current platforms that are supported include:Abiquo, Amazon EC2 (all regions), CloudSigma, Cloud.com, Eucalyptus, OpenStack (requires Glance)...
image_regenerateRe-generates an image from a previous generation request. This creates a new generation job. The image generation is done asynchronously.
publishedImageStatus_getReturns the status of a published image.
publishedImageStatus_getAllReturns the status information for all the published images for the specified Appliance.
publishedImage_deleteDeletes publish ticket information from the specified Appliance.
publishedImage_deleteAllRemoves all published images for the specified Appliance.
publishedImage_getReturns the information regarding the specified published image.
publishedImage_getAllReturns all of the published images for the specified Appliance.

Gallery

Resource Description
applianceSharingStatus_getReturns the gallery template share status. Sharing an appliance to a galleryis an asynchronous task. Getting the status allows you to check if the share has successfully finished.
applianceSharing_cancelCancels the sharing process of an appliance to a gallery.
appliance_shareShare an appliance in a specific gallery. The appliance will remain in the user's appliance libraryand a template will be created in the gallery.
galleryMember_getGets public information of a gallery member. This includes, photo, web site as well the information on templates this member has shared as a publisher.
galleryNotifications_getGets all the templates that a user is "watching". When a user is watching a template, wheneverthe template is updated, or if a comment is added, the user is notified via email. You must bean admini...
galleryPartners_getGets public information of a partner. This includes, photo, website as wellthe information on templates this user has shared in the gallery as a publisher.
galleryPublishers_getGets public information of a publisher. A publisher is either a member or a UserGroup.This includes, photo, web site as well as the information on templates this publisher hasshared in the gallery.
galleryTemplateComment_createPosts a comment for a gallery template. A notification email is sent to all the users "watching" this template.
galleryTemplateComment_deleteDeletes a specific comment posted on a gallery template. You must haveadministration privileges of the gallery organization. This will delete the commentand all of the replies attached to the comm...
galleryTemplateComment_getGets a specific comment posted on a gallery template.
galleryTemplateComment_replyPosts a reply to a comment for a gallery template. A notification email is sent to all theusers "watching" this template.
galleryTemplateComment_reportAbuseReports an abuse on a specific GalleryTemplate comment. Note that this does notchange or remove the message contents of a comment, but sends an email request to theplatform administrator(s) to modera...
galleryTemplateComment_updateUpdates a specific comment. For the moment, only an administrator from the Organization the Gallery is attached to can use this web method. You can change a limited set of fields ; please see comment...
galleryTemplateComments_deleteDeletes all the comments for a specific gallery template. You must haveadministration privileges of the gallery organization.
galleryTemplateComments_getGets all comments posted for a specific gallery template.
galleryTemplate_unwatchRemove a user from the notifications list of this template. Theuser will no longer be notified of any updates via email. By default, theuser inside the authentication header is removed unless the q...
galleryTemplate_voteAllows the user to vote for a gallery template. If the user has already votedthen their current vote value will be updated
galleryTemplate_watchAdd a user to the notifications list for this gallery template template.This action is known as "watching" the template. When the templateis updated by the publisher or a comment is added to the tem...
galleryUserGroups_getGets all the UserGroups attached to this gallery.
gallery_getGets the Org Gallery. A Gallery is the placeholder of Gallery templates shared by Org members.
image_downloadReturns the generated image file for the specified gallery template image.The download request is a two step process:- request to download the image with the image download uri, a HTTP 307 response i...
templateConfMgmtPlatform_getAllReturns all the configuration management platforms bits included for the specified template.
templateInstallProfile_getReturns the installation profile for the specified template.
templateLogo_deleteDeletes a logo from a gallery template.
templateLogo_getReturns the logo image attached to a gallery template.
templateLogo_uploadUploads a new logo to the gallery template.
templateOASpackage_getReturns any Open Appliance Studio information for the specified template
templateOSProfilePkgs_getReturns the distribution profile packages for the specified template.
templateProjects_getReturns the included projects for a specified template
templateStats_getReturns all the statistics for a gallery template.
template_deleteDeletes gallery template being shared in a gallery.
template_getGet the details of a gallery template.
template_importImport a template from the Gallery to the User's Appliance Library.
template_updateUpdates the information of an existing gallery template.
templates_getReturns all the templates from the gallery or search for specific templates. First results are latest created templates (ordered by creation date).