Welcome to UForge AppCenter REST APIs Documentation

This documentation provides a description of UForge AppCenter RESTful interface.

Data Transfer Objects

This section provides a description of all UForge AppCenter REST Data Transfer objects.

abstractWinApplication

Holds the basic information of a Windows application

Attributes

The list of attributes for abstractWinApplication are:

  • displayName (string): the name of the application
  • version (string): the version of the application
  • architecture: the architecture of the application
  • parentUri (anyURI): the resource uri of the parent windowsProfile object
  • uri (anyURI): the resource uri of the application
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

abstractWinApplications

Provides a list of abstractWinApplication objects.

Attributes

The list of attributes for abstractWinApplications are:

  • total (long): the total number of objects

address

Holds the address information of an organization or user.

Attributes

The list of attributes for address are:

  • country (string): the country name
  • region_state (string): the state or region name
  • street (string): the street name
  • town (string): the town or city name
  • zipcode (string): the zipcode or postal address
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

apiKeyPair

Holds the key pair information used as an alternative way to using basic authorization for HTTP requests.

The public key is inserted as a query in the request URI. The secret key is then used to encode the entire URI to create a signature using HMAC_SHA1. This signature is then added to the end of the request URI.

These keys are created automatically by the platform. For more information, refer to API Key API Resources.

Attributes

The list of attributes for apiKeyPair are:

  • name (string): name or tag of the API key pair
  • description (string): description of the API key pair
  • publicKey (string): the public key string
  • secretKey (string): the private key string
  • uri (anyURI): the resource uri of the APIKeyPair object
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

apiKeyPairs

Provides a list of apiKeyPair objects.

Attributes

The list of attributes for apiKeyPairs are:

  • apiKeyPairs: the list of apiKeyPair objects
  • total (long): the total number of objects

appliance

Holds all the meta-data information of a software stack (known as an appliance template). It consists of five layers, namely:

  • an Install Profile - specific information for the first time the image boots
  • an OS Profile - a list of operating system packages. Each operating system within the organization provides one or more standard OS profiles to choose from when creating the OS Profile of the appliance template. It is also possible to create custom OS profiles
  • Projects - a list of Project software components chosen from the Organization´s Project Catalog
  • My Software - a list of software components chosen from the User´s private “Software Library”
  • Configuration - configuration information including boot scripts and/or other software components to manage the image after provisioning

Appliance templates are then used to generate machine images.

Attributes

The list of attributes for appliance are:

  • uuid (string): the uuid of the object
  • applianceExports: a list of applianceExport objects holding meta-data information for each time the appliance has been exported.
  • archName (string): the operating system architecture this appliance is based on
  • baseCloneUri (anyURI): uri resource used to clone this appliance
  • baseImagesStatusUri (anyURI): uri resource to retrieve machine images status
  • baseImagesUri (anyURI): uri resource to retrieve machine images generated from this appliance
  • baseMySoftwareUri (anyURI): uri resource to retrieve the software components added to this appliance
  • baseOasPackageUri (anyURI): uri resource to retrieve any UForge Studio package added to this appliance
  • baseOsProfileUri (anyURI): uri resource to retrieve the OS Profile for this appliance
  • baseProjectsUri (anyURI): uri resource to retrieve any projects added to this appliance
  • basePublishImagesStatusUri (anyURI): uri resource to retrieve published machine image status
  • basePublishImagesUri (anyURI): uri resource to retrieve published machine images from this appliance
  • baseTemplatesStatusUri (anyURI): uri resource to retrieve the status for each time this appliance has been shared (to workspaces)
  • baseTemplatesUri (anyURI): uri resource to retrieve all the shared templates (to workspaces)
  • bootScripts: a list of bootScript objects added to this appliance
  • bootScriptsUri (anyURI): uri resource to get the boot scripts added to this appliance
  • bootScriptUris (UriList): a list of uris for the boots scripts added to this appliance
  • description (string): a description of the appliance
  • distributionName (string): the operating system this appliance is based on (includes name and version)
  • distributionUri (anyURI): uri resource to get the details of the operating system this appliance is based on
  • exportsUri (anyURI): uri resource to get all the export objects for this appliance
  • imageUris (UriList): a list of uris for the machine images generated from this appliance
  • imported (boolean): boolean to determine if this appliance is an import (e.g. from a scan)
  • installedSize (long): estimated disk size required to install the appliance’s software
  • installProfile (installProfile): the installProfile object for this appliance
  • installProfileUri (anyURI): uri resource to get the install profile of the appliance
  • lastPkgUpdate (dateTime): the os profile packages update date (this date is used to calculate if any new package updates are available
  • logo (logo): the logo object for the appliance
  • mySoftwareList: a list of mySoftware objects describing the software components added to this appliance
  • mySoftwareUris (UriList): a list of uris for the software components added to this appliance
  • name (string): the name of this appliance
  • nbSecurityUpdates (int): the number of security operating system packages available for update
  • nbUpdates (int): the number of native package updates available for update
  • orgUri (anyURI): the uri resource of the organization this appliance belongs to
  • osProfile (distribProfile): the distribProfile object describing the operating system profile of this appliance
  • osProfileUri (anyURI): the uri resource for the operating system profile of this appliance
  • parentApplianceUri (anyURI): the uri resource of the parent appliance. This is set if this appliance is a clone of another appliance
  • parentTemplateUri (anyURI): the uri resource of an parent appliance template. This is set of this appliance is a result of importing an appliance (e.g. from a workspace)
  • projects: a list of project objects added to this appliance
  • projectUris (UriList): a list of uris for the projects added to this appliance
  • publishImages: a list of publishImage objects for the machine images that have been registered to one or more cloud platforms
  • publishImageUris (UriList): a list of uris for the machine images that have been registered to one or more cloud platforms
  • revision (int): the revision number of this appliance
  • shared (boolean): a boolean highlighting this appliance has been shared to at least one workspace
  • size (long): the size (in bytes) of all the packages and software added to this appliance
  • tag (string): a tag for this appliance
  • uri (anyURI): the uri resource of this appliance
  • version (string): the version of this appliance
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

applianceExport

Holds tracking information on requests to export an appliance. An export basically archives the appliance meta-data and all relevant software and allows the user to download that archive. The archive information can then be version controlled or imported to another UForge platform.

The appliance export is an asynchronous job which may take some time. The current status of the export is stored in this object.

Attributes

The list of attributes for applianceExport are:

  • applianceName (string): the name of the exported appliance
  • applianceVersion (string): the version of the exported appliance
  • downloadUri (anyURI): the uri allowing the archive to be downloaded
  • downloaded (boolean): flag to determine if there has been at least one request to download the export archive
  • parentUri (anyURI): the uri of the exported appliance
  • status (status): the status object providing the current status of the export
  • uri (anyURI): the uri resource of this appliance export
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

applianceExports

Provides a list of applianceExport objects.

Attributes

The list of attributes for applianceExports are:

  • applianceExports: the list of applianceExport objects
  • total (long): the total number of objects

applianceImport

Holds the information when an appliance is being imported to this UForge platform. The actual import is done by uploading an appliance archive via the uploadUri.

The appliance import is an asynchronous job which may take some time. The current status of the import is stored in this object.

Attributes

The list of attributes for applianceImport are:

  • useMajor (boolean): boolean flag to instruct the import process to use only the major version of the operating system (e.g. rather than CentOS 6.2, CentOS 6 will be used)
  • reuseBundles (boolean): boolean flag to instruct the import process to re-use any software components already available in the platform rather than re-importing these software components into the user’s software library
  • force_rw (boolean): boolean flag to instruct the import process to overwrite any appliance template with the same name and version already existing on the platform (potentially from a previous import)
  • imported (boolean): boolean flag indicating whether the import is complete
  • parentUri (anyURI): the uri resource of the parent object this object is attached to
  • referenceUri (anyURI): the uri of the appliance template created from this import
  • uploadUri (anyURI): the uri resource to upload any artifacts assocaited with this import (software components etc)
  • uri (anyURI): the uri resource of this appliance import
  • md5sum (string): the md5sum of the uploaded object
  • mimeType (string): the mime type of the file uploaded
  • sha256sum (string): the sha256 value of the uploaded object
  • size (long): the size (in bytes) of the uploaded object
  • status (status): the upload status (see status)
  • uploaded (boolean): a boolean to indicate if the file has been uploaded
  • uploadedTime (dateTime): the timestamp the upload was completed
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

applianceImports

Provides a list of applianceImport objects.

Attributes

The list of attributes for applianceImports are:

  • applianceImports: the list of applianceImport objects
  • total (long): the total number of objects

appliances

Provides a list of appliance objects.

Attributes

The list of attributes for appliances are:

  • appliances: the list of appliance objects
  • total (long): the total number of objects

applianceStats

Provides the statistic information of all the appliance templates for a user. This includes:

  • the number of appliance templates
  • the number of machine images generated and a breakdown on the format types used
  • the breakdown on the operating systems used
  • the number appliance templates shared (e.g. to workspaces)

Attributes

The list of attributes for applianceStats are:

  • curr (int): the value
  • currOSUsage: list of statDataPoint for the breakdown on operating system types currently being used for the user’s appliance templates
  • currShared (int): number of appliance templates currently being shared (e.g. in a workspace)
  • currUsage: the list of statDataPoint objects holding the statistic history
  • total (int): the total value (over time regardless if the object in question has been deleted)
  • totalOSUsage: list of statDataPoint for the breakdown on operating system types that have been used for the user’s appliance templates
  • totalShared (int): number of appliance templates that have been shared (e.g. in a workspace)
  • totalUsage: the list of statDataPoint objects holding the statistic history (over time regardless if the object in question has been deleted)

applianceSummary

Holds some meta-data information of an appliance template.

Attributes

The list of attributes for applianceSummary are:

  • version (string): the version of the appliance template
  • name (string): the name
  • uri (anyURI): the uri
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

artifactCredAccount

Holds artifact account information for a software artifact. These credentials allow the platform to communicate with the remote repository to fetch to add files for a software or project.

Attributes

The list of attributes for artifactCredAccount are:

  • uri (anyURI): the uri resource of this artifact account
  • parentUri (anyURI): the uri resource of the parent object this artifact account is attached to
  • name (string): the name of the artifact account
  • host (string): the hostname of the artifact account
  • login (string): the login (optional) to connect to the artifact account
  • password (string): the password (optional) to connect to the artifact account
  • type: the type of the artifact account, for example ftp
  • port (int): the port of the artifact account
  • softwareArtifactsUri (anyURI): the uri resource to retrieve artifacts from the artifact account
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

artifactCredAccounts

Provides a list of artifactCredAccount objects.

Attributes

The list of attributes for artifactCredAccounts are:

  • total (long): the total number of objects

blueprint

Describes a blueprint. A blueprint modelizes a set of blueprintService and the information required to deploy these services on different nodes in a container or cloud environment.

Attributes

The list of attributes for blueprint are:

  • name (string): the name of the blueprint
  • version (string): the version of the blueprint
  • revision (string): the revision of the blueprint
  • uri (anyURI): the uri resource to retrieve the blueprint
  • description (string): the description of the blueprint
  • yaml (string): the blueprint yaml content
  • deployUri (anyURI): the uri resource to deploy the blueprint
  • predeployUri (anyURI): the uri resource to retrieve BlueprintPredeploy
  • prepareUri (anyURI): the uri resource to launch a pipeline based on this blueprint
  • pipelines: the list of Pipelines used to prepare this blueprint
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

blueprintDeployment

Provides the information required to deploy a blueprint.

Attributes

The list of attributes for blueprintDeployment are:

  • name (string): the blueprint deployment name used for this deployment
  • credAccountUri (anyURI): the cloud account uri used for this deployment (see credAccount)
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

deploymentActivity

an activity is launched by an entity, it contains the streams which are useful for logs.

Attributes

The list of attributes for deploymentActivity are:

  • description (string): the description of the activity.
  • displayName (string): the display name of the activity.
  • statusDetail (string): the retrieved status of the activity.
  • startTimeUtc (long): the start time of the activity.
  • endTimeUtc (long): the end time of the activity.
  • statusSummary (string): the summary of the activity status.
  • isDone (boolean): a boolean flag to know if the activity is done.
  • isError (boolean): a boolean flag to know if the activity is in error.
  • isSubmitted (boolean): a boolean flag to know if the activity is submitted.
  • isBegun (boolean): a boolean flag to know if the activity is started.
  • isEffector (boolean): a boolean flag to know if the activity is an effector.
  • id (string):
  • parentId (anyURI): the uri of the parent activity.
  • children: a set of children activities objects.
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

deploymentEffectors

Provides a list of deploymentEffector objects.

Attributes

The list of attributes for deploymentEffectors are:

  • effectors: the list of deploymentEffector objects
  • total (long): the total number of objects

deploymentEffector

an effector can be invoke by user. It do some action.

Attributes

The list of attributes for deploymentEffector are:

  • name (string): the effector name.
  • description (string): the effector description.
  • parameters: the effector parameters.
  • returnTypeName (string): the effector return type name.
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

deploymentParameter

an parameter is an descriptor of deployment parameter.

Attributes

The list of attributes for deploymentParameter are:

  • name (string): the parameter name.
  • description (string): the parameter description.
  • typeName (string): the parameter type name.
  • defaultValue (string): the parameter default value.
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

deploymentEntity

an entity represent a node in the deployed blueprint.

Attributes

The list of attributes for deploymentEntity are:

  • type (string): the type of the entity
  • serviceId (string): the service id of the entity
  • displayName (string): the display name of the entity
  • applianceUUID (string): the UUID of the uforge appliance linked to the entity
  • status (string): the status of the entity
  • hostname (string): the hostname of the entity
  • ipAddress (string): the IP address of the entity
  • loginUser (string): the user to use to login into the entity
  • sshKeyName (string): the ssh key name used to login into the entity
  • winrmAddress (string): the address used to login in a windows entity
  • uforgePublishedImageURI (anyURI): the uri of the linked published image
  • creationTime (long): the date of the entity creation
  • cloudProvider (string): the name of the cloud provider which host the entity
  • hardware (DeploymentHardware): the hardware of the entity
  • activities: the activities linked to the entity
  • sensors: Provide some information on deployment instance.
  • config: Provide actual values of blueprint config entries.
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

DeploymentHardware

The hardware used for the deployment entity

Attributes

The list of attributes for DeploymentHardware are:

  • flavorId (string): the flavor id of the hardware
  • ram (int): the amount of memory in MB allocated to the hardware
  • cores (int): the number or cores of the hardware
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

deploymentStream

Attributes

The list of attributes for deploymentStream are:

  • type (string): the type of the stream, could be: stderr, env, stdin, stdout
  • content (string): the content of the stream
  • size (int): the size of the stream in bytes
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

deploymentSensor

Provide information on deployment instance.

Attributes

The list of attributes for deploymentSensor are:

  • name (string): sensor name
  • description (string): sensor description
  • typeName (string): sensor value type
  • value (string): sensor value. Can be string, number, object …
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

deploymentConfig

Provide actual value of a blueprint config entry.

Attributes

The list of attributes for deploymentConfig are:

  • name (string): sensor name
  • value (string): sensor value. Can be string, number, object …
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

BlueprintDeploymentAws

Provides the information required to deploy a blueprint to the Amazon Web Services (AWS) environment.

Attributes

The list of attributes for BlueprintDeploymentAws are:

  • region (string): the region where this machine image is registered
  • name (string): the blueprint deployment name used for this deployment
  • credAccountUri (anyURI): the cloud account uri used for this deployment (see credAccount)
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

BlueprintDeploymentAzure

Provides the information required to deploy a blueprint to the Microsoft Azure environment.

Attributes

The list of attributes for BlueprintDeploymentAzure are:

  • region (string): the region where the blueprint will be deployed
  • storageAccount (string): the storage account where the machine images of the blueprint are stored
  • name (string): the blueprint deployment name used for this deployment
  • credAccountUri (anyURI): the cloud account uri used for this deployment (see credAccount)
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

blueprintPipeline

Holds the general information on the preparation of a blueprint to a target cloud environment.

Attributes

The list of attributes for blueprintPipeline are:

  • blueprintUri (anyURI): the blueprint uri related to this preparation
  • credAccountUri (anyURI): the uri of the cloud account used by this preparation
  • tag (string): the tag information
  • name (string): the pipeline name
  • status (status): the status of the pipeline
  • uri (anyURI): the uri of the pipeline
  • stages: the list of stages to perform the pipeline (see stage)
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

BlueprintPipelineAws

Holds the information on the preparation of a blueprint to the Amazon Web Services (AWS) environment.

Attributes

The list of attributes for BlueprintPipelineAws are:

  • region (string): the region where the blueprint is prepared
  • blueprintUri (anyURI): the blueprint uri related to this preparation
  • credAccountUri (anyURI): the uri of the cloud account used by this preparation
  • tag (string): the tag information
  • name (string): the pipeline name
  • status (status): the status of the pipeline
  • uri (anyURI): the uri of the pipeline
  • stages: the list of stages to perform the pipeline (see stage)
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

BlueprintPipelineAzure

Holds the information on the preparation of a blueprint to the Azure environment.

Attributes

The list of attributes for BlueprintPipelineAzure are:

  • storageAccount (string): the storage account where the blueprint is prepared
  • blueprintUri (anyURI): the blueprint uri related to this preparation
  • credAccountUri (anyURI): the uri of the cloud account used by this preparation
  • tag (string): the tag information
  • name (string): the pipeline name
  • status (status): the status of the pipeline
  • uri (anyURI): the uri of the pipeline
  • stages: the list of stages to perform the pipeline (see stage)
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

blueprintPredeploy

Provides the information required to know the status of the appliances related to a blueprint.

Attributes

The list of attributes for blueprintPredeploy are:

  • readyAppliances: the list of appliances that are ready
  • publicationOngoingAppliances: the list of appliances having a publication ongoing
  • nonPublishedAppliances: the list of appliances that are not published
  • nonGeneratedAppliances: the list of appliances that are not generated
  • generationOngoingAppliances: the list of appliances having an image generation ongoing
  • interactiveProfileAppliances: the list of appliances having an interactive profile

blueprintService

Describes a blueprint service.

Attributes

The list of attributes for blueprintService are:

  • serviceId (string): the id of this blueprint service. It can be used in ochestrator configuration, see blueprints example provided in UForge user guide documentation for details.
  • applianceSummary (applianceSummary): the appliance summary used to generate this blueprint service node

blueprintSummary

Holds the main meta-data information used to identify a specific blueprint template.

Attributes

The list of attributes for blueprintSummary are:

  • version (string): the version of the blueprint
  • revision (string): the revision of the blueprint
  • compliant (boolean): flag to indicate if all the appliances are blueprint compliant
  • name (string): the name
  • uri (anyURI): the uri
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

bootScript

Provides all the information of a boot script file that is executed on initial boot of a machine instance. The boot script can be executed only once on the first boot of the machine instance, or executed on every reboot of the machine instance.

Attributes

The list of attributes for bootScript are:

  • bootOrder (int): the boot order number (starting at 0)
  • bootType: the type of the boot script. The boot script can either be executed once during initial provisioning: firstboot; or executed every time the instance is rebooted: everyboot
  • uri (anyURI): the uri resource of this software artifact object
  • tag (string): the tag information
  • binaryUri (anyURI): the uri resource to retrieve the binary
  • parentUri (anyURI): the uri resource of the parent object this software artifact belongs to
  • extract (boolean): a boolean flag to extract an archive (if the uploaded object is an archive) as part of the generation
  • install (boolean): boolean to indicate whether to install the software artifact or just to store it on the filesystem
  • cache (boolean): boolean to indicate whether to put in cache the software artifact or just upload during generation
  • active (boolean): boolean to indicate whether the software artifact active or not
  • installLocation (string): the location to store the software artifact if install == false
  • name (string): the name of the software artifact
  • fullName (string): the name of the file including the extension
  • origName (string): the original name of the software artifact
  • artifactBuildDate (dateTime): the date the software artifact was built
  • artifactFileDate (dateTime): the file timestamp
  • release (string): the release information of the software artifact
  • shortTag (string): short tag value (osPackage, softwarefile or bootscript)
  • type (string): file media type
  • version (string): the version of this software artifact
  • arch (string): the architecture type for this software artifact (rpm uploaded file or OS Package)
  • params (string): silent install parameters to use as part of the installation of the object (for windows only)
  • artifactCredAccount (artifactCredAccount): the artifact account (see artifactCredAccount) this software artifact belong to
  • subSoftwareArtifacts: the list of sub-software artifact of this software artifact (which represents a folder)
  • subSoftwareArtifactUri (anyURI): the list of sub-software artifact uris of this software artifact
  • parentPath (string): the parent pathname of this software artifact (depending of its parent software artifact)
  • remotePath (string): the remote pathname of this software artifact to retrieve from artifact account
  • md5sum (string): the md5sum of the uploaded object
  • mimeType (string): the mime type of the file uploaded
  • sha256sum (string): the sha256 value of the uploaded object
  • size (long): the size (in bytes) of the uploaded object
  • status (status): the upload status (see status)
  • uploaded (boolean): a boolean to indicate if the file has been uploaded
  • uploadedTime (dateTime): the timestamp the upload was completed
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

bootScripts

Provides a list of bootScript objects.

Attributes

The list of attributes for bootScripts are:

  • bootScripts: the list of bootScript objects
  • total (long): the total number of objects

btrfsStoragePool

Describes a btrfs storage pool in a partitioning table. A volume group creates a pool of disk space from a collection of disks or partitions. This volume group can then be partitioned via a logical volume.

Note

Only partitions and LVM logical volumes of type btrfs can be added to a btrfs storage pool

Attributes

The list of attributes for btrfsStoragePool are:

  • dataRaid (string): the data RAID level of this btrfs storage pool
  • label (string): the label of this btrfs storage pool
  • metadataRaid (string): the metadata RAID level of this btrfs storage pool
  • partitionTableUri (anyURI): the uri resource of the partition table object (see partitionTable)
  • partitionsUri (anyURI): the uri resources for each partition this btrfs storage pool uses
  • partitionUris (UriList): the list of uri resources for each partition this btrfs storage pool uses
  • raidType: the RAID type for data and metadata
  • uri (anyURI): the uri resource of this btrfs storage pool
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

btrfsStoragePools

Provides a list of btrfsStoragePool objects.

Attributes

The list of attributes for btrfsStoragePools are:

  • btrfsStoragePools: the list of btrfsStoragePool objects
  • total (long): the total number of objects

btrfsSubvolume

Describes a btrfs subvolume in a partitioning table. A btrfs subvolume describes the way a btrfs storage pool should be partitioned.

Attributes

The list of attributes for btrfsSubvolume are:

  • btrfsStoragePoolUri (anyURI): the uri resource of the btrfs storage pool this subvolume uses
  • compress (string): the compression method of this btrfs storage pool
  • compressType: the compression method type
  • mpoint (string): the mount point if no subvolumes
  • partitionTableUri (anyURI): the uri resource of the partition table object (see partitionTable)
  • uri (anyURI): the uri resource of this btrfs subvolumes object
  • subvolumes: the list of subvolumes (partitions), see partition
  • subvolumesUri (anyURI): the uri resource to retrieve the list of subvolumes (partitions)
  • subvolumeUris (UriList): the list of uri resources of the subvolume objects (partitions)
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

btrfsSubvolumes

Provides a list of btrfsSubvolume objects.

Attributes

The list of attributes for btrfsSubvolumes are:

  • btrfsSubvolumes: the list of btrfsSubvolume objects
  • total (long): the total number of objects

bundleRestriction

Provides the restriction on distributions for a software bundle.

Attributes

The list of attributes for bundleRestriction are:

  • uri (anyURI): the uri of this bundle restriction
  • parentUri (anyURI): the uri resource of the parent object this bundle restriction belongs to
  • restrictionRule (string): the expression rule corresponding to restrictions
  • distributionsUri (anyURI): the uri resource to retrieve all the operating system this bundle restriction is for
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

bundleRestrictions

Provides a list of bundleRestriction objects.

Attributes

The list of attributes for bundleRestrictions are:

  • bundleRestrictions: the list of bundleRestriction objects
  • total (long): the total number of objects

categories

Provides a list of category objects.

Attributes

The list of attributes for categories are:

  • categories: the list of category objects
  • total (long): the total number of objects

category

Holds the information of one category available on the platform. Categories are used to classify appliance templates into groups. A category may have child categories, allowing an administrator to create more complicated taxonomy

Attributes

The list of attributes for category are:

  • name (string): the category name (displayed name)
  • orgUri (anyURI): the uri resource of the organization this category is registered to
  • subCategories: the list of sub categories (list of category objects)
  • subCategoryUri (anyURI): the uri resource to get all the sub-categories
  • uri (anyURI): the uri of this category
  • type: the category type
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

certificate

Provides the information of a certificate file. Certificates are used as part of some cloud accounts

Attributes

The list of attributes for certificate are:

  • content (base64Binary): the certificate file content
  • name (string): the name of the certificate file
  • parentUri (anyURI): the uri resource of the parent object this certificate is attached to
  • type: the certificate file type
  • uri (anyURI): the uri resource of this certificate
  • md5sum (string): the md5sum of the uploaded object
  • mimeType (string): the mime type of the file uploaded
  • sha256sum (string): the sha256 value of the uploaded object
  • size (long): the size (in bytes) of the uploaded object
  • status (status): the upload status (see status)
  • uploaded (boolean): a boolean to indicate if the file has been uploaded
  • uploadedTime (dateTime): the timestamp the upload was completed
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

certificates

Provides a list of certificate objects.

Attributes

The list of attributes for certificates are:

  • certificates: the list of certificate objects
  • total (long): the total number of objects

comment

Holds the information of a comment or question from an user.

Attributes

The list of attributes for comment are:

  • abused (boolean): boolean flag to determine if this comment has been flagged as abusive (the message content could be inappropriate
  • abuseUri (anyURI): the uri resource to use to flag that this comment is inappropriate
  • likesUri (anyURI): the uri resource to use to like this comment
  • loginName (string): the username of the user who has posted this comment
  • message (string): the comment content
  • nbAbused (int): the number of times this comment has been flagged as inappropriate
  • nbDislike (int): the number of dislikes for this comment
  • nbLike (int): the number of likes for this comment
  • photo (logo): the avatar/photo of the user who has posted this comment
  • rating: the overall rating for this comment (used when this comment is a review)
  • replies: a list of replies to this comment (list of comment objects)
  • replyUri (anyURI): the uri resource to post a reply to this comment
  • tags (string): a string of tags for this comment
  • type: the comment type
  • uri (anyURI): the uri resource of this comment
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

comments

Provides a list of comment objects.

Attributes

The list of attributes for comments are:

  • comments: the list of comment objects
  • total (long): the total number of objects

companies

Provides a list of company objects.

Attributes

The list of attributes for companies are:

  • companies: the list of company objects
  • total (long): the total number of objects

company

Provides information for an organization.

Attributes

The list of attributes for company are:

  • address (address): the address of the company
  • logo (logo): the photo or logo of the company
  • name (string): the name of the company
  • parentUri (anyURI): the uri resource of the parent object this company is attached to
  • uri (anyURI): the uri resource of this company
  • website (anyURI): the website URL of this company
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

containerTemplate

Holds all the meta-data of a containerTemplate.

Attributes

The list of attributes for containerTemplate are:

  • uri (anyURI): the uri of this container template
  • softwareBundle (softwareBundle): the software bundle from which the container template has been created
  • distribution (distribution): the distribution on which the container template is based
  • images: the list of images generated from the container template
  • imagesUri (anyURI): the uri to retrieve images generated from the container template
  • formatsUri (anyURI): the uri resource to retrieve all the target formats compatible with this container template
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

containerTemplates

Provides a list of containerTemplate objects.

Attributes

The list of attributes for containerTemplates are:

  • containerTemplates: the list of containerTemplate objects
  • total (long): the total number of objects

credAccount

Holds general account information for a target cloud environment. These credentials allow the platform to communicate with the target cloud environment including registering machine images.

Attributes

The list of attributes for credAccount are:

  • name (string): the name of the cloud account
  • parentUri (anyURI): the uri resource of the parent object this cloud account is attached to
  • uri (anyURI): the uri resource of this cloud account
  • targetPlatform (targetPlatform): the target platform (see targetPlatform) this cloud account is for
  • secretsMissing (boolean): a boolean flag to indicate that the secrets of this credAccount are missing and left empty in this object
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

CredAccountAws

Holds specific account information for the Amazon Web Services (AWS) cloud platform.

Attributes

The list of attributes for CredAccountAws are:

  • accessKeyId (string): the AWS access key to use
  • accountNumber (string): the AWS account number to use
  • keyPairName (string): the key pair name (for EBS) to use
  • secretAccessKeyId (string): the secret access key to use
  • baseCertificatesUri (anyURI): the uri resource to get all the certificates for this cloud account
  • certificates: a list of certificate files (see certificate)
  • certificateUris (UriList): a list of uri resources for the certificate objects
  • name (string): the name of the cloud account
  • parentUri (anyURI): the uri resource of the parent object this cloud account is attached to
  • uri (anyURI): the uri resource of this cloud account
  • targetPlatform (targetPlatform): the target platform (see targetPlatform) this cloud account is for
  • secretsMissing (boolean): a boolean flag to indicate that the secrets of this credAccount are missing and left empty in this object
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

CredAccountAzure

Holds specific account information for the Microsoft Azure cloud platform.

Attributes

The list of attributes for CredAccountAzure are:

  • tenantId (string): the tenant id to use
  • subscriptionId (string): the subscription id to use
  • applicationId (string): the application id to use
  • applicationKey (string): the application key to use
  • endpointUrl (string): the endpoint url to use
  • name (string): the name of the cloud account
  • parentUri (anyURI): the uri resource of the parent object this cloud account is attached to
  • uri (anyURI): the uri resource of this cloud account
  • targetPlatform (targetPlatform): the target platform (see targetPlatform) this cloud account is for
  • secretsMissing (boolean): a boolean flag to indicate that the secrets of this credAccount are missing and left empty in this object
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

CredAccountCert

Extends the basic credAccount adding certificate information required for a cloud account

Attributes

The list of attributes for CredAccountCert are:

  • baseCertificatesUri (anyURI): the uri resource to get all the certificates for this cloud account
  • certificates: a list of certificate files (see certificate)
  • certificateUris (UriList): a list of uri resources for the certificate objects
  • name (string): the name of the cloud account
  • parentUri (anyURI): the uri resource of the parent object this cloud account is attached to
  • uri (anyURI): the uri resource of this cloud account
  • targetPlatform (targetPlatform): the target platform (see targetPlatform) this cloud account is for
  • secretsMissing (boolean): a boolean flag to indicate that the secrets of this credAccount are missing and left empty in this object
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

CredAccountCloudStack

Holds specific account information for the CloudStack cloud platform.

Attributes

The list of attributes for CredAccountCloudStack are:

  • endpointUrl (anyURI): the CloudStack URL to use
  • publicApiKey (string): the public API key of the user
  • secretApiKey (string): the secret API key of the user
  • name (string): the name of the cloud account
  • parentUri (anyURI): the uri resource of the parent object this cloud account is attached to
  • uri (anyURI): the uri resource of this cloud account
  • targetPlatform (targetPlatform): the target platform (see targetPlatform) this cloud account is for
  • secretsMissing (boolean): a boolean flag to indicate that the secrets of this credAccount are missing and left empty in this object
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

CredAccountGoogle

Holds specific account information for the Google Compute Engine (GCE) cloud platform.

Attributes

The list of attributes for CredAccountGoogle are:

  • baseCertificatesUri (anyURI): the uri resource to get all the certificates for this cloud account
  • certificates: a list of certificate files (see certificate)
  • certificateUris (UriList): a list of uri resources for the certificate objects
  • name (string): the name of the cloud account
  • parentUri (anyURI): the uri resource of the parent object this cloud account is attached to
  • uri (anyURI): the uri resource of this cloud account
  • targetPlatform (targetPlatform): the target platform (see targetPlatform) this cloud account is for
  • secretsMissing (boolean): a boolean flag to indicate that the secrets of this credAccount are missing and left empty in this object
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

CredAccountOpenStack

Holds specific account information for the OpenStack cloud platform.

Attributes

The list of attributes for CredAccountOpenStack are:

  • glanceUrl (anyURI): the OpenStack glance endpoint URL to use
  • keystoneUrl (anyURI): the OpenStack keystone endpoint URL to use
  • login (string): the user login name to use
  • password (string): the user password to use
  • keystoneVersion (string): the keystone version this OpenStack instance is using (v2.0 or v3)
  • name (string): the name of the cloud account
  • parentUri (anyURI): the uri resource of the parent object this cloud account is attached to
  • uri (anyURI): the uri resource of this cloud account
  • targetPlatform (targetPlatform): the target platform (see targetPlatform) this cloud account is for
  • secretsMissing (boolean): a boolean flag to indicate that the secrets of this credAccount are missing and left empty in this object
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

CredAccountOutscale

A CredAccountOutscale object holds specific account information for the Outscale cloud platform.

Attributes

The list of attributes for CredAccountOutscale are:

  • accessKeyId (string): the access key to use
  • accountNumber (string): the account number to use
  • keyPairName (string): the key pair name to use
  • secretAccessKeyId (string): the secret access key to use
  • name (string): the name of the cloud account
  • parentUri (anyURI): the uri resource of the parent object this cloud account is attached to
  • uri (anyURI): the uri resource of this cloud account
  • targetPlatform (targetPlatform): the target platform (see targetPlatform) this cloud account is for
  • secretsMissing (boolean): a boolean flag to indicate that the secrets of this credAccount are missing and left empty in this object
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

credAccounts

Provides a list of credAccount objects.

Attributes

The list of attributes for credAccounts are:

  • credAccounts: the list of credAccount objects
  • total (long): the total number of objects

CredAccountSuseCloud

Holds specific account information for the SuseCloud platform.

Attributes

The list of attributes for CredAccountSuseCloud are:

  • glanceUrl (anyURI): the SuseCloud glance endpoint URL to use
  • keystoneUrl (anyURI): the SuseCloud keystone endpoint URL to use
  • login (string): the user login name to use
  • password (string): the user password to use
  • name (string): the name of the cloud account
  • parentUri (anyURI): the uri resource of the parent object this cloud account is attached to
  • uri (anyURI): the uri resource of this cloud account
  • targetPlatform (targetPlatform): the target platform (see targetPlatform) this cloud account is for
  • secretsMissing (boolean): a boolean flag to indicate that the secrets of this credAccount are missing and left empty in this object
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

CredAccountVCloudDirector

Holds specific account information for the VMware VCD platform.

Attributes

The list of attributes for CredAccountVCloudDirector are:

  • hostname (string): the server hostname for the VCD platform
  • organizationName (string): the organization name to use
  • login (string): the user login name to use
  • password (string): the user password to use
  • port (int): the port number of the VCD platform
  • proxyHost (string): the proxy hostname to use (if there is a proxy setup)
  • proxyPort (int): the proxy port to use (if there is a proxy setup)
  • name (string): the name of the cloud account
  • parentUri (anyURI): the uri resource of the parent object this cloud account is attached to
  • uri (anyURI): the uri resource of this cloud account
  • targetPlatform (targetPlatform): the target platform (see targetPlatform) this cloud account is for
  • secretsMissing (boolean): a boolean flag to indicate that the secrets of this credAccount are missing and left empty in this object
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

CredAccountVSphere

Holds specific account information for the VMware vSphere Center platform.

Attributes

The list of attributes for CredAccountVSphere are:

  • hostname (string): the server hostname for the vSphere platform
  • login (string): the user login name to use
  • password (string): the user password to use
  • port (int): the port number of the vSphere platform
  • proxyHost (string): the proxy hostname to use (if there is a proxy setup)
  • proxyPort (int): the proxy port to use (if there is a proxy setup)
  • name (string): the name of the cloud account
  • parentUri (anyURI): the uri resource of the parent object this cloud account is attached to
  • uri (anyURI): the uri resource of this cloud account
  • targetPlatform (targetPlatform): the target platform (see targetPlatform) this cloud account is for
  • secretsMissing (boolean): a boolean flag to indicate that the secrets of this credAccount are missing and left empty in this object
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

CredAccountK5

Holds specific account information for the Fujitsu K5 public cloud platform.

Attributes

The list of attributes for CredAccountK5 are:

  • login (string): the user login name to use
  • password (string): the user password to use
  • name (string): the name of the cloud account
  • parentUri (anyURI): the uri resource of the parent object this cloud account is attached to
  • uri (anyURI): the uri resource of this cloud account
  • targetPlatform (targetPlatform): the target platform (see targetPlatform) this cloud account is for
  • secretsMissing (boolean): a boolean flag to indicate that the secrets of this credAccount are missing and left empty in this object
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

CredAccountDocker

Holds specific account information for a Docker Registry platform.

Attributes

The list of attributes for CredAccountDocker are:

  • endpointUrl (anyURI): the Docker Registry URL to use
  • login (string): the user login name to use
  • password (string): the user password to use
  • name (string): the name of the cloud account
  • parentUri (anyURI): the uri resource of the parent object this cloud account is attached to
  • uri (anyURI): the uri resource of this cloud account
  • targetPlatform (targetPlatform): the target platform (see targetPlatform) this cloud account is for
  • secretsMissing (boolean): a boolean flag to indicate that the secrets of this credAccount are missing and left empty in this object
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

CredAccountOpenShift

Holds specific account information for an OpenShift Registry platform.

Attributes

The list of attributes for CredAccountOpenShift are:

  • registryUrl (anyURI): the OpenShift Registry URL to use
  • token (string): the authentication token to use
  • name (string): the name of the cloud account
  • parentUri (anyURI): the uri resource of the parent object this cloud account is attached to
  • uri (anyURI): the uri resource of this cloud account
  • targetPlatform (targetPlatform): the target platform (see targetPlatform) this cloud account is for
  • secretsMissing (boolean): a boolean flag to indicate that the secrets of this credAccount are missing and left empty in this object
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

CredAccountOracle

Holds specific account information for the Oracle Cloud platform.

Attributes

The list of attributes for CredAccountOracle are:

  • login (string): the user login name to use
  • password (string): the user password to use
  • domainName (string): the identity domain to use
  • name (string): the name of the cloud account
  • parentUri (anyURI): the uri resource of the parent object this cloud account is attached to
  • uri (anyURI): the uri resource of this cloud account
  • targetPlatform (targetPlatform): the target platform (see targetPlatform) this cloud account is for
  • secretsMissing (boolean): a boolean flag to indicate that the secrets of this credAccount are missing and left empty in this object
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

deploymentId

Provides only id information of a deployment. A deployment is a set of one or more running instances (workloads).

Attributes

The list of attributes for deploymentId are:

  • id (string): the id of the deployment
  • uri (anyURI): the uri of the deployment

deployment

Provides all the information of a deployment. A deployment is a set of one or more running instances (workloads).

Attributes

The list of attributes for deployment are:

  • uri (anyURI): the uri of the deployment
  • applicationId (string): the application id of the deployment
  • name (string): the name of the deployment
  • creationDate (dateTime): the date of the deployment
  • blueprintName (string): the blueprint name used to do this deployment
  • iconUrl (anyURI): the icon url of the application deployed
  • state (string): the deployment state
  • sourceSummary (sourceSummary): the deployment source (Blueprint, Appliance or Scan)

deployments

Provides a list of deployment objects.

Attributes

The list of attributes for deployments are:

  • deployments: the list of deployment objects
  • total (long): the total number of objects

disk

Holds the information of a physical disk that is part of a partitioning table. A disk may also contain physical and logical partitions.

Attributes

The list of attributes for disk are:

  • blockSize (int): the disk block size (bytes)
  • name: the disk name, for example sda
  • partitions: a list of partitions this disk has (see partition)
  • partitionsUri (anyURI): the uri resource to retrieve all the partitions for this disk
  • partitionTableUri (anyURI): the uri resource of the parent partition table
  • partitionType: the disk type
  • partitionUris (UriList): the list of uris for the partitions this disk has
  • size (long): the disk size (in bytes)
  • uri (anyURI): the uri resource for this disk
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

disks

Provides a list of disk objects.

Attributes

The list of attributes for disks are:

  • disks: the list of disk objects
  • total (long): the total number of objects

distribProfile

Describes an abstract profile shared between linux and windows.

Attributes

The list of attributes for distribProfile are:

  • active (boolean): boolean to determine if this os profile is active (i.e. available to use by a user)
  • applianceUri (anyURI): the uri resource of the appliance this os profile is attached to
  • arch (string): the architecture of the operating system this os profile is based on
  • description (string): the description of this os profile
  • distributionUri (anyURI): the uri resource to retrieve the operating system information this os profile is based on
  • installedSize (long): estimated install disk size required (in bytes) to install the packages this template contains. Note, this attempts to include all package dependencies.
  • name (string): the name of this os profile
  • standardProfileUri (anyURI): the uri resource to get the os profile this profile is based on (see linuxProfile)
  • uri (anyURI): the uri resource of this os profile
  • size (long): the total size of all the packages contained in this os profile
  • version (string): the version of this os profile
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

distribProfiles

Provides a list of distribProfile objects.

Attributes

The list of attributes for distribProfiles are:

  • distribProfiles: the list of distribProfile objects
  • total (long): the total number of objects

distribution

Describes a specific version of an operating system that is registered on the platform.

Attributes

The list of attributes for distribution are:

  • active (boolean): boolean flag to determine if this operating system is active i.e. namely can be accessed and used by users
  • arch: the architecture of this operating system
  • baseMilestonesUri (anyURI): the uri resource to retrieve the milestones for this operating system
  • basePkgsUri (anyURI): the uri resource to retrieve all the packages contained in this operating system
  • baseProfilesUri (anyURI): the uri resource to retrieve all the os profile templates (see distribProfile)
  • baseRepositoriesUri (anyURI): the uri resource to retrieve all the distribution repositories (see repository)
  • baseGoldensUri (anyURI): the uri resource to retrieve the base machine images (for Microsoft Windows only)
  • company (company): the company information of this operating system (see company
  • description (string): the description of this operating system
  • family: the family type for this operating system
  • license (license): the license information for this operating system (see license)
  • milestoneUris (UriList): the list of uri resources for each milestone registered to this operating system
  • name: the name of the operating system
  • parentUri (anyURI): the uri resource of the parent object this operating system is attached to (normally an organization)
  • pkgType (string): the native package type this operating system supports
  • profiles: the list of os profile template objects (see distribProfile)
  • profileUris (UriList): the list of uri resources for each os profile template registered for this operating system
  • releaseDate (dateTime): the date this operating system was released
  • size (long): the estimated size of the operating system (total size of all the packages in the repository)
  • uri (anyURI): the uri resource for this operating system
  • version (string): the version of this operating system
  • visible (boolean): boolean to determine if this operating system should be displayed
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

distributions

Provides a list of distribution objects.

Attributes

The list of attributes for distributions are:

  • distributions: the list of distribution objects
  • total (long): the total number of objects

entitlement

Describes a base permission tag pre-defined in the platform. These entitlements are used to create role that can be assigned to users.

Attributes

The list of attributes for entitlement are:

  • description (string): the entitlement description
  • name (string): the entitlement name

entitlements

Provides a list of entitlement objects.

Attributes

The list of attributes for entitlements are:

  • entitlements: the list of entitlement objects
  • total (long): the total number of objects

fileEntry

Holds the meta-data information of a file on a filesystem.

Attributes

The list of attributes for fileEntry are:

  • checksum (string): the sha256 checksum value of the file
  • directory (boolean): boolean flag determining if this file is a directory
  • fullPath (string): the full canonical pathname of the file
  • group (string): the group name for this file (access)
  • linkTarget (string): the destination of a soft or hard link in a filesystem
  • name (string): the name of this file
  • owner (string): the filesystem owner of the file
  • parentUri (anyURI): the uri resource of the parent object this file entry is attached to
  • permissions (string): the file permissions
  • scannedInstanceId (long): the id of the parent scanned instance this object belongs to (see scannedInstance)
  • size (long): the size (in bytes) of this file
  • subEntries (long): the number of files if this file entry is a directory
  • uri (string): the uri resource of this file entry object
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

galleryTemplate

Provides the information of an appliance template that has been shared with other users to use (e.g. shared into a workspace).

Attributes

The list of attributes for galleryTemplate are:

  • allowComments (boolean): boolean flag to determine if users can post comments for this shared appliance template
  • applianceUri (anyURI): the uri resource of the original appliance template that was shared
  • category: the category of this shared appliance template
  • comments: the list of comments for this shared appliance template (see comment)
  • commentsUri (anyURI): the uri resource to retrieve the comments for this shared appliance template
  • nbBootScripts (int): the number of boot scripts registered to this appliance template
  • nbClones (long): the number of times this appliance template has been imported (cloned to another user’s appliance library)
  • nbOSPackages (int): the number of native packages this appliance template has (in the os profile)
  • nbVotes (long): the number of times this appliance template has been rated
  • nbWatchers (int): the number of users watching this appliance template for updates
  • notificationsUri (anyURI): the uri resource to use to register for notifications when an appliance template has been updated
  • osProfileName (string): the name of the os profile
  • owner (string): the owner of the original appliance template (that was shared)
  • publisher (string): the login name of the user who has shared the appliance template
  • rating (float): the overall rating of the appliance template
  • relatedVersions: a list of galleryTemplate objects this appliance template is related to
  • releaseDate (dateTime): the release date of this shared appliance template
  • statistics: the statistics information of this shared appliance template (see galleryTemplateStatistics)
  • statisticsUri (anyURI): the uri resource to get the statitics for this shared appliance template (see galleryTemplateStatistics)
  • status (status): the current status during the share process (see status)
  • voteUri (anyURI): the uri resource to send a rating for this appliance template
  • watching (boolean): boolean flag to determine if the user requesting information on this shared appliance template is currently watching (requesting to be notified on an update) of this shared appliance template
  • workspaceName (string): the name of the workspace where this appliance template is being shared
  • workspaceUri (anyURI): the uri resource of the workspace where this appliance template is being shared
  • uuid (string): the uuid of the object
  • applianceExports: a list of applianceExport objects holding meta-data information for each time the appliance has been exported.
  • archName (string): the operating system architecture this appliance is based on
  • baseCloneUri (anyURI): uri resource used to clone this appliance
  • baseImagesStatusUri (anyURI): uri resource to retrieve machine images status
  • baseImagesUri (anyURI): uri resource to retrieve machine images generated from this appliance
  • baseMySoftwareUri (anyURI): uri resource to retrieve the software components added to this appliance
  • baseOasPackageUri (anyURI): uri resource to retrieve any UForge Studio package added to this appliance
  • baseOsProfileUri (anyURI): uri resource to retrieve the OS Profile for this appliance
  • baseProjectsUri (anyURI): uri resource to retrieve any projects added to this appliance
  • basePublishImagesStatusUri (anyURI): uri resource to retrieve published machine image status
  • basePublishImagesUri (anyURI): uri resource to retrieve published machine images from this appliance
  • baseTemplatesStatusUri (anyURI): uri resource to retrieve the status for each time this appliance has been shared (to workspaces)
  • baseTemplatesUri (anyURI): uri resource to retrieve all the shared templates (to workspaces)
  • bootScripts: a list of bootScript objects added to this appliance
  • bootScriptsUri (anyURI): uri resource to get the boot scripts added to this appliance
  • bootScriptUris (UriList): a list of uris for the boots scripts added to this appliance
  • description (string): a description of the appliance
  • distributionName (string): the operating system this appliance is based on (includes name and version)
  • distributionUri (anyURI): uri resource to get the details of the operating system this appliance is based on
  • exportsUri (anyURI): uri resource to get all the export objects for this appliance
  • imageUris (UriList): a list of uris for the machine images generated from this appliance
  • imported (boolean): boolean to determine if this appliance is an import (e.g. from a scan)
  • installedSize (long): estimated disk size required to install the appliance’s software
  • installProfile (installProfile): the installProfile object for this appliance
  • installProfileUri (anyURI): uri resource to get the install profile of the appliance
  • lastPkgUpdate (dateTime): the os profile packages update date (this date is used to calculate if any new package updates are available
  • logo (logo): the logo object for the appliance
  • mySoftwareList: a list of mySoftware objects describing the software components added to this appliance
  • mySoftwareUris (UriList): a list of uris for the software components added to this appliance
  • name (string): the name of this appliance
  • nbSecurityUpdates (int): the number of security operating system packages available for update
  • nbUpdates (int): the number of native package updates available for update
  • orgUri (anyURI): the uri resource of the organization this appliance belongs to
  • osProfile (distribProfile): the distribProfile object describing the operating system profile of this appliance
  • osProfileUri (anyURI): the uri resource for the operating system profile of this appliance
  • parentApplianceUri (anyURI): the uri resource of the parent appliance. This is set if this appliance is a clone of another appliance
  • parentTemplateUri (anyURI): the uri resource of an parent appliance template. This is set of this appliance is a result of importing an appliance (e.g. from a workspace)
  • projects: a list of project objects added to this appliance
  • projectUris (UriList): a list of uris for the projects added to this appliance
  • publishImages: a list of publishImage objects for the machine images that have been registered to one or more cloud platforms
  • publishImageUris (UriList): a list of uris for the machine images that have been registered to one or more cloud platforms
  • revision (int): the revision number of this appliance
  • shared (boolean): a boolean highlighting this appliance has been shared to at least one workspace
  • size (long): the size (in bytes) of all the packages and software added to this appliance
  • tag (string): a tag for this appliance
  • uri (anyURI): the uri resource of this appliance
  • version (string): the version of this appliance
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

galleryTemplates

Provides a list of galleryTemplate objects.

Attributes

The list of attributes for galleryTemplates are:

  • galleryTemplates: the list of galleryTemplate objects
  • total (long): the total number of objects

galleryTemplateStat

Provides basic statistics of a galleryTemplate. This includes the number of times it has been used (imported) by other users

Attributes

The list of attributes for galleryTemplateStat are:

  • nbDownloads (long): the number of machine image downloads (generated from this shared appliance template)
  • nbImports (long): the number of imports of this appliance template
  • parentUri (anyURI): the uri resource of the parent object (e.g. workspace)
  • uri (anyURI): the uri resource of this object
  • user (user): the login name of the user to track actions made on a galleryTemplate
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

galleryTemplateStatistics

Provides all the statistical information of a galleryTemplate. This includes basic statistics (see galleryTemplateStat, as well as rating information.

Attributes

The list of attributes for galleryTemplateStatistics are:

  • clonedStats: a list of galleryTemplateStat objects holding the statistics describing the number of times an appliance template has been cloned
  • clonedStatsUri (anyURI): the uri resource to get all import statistics for an appliance template
  • clones: a list of statDataPoint providing the history of imports
  • downloads: a list of statDataPoint providing the history of download statistics
  • hasRating (boolean): a boolean flag to determine if the appliance template has been rated
  • nbDownloads (long): the total number of downloads of machine images related to the appliance template
  • nbImports (long): the total number of imports for this appliance template
  • nbVotes (long): the total number of times this appliance template has been rated
  • overallRating (float): the overall rating of this appliance template
  • parentUri (anyURI): the uri resource of the parent appliance template
  • truncatedDate (string): the date of the data point
  • uri (anyURI): the uri resource of this object
  • voteStats: a list of voteStat providing the all the ratings by users
  • voteStatsUri (anyURI): the uri resource to retrieve all the ratings by users for this appliance template
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

generationStage

Holds all the meta-data of the generation stage of a migration.

Attributes

The list of attributes for generationStage are:

  • image (image): the image generated by the generation stage
  • imageUri (anyURI): the uri resource of the image generated
  • sourceTemplateId (long): the id of the source template if there is one
  • pipelineUri (anyURI): the uri of the parent pipeline
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

image

Describes a machine image that can be used to provision one or more instances on a target environment. A machine image is created from an appliance template.

Attributes

The list of attributes for image are:

  • parentUri (anyURI): the uri resource of the parent object this machine image was generated from
  • basePublishImagesUri (anyURI): the uri resource to retrieve all the published machine images information (see publishImage)
  • completeInstalledSize (long): estimated disk size to install the machine image (in bytes)
  • completeSize (long): the size (in bytes) of the machine image
  • compress (boolean): a boolean flag to determine if this machine image has been compressed
  • credAccount (credAccount): the cloud account object related to this machine image (see credAccount)
  • distributionName (string): the operating system name this machine image is built upon or requires to run
  • downloadKey (string): the unique download key to download the machine image without authentication (can only be used once)
  • downloadUri (anyURI): the uri resource to download the machine image
  • ebs (boolean): a boolean flag to determine if this machine image should use an EBS volume
  • ebsVolumeSize (int): size of the EBS volume size
  • fileExtension (string): the file extension of the machine image
  • fileName (string): the file name of the machine image
  • fileSize (long): the download size of the machine image (in bytes)
  • format (imageFormat): the primitive format of this machine image
  • targetFormat (targetFormat): the external format of this machine image
  • fullName (string): the complete file name of the machine image
  • imageCreated (boolean): the date this machine im age was generated
  • installProfile (installProfile): the install profile information of this machine image (see installProfile)
  • name (string): the name of this machine image
  • orgUri (anyURI): the uri resource of the organization where this machine image is stored
  • pkgsUri (anyURI): the uri resource to retrieve all the native packages for this machine image (includes packages added after package dependencies have been calculated)
  • revision (int): the revision number of this machine image
  • simulated (boolean): a boolean to indicate whether a dependency checking simulation has been run to determine the definite list of native packages
  • statusUri (anyURI): the uri resource to retrieve the current generation status
  • tag (string): the tag name for this machine image
  • updateTools (boolean): a boolean specific for AWS to determine if AWS should have the ability to update its tools automatcially of a provisioned system from this machine image
  • uri (anyURI): the uri resource of this machine image
  • version (string): the version of this machine image
  • vmDiskSize (long): the recommended disk size (in bytes) to use when provisioning an instance from this machine image
  • vmMemorySize (int): the recommended memory size (in bytes) to use when provisioning an instance from this machine image
  • forceCheckingDeps (boolean): a boolean flag to enforce checking dependencies during the generation of this machine image
  • entrypoint (string): the Entrypoint of a Docker machine image
  • registeringName (string): the name of the image registered in the registry
  • md5sum (string): the md5sum of the uploaded object
  • mimeType (string): the mime type of the file uploaded
  • sha256sum (string): the sha256 value of the uploaded object
  • size (long): the size (in bytes) of the uploaded object
  • status (status): the upload status (see status)
  • uploaded (boolean): a boolean to indicate if the file has been uploaded
  • uploadedTime (dateTime): the timestamp the upload was completed
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

imageFormat

Provides the information on a format available for generating a machine image. These are the primitive format types supported by the platform.

Attributes

The list of attributes for imageFormat are:

  • access (boolean): boolean flag to determine if the requesting user has access to this format
  • active (boolean): boolean flag to determine if this format is visible to the requesting user
  • name: the name of the format
  • uri (anyURI): the uri resource of this format
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

imageFormats

Provides a list of imageFormat objects.

Attributes

The list of attributes for imageFormats are:

  • imageFormats: the list of imageFormat objects
  • total (long): the total number of objects

imagePkg

Provides the details of a group of files (package) that are to be installed as part of a machine image. This may includes packages that have not been explicitly set in an appliance template, rather added as part of the generation process to adhere to package dependencies.

Attributes

The list of attributes for imagePkg are:

  • level (int): provides the dependency level of this package. For example if this package was added as a dependency of another package, then this will be level 1
  • native_from_distribution (boolean): a boolean determining if this package has come from a registered repository
  • pkg (package): the package details

imagePkgs

Provides a list of imagePkg objects.

Attributes

The list of attributes for imagePkgs are:

  • imagePkgs: the list of imagePkg objects
  • total (long): the total number of objects

images

Provides a list of image objects.

Attributes

The list of attributes for images are:

  • images: the list of image objects
  • total (long): the total number of objects

imageStats

Provides statistics for a machine image. This includes the number of times downloaded or registered to a target cloud environment.

Attributes

The list of attributes for imageStats are:

  • curr (int): the value
  • currDownloaded (int): number of downloads of this machine image
  • currFormatUsage: number of times a specific format has been used
  • total (int): the total value (over time regardless if the object in question has been deleted)
  • totalDownloaded (int): the total number of times a machine image has been downloaded (even if the referenced machine image has been deleted)
  • totalFormatUsage: list of statDataPoint for the breakdown on format types used for generating machine images
  • totalPublished (int): the total number of times this machine image has been published

installProfile

Describes the installation profile of an appliance template. The installation profile holds configuration information that should be applied as part of the installation of an operating system. This includes partitioning table layout, root password information, kernel parameters, keyboard settings, timezone etc.

Attributes

The list of attributes for installProfile are:

  • activationKey (string): the activation key of the Windows operating system
  • applianceUri (anyURI): the uri resource of the appliance template this install profile belongs to
  • diskSize (long): the disk size (in bytes). .. note:: this is only used for basic partitioning with one disk
  • firewallAuto (boolean): boolean to determine whether the firewall settings are automatically set, if false this question is asked to the user interactively when provisioning an instance
  • firewallEnabled (boolean): boolean to determine if the firewall is enabled (only used if firewallAuto = true)
  • groups: the list of operating system groups (see osGroup
  • groupsUri (anyURI): the uri resource to retrieve all the operating system groups
  • hwType (string): the recommended hardware type (used for VMware type machine images)
  • internetSettingsAuto (boolean): boolean to determine whether the internet settings are automatically set, if false this question is asked to the user interactively when provisioning an instance
  • kernelParameters (string): the list of kernel parameters to use (this is one string with each kernel parameter separated by a comma
  • keyboard: the keyboard setting (only used if keyboardAuto = true)
  • keyboardAuto (boolean): boolean to determine whether the keyboard settings are automatically set, if false this question is asked to the user interactively when provisioning an instance
  • memorySize (long): the recommended memory size to use for running an instance
  • nics: the list of NICs to configure (see nic)
  • nicsUri (anyURI): the uri resource to get the list of NIC information
  • partitionAuto (boolean): boolean to determine whether to automatically create the partitioning table, if false this question is asked to the user interactively when provisioning an instance
  • partitionTable (partitionTable): the partition table information (see partitionTable). Only used if partitionAuto = true
  • rootUser (osUser): the root user information, includes root password information
  • runSysprep (boolean): boolean to determine if sysprep will be executed for Windows operating system
  • skipLicenses (boolean): a boolean to determine whether to display and enforce the user to accept licensing information during the provisioning of an instance. if true no licensing information is displayed
  • swapSize (long): the swap size (in bytes). .. note:: this is only used for basic partitioning with one disk
  • timezone (string): the timezone to set. Only used if timezoneAuto == true
  • timezoneAuto (boolean): boolean to determine whether the timezone settings are automatically set, if false this question is asked to the user interactively when provisioning an instance
  • timezoneCity (string): the city name of the timezone that is set (only considered if timezoneAuto == true
  • updateTools (boolean): boolean to determine whether to allow automatic update of AWS libraries and tools in the cloud environment. .. note:: only used for AWS
  • uri (anyURI): the uri resource of this install profile
  • users: the list of operating system users to set (see osUser)
  • usersUri (anyURI): the uri resource to retrieve all the operating system users
  • vagrantUser (string): the user to set for vagrant base boxes
  • welcomeMsg (string): welcome message to display to the end user when provisioning an instance
  • seLinuxMode (seLinuxMode): the SELinux mode (disabled/permissive/enforcing)
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

ipAddress

Holds IP address information when setting NICs on an appliance template

Attributes

The list of attributes for ipAddress are:

  • address (string): the static IP address to set on the NIC
  • gateway (string): the gateway to set on the NIC
  • netmask (string): the netmask to set on the NIC
  • parentUri (anyURI): the uri resource of the parent object this object is attached to (e.g. nic)
  • type (int): IP address type (IPv4 or IPv6)
  • uri (anyURI): the uri resource of this IP address object
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

license

Holds the meta-data of a license file.

Attributes

The list of attributes for license are:

  • name (string): the file name of the license
  • parentUri (anyURI): the uri resource of the parent object this license object is attached to
  • type (string): the license type (e.g. GPL, GPLv2, CDDL, Apache)
  • uri (anyURI): the uri resource of thie license object
  • md5sum (string): the md5sum of the uploaded object
  • mimeType (string): the mime type of the file uploaded
  • sha256sum (string): the sha256 value of the uploaded object
  • size (long): the size (in bytes) of the uploaded object
  • status (status): the upload status (see status)
  • uploaded (boolean): a boolean to indicate if the file has been uploaded
  • uploadedTime (dateTime): the timestamp the upload was completed
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

licenses

Provides a list of license objects.

Attributes

The list of attributes for licenses are:

  • licenses: the list of license objects
  • total (long): the total number of objects

linuxProfile

Describes a group of native packages from a linux operating system. This profile is created by a platform administrator or used in an appliance template. These templates are used by users of the platform to easily create operating profiles that are part of an appliance template.

Attributes

The list of attributes for linuxProfile are:

  • distributionPackagesUri (anyURI): the uri resource to retrieve all the operating system packages contained in this os profile
  • distributionServicesUri (anyURI): the uri resource to retrieve all the operating system services contained in this os profile
  • packagesUri (anyURI): the uri resource to retrieve all the packages this os profile contains (may contain custom packages from other repositories other than the operating system)
  • packageUris (UriList): the list of uris for the packages this os profile contains
  • servicesUri (anyURI): the uri resource to retrieve all the services contained in this os profile
  • serviceUris (UriList): the uri resource to get all the available services uri
  • updatesUri (anyURI): the uri resource to get all the available package updates (see osUpdate)
  • active (boolean): boolean to determine if this os profile is active (i.e. available to use by a user)
  • applianceUri (anyURI): the uri resource of the appliance this os profile is attached to
  • arch (string): the architecture of the operating system this os profile is based on
  • description (string): the description of this os profile
  • distributionUri (anyURI): the uri resource to retrieve the operating system information this os profile is based on
  • installedSize (long): estimated install disk size required (in bytes) to install the packages this template contains. Note, this attempts to include all package dependencies.
  • name (string): the name of this os profile
  • standardProfileUri (anyURI): the uri resource to get the os profile this profile is based on (see linuxProfile)
  • uri (anyURI): the uri resource of this os profile
  • size (long): the total size of all the packages contained in this os profile
  • version (string): the version of this os profile
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

linuxProfiles

Provides a list of linuxProfile objects.

Attributes

The list of attributes for linuxProfiles are:

  • linuxProfiles: the list of linuxProfile objects
  • total (long): the total number of objects

LocalizedMessage

Localized message returned by the platform.

Attributes

The list of attributes for LocalizedMessage are:

  • message (string): the message in the request language
  • messageId (string): the message id. This is a unique id regardless the language. The id will always be the same for the same kind of error.
  • parameters: the parameters that help a client to rebuild the complete message.

location

Location where a deployed instance is running.

Attributes

The list of attributes for location are:

  • name (string): the name of the location
  • provider (string): the cloud provider
  • credentialsUri (anyURI): the credentials URI used for this location

logicalGroup

Describes a logical volume group in a partitioning table. A volume group creates a pool of disk space from a collection of disks or partitions. This volume group can then be partitioned via a logical volume.

Note

Only disks and partitions of type lvm and logical partitions can be added to a volume group

Attributes

The list of attributes for logicalGroup are:

  • diskUri (anyURI): the uri resources for each disk this logical group uses
  • diskUris (UriList): the list of uri resources for each disk this logical group uses
  • groupName (string): the logical group name
  • partitionTableUri (anyURI): the uri resource of the partition table object (see partitionTable)
  • partitionUri (anyURI): the uri resources for each partition this logical group uses
  • partitionUris (UriList): the list of uri resources for each partition this logical group uses
  • uri (anyURI): the uri resource of this logical group
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

logicalGroups

Provides a list of logicalGroup objects.

Attributes

The list of attributes for logicalGroups are:

  • logicalGroups: the list of logicalGroup objects
  • total (long): the total number of objects

logicalVolume

Describes a logical volume in a partitioning table. A logical volume describes the way a volume group should be partitioned.

Attributes

The list of attributes for logicalVolume are:

  • groupUri (anyURI): the uri resource of the logical group this logical volume uses
  • name (string): the name of this logical volume
  • partitionTableUri (anyURI): the uri resource of the partition table object (see partitionTable)
  • uri (anyURI): the uri resource of this logical volume object
  • volumes: the list of volumes (partitions), see partition
  • volumesUri (anyURI): the uri resource to retrieve the list of volumes (partitions)
  • volumeUris (UriList): the list of uri resources of the volume objects (partitions)
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

logicalVolumes

Provides a list of logicalVolume objects.

Attributes

The list of attributes for logicalVolumes are:

  • logicalVolumes: the list of logicalVolume objects
  • total (long): the total number of objects

membership

Describes the membership status of a user in a workspace.

Attributes

The list of attributes for membership are:

  • joinedDate (dateTime): the date the user accepted the membership invitation
  • leftDate (dateTime): the date the user has stopped becoming a member or declined the initial membership invitation
  • role: the current role of the user (privileges)
  • accepted (boolean): a boolean indicating whether the invitation has been accepted
  • declined (boolean): a boolean indicating whether the invitation has been declined
  • msg (string): a message included in the invitation
  • parentUri (anyURI): the uri resource of the parent object this object belongs to
  • referrer (userProfile): the user creating the invitation
  • uri (anyURI): the uri resource of this object
  • user (userProfile): the user being invited
  • userEmail (string): the email of the user being invited
  • userLogin (string): the username of the user being invited
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

memberships

Provides a list of membership objects.

Attributes

The list of attributes for memberships are:

  • memberships: the list of membership objects
  • total (long): the total number of objects

migration

Holds all the meta-data of a migration. Contains the list of stages to perform a migration.

Attributes

The list of attributes for migration are:

  • cancellable (boolean): a boolean highlighting if the Migration is cancellable or not
  • tag (string): the tag information
  • name (string): the pipeline name
  • status (status): the status of the pipeline
  • uri (anyURI): the uri of the pipeline
  • stages: the list of stages to perform the pipeline (see stage)
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

migrations

Provides a list of milestone objects.

Attributes

The list of attributes for migrations are:

  • migrations: the list of migration objects
  • total (long): the total number of objects

milestone

Marks a specific point along a an operating system’s timeline. This can then be used to help users rollback or forward package updates of their appliance templates. Milestones are created and maintained by a platform administrator for each of the operating systems registered with the platform.

Attributes

The list of attributes for milestone are:

  • date (dateTime): the date for this milestone
  • description (string): a description of the milestone
  • name (string): the name or title of the milestone
  • source (string): the source of the Milestone. Reserved source : distribution (populated automatically by the platform population tools)
  • uri (anyURI): the uri resource of this milestone object
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

milestones

Provides a list of milestone objects.

Attributes

The list of attributes for milestones are:

  • milestones: the list of milestone objects
  • total (long): the total number of objects

mySoftware

Describes a software component contained in a user’s Software Library. These software components are private to a user, and are maintained by the user. They can be added to a user’s appliance templates.

Attributes

The list of attributes for mySoftware are:

  • appliancesUri (anyURI): the uri resource to retrieve all the appliance templates that use this software component
  • applianceUris (UriList): the list of uri resources of each appliance template using this software component
  • cloneUri (anyURI): uri resource used to clone this MySoftware
  • imported (boolean): a boolean highlighting if the MySoftware has been imported (from a scan, an appliance import or a workspace)
  • generationEnabled (boolean): a boolean highlighting if the Software component is able to be generated or not
  • tag (string): the tag information
  • shortTag (string): the short tag information (mySoftware or project)
  • name (string): the name of this software bundle
  • version (string): the version information of this software bundle
  • description (string): the description for this software bundle
  • release (string): the release information for the software bundle
  • defaultInstallLocation (string): the default full pathname of where to install the software bundle (if not a native package)
  • installLocation (string): the full pathname of where to install this software bundle item (overrides the defaultInstallLocation)
  • restricted (boolean): a boolean highlighting if the Software bundle is restricted
  • installedSize (long): the estimated disk size (in bytes) required to install this software bundle
  • size (long): the total size of this software bundle (in bytes)
  • revision (long): the revision number of the software bundle
  • bundleRestriction (bundleRestriction): the restriction for this software bundle
  • artifactsUri (anyURI): the uri resource to retrieve the details of software artifacts contained in the software bundle
  • uri (anyURI): the uri resource of this software bundle object
  • exportUri (anyURI): uri resource used to export this software bundle
  • category (category): the category for this software bundle (project)
  • license (license): the license information (see license)
  • logo (logo): the logo object for the software bundle
  • maintainer (string): the maintainer name for this project
  • website (anyURI): the website URL of the maintainer
  • softwareArtifactUris (UriList): the list of uri resources for each software artifacts in the software bundle
  • formatDependent (boolean): a boolean highlighting if the Software bundle is restricted on target format
  • containerTemplatesUri (anyURI): the uri to retrieve container templates created from the software bundle
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

mySoftwareList

Provides a list of mySoftware objects.

Attributes

The list of attributes for mySoftwareList are:

  • mySoftwareList: the list of mySoftware objects
  • total (long): the total number of objects

nic

Provides the information of a network interface card (NIC). This NIC information is attached to the installation profile belonging to an appliance template.

Attributes

The list of attributes for nic are:

  • autoConnect (boolean): a boolean highlighting if the network card should be activated automatically
  • ipAddresses: the list of static IP address information for this NIC (see ipAddress
  • ipv4Method: the IPv4 method to be used (manual, dhcp, etc.)
  • ipv6Method: the IPv6 method to be used (manual, dhcp, etc.)
  • name (string): the name of this NIC
  • parentUri (anyURI): the uri resource of the parent object this NIC is attached to (e.g. an install profile object)
  • type: the type of NIC
  • order (int): the order of NIC
  • uri (anyURI): the uri resource of this NIC
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

nics

Provides a list of nic objects.

Attributes

The list of attributes for nics are:

  • nics: the list of nic objects
  • total (long): the total number of objects

status

Primitive object to describe the status of the parent object it is attached to. Normally used for asynchronous actions on the platform (e.g. generating machine images, registering machine images, importing/exporting appliance templates).

Attributes

The list of attributes for status are:

  • bytesLoaded (long): the number of bytes uploaded or downloaded (used for calculating progress)
  • bytesTotal (long): the total number of bytes expecting to be loaded (used for calculating progress)
  • cancelled (boolean): a boolean flag to indicate that the job this status was attached to has been cancelled
  • complete (boolean): a boolean flag to indicate that the job this status was attached has completed
  • detailedError (boolean): a boolean flag to indicate that there is detailed error message information
  • detailedErrorMsg (string): the detailed error message
  • error (boolean): a boolean flag to indicate that an error has occurred in the job this status is attached to
  • errorMessage (string): the error message
  • eta (dateTime): the estimated time of when the job will complete
  • message (string): the current status message
  • parentUri (anyURI): the uri resource of the parent object this status object is attached to
  • percentage (int): the current progress as a percentage
  • published (boolean): a boolean flag used to indicate if the job has finished (for publishing jobs)
  • totalTime (dateTime): the total time the job has taken to complete
  • uri (anyURI): the uri resource of this status object
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

statuses

Provides a list of status objects.

Attributes

The list of attributes for statuses are:

  • statuses: the list of status objects
  • total (long): the total number of objects

org

Holds the meta-data of an organization of the platform.

Attributes

The list of attributes for org are:

  • activateNewUsers (boolean): a boolean flag to indicate to make any news users being created in this organization to automatically active
  • admin (boolean): boolean flag to indicate whether the user requesting this organization information is an administrator of this organization
  • appliancesUri (anyURI): the uri resource to retrieve all the appliance templates in this organization
  • categoriesUri (anyURI): the uri resource to retrieve all the categories added to this organization (see category)
  • companiesUri (anyURI): the uri resource to retrieve all the companies registered in this organization (see company)
  • company (company): the org company
  • defaultOrg (boolean): boolean to indicate if this organization is the default of the platform
  • distributionsUri (anyURI): the uri resource to retrieve all the operating systems of the organization
  • targetFormats: the list of target formats available in this organization
  • formatsUri (anyURI): the uri resource to retrieve all the available primitive formats in this organization
  • targetPlatformsUri (anyURI): the uri resource to retrieve all the available target platforms in this organization
  • targetFormatsUri (anyURI): the uri resource to retrieve all the available target formats in this organization
  • license (license): the org license
  • licensesUri (anyURI): the uri resource to retrieve all the registered licenses in the org
  • licenseUri (anyURI): the uri resource to retrieve the license of the org
  • membersUri (anyURI): the uri resource to retrieve all the users registered to this organization
  • milestonesUri (anyURI): the uri resource to retrieve all the milestones registered to this organization
  • name (string): the organization name
  • projectsUri (anyURI): the uri resource to retrieve all the projects registered to this organization’s project catalog
  • rolesUri (anyURI): the uri resource to retrieve all the roles registered to this organization
  • statsUri (anyURI): the uri resource to retrieve all the statistics for this organization
  • subscriptionProfilesUri (anyURI): the uri resource to retrieve all the subscription profiles registered to this organization
  • uri (anyURI): the uri resource for this organization object
  • workspacesUri (anyURI): the uri resource to retrieve all the workspaces registered to this organization
  • repositoriesUri (anyURI): the uri resource to retrieve all the operating system repositories registered to this organization
  • artifactAccountsUri (anyURI): the uri resource to retrieve all the artifact accounts registered to this organization
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

orgs

Provides a list of org objects.

Attributes

The list of attributes for orgs are:

  • orgs: the list of org objects
  • total (long): the total number of objects

osConfig

Provides OS configuration information

Attributes

The list of attributes for osConfig are:

  • edition: OS edition
  • type: OS type
  • language (string): OS language
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

osConfigs

Provides a list of osConfig objects.

Attributes

The list of attributes for osConfigs are:

  • osConfigs: the list of osConfig objects
  • total (long): the total number of objects

osGroup

Description of an operating system group for filesystem directory and file permissions. See also osUser.

Attributes

The list of attributes for osGroup are:

  • groupId (string): the unique id of the group (only used if groupIdAuto == false
  • groupIdAuto (boolean): boolean flag to determine if the group id should be calculated
  • name (string): the group name
  • sudo (int): a flag to configure sudoers parameters (0 : no sudo, 1: sudo, 2: sudo without password)
  • systemGroup (boolean): flag to determine if this is a system group
  • uri (anyURI): the uri resource of this group object
  • password (string): the group password
  • encrypted (boolean): boolean flag to determine if the group password string is encrypted
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

osGroups

Provides a list of osGroup objects.

Attributes

The list of attributes for osGroups are:

  • osGroups: the list of osGroup objects
  • total (long): the total number of objects

osPackage

Holds information of a native operating system package attached to a software bundle.

Attributes

The list of attributes for osPackage are:

  • sticky (boolean): boolean to indicate that this package version should not be updated when new package updates are available
  • repoId (long): the unique id of the repository these packages belong to
  • repository (string): repository name
  • distroId (long): the unique id of the operating system this software artifact (OS Package) belong to
  • uri (anyURI): the uri resource of this software artifact object
  • tag (string): the tag information
  • binaryUri (anyURI): the uri resource to retrieve the binary
  • parentUri (anyURI): the uri resource of the parent object this software artifact belongs to
  • extract (boolean): a boolean flag to extract an archive (if the uploaded object is an archive) as part of the generation
  • install (boolean): boolean to indicate whether to install the software artifact or just to store it on the filesystem
  • cache (boolean): boolean to indicate whether to put in cache the software artifact or just upload during generation
  • active (boolean): boolean to indicate whether the software artifact active or not
  • installLocation (string): the location to store the software artifact if install == false
  • name (string): the name of the software artifact
  • fullName (string): the name of the file including the extension
  • origName (string): the original name of the software artifact
  • artifactBuildDate (dateTime): the date the software artifact was built
  • artifactFileDate (dateTime): the file timestamp
  • release (string): the release information of the software artifact
  • shortTag (string): short tag value (osPackage, softwarefile or bootscript)
  • type (string): file media type
  • version (string): the version of this software artifact
  • arch (string): the architecture type for this software artifact (rpm uploaded file or OS Package)
  • params (string): silent install parameters to use as part of the installation of the object (for windows only)
  • artifactCredAccount (artifactCredAccount): the artifact account (see artifactCredAccount) this software artifact belong to
  • subSoftwareArtifacts: the list of sub-software artifact of this software artifact (which represents a folder)
  • subSoftwareArtifactUri (anyURI): the list of sub-software artifact uris of this software artifact
  • parentPath (string): the parent pathname of this software artifact (depending of its parent software artifact)
  • remotePath (string): the remote pathname of this software artifact to retrieve from artifact account
  • md5sum (string): the md5sum of the uploaded object
  • mimeType (string): the mime type of the file uploaded
  • sha256sum (string): the sha256 value of the uploaded object
  • size (long): the size (in bytes) of the uploaded object
  • status (status): the upload status (see status)
  • uploaded (boolean): a boolean to indicate if the file has been uploaded
  • uploadedTime (dateTime): the timestamp the upload was completed
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

osPackages

Provides a list of osPackage objects.

Attributes

The list of attributes for osPackages are:

  • total (long): the total number of objects

osUpdate

Provides the information of a new package available in the an operating system repository compared with an existing package in an appliance template’s os profile.

Attributes

The list of attributes for osUpdate are:

  • currPkg (package): the current package information (see package)
  • date (dateTime): the end date where to calculate the available updates for the currPkg
  • newPkg (package): the proposed new package version to update to
  • numUpdates (int): the number of updates available for this package from the current package version to the date value
  • pkgs: the list of package updates available between currPkg version and the date provided

osUpdates

Holds the operating system updates available for an appliance template. This is the result of comparing the appliance template’s os profile package list with the operating system repository registered on the platform. Versions of each package are compared, all new package versions are provided in this object.

Attributes

The list of attributes for osUpdates are:

  • availUpdates: the list of package updates (see osUpdate) available for the list of packages in the os profile
  • osEOLDate (dateTime): the date where the operating system will receive no more updates
  • osReleaseDate (dateTime): the date where the operating system was released
  • simulation: the list of package updates (see osUpdate) available after a simulation
  • simulationDate (dateTime): the end date where to calculate the available updates (for a simulation)

osUser

Description of an operating system user for filesystem directory and file permissions. OS users can be grouped together using osGroup objects.

Attributes

The list of attributes for osUser are:

  • disablePasswordLogin (boolean): boolean to disable the user logging into the system using a password
  • encrypted (boolean): boolean indicating that the password string is encrypted
  • fullName (string): the full name of the user
  • homeDir (string): the home directory of the user
  • name (string): the user name
  • password (string): the user password
  • passwordAuto (boolean): a boolean indicating for the platform to automatically set the password listed in the attribute password
  • primaryGroup (string): the user’s primary group (see osGroup)
  • primaryGroupAuto (boolean): boolean indicating for the platform to automatically assign the user’s primary group
  • secondaryGroups (string): a list of the user’s secondary groups (each group separated by a comma)
  • shell (string): the shell type for the user
  • sshKeys: a list of public SSH keys for the user (see sshKey)
  • sudo (int): a flag to configure sudoers parameters (0 : no sudo, 1: sudo, 2: sudo without password)
  • systemUser (boolean): a boolean indicating that this is a system user
  • uri (anyURI): the uri resource of this user object
  • userId (string): the unique id of this user (only used if userIdAuto == false
  • userIdAuto (boolean): boolean indicating whether the platform should automatically calculate the user’s id
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

osUsers

Provides a list of osUser objects.

Attributes

The list of attributes for osUsers are:

  • osUsers: the list of osUser objects
  • total (long): the total number of objects

partition

Holds the information of a physical or logical partition that is part of a partitioning table.

Attributes

The list of attributes for partition are:

  • defaultSubvolume (boolean): boolean indicating whether this partition is default subvolume
  • dumpLocation (string): the location of the partition’s dump file
  • fstype: the filesystem type of the partition
  • growable (boolean): boolean indicating whether this partition is growable
  • label (string): partition label
  • logicalPartitions: list of logical partitions (this needs to be an extended partition)
  • logicalPartitionsUri (anyURI): the uri resource to retrieve the logical partitions
  • logicalPartitionUris (UriList): the list of uris of each logical partition
  • mpoint (string): the mount point
  • name (string): the partition name
  • parentUri (anyURI): the uri resource of the parent object this partition is attached to
  • partitionTableUri (anyURI): the uri resource of the partition table
  • size (long): the size (in bytes) of the partition
  • uri (anyURI): the uri resource of this partition object
  • volumeOrder (int): the volume order
  • mbrBoot (boolean): boolean indicating whether this partition is bootable
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

partitions

Provides a list of partition objects.

Attributes

The list of attributes for partitions are:

  • partitions: the list of partition objects
  • total (long): the total number of objects

partitionTable

Describes a complete partitioning table for an appliance template. This partitioning table is part of the installProfile.

Attributes

The list of attributes for partitionTable are:

  • btrfsStoragePools: the list of btrfs storage pools for this partition table (see btrfsStoragePool)
  • btrfsStoragePoolsUri (anyURI): the uri resource to retrieve the btrfs storage pools in this partition table
  • btrfsStoragePoolUris (UriList): the list of uri resources for each btrfs storage pool in this partition table
  • btrfsSubvolumes: the list of btrfs subvolumes (partitions) in this partition table
  • btrfsSubvolumesUri (anyURI): the uri resource to retrieve the btrfs subvolumes in this partition table
  • btrfsSubvolumeUris (UriList): the list of uri resources for each btrfs subvolume in this partition table
  • disks: the list of disks this partition table has (see disk)
  • disksUri (anyURI): the uri resource to retrieve the disks for this partition table
  • diskUris (UriList): the list of uris for each disk of the partition table
  • parentUri (anyURI): the uri resource of the parent this partition table is attached to
  • logicalGroups: the list of logical groups for this partition table (see logicalGroup)
  • logicalGroupsUri (anyURI): the uri resource to retrieve the logical groups in this partition table
  • logicalGroupUris (UriList): the list of uri resources for each logical group in this partition table
  • logicalVolumes: the list of logical volumes (partitions) in this partition table
  • logicalVolumesUri (anyURI): the uri resource to retrieve the logical volumes in this partition table
  • logicalVolumeUris (UriList): the list of uri resources for each logical volume in this partition table
  • uri (anyURI): the uri resource of this partition table object
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

pipeline

Holds all the meta-data of a pipeline. Contains the list of stages to perform a pipeline.

Attributes

The list of attributes for pipeline are:

  • tag (string): the tag information
  • name (string): the pipeline name
  • status (status): the status of the pipeline
  • uri (anyURI): the uri of the pipeline
  • stages: the list of stages to perform the pipeline (see stage)
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

pipelines

Provides a list of pipeline objects.

Attributes

The list of attributes for pipelines are:

  • pipelines: the list of pipeline objects
  • total (long): the total number of objects

package

Holds information of a native operating system package or file.

Attributes

The list of attributes for package are:

  • arch (string): the architecture type for this package
  • binaryUri (anyURI): the uri resource to retrieve the binary
  • extract (boolean): a boolean flag to extract an archive (if the uploaded object is an archive) as part of the generation
  • fullName (string): the name of the file including the extension
  • install (boolean): boolean to indicate whether to install the package or just to store it on the filesystem
  • installLocation (string): the location to store the package if install == false
  • name (string): the name of the package
  • origName (string): the original name of the package
  • params (string): silent install parameters to use as part of the installation of the object (for windows only)
  • parentUri (anyURI): the uri resource of the parent object this package belongs to
  • pkgBuildDate (dateTime): the date the package was built
  • pkgFileDate (dateTime): the file timestamp
  • release (string): the release information package
  • shortTag (string): tag value
  • repositoryName (string): repository name
  • sticky (boolean): boolean to indicate that this package version should not be updated when new package updates are available
  • type (string): file media type
  • uri (anyURI): the uri resource of this package object
  • version (string): the version of this package
  • epoch (int): the epoch value (used for native packages)
  • md5sum (string): the md5sum of the uploaded object
  • mimeType (string): the mime type of the file uploaded
  • sha256sum (string): the sha256 value of the uploaded object
  • size (long): the size (in bytes) of the uploaded object
  • status (status): the upload status (see status)
  • uploaded (boolean): a boolean to indicate if the file has been uploaded
  • uploadedTime (dateTime): the timestamp the upload was completed
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

pkgGroup

Describes a group of packages.

Attributes

The list of attributes for pkgGroup are:

  • category (string): the category for this group of packages
  • company (company): the company name
  • description (string): the description for this group of packages
  • distributionUri (anyURI): the uri resource of the operating system these packages belong to
  • distroId (long): the unique id of the operating system these packages belong to
  • installedSize (long): the estimated disk size (in bytes) required to install these group of packages
  • license (license): the license information (see license)
  • name (string): the name of these group of packages
  • packagesUri (anyURI): the uri resource to retrieve the details of these packages
  • packageUris (UriList): the list of uri resources for each package in the group
  • release (string): the release information for the group
  • size (long): the total size of all the packages in the group (in bytes)
  • tag (string): the tag information
  • uri (anyURI): the uri resource of this package group object
  • version (string): the version information of this package group
  • packages: the list of packages in this group (see package)
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

packages

Provides a list of package objects to add or delete.

Attributes

The list of attributes for packages are:

project

A software component that is part of the platform’s Project Catalog. Such software components are public for all users to use in their appliance templates. These software components are updated and maintained by an administrator of the platform.

Attributes

The list of attributes for project are:

  • orgUris (UriList): the list of uri resources of each organization this software bundle (project) has been registered to
  • tag (string): the tag information
  • shortTag (string): the short tag information (mySoftware or project)
  • name (string): the name of this software bundle
  • version (string): the version information of this software bundle
  • description (string): the description for this software bundle
  • release (string): the release information for the software bundle
  • defaultInstallLocation (string): the default full pathname of where to install the software bundle (if not a native package)
  • installLocation (string): the full pathname of where to install this software bundle item (overrides the defaultInstallLocation)
  • restricted (boolean): a boolean highlighting if the Software bundle is restricted
  • installedSize (long): the estimated disk size (in bytes) required to install this software bundle
  • size (long): the total size of this software bundle (in bytes)
  • revision (long): the revision number of the software bundle
  • bundleRestriction (bundleRestriction): the restriction for this software bundle
  • artifactsUri (anyURI): the uri resource to retrieve the details of software artifacts contained in the software bundle
  • uri (anyURI): the uri resource of this software bundle object
  • exportUri (anyURI): uri resource used to export this software bundle
  • category (category): the category for this software bundle (project)
  • license (license): the license information (see license)
  • logo (logo): the logo object for the software bundle
  • maintainer (string): the maintainer name for this project
  • website (anyURI): the website URL of the maintainer
  • softwareArtifactUris (UriList): the list of uri resources for each software artifacts in the software bundle
  • formatDependent (boolean): a boolean highlighting if the Software bundle is restricted on target format
  • containerTemplatesUri (anyURI): the uri to retrieve container templates created from the software bundle
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

projects

Provides a list of project objects.

Attributes

The list of attributes for projects are:

  • projects: the list of project objects
  • total (long): the total number of objects

publicationStage

Holds all the meta-data of the publication stage of a migration.

Attributes

The list of attributes for publicationStage are:

  • publishImage (publishImage): the image published by the publication stage
  • publishImageUri (anyURI): the uri resource of the published image
  • sourceImageId (long): the id of the source image if there is one
  • pipelineUri (anyURI): the uri of the parent pipeline
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

publishImage

Holds the general information on the registration of a machine image to a target cloud environment.

Attributes

The list of attributes for publishImage are:

  • cloudId (string): the unique id for the machine image registered on the cloud environment
  • imageUri (anyURI): the uri resource of the machine image
  • publishLocation (string): the location of the registered machine image (e.g. region)
  • parentUri (anyURI): the uri resource of the parent object this machine image was generated from
  • basePublishImagesUri (anyURI): the uri resource to retrieve all the published machine images information (see publishImage)
  • completeInstalledSize (long): estimated disk size to install the machine image (in bytes)
  • completeSize (long): the size (in bytes) of the machine image
  • compress (boolean): a boolean flag to determine if this machine image has been compressed
  • credAccount (credAccount): the cloud account object related to this machine image (see credAccount)
  • distributionName (string): the operating system name this machine image is built upon or requires to run
  • downloadKey (string): the unique download key to download the machine image without authentication (can only be used once)
  • downloadUri (anyURI): the uri resource to download the machine image
  • ebs (boolean): a boolean flag to determine if this machine image should use an EBS volume
  • ebsVolumeSize (int): size of the EBS volume size
  • fileExtension (string): the file extension of the machine image
  • fileName (string): the file name of the machine image
  • fileSize (long): the download size of the machine image (in bytes)
  • format (imageFormat): the primitive format of this machine image
  • targetFormat (targetFormat): the external format of this machine image
  • fullName (string): the complete file name of the machine image
  • imageCreated (boolean): the date this machine im age was generated
  • installProfile (installProfile): the install profile information of this machine image (see installProfile)
  • name (string): the name of this machine image
  • orgUri (anyURI): the uri resource of the organization where this machine image is stored
  • pkgsUri (anyURI): the uri resource to retrieve all the native packages for this machine image (includes packages added after package dependencies have been calculated)
  • revision (int): the revision number of this machine image
  • simulated (boolean): a boolean to indicate whether a dependency checking simulation has been run to determine the definite list of native packages
  • statusUri (anyURI): the uri resource to retrieve the current generation status
  • tag (string): the tag name for this machine image
  • updateTools (boolean): a boolean specific for AWS to determine if AWS should have the ability to update its tools automatcially of a provisioned system from this machine image
  • uri (anyURI): the uri resource of this machine image
  • version (string): the version of this machine image
  • vmDiskSize (long): the recommended disk size (in bytes) to use when provisioning an instance from this machine image
  • vmMemorySize (int): the recommended memory size (in bytes) to use when provisioning an instance from this machine image
  • forceCheckingDeps (boolean): a boolean flag to enforce checking dependencies during the generation of this machine image
  • entrypoint (string): the Entrypoint of a Docker machine image
  • registeringName (string): the name of the image registered in the registry
  • md5sum (string): the md5sum of the uploaded object
  • mimeType (string): the mime type of the file uploaded
  • sha256sum (string): the sha256 value of the uploaded object
  • size (long): the size (in bytes) of the uploaded object
  • status (status): the upload status (see status)
  • uploaded (boolean): a boolean to indicate if the file has been uploaded
  • uploadedTime (dateTime): the timestamp the upload was completed
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

PublishImageAws

Holds the information on the registration of a machine image to the Amazon Web Services (AWS) environment.

Attributes

The list of attributes for PublishImageAws are:

  • region (string): the region where this machine image is registered
  • cloudId (string): the unique id for the machine image registered on the cloud environment
  • imageUri (anyURI): the uri resource of the machine image
  • publishLocation (string): the location of the registered machine image (e.g. region)
  • parentUri (anyURI): the uri resource of the parent object this machine image was generated from
  • basePublishImagesUri (anyURI): the uri resource to retrieve all the published machine images information (see publishImage)
  • completeInstalledSize (long): estimated disk size to install the machine image (in bytes)
  • completeSize (long): the size (in bytes) of the machine image
  • compress (boolean): a boolean flag to determine if this machine image has been compressed
  • credAccount (credAccount): the cloud account object related to this machine image (see credAccount)
  • distributionName (string): the operating system name this machine image is built upon or requires to run
  • downloadKey (string): the unique download key to download the machine image without authentication (can only be used once)
  • downloadUri (anyURI): the uri resource to download the machine image
  • ebs (boolean): a boolean flag to determine if this machine image should use an EBS volume
  • ebsVolumeSize (int): size of the EBS volume size
  • fileExtension (string): the file extension of the machine image
  • fileName (string): the file name of the machine image
  • fileSize (long): the download size of the machine image (in bytes)
  • format (imageFormat): the primitive format of this machine image
  • targetFormat (targetFormat): the external format of this machine image
  • fullName (string): the complete file name of the machine image
  • imageCreated (boolean): the date this machine im age was generated
  • installProfile (installProfile): the install profile information of this machine image (see installProfile)
  • name (string): the name of this machine image
  • orgUri (anyURI): the uri resource of the organization where this machine image is stored
  • pkgsUri (anyURI): the uri resource to retrieve all the native packages for this machine image (includes packages added after package dependencies have been calculated)
  • revision (int): the revision number of this machine image
  • simulated (boolean): a boolean to indicate whether a dependency checking simulation has been run to determine the definite list of native packages
  • statusUri (anyURI): the uri resource to retrieve the current generation status
  • tag (string): the tag name for this machine image
  • updateTools (boolean): a boolean specific for AWS to determine if AWS should have the ability to update its tools automatcially of a provisioned system from this machine image
  • uri (anyURI): the uri resource of this machine image
  • version (string): the version of this machine image
  • vmDiskSize (long): the recommended disk size (in bytes) to use when provisioning an instance from this machine image
  • vmMemorySize (int): the recommended memory size (in bytes) to use when provisioning an instance from this machine image
  • forceCheckingDeps (boolean): a boolean flag to enforce checking dependencies during the generation of this machine image
  • entrypoint (string): the Entrypoint of a Docker machine image
  • registeringName (string): the name of the image registered in the registry
  • md5sum (string): the md5sum of the uploaded object
  • mimeType (string): the mime type of the file uploaded
  • sha256sum (string): the sha256 value of the uploaded object
  • size (long): the size (in bytes) of the uploaded object
  • status (status): the upload status (see status)
  • uploaded (boolean): a boolean to indicate if the file has been uploaded
  • uploadedTime (dateTime): the timestamp the upload was completed
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

PublishImageAzure

Holds the information on the registration of a machine image to the Microsoft Azure environment.

Attributes

The list of attributes for PublishImageAzure are:

  • storageAccount (string): the storageAccount where this machine image is registered
  • container (string): the container where this machine image is registered
  • resourceGroup (string): the resourceGroup where this machine image is registered
  • blob (string): the blob of the published machine image
  • displayName (string): the cloud name for this machine image
  • region (string): the region where this machine image is registered
  • cloudId (string): the unique id for the machine image registered on the cloud environment
  • imageUri (anyURI): the uri resource of the machine image
  • publishLocation (string): the location of the registered machine image (e.g. region)
  • parentUri (anyURI): the uri resource of the parent object this machine image was generated from
  • basePublishImagesUri (anyURI): the uri resource to retrieve all the published machine images information (see publishImage)
  • completeInstalledSize (long): estimated disk size to install the machine image (in bytes)
  • completeSize (long): the size (in bytes) of the machine image
  • compress (boolean): a boolean flag to determine if this machine image has been compressed
  • credAccount (credAccount): the cloud account object related to this machine image (see credAccount)
  • distributionName (string): the operating system name this machine image is built upon or requires to run
  • downloadKey (string): the unique download key to download the machine image without authentication (can only be used once)
  • downloadUri (anyURI): the uri resource to download the machine image
  • ebs (boolean): a boolean flag to determine if this machine image should use an EBS volume
  • ebsVolumeSize (int): size of the EBS volume size
  • fileExtension (string): the file extension of the machine image
  • fileName (string): the file name of the machine image
  • fileSize (long): the download size of the machine image (in bytes)
  • format (imageFormat): the primitive format of this machine image
  • targetFormat (targetFormat): the external format of this machine image
  • fullName (string): the complete file name of the machine image
  • imageCreated (boolean): the date this machine im age was generated
  • installProfile (installProfile): the install profile information of this machine image (see installProfile)
  • name (string): the name of this machine image
  • orgUri (anyURI): the uri resource of the organization where this machine image is stored
  • pkgsUri (anyURI): the uri resource to retrieve all the native packages for this machine image (includes packages added after package dependencies have been calculated)
  • revision (int): the revision number of this machine image
  • simulated (boolean): a boolean to indicate whether a dependency checking simulation has been run to determine the definite list of native packages
  • statusUri (anyURI): the uri resource to retrieve the current generation status
  • tag (string): the tag name for this machine image
  • updateTools (boolean): a boolean specific for AWS to determine if AWS should have the ability to update its tools automatcially of a provisioned system from this machine image
  • uri (anyURI): the uri resource of this machine image
  • version (string): the version of this machine image
  • vmDiskSize (long): the recommended disk size (in bytes) to use when provisioning an instance from this machine image
  • vmMemorySize (int): the recommended memory size (in bytes) to use when provisioning an instance from this machine image
  • forceCheckingDeps (boolean): a boolean flag to enforce checking dependencies during the generation of this machine image
  • entrypoint (string): the Entrypoint of a Docker machine image
  • registeringName (string): the name of the image registered in the registry
  • md5sum (string): the md5sum of the uploaded object
  • mimeType (string): the mime type of the file uploaded
  • sha256sum (string): the sha256 value of the uploaded object
  • size (long): the size (in bytes) of the uploaded object
  • status (status): the upload status (see status)
  • uploaded (boolean): a boolean to indicate if the file has been uploaded
  • uploadedTime (dateTime): the timestamp the upload was completed
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

PublishImageCloudStack

Holds the information on the registration of a machine image to the CloudStack environment.

Attributes

The list of attributes for PublishImageCloudStack are:

  • description (string): the public description of this machine image
  • displayName (string): the public name displayed for this machine image
  • featuredEnabled (boolean): boolean to indicate whether this machine image is featured
  • passwordEnabled (boolean): boolean to indicate whether a password has been enabled for this machine image
  • publicImage (boolean): boolean to indicate whether this machine image can be used publicly by all users of the CloudStack platform
  • zoneName (string): the zone where this machine image is registered
  • cloudId (string): the unique id for the machine image registered on the cloud environment
  • imageUri (anyURI): the uri resource of the machine image
  • publishLocation (string): the location of the registered machine image (e.g. region)
  • parentUri (anyURI): the uri resource of the parent object this machine image was generated from
  • basePublishImagesUri (anyURI): the uri resource to retrieve all the published machine images information (see publishImage)
  • completeInstalledSize (long): estimated disk size to install the machine image (in bytes)
  • completeSize (long): the size (in bytes) of the machine image
  • compress (boolean): a boolean flag to determine if this machine image has been compressed
  • credAccount (credAccount): the cloud account object related to this machine image (see credAccount)
  • distributionName (string): the operating system name this machine image is built upon or requires to run
  • downloadKey (string): the unique download key to download the machine image without authentication (can only be used once)
  • downloadUri (anyURI): the uri resource to download the machine image
  • ebs (boolean): a boolean flag to determine if this machine image should use an EBS volume
  • ebsVolumeSize (int): size of the EBS volume size
  • fileExtension (string): the file extension of the machine image
  • fileName (string): the file name of the machine image
  • fileSize (long): the download size of the machine image (in bytes)
  • format (imageFormat): the primitive format of this machine image
  • targetFormat (targetFormat): the external format of this machine image
  • fullName (string): the complete file name of the machine image
  • imageCreated (boolean): the date this machine im age was generated
  • installProfile (installProfile): the install profile information of this machine image (see installProfile)
  • name (string): the name of this machine image
  • orgUri (anyURI): the uri resource of the organization where this machine image is stored
  • pkgsUri (anyURI): the uri resource to retrieve all the native packages for this machine image (includes packages added after package dependencies have been calculated)
  • revision (int): the revision number of this machine image
  • simulated (boolean): a boolean to indicate whether a dependency checking simulation has been run to determine the definite list of native packages
  • statusUri (anyURI): the uri resource to retrieve the current generation status
  • tag (string): the tag name for this machine image
  • updateTools (boolean): a boolean specific for AWS to determine if AWS should have the ability to update its tools automatcially of a provisioned system from this machine image
  • uri (anyURI): the uri resource of this machine image
  • version (string): the version of this machine image
  • vmDiskSize (long): the recommended disk size (in bytes) to use when provisioning an instance from this machine image
  • vmMemorySize (int): the recommended memory size (in bytes) to use when provisioning an instance from this machine image
  • forceCheckingDeps (boolean): a boolean flag to enforce checking dependencies during the generation of this machine image
  • entrypoint (string): the Entrypoint of a Docker machine image
  • registeringName (string): the name of the image registered in the registry
  • md5sum (string): the md5sum of the uploaded object
  • mimeType (string): the mime type of the file uploaded
  • sha256sum (string): the sha256 value of the uploaded object
  • size (long): the size (in bytes) of the uploaded object
  • status (status): the upload status (see status)
  • uploaded (boolean): a boolean to indicate if the file has been uploaded
  • uploadedTime (dateTime): the timestamp the upload was completed
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

PublishImageGoogle

Holds the information on the registration of a machine image to the Google Compute Engine (GCE) environment.

Attributes

The list of attributes for PublishImageGoogle are:

  • bucket (string): the bucket name where this machine image is stored
  • bucketLocation (string): the location of the bucket where this machine image is stored
  • diskNamePrefix (string): the disk name prefix used when registering the machine image
  • description (string): the public description of the machine image
  • projectId (string): the project id used for publishing this machine image
  • storageClass (string): the storage class used for publishing this machine image
  • zoneName (string): the zone name used for publishing this machine image
  • cloudId (string): the unique id for the machine image registered on the cloud environment
  • imageUri (anyURI): the uri resource of the machine image
  • publishLocation (string): the location of the registered machine image (e.g. region)
  • parentUri (anyURI): the uri resource of the parent object this machine image was generated from
  • basePublishImagesUri (anyURI): the uri resource to retrieve all the published machine images information (see publishImage)
  • completeInstalledSize (long): estimated disk size to install the machine image (in bytes)
  • completeSize (long): the size (in bytes) of the machine image
  • compress (boolean): a boolean flag to determine if this machine image has been compressed
  • credAccount (credAccount): the cloud account object related to this machine image (see credAccount)
  • distributionName (string): the operating system name this machine image is built upon or requires to run
  • downloadKey (string): the unique download key to download the machine image without authentication (can only be used once)
  • downloadUri (anyURI): the uri resource to download the machine image
  • ebs (boolean): a boolean flag to determine if this machine image should use an EBS volume
  • ebsVolumeSize (int): size of the EBS volume size
  • fileExtension (string): the file extension of the machine image
  • fileName (string): the file name of the machine image
  • fileSize (long): the download size of the machine image (in bytes)
  • format (imageFormat): the primitive format of this machine image
  • targetFormat (targetFormat): the external format of this machine image
  • fullName (string): the complete file name of the machine image
  • imageCreated (boolean): the date this machine im age was generated
  • installProfile (installProfile): the install profile information of this machine image (see installProfile)
  • name (string): the name of this machine image
  • orgUri (anyURI): the uri resource of the organization where this machine image is stored
  • pkgsUri (anyURI): the uri resource to retrieve all the native packages for this machine image (includes packages added after package dependencies have been calculated)
  • revision (int): the revision number of this machine image
  • simulated (boolean): a boolean to indicate whether a dependency checking simulation has been run to determine the definite list of native packages
  • statusUri (anyURI): the uri resource to retrieve the current generation status
  • tag (string): the tag name for this machine image
  • updateTools (boolean): a boolean specific for AWS to determine if AWS should have the ability to update its tools automatcially of a provisioned system from this machine image
  • uri (anyURI): the uri resource of this machine image
  • version (string): the version of this machine image
  • vmDiskSize (long): the recommended disk size (in bytes) to use when provisioning an instance from this machine image
  • vmMemorySize (int): the recommended memory size (in bytes) to use when provisioning an instance from this machine image
  • forceCheckingDeps (boolean): a boolean flag to enforce checking dependencies during the generation of this machine image
  • entrypoint (string): the Entrypoint of a Docker machine image
  • registeringName (string): the name of the image registered in the registry
  • md5sum (string): the md5sum of the uploaded object
  • mimeType (string): the mime type of the file uploaded
  • sha256sum (string): the sha256 value of the uploaded object
  • size (long): the size (in bytes) of the uploaded object
  • status (status): the upload status (see status)
  • uploaded (boolean): a boolean to indicate if the file has been uploaded
  • uploadedTime (dateTime): the timestamp the upload was completed
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

PublishImageOpenStack

Holds the information on the registration of a machine image to the OpenStack environment.

Attributes

The list of attributes for PublishImageOpenStack are:

  • keystoneDomain (string): the keystone domain to use when registering the machine image
  • keystoneProject (string): the keystone project to use when registering the machine image
  • displayName (string): the public name of the machine image
  • publicImage (boolean): boolean indicating whether this machine image is public, allowing any user to use to provision instances
  • tenantName (string): the tenant name to use when registering the machine image
  • cloudId (string): the unique id for the machine image registered on the cloud environment
  • imageUri (anyURI): the uri resource of the machine image
  • publishLocation (string): the location of the registered machine image (e.g. region)
  • parentUri (anyURI): the uri resource of the parent object this machine image was generated from
  • basePublishImagesUri (anyURI): the uri resource to retrieve all the published machine images information (see publishImage)
  • completeInstalledSize (long): estimated disk size to install the machine image (in bytes)
  • completeSize (long): the size (in bytes) of the machine image
  • compress (boolean): a boolean flag to determine if this machine image has been compressed
  • credAccount (credAccount): the cloud account object related to this machine image (see credAccount)
  • distributionName (string): the operating system name this machine image is built upon or requires to run
  • downloadKey (string): the unique download key to download the machine image without authentication (can only be used once)
  • downloadUri (anyURI): the uri resource to download the machine image
  • ebs (boolean): a boolean flag to determine if this machine image should use an EBS volume
  • ebsVolumeSize (int): size of the EBS volume size
  • fileExtension (string): the file extension of the machine image
  • fileName (string): the file name of the machine image
  • fileSize (long): the download size of the machine image (in bytes)
  • format (imageFormat): the primitive format of this machine image
  • targetFormat (targetFormat): the external format of this machine image
  • fullName (string): the complete file name of the machine image
  • imageCreated (boolean): the date this machine im age was generated
  • installProfile (installProfile): the install profile information of this machine image (see installProfile)
  • name (string): the name of this machine image
  • orgUri (anyURI): the uri resource of the organization where this machine image is stored
  • pkgsUri (anyURI): the uri resource to retrieve all the native packages for this machine image (includes packages added after package dependencies have been calculated)
  • revision (int): the revision number of this machine image
  • simulated (boolean): a boolean to indicate whether a dependency checking simulation has been run to determine the definite list of native packages
  • statusUri (anyURI): the uri resource to retrieve the current generation status
  • tag (string): the tag name for this machine image
  • updateTools (boolean): a boolean specific for AWS to determine if AWS should have the ability to update its tools automatcially of a provisioned system from this machine image
  • uri (anyURI): the uri resource of this machine image
  • version (string): the version of this machine image
  • vmDiskSize (long): the recommended disk size (in bytes) to use when provisioning an instance from this machine image
  • vmMemorySize (int): the recommended memory size (in bytes) to use when provisioning an instance from this machine image
  • forceCheckingDeps (boolean): a boolean flag to enforce checking dependencies during the generation of this machine image
  • entrypoint (string): the Entrypoint of a Docker machine image
  • registeringName (string): the name of the image registered in the registry
  • md5sum (string): the md5sum of the uploaded object
  • mimeType (string): the mime type of the file uploaded
  • sha256sum (string): the sha256 value of the uploaded object
  • size (long): the size (in bytes) of the uploaded object
  • status (status): the upload status (see status)
  • uploaded (boolean): a boolean to indicate if the file has been uploaded
  • uploadedTime (dateTime): the timestamp the upload was completed
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

PublishImageOutscale

Holds the information on the registration of a machine image to the Outscale environment.

Attributes

The list of attributes for PublishImageOutscale are:

  • bucket (string): the bucket used to store the registered machine image
  • region (string): the region used to store the registered machine image
  • cloudId (string): the unique id for the machine image registered on the cloud environment
  • imageUri (anyURI): the uri resource of the machine image
  • publishLocation (string): the location of the registered machine image (e.g. region)
  • parentUri (anyURI): the uri resource of the parent object this machine image was generated from
  • basePublishImagesUri (anyURI): the uri resource to retrieve all the published machine images information (see publishImage)
  • completeInstalledSize (long): estimated disk size to install the machine image (in bytes)
  • completeSize (long): the size (in bytes) of the machine image
  • compress (boolean): a boolean flag to determine if this machine image has been compressed
  • credAccount (credAccount): the cloud account object related to this machine image (see credAccount)
  • distributionName (string): the operating system name this machine image is built upon or requires to run
  • downloadKey (string): the unique download key to download the machine image without authentication (can only be used once)
  • downloadUri (anyURI): the uri resource to download the machine image
  • ebs (boolean): a boolean flag to determine if this machine image should use an EBS volume
  • ebsVolumeSize (int): size of the EBS volume size
  • fileExtension (string): the file extension of the machine image
  • fileName (string): the file name of the machine image
  • fileSize (long): the download size of the machine image (in bytes)
  • format (imageFormat): the primitive format of this machine image
  • targetFormat (targetFormat): the external format of this machine image
  • fullName (string): the complete file name of the machine image
  • imageCreated (boolean): the date this machine im age was generated
  • installProfile (installProfile): the install profile information of this machine image (see installProfile)
  • name (string): the name of this machine image
  • orgUri (anyURI): the uri resource of the organization where this machine image is stored
  • pkgsUri (anyURI): the uri resource to retrieve all the native packages for this machine image (includes packages added after package dependencies have been calculated)
  • revision (int): the revision number of this machine image
  • simulated (boolean): a boolean to indicate whether a dependency checking simulation has been run to determine the definite list of native packages
  • statusUri (anyURI): the uri resource to retrieve the current generation status
  • tag (string): the tag name for this machine image
  • updateTools (boolean): a boolean specific for AWS to determine if AWS should have the ability to update its tools automatcially of a provisioned system from this machine image
  • uri (anyURI): the uri resource of this machine image
  • version (string): the version of this machine image
  • vmDiskSize (long): the recommended disk size (in bytes) to use when provisioning an instance from this machine image
  • vmMemorySize (int): the recommended memory size (in bytes) to use when provisioning an instance from this machine image
  • forceCheckingDeps (boolean): a boolean flag to enforce checking dependencies during the generation of this machine image
  • entrypoint (string): the Entrypoint of a Docker machine image
  • registeringName (string): the name of the image registered in the registry
  • md5sum (string): the md5sum of the uploaded object
  • mimeType (string): the mime type of the file uploaded
  • sha256sum (string): the sha256 value of the uploaded object
  • size (long): the size (in bytes) of the uploaded object
  • status (status): the upload status (see status)
  • uploaded (boolean): a boolean to indicate if the file has been uploaded
  • uploadedTime (dateTime): the timestamp the upload was completed
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

PublishImageSuseCloud

Holds the information on the registration of a machine image to the SuseCloud environment.

Attributes

The list of attributes for PublishImageSuseCloud are:

  • keystoneDomain (string): the keystone domain to use when registering the machine image
  • keystoneProject (string): the keystone project to use when registering the machine image
  • displayName (string): the public name of the machine image
  • publicImage (boolean): boolean indicating whether this machine image is public, allowing any user to use to provision instances
  • tenantName (string): the tenant name to use when registering the machine image
  • cloudId (string): the unique id for the machine image registered on the cloud environment
  • imageUri (anyURI): the uri resource of the machine image
  • publishLocation (string): the location of the registered machine image (e.g. region)
  • parentUri (anyURI): the uri resource of the parent object this machine image was generated from
  • basePublishImagesUri (anyURI): the uri resource to retrieve all the published machine images information (see publishImage)
  • completeInstalledSize (long): estimated disk size to install the machine image (in bytes)
  • completeSize (long): the size (in bytes) of the machine image
  • compress (boolean): a boolean flag to determine if this machine image has been compressed
  • credAccount (credAccount): the cloud account object related to this machine image (see credAccount)
  • distributionName (string): the operating system name this machine image is built upon or requires to run
  • downloadKey (string): the unique download key to download the machine image without authentication (can only be used once)
  • downloadUri (anyURI): the uri resource to download the machine image
  • ebs (boolean): a boolean flag to determine if this machine image should use an EBS volume
  • ebsVolumeSize (int): size of the EBS volume size
  • fileExtension (string): the file extension of the machine image
  • fileName (string): the file name of the machine image
  • fileSize (long): the download size of the machine image (in bytes)
  • format (imageFormat): the primitive format of this machine image
  • targetFormat (targetFormat): the external format of this machine image
  • fullName (string): the complete file name of the machine image
  • imageCreated (boolean): the date this machine im age was generated
  • installProfile (installProfile): the install profile information of this machine image (see installProfile)
  • name (string): the name of this machine image
  • orgUri (anyURI): the uri resource of the organization where this machine image is stored
  • pkgsUri (anyURI): the uri resource to retrieve all the native packages for this machine image (includes packages added after package dependencies have been calculated)
  • revision (int): the revision number of this machine image
  • simulated (boolean): a boolean to indicate whether a dependency checking simulation has been run to determine the definite list of native packages
  • statusUri (anyURI): the uri resource to retrieve the current generation status
  • tag (string): the tag name for this machine image
  • updateTools (boolean): a boolean specific for AWS to determine if AWS should have the ability to update its tools automatcially of a provisioned system from this machine image
  • uri (anyURI): the uri resource of this machine image
  • version (string): the version of this machine image
  • vmDiskSize (long): the recommended disk size (in bytes) to use when provisioning an instance from this machine image
  • vmMemorySize (int): the recommended memory size (in bytes) to use when provisioning an instance from this machine image
  • forceCheckingDeps (boolean): a boolean flag to enforce checking dependencies during the generation of this machine image
  • entrypoint (string): the Entrypoint of a Docker machine image
  • registeringName (string): the name of the image registered in the registry
  • md5sum (string): the md5sum of the uploaded object
  • mimeType (string): the mime type of the file uploaded
  • sha256sum (string): the sha256 value of the uploaded object
  • size (long): the size (in bytes) of the uploaded object
  • status (status): the upload status (see status)
  • uploaded (boolean): a boolean to indicate if the file has been uploaded
  • uploadedTime (dateTime): the timestamp the upload was completed
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

PublishImageVCloudDirector

Holds the information on the registration of a machine image to the VMware vCloud Director environment.

Attributes

The list of attributes for PublishImageVCloudDirector are:

  • catalogName (string): the catalog name to use when registering the machine image
  • displayName (string): the public name of the registered machine image
  • vdcName (string): the virtual datacenter where to register the machine image
  • cloudId (string): the unique id for the machine image registered on the cloud environment
  • imageUri (anyURI): the uri resource of the machine image
  • publishLocation (string): the location of the registered machine image (e.g. region)
  • parentUri (anyURI): the uri resource of the parent object this machine image was generated from
  • basePublishImagesUri (anyURI): the uri resource to retrieve all the published machine images information (see publishImage)
  • completeInstalledSize (long): estimated disk size to install the machine image (in bytes)
  • completeSize (long): the size (in bytes) of the machine image
  • compress (boolean): a boolean flag to determine if this machine image has been compressed
  • credAccount (credAccount): the cloud account object related to this machine image (see credAccount)
  • distributionName (string): the operating system name this machine image is built upon or requires to run
  • downloadKey (string): the unique download key to download the machine image without authentication (can only be used once)
  • downloadUri (anyURI): the uri resource to download the machine image
  • ebs (boolean): a boolean flag to determine if this machine image should use an EBS volume
  • ebsVolumeSize (int): size of the EBS volume size
  • fileExtension (string): the file extension of the machine image
  • fileName (string): the file name of the machine image
  • fileSize (long): the download size of the machine image (in bytes)
  • format (imageFormat): the primitive format of this machine image
  • targetFormat (targetFormat): the external format of this machine image
  • fullName (string): the complete file name of the machine image
  • imageCreated (boolean): the date this machine im age was generated
  • installProfile (installProfile): the install profile information of this machine image (see installProfile)
  • name (string): the name of this machine image
  • orgUri (anyURI): the uri resource of the organization where this machine image is stored
  • pkgsUri (anyURI): the uri resource to retrieve all the native packages for this machine image (includes packages added after package dependencies have been calculated)
  • revision (int): the revision number of this machine image
  • simulated (boolean): a boolean to indicate whether a dependency checking simulation has been run to determine the definite list of native packages
  • statusUri (anyURI): the uri resource to retrieve the current generation status
  • tag (string): the tag name for this machine image
  • updateTools (boolean): a boolean specific for AWS to determine if AWS should have the ability to update its tools automatcially of a provisioned system from this machine image
  • uri (anyURI): the uri resource of this machine image
  • version (string): the version of this machine image
  • vmDiskSize (long): the recommended disk size (in bytes) to use when provisioning an instance from this machine image
  • vmMemorySize (int): the recommended memory size (in bytes) to use when provisioning an instance from this machine image
  • forceCheckingDeps (boolean): a boolean flag to enforce checking dependencies during the generation of this machine image
  • entrypoint (string): the Entrypoint of a Docker machine image
  • registeringName (string): the name of the image registered in the registry
  • md5sum (string): the md5sum of the uploaded object
  • mimeType (string): the mime type of the file uploaded
  • sha256sum (string): the sha256 value of the uploaded object
  • size (long): the size (in bytes) of the uploaded object
  • status (status): the upload status (see status)
  • uploaded (boolean): a boolean to indicate if the file has been uploaded
  • uploadedTime (dateTime): the timestamp the upload was completed
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

PublishImageVSphere

Holds the information on the registration of a template to the VMware vSphere vCenter environment.

Attributes

The list of attributes for PublishImageVSphere are:

  • datastore (string): the datastore where to register the template
  • displayName (string): the public name of the registered template
  • esxHost (string): the hostname or IP address of the ESX server
  • network (string): the network where to register the template
  • cloudId (string): the unique id for the machine image registered on the cloud environment
  • imageUri (anyURI): the uri resource of the machine image
  • publishLocation (string): the location of the registered machine image (e.g. region)
  • parentUri (anyURI): the uri resource of the parent object this machine image was generated from
  • basePublishImagesUri (anyURI): the uri resource to retrieve all the published machine images information (see publishImage)
  • completeInstalledSize (long): estimated disk size to install the machine image (in bytes)
  • completeSize (long): the size (in bytes) of the machine image
  • compress (boolean): a boolean flag to determine if this machine image has been compressed
  • credAccount (credAccount): the cloud account object related to this machine image (see credAccount)
  • distributionName (string): the operating system name this machine image is built upon or requires to run
  • downloadKey (string): the unique download key to download the machine image without authentication (can only be used once)
  • downloadUri (anyURI): the uri resource to download the machine image
  • ebs (boolean): a boolean flag to determine if this machine image should use an EBS volume
  • ebsVolumeSize (int): size of the EBS volume size
  • fileExtension (string): the file extension of the machine image
  • fileName (string): the file name of the machine image
  • fileSize (long): the download size of the machine image (in bytes)
  • format (imageFormat): the primitive format of this machine image
  • targetFormat (targetFormat): the external format of this machine image
  • fullName (string): the complete file name of the machine image
  • imageCreated (boolean): the date this machine im age was generated
  • installProfile (installProfile): the install profile information of this machine image (see installProfile)
  • name (string): the name of this machine image
  • orgUri (anyURI): the uri resource of the organization where this machine image is stored
  • pkgsUri (anyURI): the uri resource to retrieve all the native packages for this machine image (includes packages added after package dependencies have been calculated)
  • revision (int): the revision number of this machine image
  • simulated (boolean): a boolean to indicate whether a dependency checking simulation has been run to determine the definite list of native packages
  • statusUri (anyURI): the uri resource to retrieve the current generation status
  • tag (string): the tag name for this machine image
  • updateTools (boolean): a boolean specific for AWS to determine if AWS should have the ability to update its tools automatcially of a provisioned system from this machine image
  • uri (anyURI): the uri resource of this machine image
  • version (string): the version of this machine image
  • vmDiskSize (long): the recommended disk size (in bytes) to use when provisioning an instance from this machine image
  • vmMemorySize (int): the recommended memory size (in bytes) to use when provisioning an instance from this machine image
  • forceCheckingDeps (boolean): a boolean flag to enforce checking dependencies during the generation of this machine image
  • entrypoint (string): the Entrypoint of a Docker machine image
  • registeringName (string): the name of the image registered in the registry
  • md5sum (string): the md5sum of the uploaded object
  • mimeType (string): the mime type of the file uploaded
  • sha256sum (string): the sha256 value of the uploaded object
  • size (long): the size (in bytes) of the uploaded object
  • status (status): the upload status (see status)
  • uploaded (boolean): a boolean to indicate if the file has been uploaded
  • uploadedTime (dateTime): the timestamp the upload was completed
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

PublishImageK5

Holds the information on the registration of a machine image to the K5 environment.

Attributes

The list of attributes for PublishImageK5 are:

  • keystoneDomain (string): the keystone domain to use when registering the machine image
  • keystoneProject (string): the keystone project to use when registering the machine image
  • displayName (string): the public name of the machine image
  • cloudId (string): the unique id for the machine image registered on the cloud environment
  • imageUri (anyURI): the uri resource of the machine image
  • publishLocation (string): the location of the registered machine image (e.g. region)
  • parentUri (anyURI): the uri resource of the parent object this machine image was generated from
  • basePublishImagesUri (anyURI): the uri resource to retrieve all the published machine images information (see publishImage)
  • completeInstalledSize (long): estimated disk size to install the machine image (in bytes)
  • completeSize (long): the size (in bytes) of the machine image
  • compress (boolean): a boolean flag to determine if this machine image has been compressed
  • credAccount (credAccount): the cloud account object related to this machine image (see credAccount)
  • distributionName (string): the operating system name this machine image is built upon or requires to run
  • downloadKey (string): the unique download key to download the machine image without authentication (can only be used once)
  • downloadUri (anyURI): the uri resource to download the machine image
  • ebs (boolean): a boolean flag to determine if this machine image should use an EBS volume
  • ebsVolumeSize (int): size of the EBS volume size
  • fileExtension (string): the file extension of the machine image
  • fileName (string): the file name of the machine image
  • fileSize (long): the download size of the machine image (in bytes)
  • format (imageFormat): the primitive format of this machine image
  • targetFormat (targetFormat): the external format of this machine image
  • fullName (string): the complete file name of the machine image
  • imageCreated (boolean): the date this machine im age was generated
  • installProfile (installProfile): the install profile information of this machine image (see installProfile)
  • name (string): the name of this machine image
  • orgUri (anyURI): the uri resource of the organization where this machine image is stored
  • pkgsUri (anyURI): the uri resource to retrieve all the native packages for this machine image (includes packages added after package dependencies have been calculated)
  • revision (int): the revision number of this machine image
  • simulated (boolean): a boolean to indicate whether a dependency checking simulation has been run to determine the definite list of native packages
  • statusUri (anyURI): the uri resource to retrieve the current generation status
  • tag (string): the tag name for this machine image
  • updateTools (boolean): a boolean specific for AWS to determine if AWS should have the ability to update its tools automatcially of a provisioned system from this machine image
  • uri (anyURI): the uri resource of this machine image
  • version (string): the version of this machine image
  • vmDiskSize (long): the recommended disk size (in bytes) to use when provisioning an instance from this machine image
  • vmMemorySize (int): the recommended memory size (in bytes) to use when provisioning an instance from this machine image
  • forceCheckingDeps (boolean): a boolean flag to enforce checking dependencies during the generation of this machine image
  • entrypoint (string): the Entrypoint of a Docker machine image
  • registeringName (string): the name of the image registered in the registry
  • md5sum (string): the md5sum of the uploaded object
  • mimeType (string): the mime type of the file uploaded
  • sha256sum (string): the sha256 value of the uploaded object
  • size (long): the size (in bytes) of the uploaded object
  • status (status): the upload status (see status)
  • uploaded (boolean): a boolean to indicate if the file has been uploaded
  • uploadedTime (dateTime): the timestamp the upload was completed
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

PublishImageDocker

Holds the information on the registration of a machine image to a Docker Registry.

Attributes

The list of attributes for PublishImageDocker are:

  • namespace (string): the namespace to use when registering the machine image
  • repositoryName (string): the name to use when registering the machine image
  • tagName (string): the tag name to use when registering the machine image
  • cloudId (string): the unique id for the machine image registered on the cloud environment
  • imageUri (anyURI): the uri resource of the machine image
  • publishLocation (string): the location of the registered machine image (e.g. region)
  • parentUri (anyURI): the uri resource of the parent object this machine image was generated from
  • basePublishImagesUri (anyURI): the uri resource to retrieve all the published machine images information (see publishImage)
  • completeInstalledSize (long): estimated disk size to install the machine image (in bytes)
  • completeSize (long): the size (in bytes) of the machine image
  • compress (boolean): a boolean flag to determine if this machine image has been compressed
  • credAccount (credAccount): the cloud account object related to this machine image (see credAccount)
  • distributionName (string): the operating system name this machine image is built upon or requires to run
  • downloadKey (string): the unique download key to download the machine image without authentication (can only be used once)
  • downloadUri (anyURI): the uri resource to download the machine image
  • ebs (boolean): a boolean flag to determine if this machine image should use an EBS volume
  • ebsVolumeSize (int): size of the EBS volume size
  • fileExtension (string): the file extension of the machine image
  • fileName (string): the file name of the machine image
  • fileSize (long): the download size of the machine image (in bytes)
  • format (imageFormat): the primitive format of this machine image
  • targetFormat (targetFormat): the external format of this machine image
  • fullName (string): the complete file name of the machine image
  • imageCreated (boolean): the date this machine im age was generated
  • installProfile (installProfile): the install profile information of this machine image (see installProfile)
  • name (string): the name of this machine image
  • orgUri (anyURI): the uri resource of the organization where this machine image is stored
  • pkgsUri (anyURI): the uri resource to retrieve all the native packages for this machine image (includes packages added after package dependencies have been calculated)
  • revision (int): the revision number of this machine image
  • simulated (boolean): a boolean to indicate whether a dependency checking simulation has been run to determine the definite list of native packages
  • statusUri (anyURI): the uri resource to retrieve the current generation status
  • tag (string): the tag name for this machine image
  • updateTools (boolean): a boolean specific for AWS to determine if AWS should have the ability to update its tools automatcially of a provisioned system from this machine image
  • uri (anyURI): the uri resource of this machine image
  • version (string): the version of this machine image
  • vmDiskSize (long): the recommended disk size (in bytes) to use when provisioning an instance from this machine image
  • vmMemorySize (int): the recommended memory size (in bytes) to use when provisioning an instance from this machine image
  • forceCheckingDeps (boolean): a boolean flag to enforce checking dependencies during the generation of this machine image
  • entrypoint (string): the Entrypoint of a Docker machine image
  • registeringName (string): the name of the image registered in the registry
  • md5sum (string): the md5sum of the uploaded object
  • mimeType (string): the mime type of the file uploaded
  • sha256sum (string): the sha256 value of the uploaded object
  • size (long): the size (in bytes) of the uploaded object
  • status (status): the upload status (see status)
  • uploaded (boolean): a boolean to indicate if the file has been uploaded
  • uploadedTime (dateTime): the timestamp the upload was completed
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

PublishImageOpenShift

Holds the information on the registration of a machine image to OpenShift Registry.

Attributes

The list of attributes for PublishImageOpenShift are:

  • namespace (string): the namespace to use when registering the machine image
  • repositoryName (string): the name to use when registering the machine image
  • tagName (string): the tag name to use when registering the machine image
  • cloudId (string): the unique id for the machine image registered on the cloud environment
  • imageUri (anyURI): the uri resource of the machine image
  • publishLocation (string): the location of the registered machine image (e.g. region)
  • parentUri (anyURI): the uri resource of the parent object this machine image was generated from
  • basePublishImagesUri (anyURI): the uri resource to retrieve all the published machine images information (see publishImage)
  • completeInstalledSize (long): estimated disk size to install the machine image (in bytes)
  • completeSize (long): the size (in bytes) of the machine image
  • compress (boolean): a boolean flag to determine if this machine image has been compressed
  • credAccount (credAccount): the cloud account object related to this machine image (see credAccount)
  • distributionName (string): the operating system name this machine image is built upon or requires to run
  • downloadKey (string): the unique download key to download the machine image without authentication (can only be used once)
  • downloadUri (anyURI): the uri resource to download the machine image
  • ebs (boolean): a boolean flag to determine if this machine image should use an EBS volume
  • ebsVolumeSize (int): size of the EBS volume size
  • fileExtension (string): the file extension of the machine image
  • fileName (string): the file name of the machine image
  • fileSize (long): the download size of the machine image (in bytes)
  • format (imageFormat): the primitive format of this machine image
  • targetFormat (targetFormat): the external format of this machine image
  • fullName (string): the complete file name of the machine image
  • imageCreated (boolean): the date this machine im age was generated
  • installProfile (installProfile): the install profile information of this machine image (see installProfile)
  • name (string): the name of this machine image
  • orgUri (anyURI): the uri resource of the organization where this machine image is stored
  • pkgsUri (anyURI): the uri resource to retrieve all the native packages for this machine image (includes packages added after package dependencies have been calculated)
  • revision (int): the revision number of this machine image
  • simulated (boolean): a boolean to indicate whether a dependency checking simulation has been run to determine the definite list of native packages
  • statusUri (anyURI): the uri resource to retrieve the current generation status
  • tag (string): the tag name for this machine image
  • updateTools (boolean): a boolean specific for AWS to determine if AWS should have the ability to update its tools automatcially of a provisioned system from this machine image
  • uri (anyURI): the uri resource of this machine image
  • version (string): the version of this machine image
  • vmDiskSize (long): the recommended disk size (in bytes) to use when provisioning an instance from this machine image
  • vmMemorySize (int): the recommended memory size (in bytes) to use when provisioning an instance from this machine image
  • forceCheckingDeps (boolean): a boolean flag to enforce checking dependencies during the generation of this machine image
  • entrypoint (string): the Entrypoint of a Docker machine image
  • registeringName (string): the name of the image registered in the registry
  • md5sum (string): the md5sum of the uploaded object
  • mimeType (string): the mime type of the file uploaded
  • sha256sum (string): the sha256 value of the uploaded object
  • size (long): the size (in bytes) of the uploaded object
  • status (status): the upload status (see status)
  • uploaded (boolean): a boolean to indicate if the file has been uploaded
  • uploadedTime (dateTime): the timestamp the upload was completed
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

PublishImageOracle

Holds the information on the registration of a machine image to the Oracle Cloud environment.

Attributes

The list of attributes for PublishImageOracle are:

  • computeEndPoint (string): the compute EndPoint URL to use when publishing the machine image
  • displayName (string): the public name of the machine image
  • cloudId (string): the unique id for the machine image registered on the cloud environment
  • imageUri (anyURI): the uri resource of the machine image
  • publishLocation (string): the location of the registered machine image (e.g. region)
  • parentUri (anyURI): the uri resource of the parent object this machine image was generated from
  • basePublishImagesUri (anyURI): the uri resource to retrieve all the published machine images information (see publishImage)
  • completeInstalledSize (long): estimated disk size to install the machine image (in bytes)
  • completeSize (long): the size (in bytes) of the machine image
  • compress (boolean): a boolean flag to determine if this machine image has been compressed
  • credAccount (credAccount): the cloud account object related to this machine image (see credAccount)
  • distributionName (string): the operating system name this machine image is built upon or requires to run
  • downloadKey (string): the unique download key to download the machine image without authentication (can only be used once)
  • downloadUri (anyURI): the uri resource to download the machine image
  • ebs (boolean): a boolean flag to determine if this machine image should use an EBS volume
  • ebsVolumeSize (int): size of the EBS volume size
  • fileExtension (string): the file extension of the machine image
  • fileName (string): the file name of the machine image
  • fileSize (long): the download size of the machine image (in bytes)
  • format (imageFormat): the primitive format of this machine image
  • targetFormat (targetFormat): the external format of this machine image
  • fullName (string): the complete file name of the machine image
  • imageCreated (boolean): the date this machine im age was generated
  • installProfile (installProfile): the install profile information of this machine image (see installProfile)
  • name (string): the name of this machine image
  • orgUri (anyURI): the uri resource of the organization where this machine image is stored
  • pkgsUri (anyURI): the uri resource to retrieve all the native packages for this machine image (includes packages added after package dependencies have been calculated)
  • revision (int): the revision number of this machine image
  • simulated (boolean): a boolean to indicate whether a dependency checking simulation has been run to determine the definite list of native packages
  • statusUri (anyURI): the uri resource to retrieve the current generation status
  • tag (string): the tag name for this machine image
  • updateTools (boolean): a boolean specific for AWS to determine if AWS should have the ability to update its tools automatcially of a provisioned system from this machine image
  • uri (anyURI): the uri resource of this machine image
  • version (string): the version of this machine image
  • vmDiskSize (long): the recommended disk size (in bytes) to use when provisioning an instance from this machine image
  • vmMemorySize (int): the recommended memory size (in bytes) to use when provisioning an instance from this machine image
  • forceCheckingDeps (boolean): a boolean flag to enforce checking dependencies during the generation of this machine image
  • entrypoint (string): the Entrypoint of a Docker machine image
  • registeringName (string): the name of the image registered in the registry
  • md5sum (string): the md5sum of the uploaded object
  • mimeType (string): the mime type of the file uploaded
  • sha256sum (string): the sha256 value of the uploaded object
  • size (long): the size (in bytes) of the uploaded object
  • status (status): the upload status (see status)
  • uploaded (boolean): a boolean to indicate if the file has been uploaded
  • uploadedTime (dateTime): the timestamp the upload was completed
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

publishImages

Provides a list of publishImage objects.

Attributes

The list of attributes for publishImages are:

  • publishImages: the list of publishImage objects
  • total (long): the total number of objects

quota

Provides information on quota used to restrict user usage.

Attributes

The list of attributes for quota are:

  • frequency: whether the quota should be reset at a certain frequency (only monthly is supported at the moment)
  • limit (long): the quota limit
  • nb (long): the current number
  • renewalDate (dateTime): the renewal date of the quota
  • type: the quota type
  • typeId (int): the id of the type
  • uri (anyURI): the uri resource of this quota object
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

quotas

Provides a list of quota objects.

Attributes

The list of attributes for quotas are:

  • quotas: the list of quota objects
  • total (long): the total number of objects

referral

Provides information on an invitation’s status.

Attributes

The list of attributes for referral are:

  • accepted (boolean): a boolean indicating whether the invitation has been accepted
  • declined (boolean): a boolean indicating whether the invitation has been declined
  • msg (string): a message included in the invitation
  • parentUri (anyURI): the uri resource of the parent object this object belongs to
  • referrer (userProfile): the user creating the invitation
  • uri (anyURI): the uri resource of this object
  • user (userProfile): the user being invited
  • userEmail (string): the email of the user being invited
  • userLogin (string): the username of the user being invited
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

referrals

Provides a list of referral objects.

Attributes

The list of attributes for referrals are:

  • referrals: the list of referral objects
  • total (long): the total number of objects

repository

Describes an operating system repository registered on the platform.

Attributes

The list of attributes for repository are:

  • name (string): the name of the repository
  • parentUri (anyURI): the uri resource of the parent object this repository object belongs to
  • uri (anyURI): the uri resource of this repository object
  • distributionsUri (anyURI): the uri resource to retrieve the operating system(s) of this repository (may contain minor versions)
  • url (string): the URL endpoint of this repository
  • packagingType: the package type ths repository holds
  • lastUpdated (dateTime): the date this repository last received a package update
  • coreRepository (boolean): boolean indicating when the repository is mandatory for a distribution to function properly.
  • officiallySupported (boolean): DEPRECATED, will be removed in a future release. Use “coreRepository” instead.
  • distributionsUriList (UriList): the list of uri resources for each operating system contained in this repository
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

repositories

Provides a list of repository objects.

Attributes

The list of attributes for repositories are:

  • repositories: the list of repository objects
  • total (long): the total number of objects

repositoryUpdate

Object holding the update information of a repository.

Attributes

The list of attributes for repositoryUpdate are:

  • uri (anyURI): the uri resource of this repository update object
  • status (status): the current status of the update
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

repositoryUpdates

Provides a list of repositoryUpdate objects.

Attributes

The list of attributes for repositoryUpdates are:

  • repositoryUpdates: the list of repositoryUpdate objects
  • total (long): the total number of objects

role

Describes a role used for Role-Based Access Control (RBAC). A role groups together a list of entitlements (see entitlement.)

A role can then be assigned to an user to enforce access rights.

Attributes

The list of attributes for role are:

  • name (string): the role name
  • description (string): the role description
  • entitlements: the list of entitlements this role contains (see entitlement
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

roles

Provides a list of role objects.

Attributes

The list of attributes for roles are:

  • roles: the list of role objects
  • total (long): the total number of objects

route

Describes a networking route. Used as part of a NIC.

Attributes

The list of attributes for route are:

  • address (string): the IP address
  • gateway (string): the gateway value
  • metric (int): the metric value
  • netmask (string): the netmask value
  • parentUri (anyURI): the uri resource of the parent object this route is attached to
  • uri (anyURI): the uri resource of this route
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

scan

Holds all the meta-data of a scan. This is the report information after scanning a live system.

Attributes

The list of attributes for scan are:

  • images: a list of image objects that have been generated from this scan report
  • imports: a list of scanImport objects that have been imported from this scan report
  • unixServices: a list of unixService objects that represent Unix services on the scanned machine
  • winServices: a list of winService objects that represent Windows services on the scanned machine
  • winApplications: a list of winMsiApplication and winStoreApplication objects that represent Windows applications on the scanned machine
  • packages: the list of package objects listed in the scan report
  • binariesExtracted (boolean): a boolean flag determining of the overall has been extracted by the platform
  • binariesReceived (boolean): a boolean flag determining of the overall has been received by the platform
  • error (boolean): a boolean flag to indicate an error during the scan process
  • errorMsg (string): the error message
  • filesUri (anyURI): a uri resource to retrieve all the filesystem files reported by the scan process
  • imagesUri (anyURI): the uri resource to retrieve all the machine images generated from this scan report
  • osConfig (osConfig): osconfig-object of the scan
  • importsUri (anyURI): the uri resource to retrieve all the imports
  • goldenImportsUri (anyURI): the uri resource to retrieve all the golden imports
  • installProfile (installProfile): the install profile of the scanned system
  • installProfileUri (anyURI): the uri resource of the installProfile
  • scanSyncUri (anyURI): the uri resource of the scanSync
  • name (string): the scan name
  • overlayCrc (string): the crc of the scan overlay archive
  • overlayImported (boolean): a boolean indicating whether the overlay has been imported on the platform
  • overlayUri (anyURI): the uri resource to upload the overlay
  • rawPartitionsUri (anyURI): the uri resource to upload the raw partitions (only for Windows source machines)
  • packagesUri (anyURI): the uri resource to retrieve all the meta data of the scanned packages
  • scanned (boolean): a boolean indicating if the scan report has been received from the scan agent on the source machine
  • scannedInstanceUri (anyURI): the uri of the parent scanned instance
  • status (status): the status of the scan
  • totalFilesAdded (int): the number of extra files found in the scan report
  • totalFilesDeleted (int): the number of files that have been deleted in source machine installed packages
  • totalFilesModified (int): the number of files that have been modified in the source machine installed packages
  • totalPackages (int): the number of native packages installed on the source machine
  • uncompressedBinarySize (long): the size of all the overlays
  • uri (anyURI): the uri of the scan
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

scanCompare

Holds all the results of a comparison between two scans.

Attributes

The list of attributes for scanCompare are:

  • extraFiles: a list of scannedFile files that are not part of any native package on the file system
  • filesUri (anyURI): a uri resource to retrieve all the filesystem files reported by the scan process
  • scanAUri (anyURI): the uri of the first scan to compare
  • scanBUri (anyURI): the uri of the second scan to compare
  • packages: the list of package objects listed in the scan report
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

scanImport

Holds the information of the transformation process from a scan report to an appliance template or a golden image.

Attributes

The list of attributes for scanImport are:

  • importedObjectName (string): the name of the imported appliance or golden. This name won’t be updated even if the name of the imported object gets changed
  • importedObjectUri (anyURI): the URI of the imported appliance or golden. This URI could be deprecated in case the imported object is deleted.
  • importedObjectVersion (string): the version of the imported appliance or golden. This version won’t be updated even if the version of the imported object gets changed
  • importedObjectDescription (string): the description of the imported golden only. This description won’t be updated even if the description of the imported golden gets changed
  • orgUri (anyURI): the uri of the Organization where the scan has been imported
  • parentUri (anyURI): the parent uri of the scan import
  • status (status): the status of the import
  • uri (anyURI): the uri of the scan import
  • importedToGolden (boolean): a boolean indicating if the imported object is a golden image. If set to false the imported object is an appliance template
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

scanImports

Provides a list of scanImport objects.

Attributes

The list of attributes for scanImports are:

  • scanImports: the list of scanImport objects
  • total (long): the total number of objects

scannedFile

Holds the meta-data of a file discovered on the file system after a scan process.

Attributes

The list of attributes for scannedFile are:

  • deleted (boolean): a boolean indicating if the file has been deleted on the source machine
  • inherited (boolean): a boolean indicating if this file has already been found, with the same metadata and content, in an other scan of the same scanned instance
  • selected (boolean): a boolean indicating if this file has been selected to be imported as part of the overlay
  • uploaded (boolean): a boolean indicating if this file has been received as part of the overlay upload
  • changeType: the change type of the file
  • checksum (string): the sha256 checksum value of the file
  • directory (boolean): boolean flag determining if this file is a directory
  • fullPath (string): the full canonical pathname of the file
  • group (string): the group name for this file (access)
  • linkTarget (string): the destination of a soft or hard link in a filesystem
  • name (string): the name of this file
  • owner (string): the filesystem owner of the file
  • parentUri (anyURI): the uri resource of the parent object this file entry is attached to
  • permissions (string): the file permissions
  • scannedInstanceId (long): the id of the parent scanned instance this object belongs to (see scannedInstance)
  • size (long): the size (in bytes) of this file
  • subEntries (long): the number of files if this file entry is a directory
  • uri (string): the uri resource of this file entry object
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

scannedFiles

Provides a list of scannedFile objects.

Attributes

The list of attributes for scannedFiles are:

  • scannedFiles: the list of scannedFile objects
  • total (long): the total number of objects

directoryStructure

Holds the meta-data of a directory on the file system.

Attributes

The list of attributes for directoryStructure are:

  • id (string): the id of the directory
  • path (string): the path of the directory
  • subDirectories: the list of sub directories
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

scannedDirectory

Holds the meta-data of a directory discovered on the file system after a scan process.

Attributes

The list of attributes for scannedDirectory are:

  • changeType: the change type of the directory
  • owner (string): the owner of the directory
  • group (string): the group of the directory
  • permissions (string): the permissions of the directory
  • sumAdded (long): the sum of added files in the directory
  • sumChanged (long): the sum of changed files in the directory
  • sumDeleted (long): the sum of deleted files in the directory
  • files: the list of scanned files in the directorie
  • id (string): the id of the directory
  • path (string): the path of the directory
  • subDirectories: the list of sub directories
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

scanSync

Handles synchronization information for files belonging to a scan.

Attributes

The list of attributes for scanSync are:

  • uri (anyURI): the uri resource of this synchronization object
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

scanFilesToSynchronize

Provides a list of full paths of scanned files to be synchronized from the scanSync object.

Attributes

The list of attributes for scanFilesToSynchronize are:

  • scanFilesToSynchronize: the list of full paths of scanned files to be synchronized

scannedInstance

Used to group together one or more scan reports from the a running system.

Attributes

The list of attributes for scannedInstance are:

  • distribution (distribution): the operating system detected on the live system (see distribution)
  • group (string): the group name (reserved for future use)
  • name (string): the name of the live system
  • parentUri (anyURI): the uri resource of the parent object this scanned instance belongs to
  • platformType (string): the type of platform the scanned instance is hosted in
  • ramSize (int): the size of the virtual memory detected on the source system
  • overlayIncluded (boolean): a boolean indicating whether overlay files are included into the scans within this scanned instance
  • scans: the list of scan reports carried out on this live system (see scan)
  • scansUri (anyURI): the uri resource to retrieve all the scan reports
  • totalScans (int): the number of scans carried out on this live system
  • uri (anyURI): the uri resource of this scanned instance
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

scannedInstances

Provides a list of scannedInstance objects.

Attributes

The list of attributes for scannedInstances are:

  • scannedInstances: the list of scannedInstance objects
  • total (long): the total number of objects

scannedPackage

Holds the meta-data of a native package discovered on the file system after a scan process.

Attributes

The list of attributes for scannedPackage are:

  • deleted (boolean): a boolean indicating if the native package has been deleted on the source machine
  • deltaModified (boolean): a boolean indicating if the package has been modified compared to its initial installation state
  • distributionUri (anyURI): the uri of the distribution this package is attached to
  • filesUri (anyURI): the uri resource to retrieve all the files scanned and associated to this package
  • fromRepo (boolean): a boolean indicating if the package has been found in any platform registered repositories
  • headers (string): the headers (metadata) of the native package
  • inherited (boolean): a boolean indicating if this package has already been found, with the same metadata and content, in an other scan of the same scanned instance
  • modifiedFiles: the list of scannedFile objects that are modified in this package compared to the initial installation state
  • notModifiedFiles: the list of scannedFile objects that have not been modified in this package. Please note: this list will be empty if the package has been detected in one or several of the platform registered repositories
  • postunScripts (string): the content of the native package post uninstall scripts
  • preunScripts (string): the content of the native package pre uninstall scripts
  • scannedInstanceId (long): the id of the parent scanned instance
  • selected (boolean): a boolean incidating if this package has been marked to be included in the overlay
  • arch (string): the architecture type for this package
  • binaryUri (anyURI): the uri resource to retrieve the binary
  • extract (boolean): a boolean flag to extract an archive (if the uploaded object is an archive) as part of the generation
  • fullName (string): the name of the file including the extension
  • install (boolean): boolean to indicate whether to install the package or just to store it on the filesystem
  • installLocation (string): the location to store the package if install == false
  • name (string): the name of the package
  • origName (string): the original name of the package
  • params (string): silent install parameters to use as part of the installation of the object (for windows only)
  • parentUri (anyURI): the uri resource of the parent object this package belongs to
  • pkgBuildDate (dateTime): the date the package was built
  • pkgFileDate (dateTime): the file timestamp
  • release (string): the release information package
  • shortTag (string): tag value
  • repositoryName (string): repository name
  • sticky (boolean): boolean to indicate that this package version should not be updated when new package updates are available
  • type (string): file media type
  • uri (anyURI): the uri resource of this package object
  • version (string): the version of this package
  • epoch (int): the epoch value (used for native packages)
  • md5sum (string): the md5sum of the uploaded object
  • mimeType (string): the mime type of the file uploaded
  • sha256sum (string): the sha256 value of the uploaded object
  • size (long): the size (in bytes) of the uploaded object
  • status (status): the upload status (see status)
  • uploaded (boolean): a boolean to indicate if the file has been uploaded
  • uploadedTime (dateTime): the timestamp the upload was completed
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

scannedPackages

Provides a list of scannedPackage objects.

Attributes

The list of attributes for scannedPackages are:

  • scannedPackages: the list of scannedPackage objects
  • total (long): the total number of objects

scans

Provides a list of scan objects.

Attributes

The list of attributes for scans are:

  • scans: the list of scan objects
  • total (long): the total number of objects

scanStage

Holds all the meta-data of the scan stage of a migration.

Attributes

The list of attributes for scanStage are:

  • family: the family type for the operating system of the scan
  • scannedInstanceUri (anyURI): the uri resource of the scannedInstance
  • pipelineUri (anyURI): the uri of the parent pipeline
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

scanStats

Holds statistical data on all the scans carried out by an user.

Attributes

The list of attributes for scanStats are:

  • currGenerated (int): the number of scan generations the user still has access to
  • currImported (int): the number of appliance templates imported from scans the user still has access to
  • currOSUsage: number of times a specific OS has been used when scanning
  • currScans (int): the number of scans currently available in the user account
  • totalGenerated (int): the number of generations done from a scan
  • totalImported (int): the number of appliance imports done from a scan
  • totalOSUsage: the number of times a specific distribution has been scanned
  • totalScans (int): the number of scans done for a specific user account (counting deleted scans)

scanSummary

Holds all the summary meta-data of a scan. This is the report information after scanning a live system.

Attributes

The list of attributes for scanSummary are:

  • binariesExtracted (boolean): a boolean flag determining of the overall has been extracted by the platform
  • binariesReceived (boolean): a boolean flag determining of the overall has been received by the platform
  • error (boolean): a boolean flag to indicate an error during the scan process
  • errorMsg (string): the error message
  • filesUri (anyURI): a uri resource to retrieve all the filesystem files reported by the scan process
  • imagesUri (anyURI): the uri resource to retrieve all the machine images generated from this scan report
  • osConfig (osConfig): osconfig-object of the scan
  • importsUri (anyURI): the uri resource to retrieve all the imports
  • goldenImportsUri (anyURI): the uri resource to retrieve all the golden imports
  • installProfile (installProfile): the install profile of the scanned system
  • installProfileUri (anyURI): the uri resource of the installProfile
  • scanSyncUri (anyURI): the uri resource of the scanSync
  • name (string): the scan name
  • overlayCrc (string): the crc of the scan overlay archive
  • overlayImported (boolean): a boolean indicating whether the overlay has been imported on the platform
  • overlayUri (anyURI): the uri resource to upload the overlay
  • rawPartitionsUri (anyURI): the uri resource to upload the raw partitions (only for Windows source machines)
  • packagesUri (anyURI): the uri resource to retrieve all the meta data of the scanned packages
  • scanned (boolean): a boolean indicating if the scan report has been received from the scan agent on the source machine
  • scannedInstanceUri (anyURI): the uri of the parent scanned instance
  • status (status): the status of the scan
  • totalFilesAdded (int): the number of extra files found in the scan report
  • totalFilesDeleted (int): the number of files that have been deleted in source machine installed packages
  • totalFilesModified (int): the number of files that have been modified in the source machine installed packages
  • totalPackages (int): the number of native packages installed on the source machine
  • uncompressedBinarySize (long): the size of all the overlays
  • uri (anyURI): the uri of the scan
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

ScanSummaryLight

Holds some meta-data information of a scan.

Attributes

The list of attributes for ScanSummaryLight are:

  • name (string): the name
  • uri (anyURI): the uri
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

serviceStatus

Provides the status of the platform.

Attributes

The list of attributes for serviceStatus are:

  • alive (boolean): determines if the platform is up and running
  • version (string): the current version of the platform
  • serviceLoad (int): the current service load (max is 100)
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

softwareArtifact

Holds information of a native operating system package, file or bootscript.

Attributes

The list of attributes for softwareArtifact are:

  • uri (anyURI): the uri resource of this software artifact object
  • tag (string): the tag information
  • binaryUri (anyURI): the uri resource to retrieve the binary
  • parentUri (anyURI): the uri resource of the parent object this software artifact belongs to
  • extract (boolean): a boolean flag to extract an archive (if the uploaded object is an archive) as part of the generation
  • install (boolean): boolean to indicate whether to install the software artifact or just to store it on the filesystem
  • cache (boolean): boolean to indicate whether to put in cache the software artifact or just upload during generation
  • active (boolean): boolean to indicate whether the software artifact active or not
  • installLocation (string): the location to store the software artifact if install == false
  • name (string): the name of the software artifact
  • fullName (string): the name of the file including the extension
  • origName (string): the original name of the software artifact
  • artifactBuildDate (dateTime): the date the software artifact was built
  • artifactFileDate (dateTime): the file timestamp
  • release (string): the release information of the software artifact
  • shortTag (string): short tag value (osPackage, softwarefile or bootscript)
  • type (string): file media type
  • version (string): the version of this software artifact
  • arch (string): the architecture type for this software artifact (rpm uploaded file or OS Package)
  • params (string): silent install parameters to use as part of the installation of the object (for windows only)
  • artifactCredAccount (artifactCredAccount): the artifact account (see artifactCredAccount) this software artifact belong to
  • subSoftwareArtifacts: the list of sub-software artifact of this software artifact (which represents a folder)
  • subSoftwareArtifactUri (anyURI): the list of sub-software artifact uris of this software artifact
  • parentPath (string): the parent pathname of this software artifact (depending of its parent software artifact)
  • remotePath (string): the remote pathname of this software artifact to retrieve from artifact account
  • md5sum (string): the md5sum of the uploaded object
  • mimeType (string): the mime type of the file uploaded
  • sha256sum (string): the sha256 value of the uploaded object
  • size (long): the size (in bytes) of the uploaded object
  • status (status): the upload status (see status)
  • uploaded (boolean): a boolean to indicate if the file has been uploaded
  • uploadedTime (dateTime): the timestamp the upload was completed
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

softwareArtifacts

Provides a list of softwareArtifact objects.

Attributes

The list of attributes for softwareArtifacts are:

  • total (long): the total number of objects

softwareBundle

Describes a software bundle (MySoftware or Project).

Attributes

The list of attributes for softwareBundle are:

  • tag (string): the tag information
  • shortTag (string): the short tag information (mySoftware or project)
  • name (string): the name of this software bundle
  • version (string): the version information of this software bundle
  • description (string): the description for this software bundle
  • release (string): the release information for the software bundle
  • defaultInstallLocation (string): the default full pathname of where to install the software bundle (if not a native package)
  • installLocation (string): the full pathname of where to install this software bundle item (overrides the defaultInstallLocation)
  • restricted (boolean): a boolean highlighting if the Software bundle is restricted
  • installedSize (long): the estimated disk size (in bytes) required to install this software bundle
  • size (long): the total size of this software bundle (in bytes)
  • revision (long): the revision number of the software bundle
  • bundleRestriction (bundleRestriction): the restriction for this software bundle
  • artifactsUri (anyURI): the uri resource to retrieve the details of software artifacts contained in the software bundle
  • uri (anyURI): the uri resource of this software bundle object
  • exportUri (anyURI): uri resource used to export this software bundle
  • category (category): the category for this software bundle (project)
  • license (license): the license information (see license)
  • logo (logo): the logo object for the software bundle
  • maintainer (string): the maintainer name for this project
  • website (anyURI): the website URL of the maintainer
  • softwareArtifactUris (UriList): the list of uri resources for each software artifacts in the software bundle
  • formatDependent (boolean): a boolean highlighting if the Software bundle is restricted on target format
  • containerTemplatesUri (anyURI): the uri to retrieve container templates created from the software bundle
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

softwareBundles

Provides a list of softwareBundle objects.

Attributes

The list of attributes for softwareBundles are:

  • total (long): the total number of objects

softwareBundleExport

Holds tracking information on requests to export a software bundle. An export basically archives the software bundle meta-data and all relevant files and allows the user to download that archive. The archive information can then be version controlled or imported to another UForge platform.

The software bundle export is an asynchronous job which may take some time. The current status of the export is stored in this object.

Attributes

The list of attributes for softwareBundleExport are:

  • bundleName (string): the name of this exported software bundle
  • bundleVersion (string): the version information of this exported software bundle
  • downloadUri (anyURI): uri resource used to download this exported software bundle (as an archive)
  • location (anyURI): the full pathname where the exported software bundle (as an archive) is stored locally
  • parentUri (anyURI): the uri resource of the parent object this exported software bundle belongs to
  • status (status): the current status of the exported software bundle
  • uri (anyURI): the uri resource of this exported software bundle object
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

softwareBundleImport

Holds the information when a software bundle is being imported to this UForge platform. The actual import is done by uploading a software bundle archive via the uploadUri.

The software bundle import is an asynchronous job which may take some time. The current status of the import is stored in this object.

Attributes

The list of attributes for softwareBundleImport are:

  • parentUri (anyURI): the uri resource of the parent object this object is attached to
  • referenceUri (anyURI): the uri of the software bundle created from this import
  • uploadUri (anyURI): the uri resource to upload any files assocaited with this import
  • statusUri (anyURI): the uri resource of the current status of the software bundle import
  • imported (boolean): boolean flag indicating that is a real import or a creation
  • uri (anyURI): the uri resource of this software bundle import
  • md5sum (string): the md5sum of the uploaded object
  • mimeType (string): the mime type of the file uploaded
  • sha256sum (string): the sha256 value of the uploaded object
  • size (long): the size (in bytes) of the uploaded object
  • status (status): the upload status (see status)
  • uploaded (boolean): a boolean to indicate if the file has been uploaded
  • uploadedTime (dateTime): the timestamp the upload was completed
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

softwareFile

Holds information of a simple file attached to a software bundle.

Attributes

The list of attributes for softwareFile are:

  • ownerGroup (string): the string owner:group for this software file to set during the generation of a machine image
  • rights (string): the rights for this software file (for example 777) to set during the generation of a machine image
  • symlink (string): a symbolic link for this software file to set during the generation of a machine image
  • uri (anyURI): the uri resource of this software artifact object
  • tag (string): the tag information
  • binaryUri (anyURI): the uri resource to retrieve the binary
  • parentUri (anyURI): the uri resource of the parent object this software artifact belongs to
  • extract (boolean): a boolean flag to extract an archive (if the uploaded object is an archive) as part of the generation
  • install (boolean): boolean to indicate whether to install the software artifact or just to store it on the filesystem
  • cache (boolean): boolean to indicate whether to put in cache the software artifact or just upload during generation
  • active (boolean): boolean to indicate whether the software artifact active or not
  • installLocation (string): the location to store the software artifact if install == false
  • name (string): the name of the software artifact
  • fullName (string): the name of the file including the extension
  • origName (string): the original name of the software artifact
  • artifactBuildDate (dateTime): the date the software artifact was built
  • artifactFileDate (dateTime): the file timestamp
  • release (string): the release information of the software artifact
  • shortTag (string): short tag value (osPackage, softwarefile or bootscript)
  • type (string): file media type
  • version (string): the version of this software artifact
  • arch (string): the architecture type for this software artifact (rpm uploaded file or OS Package)
  • params (string): silent install parameters to use as part of the installation of the object (for windows only)
  • artifactCredAccount (artifactCredAccount): the artifact account (see artifactCredAccount) this software artifact belong to
  • subSoftwareArtifacts: the list of sub-software artifact of this software artifact (which represents a folder)
  • subSoftwareArtifactUri (anyURI): the list of sub-software artifact uris of this software artifact
  • parentPath (string): the parent pathname of this software artifact (depending of its parent software artifact)
  • remotePath (string): the remote pathname of this software artifact to retrieve from artifact account
  • md5sum (string): the md5sum of the uploaded object
  • mimeType (string): the mime type of the file uploaded
  • sha256sum (string): the sha256 value of the uploaded object
  • size (long): the size (in bytes) of the uploaded object
  • status (status): the upload status (see status)
  • uploaded (boolean): a boolean to indicate if the file has been uploaded
  • uploadedTime (dateTime): the timestamp the upload was completed
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

softwareFiles

Provides a list of softwareFile objects.

Attributes

The list of attributes for softwareFiles are:

  • total (long): the total number of objects

sshKey

Provides information of a public SSH key.

Attributes

The list of attributes for sshKey are:

  • name (string): the name of the ssh key
  • publicKey (string): the public ssh key content
  • uri (anyURI): the uri resource to this ssh key object
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

sshKeys

Provides a list of sshKey objects.

Attributes

The list of attributes for sshKeys are:

  • sshKeys: the list of sshKey objects
  • total (long): the total number of objects

stage

Holds all the meta-data of a stage to perform a pipeline.

Attributes

The list of attributes for stage are:

  • pipelineUri (anyURI): the uri of the parent pipeline
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

statDataPoint

Generic object holding a statistic data point.

Attributes

The list of attributes for statDataPoint are:

  • date (dateTime): the date of this data point
  • distribArch (string): the architecture of the operating system
  • distribName (string): the operating system name
  • distribVersion (string): the operating system version
  • endDate (dateTime): the stat timestamp
  • errorMessage (string): error message
  • message (string): message for this data point
  • name (string): the name or tooltip for this data point
  • nb (long): the value for this data point
  • percentage (float): the percentage
  • startDate (dateTime): the timestamp from where this stat begins
  • total (long): the total value for this stat
  • type (string): the type of stat
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

statDataPoints

Provides a list of statDataPoint objects.

Attributes

The list of attributes for statDataPoints are:

  • statDataPoints: the list of statDataPoint objects
  • total (long): the total number of objects

statTicket

Generic object hodling reference to most of the platform CRUD (create / update / delete) operations. StatTicket remains even if the initial attach object gets deleted / updated.

Attributes

The list of attributes for statTicket are:

  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

statTickets

Provides a list of statTicket objects.

Attributes

The list of attributes for statTickets are:

  • statTickets: the list of statTicket objects
  • total (long): the total number of objects

subscriptionProfile

Describes access and permission information used when creating new users on the platform.

Attributes

The list of attributes for subscriptionProfile are:

  • active (boolean): boolean flag to indicate whether this subscription profile can be used
  • admins: the list of administrators that can use this subscription profile when creating a new user (see user)
  • adminsUri (anyURI): the uri resource to retrieve all the administrators that can use this subscription profile
  • code (string): the subscription profile code to use when creating a user (this subscription profile will be used)
  • description (string): the description of this subscription profile
  • distribsUri (anyURI): the uri resource to get all the operating systems that the user will be given access to
  • distributions: the list of operating systems that the user will be given access to (see distribution)
  • formats: the list of primitive formats that the user will be given access to (see imageFormat)
  • formatsUri (anyURI): the uri resource to get all the primitive formats that the user will be given access to
  • targetPlatforms: the list of target platforms that the user will be given access to (see targetPlatform)
  • targetPlatformsUri (anyURI): the uri resource to get all the target platforms that the user will be given access to
  • targetFormats: the list of target formats that the user will be given access to (see targetFormat)
  • targetFormatsUri (anyURI): the uri resource to get all the target formats that the user will be given access to
  • name (string): the name of this subscription profile
  • orgUri (anyURI): the uri resource of the organization this subscription profile is registered to
  • quotas: the list of quotas that the user will be given (see quota)
  • quotasUri (anyURI): the uri resource to get all the quota information that the user will be given
  • roles: the list of roles that the user will be given to (see role)
  • rolesUri (anyURI): the uri resource to get all the roles that the user will be given
  • uri (anyURI): the uri resource of this subscription profile object
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

subscriptionProfiles

Provides a list of subscriptionProfile objects.

Attributes

The list of attributes for subscriptionProfiles are:

  • subscriptionProfiles: the list of subscriptionProfile objects
  • total (long): the total number of objects

sourceSummary

Provides source information.

Attributes

The list of attributes for sourceSummary are:

  • name (string): the name
  • uri (anyURI): the uri
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

tag

Provides tagging information.

Attributes

The list of attributes for tag are:

  • name (string): the public tag name
  • uri (anyURI): the uri resource of this tag object
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

targetFormat

Holds information that extends a primitive imageFormat. This allows administrators to customize and rebrand machine image formats.

Attributes

The list of attributes for targetFormat are:

  • name (string): the name of this format
  • logo (logo): the logo of this format (see logo)
  • format (imageFormat): the primitive format this target platform is based on
  • category (category): the category for this target format
  • type: the target format type
  • credAccountType: the cloud account type this target format is mapped to
  • targetPlatformsUri (anyURI): the uri resource to retrieve all the target platforms where this target format is used
  • targetPlatformsUriList (UriList): the list of uri resources for the target platform objects where this target format is used
  • credInfos (string): the end-user information to get the necessary credentials to generate a machine image to this particular TargetFormat
  • imageInfos (string): the end-user information that could be provided before a user generates a machine image
  • publishInfos (string): the end-user information that could be provided before a user publishes a machine image
  • access (boolean): a boolean indicating whether the user has access to the TargetFormat or not
  • active (boolean): a boolean indicated whether the TargetFormat is availble in the Org the user is registered to
  • uri (anyURI): the uri resource of this target format object
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

targetFormats

Provides a list of targetFormat objects.

Attributes

The list of attributes for targetFormats are:

  • targetFormats: the list of targetFormat objects
  • total (long): the total number of objects

targetPlatform

Holds information on a target cloud platform that extends one of the primitive cloud environments supported by the platform. This allows administrators to customize target cloud environments. A target platform may include one or more targetFormat objects.

Attributes

The list of attributes for targetPlatform are:

  • name (string): the name of this target platform
  • logo (logo): the logo of this target platform (see logo)
  • type: the primitive type for this target platform
  • targetFormatsUri (anyURI): the uri resource to retrieve the target formats this target platform contains
  • targetFormatsUriList (UriList): the list of uri resources for each target format this target platform contains
  • accountInfos (string): the end-user information that could be displayed to help the user get the necessary credentials information (cloud platform api keys, etc.)
  • access (boolean): a boolean indicating whether the user has access to the TargetFormat or not
  • active (boolean): a boolean indicated whether the TargetFormat is availble in the Org the user is registered to
  • uri (anyURI): the uri resource for this target platform object
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

targetPlatforms

Provides a list of targetPlatform objects.

Attributes

The list of attributes for targetPlatforms are:

  • targetPlatforms: the list of targetPlatform objects
  • total (long): the total number of objects

uforgeError

Holds information on a platform error.

Attributes

The list of attributes for uforgeError are:

  • localizedErrorMsg (LocalizedMessage): the error message (supports i18n)
  • requestMethod (string): the HTTP request method used in the request
  • requestUri (string): the HTTP uri resource used in the request
  • statusCode (int): the HTTP status code
  • timestamp (dateTime): the timestamp the request was received by the platform

UForgeObject

Holds generic information used by platform objects.

Attributes

The list of attributes for UForgeObject are:

  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

UForgeObjects

Provides a list of UForgeObject objects.

Attributes

The list of attributes for UForgeObjects are:

  • total (long): the total number of objects

UForgeUploadObject

Holds generic information used by platform objects that can be uploaded

Attributes

The list of attributes for UForgeUploadObject are:

  • md5sum (string): the md5sum of the uploaded object
  • mimeType (string): the mime type of the file uploaded
  • sha256sum (string): the sha256 value of the uploaded object
  • size (long): the size (in bytes) of the uploaded object
  • status (status): the upload status (see status)
  • uploaded (boolean): a boolean to indicate if the file has been uploaded
  • uploadedTime (dateTime): the timestamp the upload was completed
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

UriList

Provides a list of URI resources.

user

Describes an user of the platform.

Attributes

The list of attributes for user are:

  • address (address): the user’s address
  • admin (boolean): boolean indicating if the user is an administrator
  • adminOrgsUri (anyURI): the uri resource to get the list of Org this user is an administrator of
  • adminOrgUris (UriList): the list of Org URI where this user is an administrator
  • apiKeysQuota (int): the number of API keys this user can generate
  • applianceUris (UriList): the list of uri resources for each appliance template this user is managing
  • baseApiKeysUri (anyURI): the uri resource to retrieve the user’s api keys
  • baseAppliancesUri (anyURI): the uri resource to retrieve the user’s appliance templates
  • baseBlueprintsUri (anyURI): the uri resource to retrieve the user’s blueprint
  • baseCredAccountsUri (anyURI): the uri resource to retrieve the user’s cloud accounts
  • baseDeploymentsUri (anyURI): the uri resource to retrieve the user’s deployments
  • baseDistributionsUri (anyURI): the uri resource to retrieve the operating systems the user has access to
  • baseFormatsUri (anyURI): the uri resource to retrieve the primitive formats the user has access to
  • baseTargetPlatformsUri (anyURI): the uri resource to retrieve the target platforms the user has access to
  • baseTargetFormatsUri (anyURI): the uri resource to retrieve the target formats the user has access to
  • baseImagesUri (anyURI): the uri resource to retrieve the user’s machine images
  • baseExportsUri (anyURI): the uri resource to retrieve the user’s exported appliance templates
  • baseImportsUri (anyURI): the uri resource to retrieve the user’s imported appliance templates
  • mySoftwareImportsUri (anyURI): the uri resource to retrieve the user’s imported software bundles
  • baseMySoftwareLibraryUri (anyURI): the uri resource to retrieve the user’s software library (containing private software components)
  • baseOrgsUri (anyURI): the uri resource to retrieve the organizations the user is a member of
  • baseProjectsUri (anyURI): the uri resource to retrieve the project catalog software components
  • basePublishImagesUri (anyURI): the uri resource to retrieve the user’s published machine images
  • baseRolesUri (anyURI): the uri resource to retrieve the user’s roles
  • baseWorkspacesUri (anyURI): the uri resource to retrieve the workspaces the user has access to
  • creationCode (string): the code used for creating the user (subscription profile code, see subscriptionProfile)
  • credAccountUris (UriList): the list of uri resources for each cloud account the user has
  • artifactAccountsUri (anyURI): the uri resource to retrieve the user’s artifact accounts
  • dob (dateTime): the user’s date of birth
  • gender (string): the user’s gender
  • homePhone (string): the user’s home phone number
  • lang (string): the user’s preferred language
  • migrationsUri (anyURI): the uri resource to retrieve all the migrations for the user (see migration)
  • mobilePhone (string): the user’s mobile phone number
  • mySoftwareLibraryUris (UriList): the list of uri resources for each software component the user has in their software library
  • name (string): the user’s first name
  • officePhone (string): the user’s office phone number
  • orgUris (UriList): the list of uri resources for each organization this user is a member of
  • password (string): the user’s password
  • projectUris (UriList): the list of uri resources for each software component in the project catalog
  • promoCode (string): the promotion code used when creating the user account
  • quotasUri (anyURI): the uri resource to retrieve the user’s quota information
  • roles: the list of roles assigned to the user (see role)
  • scannedInstancesUri (anyURI): the uri resource to retrieve all the scanned instances for the user (see scannedInstance)
  • scansUri (anyURI): the uri resource to retrieve all the scans for the user (see scan)
  • sshKeys: the list of public ssh keys for the user (see sshKey
  • sshKeysUri (anyURI): the uri resource to retrieve all the publish ssh keys for the user
  • statsUri (anyURI): the uri resource to retrieve all the user statistics
  • uri (anyURI): the uri resource of this user object
  • usageUri (anyURI): the uri resource to retrieve the platform usage for the user
  • loginName (string): the user login name
  • active (boolean): boolean indicating whether the user account is active
  • company (company): the company information for this user
  • email (string): the user’s email address
  • firstName (string): the user’s first name
  • surname (string): the user’s surname
  • jobTitle (string): the user’s job title
  • photo (logo): the user’s photo / avatar
  • website (anyURI): the user’s website
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

userProfile

Describes an user’s profile

Attributes

The list of attributes for userProfile are:

  • loginName (string): the user login name
  • active (boolean): boolean indicating whether the user account is active
  • company (company): the company information for this user
  • email (string): the user’s email address
  • firstName (string): the user’s first name
  • surname (string): the user’s surname
  • jobTitle (string): the user’s job title
  • photo (logo): the user’s photo / avatar
  • website (anyURI): the user’s website
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

userProfiles

Provides a list of userProfile objects.

Attributes

The list of attributes for userProfiles are:

  • userProfiles: the list of userProfile objects
  • total (long): the total number of objects

users

Provides a list of user objects.

Attributes

The list of attributes for users are:

  • users: the list of user objects
  • total (long): the total number of objects

userStat

Holds statistical data for a user of the platform.

Attributes

The list of attributes for userStat are:

  • type: statistic type (APPLIANCE | FORMAT_APPLIANCE | FORMAT_SCAN | GENERATION_APPLIANCE | GENERATION_SCAN | OS_APPLIANCE | OS_SCAN | SCAN | SOFTWARE_BUNDLE)
  • currNb (int): current number of items
  • dataPoints: a list of statDataPoint objects.
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

userStats

Provides a list of userStat objects.

voteStat

Provides information on a review rating

Attributes

The list of attributes for voteStat are:

  • loginName (string): the login name of the user sending the rating
  • parentUri (anyURI): the uri resource of the parent object this object belongs to
  • rating (float): the rating value
  • uri (anyURI): the uri resource of this object
  • user (user): the user information providing the rating (see user)
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

windowsProfile

Describes a group of native applications and services from a windows operating system. This profile is created by a platform administrator or used in an appliance template. These templates are used by users of the platform to easily create operating profiles that are part of an appliance template.

Attributes

The list of attributes for windowsProfile are:

  • edition: the edition of the operating system for this os profile
  • importedGolden (boolean): boolean indicating if this os profile was created from an imported scan
  • partitionTable (partitionTable): the partition table of the os profile (see partitionTable).
  • type: the type of the operating system for this os profile
  • language (string): the language of the attached golden machine image
  • servicesUri (anyURI): the uri resource to retrieve all the services contained in this os profile
  • applicationsUri (anyURI): the uri resource to retrieve all the applications contained in this os profile
  • active (boolean): boolean to determine if this os profile is active (i.e. available to use by a user)
  • applianceUri (anyURI): the uri resource of the appliance this os profile is attached to
  • arch (string): the architecture of the operating system this os profile is based on
  • description (string): the description of this os profile
  • distributionUri (anyURI): the uri resource to retrieve the operating system information this os profile is based on
  • installedSize (long): estimated install disk size required (in bytes) to install the packages this template contains. Note, this attempts to include all package dependencies.
  • name (string): the name of this os profile
  • standardProfileUri (anyURI): the uri resource to get the os profile this profile is based on (see linuxProfile)
  • uri (anyURI): the uri resource of this os profile
  • size (long): the total size of all the packages contained in this os profile
  • version (string): the version of this os profile
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

windowsProfiles

Provides a list of windowsProfile objects.

Attributes

The list of attributes for windowsProfiles are:

  • windowsProfiles: the list of windowsProfile objects
  • total (long): the total number of objects

winMsiApplication

Provides information of a Windows Msi Application

Attributes

The list of attributes for winMsiApplication are:

  • publisher (string): The publisher of the msi application
  • installLocation (string): the location the msi application is installed
  • estimatedSizeInKB (integer): the estimated size of the msi application
  • displayName (string): the name of the application
  • version (string): the version of the application
  • architecture: the architecture of the application
  • parentUri (anyURI): the resource uri of the parent windowsProfile object
  • uri (anyURI): the resource uri of the application
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

winMsiApplications

Provides a list of winMsiApplication objects.

Attributes

The list of attributes for winMsiApplications are:

  • winMsiApplications: the list of winMsiApplication objects
  • total (long): the total number of objects

winStoreApplication

Provides information of a Windows Store Application

Attributes

The list of attributes for winStoreApplication are:

  • displayName (string): the name of the application
  • version (string): the version of the application
  • architecture: the architecture of the application
  • parentUri (anyURI): the resource uri of the parent windowsProfile object
  • uri (anyURI): the resource uri of the application
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

winStoreApplications

Provides a list of winStoreApplication objects.

Attributes

The list of attributes for winStoreApplications are:

  • winStoreApplications: the list of winStoreApplication objects
  • total (long): the total number of objects

winService

Provides information of a Windows Service

Attributes

The list of attributes for winService are:

  • serviceName (string): The name of the service
  • displayName (string): the human readable name of the service
  • description (string): the description of the service
  • parentUri (anyURI): the resource uri of the parent windowsProfile object
  • uri (anyURI): the resource uri of the service
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

unixService

Provides information of an Unix Service

Attributes

The list of attributes for unixService are:

  • serviceManager (string): The service manager
  • serviceName (string): The name of the service
  • serviceStatus (string): The status of the service
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

winServices

Provides a list of winService objects.

Attributes

The list of attributes for winServices are:

  • winServices: the list of winService objects
  • total (long): the total number of objects

workspace

Describes a workspace used to share appliance templates between users.

Attributes

The list of attributes for workspace are:

  • commentsUri (anyURI): the uri resource of the comments posted to this workspace
  • membershipsUri (anyURI): the uri resource to retrieve the members of this workspace
  • myMembership (membership): the membership information on the user sending the request
  • name (string): the name of the workspace
  • nbTemplates (long): the number of shared appliance templates in the workspace
  • orgUri (anyURI): the uri resource of the organization where this workspace is created
  • templatesUri (anyURI): the uri resource to retrieve all the shared appliance templates
  • uri (anyURI): the uri resource of this workspace
  • created (dateTime): the date the appliance template is created
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object

workspaces

Provides a list of workspace objects.

Attributes

The list of attributes for workspaces are:

  • workspaces: the list of workspace objects
  • total (long): the total number of objects

API Key API Resources

apiKey_create

POST /users/{uid}/apikeys

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.7

Creates an API Key for the specified user.

Note

The apiKeyPair can be empty as only the description information is used. The public and secret key information is generated automatically. Though you must send an empty apiKeyPair in the request body.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: api_key_access

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

A apiKeyPair object

Example Request

curl "https://uforge.example.com/api/users/{uid}/apikeys" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:apiKeyPair xmlns:ns0="http://www.usharesoft.com/uforge"></ns0:apiKeyPair>

See also

apiKey_delete

DELETE /users/{uid}/apikeys/{akid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.0

Deletes an API key from the specified user.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: api_key_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • akid (required): the id of the apiKeyPair

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/apikeys/{akid}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

apiKey_getAll

GET /users/{uid}/apikeys

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.0

Returns all the API keys for the specified user.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: api_key_access

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/apikeys" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

apiKey_update

PUT /users/{uid}/apikeys/{akid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.7

Updates an API key.

Note

Only the optional meta-data name and description can be updated. The actual key pair information will not be changed.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: api_key_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • akid (required): the id of the apiKeyPair

HTTP Request Body Parameters

A apiKeyPair object

Example Request

curl "https://uforge.example.com/api/users/{uid}/apikeys/{akid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

See also

Appliance API Resources

applianceLogo_delete

DELETE /users/{uid}/appliances/{aid}/logo/{logoId}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.0

Deletes the logo binary from the specified appliance.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • aid (required): the id of the appliance
  • logoId (required): the id of the logo

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/logo/{logoId}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

applianceLogo_download

GET /users/{uid}/appliances/{aid}/logo/{logoId}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 3.0

Downloads the logo binary for the appliance.

This is the same request as applianceLogo_downloadFile

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user
  • aid (required): the id of the appliance
  • logoId (required): the id of the logo

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/logo/{logoId}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

applianceLogo_downloadFile

GET /users/{uid}/appliances/{aid}/logo/{logoId}/{fileName}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 3.0

Downloads the logo binary for the appliance.

This is the same request as applianceLogo_download

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user
  • fileName (required): the file name of the logo to upload
  • aid (required): the id of the appliance
  • logoId (required): the id of the logo

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/logo/{logoId}/{fileName}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

applianceLogo_upload

POST /users/{uid}/appliances/{aid}/logo/{logoId}/{fileName}

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.0

Uploads a logo for the specified appliance.

Note

the following media types are supported: .jpg, .jpeg, .png

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • fileName (required): the file name of the logo to upload
  • aid (required): the id of the appliance
  • logoId (required): the id of the logo

HTTP Request Body Parameters

The file to upload.

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/logo/{logoId}/{fileName}" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@binaryFilePath"

See also

appliance_clone

POST /users/{uid}/appliances/{aid}/clones

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Creates a new appliance by cloning all the meta-data of an existing appliance.

A new appliance name and version is required for the new appliance

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the id of the user
  • aid (required): the id of the appliance to update

HTTP Request Body Parameters

A appliance object

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/clones" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:appliance xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>Appliance Clone Example</name>
        <orgUri>orgs/1</orgUri>
        <projects></projects>
        <version>1.0</version>
</ns0:appliance>

See also

appliance_create

POST /users/{uid}/appliances

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Creates a new appliance in a user’s Appliance Library.

Please refer to appliance for a complete list of all the appliance attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

A appliance object

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:appliance xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>Appliance Example</name>
        <orgUri>orgs/1</orgUri>
        <version>1.0</version>
</ns0:appliance>

See also

appliance_delete

DELETE /users/{uid}/appliances/{aid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.6

Deletes the specified appliance.

The optional query parameter force can be used to ensure any asynchronous generation or publish activities are also stopped and deleted for this appliance. By default this is false.

Warning

this also deletes all associated machine images that have been generated from this appliance

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

appliance_get

GET /users/{uid}/appliances/{aid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Gets the information for an appliance.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

appliance_getAll

GET /users/{uid}/appliances

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Gets all the appliances created by a particular user.

A list of appliance objects are returned.

You can use a search criteria to retrieve a subset of these appliances.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

appliance_update

PUT /users/{uid}/appliances/{aid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Updates the meta-data information of an appliance.

Please refer to appliance for a complete list of all the appliance attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • aid (required): the id of the appliance

HTTP Request Body Parameters

A appliance object

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:appliance xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>Appliance Example Updated</name>
        <version>1.0Reloaded</version>
</ns0:appliance>

See also

Appliance Configuration API Resources

applianceBootScript_create

POST /users/{uid}/appliances/{aid}/bootscripts

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 2.1.06

Adds a new boot script object to an appliance.

This is just the meta-data of the boot script file. Once created, you can upload the boot script file using applianceBootScript_upload

Boot scripts have two types:

  • firstboot: declaring that this boot script should only be executed once on the first time the instance is provisioned
  • everyboot: declaring that this boot script should be executed every time the instance is rebooted.

Refer to bootScript for more information on the boot script attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • aid (required): the id of the appliance

HTTP Request Body Parameters

A bootScript object

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/bootscripts" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:bootScript xmlns:ns0="http://www.usharesoft.com/uforge">
        <md5sum>e46d011c92f41cfc815213d968596081</md5sum>
        <sha256sum>3396aa52b2a0a401924525c52ce4ed1641d53f743ff35d8edfef368098912e8b</sha256sum>
        <size>26</size>
        <name>firstbootscript_example.sh</name>
        <bootOrder>1</bootOrder>
        <bootType>firstboot</bootType>
</ns0:bootScript>

See also

applianceBootScript_delete

DELETE /users/{uid}/appliances/{aid}/bootscripts/{bsid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 2.1.06

Removes a boot script attached to an appliance. This includes any boot script file that has been uploaded.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • bsid (required): the id of the bootScript
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/bootscripts/{bsid}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

applianceBootScript_deleteAll

DELETE /users/{uid}/appliances/{aid}/bootscripts

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 2.1.06

Removes all of the boot scripts attached to an appliance. This includes any boot script file that has been uploaded.

A list of query parameters can be used to delete a subset of boot scripts. The list of boot scripts to delete are expressed as a list of query parameters: - name: delete a boot script that matches a name - id: delete a boot script that matches the boot script id - type: delete a boot script that matches a boot script type

For example, the following query parameters requests to delete boot scripts that have the name bootscript1.sh, bootscript2.sh and a boot script that has the id 23:

{uri}?name=”bootscript1.sh”&name=”bootscript2.sh”&id=”23”

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/bootscripts" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

applianceBootScript_download

GET /users/{uid}/appliances/{aid}/bootscripts/{bsid}/bin

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 2.1.06

Downloads a boot script file.

This request is the same as applianceBootScript_downloadFile

The boot script can be downloaded without authentication if an downloadId is added as a query parameter. To retrieve the downloadId, use applianceBootScript_get.

Note

The downloadId can only be used once, afterwards it expires, and a new downloadId must be retrieved.

Security Summary

  • Requires Authentication: false
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user
  • bsid (required): the id of the bootScript
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/bootscripts/{bsid}/bin" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

applianceBootScript_downloadFile

GET /users/{uid}/appliances/{aid}/bootscripts/{bsid}/bin/{fileName}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 2.1.06

Downloads a boot script file.

This request is the same as applianceBootScript_download

The boot script can be downloaded without authentication if an downloadId is added as a query parameter. To retrieve the downloadId, use applianceBootScript_get.

Note

The downloadId can only be used once, afterwards it expires, and a new downloadId must be retrieved.

Security Summary

  • Requires Authentication: false
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user
  • bsid (required): the id of the bootScript
  • fileName (required): the boot script filename to add
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/bootscripts/{bsid}/bin/{fileName}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

applianceBootScript_get

GET /users/{uid}/appliances/{aid}/bootscripts/{bsid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 2.1.06

Retrieves a boot script that is attached to an appliance.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • bsid (required): the id of the bootScript
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/bootscripts/{bsid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

applianceBootScript_getAll

GET /users/{uid}/appliances/{aid}/bootscripts

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Retrieves all the boot scripts for a particular appliance.

A list of bootScript objects are returned. You can use a search criteria to retrieve a subset of these boot scripts.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/bootscripts" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

applianceBootScript_update

PUT /users/{uid}/appliances/{aid}/bootscripts/{bsid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 2.1.06

Updates a boot script that is attached to an appliance.

This only updates the meta-data associated with any uploaded boot script file.

Refer to bootScript for more information on the boot script attributes.

Warning

If the new boot script data contains a md5sum and if this md5sum is not equal to the existing boot script meta-data, then any uploaded boot script file is deleted and a new boot script file will need to be uploaded using applianceBootScript_upload

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • bsid (required): the id of the bootScript
  • aid (required): the id of the appliance

HTTP Request Body Parameters

A bootScript object

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/bootscripts/{bsid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:bootScript xmlns:ns0="http://www.usharesoft.com/uforge">
        <bootType>everyboot</bootType>
</ns0:bootScript>

See also

applianceBootScript_upload

POST /users/{uid}/appliances/{aid}/bootscripts/{bsid}/bin/{fileName}

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 2.1.06

Uploads a boot script file.

Prior to uploading a boot script file, a bootScript object must be created. Refer to applianceBootScript_create to understand how to create a new boot script object for an appliance.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • bsid (required): the id of the bootScript
  • fileName (required): the boot script filename to add
  • aid (required): the id of the appliance

HTTP Request Body Parameters

The file to upload.

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/bootscripts/{bsid}/bin/{fileName}" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@binaryFilePath"

See also

Appliance Import and Export API Resources

applianceExportStatus_get

GET /users/{uid}/appliances/{aid}/exports/{eid}/status

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.5

Gets the status of the specified appliance export.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • eid (required): the id of the export ticket (provided after appliance_export)
  • aid (required): the id of the appliance being exported

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/exports/{eid}/status" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

applianceExport_cancel

DELETE /users/{uid}/appliances/{aid}/exports/{eid}/status

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.5

Cancels a current export job of an appliance.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • eid (required): the id of the export ticket (provided after appliance_export)
  • aid (required): the id of the appliance being exported

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/exports/{eid}/status" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

applianceExport_delete

DELETE /users/{uid}/appliances/{aid}/exports/{eid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.5

Deletes the export ticket. This deletes the associated archive of an exported appliance export metadata (archive).

Note

This does not delete the source appliance.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • eid (required): the id of the export ticket (provided after appliance_export)
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/exports/{eid}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

applianceExport_download

GET /users/{uid}/appliances/{aid}/exports/{eid}/downloads

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 3.5

Downloads the archive of an exported appliance. The archive is a .tar.gz file. The archive contains the meta-data file of the appliance and any 3rd party software or configuration scripts associated with the appliance.

An archive can be used with the hammr command-line tool.

Warning

you can only download an archive once the creation of the archive is complete. Use applianceExportStatus_get to check the status of an export prior to a download request.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • eid (required): the id of the export ticket (provided after appliance_export)
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/exports/{eid}/downloads" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

applianceExport_get

GET /users/{uid}/appliances/{aid}/exports/{eid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.5

Gets an appliance export ticket.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • eid (required): the id of the export ticket (provided after appliance_export)
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/exports/{eid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

applianceExport_getAll

GET /users/{uid}/exports

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: 3.6

Gets all the appliance exports requested by a particular user. <p/>

A list of applianceExport objects are returned. <p/>

You can use a search criteria to retrieve a subset of these appliance export objects.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/exports" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

applianceExport_getAllStatus

GET /users/{uid}/exports/statuses

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: 3.6

Retrieves the status of all the current appliance exports for the user.

A list of status objects are returned.

The ae query parameter can be used to retrieve a subset of these export statuses.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/exports/statuses" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

applianceImportStatus_get

GET /users/{uid}/imports/{iid}/status

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.5

Retrieve the current status of an appliance archive import.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • iid (required): the id of the applianceImport ticket

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/imports/{iid}/status" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

applianceImport_delete

DELETE /users/{uid}/imports/{iid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: 3.6

Deletes the specified appliance import.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • iid (required): the id of the applianceImport ticket to delete

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/imports/{iid}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

applianceImport_get

GET /users/{uid}/imports/{iid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: 3.4

Gets an appliance import ticket. <p/>

This object is created automatically when a request to import an appliance archive is sent to the platform. See appliance_import for more information.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • iid (required): the id of the applianceImport ticket to delete

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/imports/{iid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

applianceImport_getAll

GET /users/{uid}/imports

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: 3.6

Gets all the appliance imports requested by a particular user. <p/>

A list of applianceImport objects are returned. <p/>

You can use a search criteria to retrieve a subset of these appliance import objects.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/imports" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

applianceImport_getAllStatus

GET /users/{uid}/imports/statuses

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: 3.6

Gets the status of all the current appliance imports for the user.

A list of status objects are returned.

The ai query parameter can be used to retrieve a subset of these import statuses.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/imports/statuses" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

applianceImport_upload

POST /users/{uid}/imports/{iid}/uploads

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.5

Upload the appliance archive. <p/>

In order to upload an archive, an appliance import ticket must first be created by using appliance_import. <p/>

Once the upload is complete, the platform extracts the archive and creates an appliance from the archive contents. This is an asynchronous job. To get the status of this import, use applianceImportStatus_get

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • iid (required): the id of the applianceImport ticket

HTTP Request Body Parameters

The file to upload.

Example Request

curl "https://uforge.example.com/api/users/{uid}/imports/{iid}/uploads" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@binaryFilePath"

See also

appliance_export

POST /users/{uid}/appliances/{aid}/exports

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.5

Request to export the specified appliance as an archive. This creates an export ticket that contains an archive that can be downloaded. The archive contains the meta-data file of the appliance and any 3rd party software or configuration scripts associated with the appliance.

An archive can be used with the hammr command-line tool.

The response body is an export appliance ticket. To poll the status of this export, use applianceExportStatus_get. Once complete, the archive can be downloaded using applianceExport_download.

Note

No request body is required in this HTTP POST.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/exports" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

appliance_import

POST /users/{uid}/imports

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Requests to import an appliance archive. This creates an appliance import ticket that contains the meta-data information on the appliance that will be created from the archive. Once this ticket is created, the archive can be uploaded using applianceImport_upload. <p/>

An archive can be used with the hammr command-line tool.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/imports" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

Appliance Install Profile API Resources

installProfile_get

GET /users/{uid}/appliances/{aid}/installProfile/{ipid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Retrieves the installation profile for an appliance.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that has created the appliance
  • ipid (required): the id of the installProfile
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/installProfile/{ipid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

installProfile_getDeprecated

GET /users/{uid}/appliances/{aid}/installProfile

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Retrieves the installation profile for an appliance.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that has created the appliance
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/installProfile" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

installProfile_update

PUT /users/{uid}/appliances/{aid}/installProfile/{ipid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Updates an installation profile for an appliance.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that has created the appliance
  • ipid (required): the id of the installProfile
  • aid (required): the id of the appliance

HTTP Request Body Parameters

A installProfile object

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/installProfile/{ipid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:installProfile xmlns:ns0="http://www.usharesoft.com/uforge">
        <firewallAuto>true</firewallAuto>
        <firewallEnabled>false</firewallEnabled>
        <internetSettingsAuto>true</internetSettingsAuto>
        <keyboard>ar-azerty</keyboard>
        <keyboardAuto>false</keyboardAuto>
        <partitionAuto>true</partitionAuto>
        <rootUser>
                <disablePasswordLogin>false</disablePasswordLogin>
                <encrypted>false</encrypted>
                <fullName>root</fullName>
                <name>root</name>
                <password>example</password>
                <passwordAuto>true</passwordAuto>
        </rootUser>
        <timezone>Europe/London</timezone>
        <timezoneAuto>true</timezoneAuto>
</ns0:installProfile>

See also

installProfile_updateDeprecated

PUT /users/{uid}/appliances/{aid}/installProfile

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Updates an installation profile for an appliance.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that has created the appliance
  • aid (required): the id of the appliance

HTTP Request Body Parameters

A installProfile object

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/installProfile" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:installProfile xmlns:ns0="http://www.usharesoft.com/uforge">
        <firewallAuto>true</firewallAuto>
        <firewallEnabled>false</firewallEnabled>
        <internetSettingsAuto>true</internetSettingsAuto>
        <keyboard>ar-azerty</keyboard>
        <keyboardAuto>false</keyboardAuto>
        <partitionAuto>true</partitionAuto>
        <rootUser>
                <disablePasswordLogin>false</disablePasswordLogin>
                <encrypted>false</encrypted>
                <fullName>root</fullName>
                <name>root</name>
                <password>example</password>
                <passwordAuto>true</passwordAuto>
        </rootUser>
        <timezone>Europe/London</timezone>
        <timezoneAuto>true</timezoneAuto>
</ns0:installProfile>

See also

Appliance Install Profile NIC API Resources

  • nic_create: Creates a new network interface card (NIC) for an appliance
  • nic_delete: Deletes the specified network interface card
  • nic_get: Gets the information for a network interface card
  • nic_getAll: Gets all the network interface cards for an appliance
  • nic_update: Updates the meta-data information of a network interface card
  • nic_updateList: Updates the meta-data information of a list of network interface cards

nic_create

POST /users/{uid}/appliances/{aid}/installProfile/{ipid}/nics

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.7

Creates a new network interface card (NIC) for an appliance.

The NIC information is stored in the install profile of the appliance.

Please refer to nic for a complete list of all the nic attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • ipid (required): the id of the installProfile
  • aid (required): the id of the appliance

HTTP Request Body Parameters

A nic object

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/installProfile/{ipid}/nics" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:nic xmlns:ns0="http://www.usharesoft.com/uforge">
        <type>ETHERNET</type>
        <ipv4Method>AUTOMATIC</ipv4Method>
        <ipv6Method>IGNORE</ipv6Method>
</ns0:nic>

See also

nic_delete

DELETE /users/{uid}/appliances/{aid}/installProfile/{ipid}/nics/{nid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.7

Deletes the specified network interface card.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • ipid (required): the id of the installProfile
  • nid (required): the id of the nic to delete
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/installProfile/{ipid}/nics/{nid}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

nic_get

GET /users/{uid}/appliances/{aid}/installProfile/{ipid}/nics/{nid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.7

Gets the information for a network interface card.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • ipid (required): the id of the installProfile
  • nid (required): the id of the nic to delete
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/installProfile/{ipid}/nics/{nid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

nic_getAll

GET /users/{uid}/appliances/{aid}/installProfile/{ipid}/nics

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.7

Gets all the network interface cards for an appliance.

A list of nic objects are returned.

You can use a search criteria to retrieve a subset of these nics.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • ipid (required): the id of the installProfile
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/installProfile/{ipid}/nics" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

nic_update

PUT /users/{uid}/appliances/{aid}/installProfile/{ipid}/nics/{nid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.7

Updates the meta-data information of a network interface card.

Please refer to nic for a complete list of all the nic attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • ipid (required): the id of the installProfile
  • nid (required): the id of the nic to delete
  • aid (required): the id of the appliance

HTTP Request Body Parameters

A nic object

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/installProfile/{ipid}/nics/{nid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:nics xmlns:ns0="http://www.usharesoft.com/uforge">
        <nics>
                <nic>
                        <dbId>1</dbId>
                        <type>ETHERNET</type>
                        <order>1</order>
                </nic>
                <nic>
                        <dbId>12</dbId>
                        <type>ETHERNET</type>
                        <order>0</order>
                </nic>
        </nics>
</ns0:nics>

See also

nic_updateList

PUT /users/{uid}/appliances/{aid}/installProfile/{ipid}/nics

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.7

Updates the meta-data information of a list of network interface cards.

Please refer to nic for a complete list of all the nic attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • ipid (required): the id of the installProfile
  • aid (required): the id of the appliance

HTTP Request Body Parameters

A nics object

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/installProfile/{ipid}/nics" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:nic xmlns:ns0="http://www.usharesoft.com/uforge">
        <type>ETHERNET</type>
        <ipv4Method>AUTOMATIC</ipv4Method>
        <ipv6Method>AUTOMATIC</ipv6Method>
</ns0:nic>

See also

Appliance Install Users and Groups API Resources

installProfileGroup_create

POST /users/{uid}/appliances/{aid}/installProfile/{ipid}/groups

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Adds a new OS group in an install profile.

Refer to osGroup for the mandatory and optional attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that has created the appliance
  • ipid (required): the id of the installProfile
  • aid (required): the id of the appliance

HTTP Request Body Parameters

A osGroup object

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/installProfile/{ipid}/groups" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:osGroup xmlns:ns0="http://www.usharesoft.com/uforge">
        <groupIdAuto>true</groupIdAuto>
        <name>OS Group Example</name>
        <systemGroup>true</systemGroup>
</ns0:osGroup>

See also

installProfileGroup_delete

DELETE /users/{uid}/appliances/{aid}/installProfile/{ipid}/groups/{osgid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.4

Removes an OS group from an install profile.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that has created the appliance
  • ipid (required): the id of the installProfile
  • osgid (required): the id of the osGroup
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/installProfile/{ipid}/groups/{osgid}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

installProfileGroup_deleteAll

DELETE /users/{uid}/appliances/{aid}/installProfile/{ipid}/groups

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.4

Removes all the OS groups from an install profile.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that has created the appliance
  • ipid (required): the id of the installProfile
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/installProfile/{ipid}/groups" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

installProfileGroup_get

GET /users/{uid}/appliances/{aid}/installProfile/{ipid}/groups/{osgid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Retrieves the meta-data information of an OS group registered in an install profile.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that has created the appliance
  • ipid (required): the id of the installProfile
  • osgid (required): the id of the osGroup
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/installProfile/{ipid}/groups/{osgid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

installProfileGroup_getAll

GET /users/{uid}/appliances/{aid}/installProfile/{ipid}/groups

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Retrieves all the OS groups registered in an install profile.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that has created the appliance
  • ipid (required): the id of the installProfile
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

installProfileGroup_update

PUT /users/{uid}/appliances/{aid}/installProfile/{ipid}/groups/{osgid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Updates an OS group registered in an install profile.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that has created the appliance
  • ipid (required): the id of the installProfile
  • osgid (required): the id of the osGroup
  • aid (required): the id of the appliance

HTTP Request Body Parameters

A osGroup object

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/installProfile/{ipid}/groups/{osgid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:osGroup xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>OS Group Example Updated</name>
        <systemGroup>false</systemGroup>
</ns0:osGroup>

See also

installProfileUser_create

POST /users/{uid}/appliances/{aid}/installProfile/{ipid}/users

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Adds a new OS user in an install profile.

Refer to osUser for the mandatory and optional attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that has created the appliance
  • ipid (required): the id of the installProfile
  • aid (required): the id of the appliance

HTTP Request Body Parameters

A osUser object

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/installProfile/{ipid}/users" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:osUser xmlns:ns0="http://www.usharesoft.com/uforge">
        <fullName>OSUserExample</fullName>
        <homeDir>/home/OSUserExample</homeDir>
        <name>OSUserExample</name>
        <password>password</password>
        <primaryGroupAuto>true</primaryGroupAuto>
        <shell>/bin/bash</shell>
        <systemUser>true</systemUser>
        <userIdAuto>true</userIdAuto>
</ns0:osUser>

See also

installProfileUser_delete

DELETE /users/{uid}/appliances/{aid}/installProfile/{ipid}/users/{osuid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.4

Removes an OS user from an install profile.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that has created the appliance
  • ipid (required): the id of the installProfile
  • aid (required): the id of the appliance
  • osuid (required): the id of the osUser

HTTP Request Body Parameters

None

installProfileUser_deleteAll

DELETE /users/{uid}/appliances/{aid}/installProfile/{ipid}/users

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.4

Removes all the OS users from an install profile.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that has created the appliance
  • ipid (required): the id of the installProfile
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

installProfileUser_get

GET /users/{uid}/appliances/{aid}/installProfile/{ipid}/users/{osuid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Retrieves the meta-data information of an OS user registered in an install profile.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that has created the appliance
  • ipid (required): the id of the installProfile
  • aid (required): the id of the appliance
  • osuid (required): the id of the osUser

HTTP Request Body Parameters

None

installProfileUser_getAll

GET /users/{uid}/appliances/{aid}/installProfile/{ipid}/users

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Retrieves all the OS users registered in an install profile.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that has created the appliance
  • ipid (required): the id of the installProfile
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

installProfileUser_update

PUT /users/{uid}/appliances/{aid}/installProfile/{ipid}/users/{osuid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Updates an OS user registered in an install profile.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that has created the appliance
  • ipid (required): the id of the installProfile
  • aid (required): the id of the appliance
  • osuid (required): the id of the osUser

HTTP Request Body Parameters

A osUser object

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/installProfile/{ipid}/users/{osuid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:osUser xmlns:ns0="http://www.usharesoft.com/uforge">
        <fullName>OS User Example Updated</fullName>
        <homeDir>/home/OSUserExampleUpdated</homeDir>
</ns0:osUser>

See also

Appliance OS Profile API Resources

applianceOSProfileApplications_get

GET /users/{uid}/appliances/{aid}/osprofile/{osid}/applications/{appid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.7.fp3

Retrieves an application contained in the OS profile.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/osprofile/{osid}/applications/{appid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

applianceOSProfileApplications_getAll

GET /users/{uid}/appliances/{aid}/osprofile/{osid}/applications

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.7.fp3

Retrieves all the applications contained in the OS profile.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • osid (required): the id of the windowsProfile
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

applianceOSProfilePkg_getAll

GET /users/{uid}/appliances/{aid}/osprofile/{osid}/pkgs

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Retrieves all the native packages contained in the OS profile.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that has created the appliance
  • osid (required): the id of the linuxProfile
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/osprofile/{osid}/pkgs" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

applianceOSProfilePkg_updateAll

PUT /users/{uid}/appliances/{aid}/osprofile/{osid}/pkgs

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Updates the native packages contained in an OS profile.

Warning

All the packages that are not contained in the new package list are removed from the OS profile. All new packages in the list will be added to the OS profile.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that has created the appliance
  • osid (required): the id of the linuxProfile
  • aid (required): the id of the appliance

HTTP Request Body Parameters

A packages object

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/osprofile/{osid}/pkgs" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:packages xmlns:ns0="http://www.usharesoft.com/uforge">
        <addedPkgUris>
                <uri>distributions/1/pkgs/104169</uri>
                <uri>distributions/1/pkgs/104537</uri>
        </addedPkgUris>
        <deletedPkgUris></deletedPkgUris>
</ns0:packages>

See also

applianceOSProfileServices_get

GET /users/{uid}/appliances/{aid}/osprofile/{osid}/services/{sid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.7.fp3

Retrieves a service contained in the OS profile.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that has created the appliance
  • prid (optional):
  • aid (required): the id of the abstractWinApplication
  • sid (required): the id of the winService

HTTP Request Body Parameters

None

applianceOSProfileServices_getAll

GET /users/{uid}/appliances/{aid}/osprofile/{osid}/services

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.7.fp3

Retrieves all the services contained in the OS profile.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that has created the appliance
  • prid (optional):
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

applianceOSProfile_create

POST /users/{uid}/appliances/{aid}/osprofile

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Adds a new OS profile to an appliance.

Refer to distribprofile-object for mandatory and optional parameters

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that has created the appliance
  • aid (required): the id of the appliance

HTTP Request Body Parameters

A distribProfile object

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/osprofile" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:distribProfile xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>Minimal</name>
        <standardProfileUri>distributions/1/profiles/4</standardProfileUri>
</ns0:distribProfile>

See also

applianceOSProfile_delete

DELETE /users/{uid}/appliances/{aid}/osprofile/{osid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 1.0

Removes an OS profile from an appliance.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that has created the appliance
  • osid (required): the id of the distribProfile
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/osprofile/{osid}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

applianceOSProfile_get

GET /users/{uid}/appliances/{aid}/osprofile/{osid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Retrieves an OS profile from an appliance.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that has created the appliance
  • osid (required): the id of the distribProfile
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/osprofile/{osid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

applianceOSUpdates_get

GET /users/{uid}/appliances/{aid}/osprofile/{osid}/updates

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 2.1

Retrieves a list of possible package updates for all the packages contained in an OS profile. The available updates are calculated based on one or more timestamps provided as part of the request. This includes: - from: the start date on where to calculate available updates - to: the end date on where to calculate available updates - at: a specific date on where to calculate available updates

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that has created the appliance
  • osid (required): the id of the linuxProfile
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/osprofile/{osid}/updates" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

applianceOSUpdates_save

PUT /users/{uid}/appliances/{aid}/osprofile/{osid}/updates

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 2.1

Updates the OS profile package list with any available updates. The available updates are calculated based on a date timestamp provided as part of the request as a query parameter.

To simulate the available updates available at a certain date or range of dates, see applianceOSUpdates_get

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that has created the appliance
  • osid (required): the id of the linuxProfile
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/osprofile/{osid}/updates" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

Appliance Partition Table API Resources

partitionTableBtrfsStoragePool_create

POST users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/pools

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.5

Creates a new btrfs storage pool in a partitioning table.

Please refer to btrfsStoragePool for a complete list of all the btrfs storage pool attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance

HTTP Request Body Parameters

A btrfsStoragePool object

Example Request

curl "https://uforge.example.com/apiusers/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/pools" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

See also

partitionTableBtrfsStoragePool_delete

DELETE users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/pools/{plid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.8.5

Removes a btrfs storage pool from a partitioning table.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that has created the appliance
  • plid (required): the id of the btrfsStoragePool
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/apiusers/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/pools/{plid}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

partitionTableBtrfsStoragePool_deleteAll

DELETE users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/pools

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.8.5

Removes all the btrfs storage pools from a partitioning table.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/apiusers/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/pools" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

partitionTableBtrfsStoragePool_get

GET users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/pools/{plid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.5

Retrieves the information of a btrfs storage pool.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that has created the appliance
  • plid (required): the id of the btrfsStoragePool
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

partitionTableBtrfsStoragePool_getAll

GET users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/pools

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.5

Retrieves all the btrfs storage pools for a partitioning table.

A list of btrfsStoragePool objects are returned.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/apiusers/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/pools" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

partitionTableBtrfsStoragePool_update

PUT users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/pools/{plid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.5

Updates the information of a btrfs storage pool.

Please refer to btrfsStoragePool for a complete list of all the btrfs storage pool attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that has created the appliance
  • plid (required): the id of the btrfsStoragePool
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance

HTTP Request Body Parameters

A btrfsStoragePool object

Example Request

curl "https://uforge.example.com/apiusers/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/pools/{plid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

See also

partitionTableBtrfsSubvolume_create

POST users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/subvolumes

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.5

Creates a new btrfs subvolume in a partitioning table.

Please refer to btrfsSubvolume for a complete list of all the btrfs subvolume attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance

HTTP Request Body Parameters

A btrfsSubvolume object

Example Request

curl "https://uforge.example.com/apiusers/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/subvolumes" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

See also

partitionTableBtrfsSubvolume_delete

DELETE users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/subvolumes/{svid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.8.5

Removes a btrfs subvolume from a partitioning table.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • svid (required): the id of the btrfsSubvolume
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/apiusers/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/subvolumes/{svid}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

partitionTableBtrfsSubvolume_deleteAll

DELETE users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/subvolumes

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.8.5

Removes all the btrfs subvolumes from a partitioning table.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/apiusers/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/subvolumes" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

partitionTableBtrfsSubvolume_get

GET users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/subvolumes/{svid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.5

Retrieves the information of a btrfs subvolume.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • svid (required): the id of the btrfsSubvolume
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/apiusers/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/subvolumes/{svid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

partitionTableBtrfsSubvolume_getAll

GET users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/subvolumes

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.5

Retrieves all the btrfs subvolumes for a partitioning table.

A list of btrfsSubvolume objects are returned.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

partitionTableBtrfsSubvolume_update

PUT users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/subvolumes/{svid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.5

Updates the information of a btrfs subvolume.

Please refer to btrfsSubvolume for a complete list of all the logical volume attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • svid (required): the id of the btrfsSubvolume
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance

HTTP Request Body Parameters

A btrfsSubvolume object

Example Request

curl "https://uforge.example.com/apiusers/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/subvolumes/{svid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

See also

Appliance Partition Table Disk API Resources

partitionTableDisk_create

POST users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/disks

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 2.1

Creates a new physical disk to a partitioning table.

Please refer to disk for a complete list of all the partition table disk attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance

HTTP Request Body Parameters

A disk object

Example Request

curl "https://uforge.example.com/apiusers/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/disks" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<disk xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>sda</name>
        <partitionType>MSDOS</partitionType>
        <partition>
                <name>boot</name>
                <mpoint>/boot</mpoint>
                <size>256</size>
                <label>/boot</label>
                <fstype>ext3</fstype>
        </partition>
</disk>

See also

partitionTableDisk_delete

DELETE users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/disks/{did}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 2.1

Removes a disk from a partitioning table.

This deletes any physical or logical partitions for the disk.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance
  • did (required): the id of the disk

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/apiusers/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/disks/{did}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

partitionTableDisk_deleteAll

DELETE users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/disks

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 2.1

Remove all the disks from a partitioning table.

This deletes any physical or logical partitions for the disks.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

partitionTableDisk_get

GET users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/disks/{did}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 2.1

Retrieves the information of a disk in a partitioning table.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance
  • did (required): the id of the disk

HTTP Request Body Parameters

None

partitionTableDisk_getAll

GET users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/disks

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 2.1

Retrieves all the physical disks for a partitioning table.

A list of appliance objects are returned.

You can use a search criteria to retrieve a subset of these disks.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

partitionTableDisk_update

PUT users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/disks/{did}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 2.1

Updates the information of a disk in a partitioning table.

Please refer to disk for a complete list of all the partition table disk attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance
  • did (required): the id of the disk

HTTP Request Body Parameters

A disk object

Example Request

curl "https://uforge.example.com/apiusers/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/disks/{did}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<disk xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>sda</name>
        <partitionType>MSDOS</partitionType>
        <partition>
                <name>boot</name>
                <mpoint>/boot</mpoint>
                <size>256</size>
                <label>/boot</label>
                <fstype>ext3</fstype>
        </partition>
</disk>

See also

Appliance Partition Table Disk Partition API Resources

partitionTableDiskLogicalPartition_create

POST users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/disks/{did}/partitions/{pid}/lpartitions

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 2.1

Create a logical partition in a physical partition.

Please refer to partition for a complete list of all the partition attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • pid (required): the id of the partition
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance
  • did (required): the id of the disk

HTTP Request Body Parameters

A partition object

Example Request

curl "https://uforge.example.com/apiusers/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/disks/{did}/partitions/{pid}/lpartitions" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:partition xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>logicalPartition1</name>
        <mpoint>/data</mpoint>
        <size>1024</size>
        <label>/data</label>
        <fstype>ext3</fstype>
</ns0:partition>

See also

partitionTableDiskLogicalPartition_delete

DELETE users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/disks/{did}/partitions/{pid}/lpartitions/{lpid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 2.1

Removes a logical partition from a physical partition.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • pid (required): the id of the partition
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance
  • lpid (required): the id of the logical partition
  • did (required): the id of the disk

HTTP Request Body Parameters

None

partitionTableDiskLogicalPartition_deleteAll

DELETE users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/disks/{did}/partitions/{pid}/lpartitions

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 2.1

Removes all the logical partitions from a physical partition.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • pid (required): the id of the partition
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance
  • did (required): the id of the disk

HTTP Request Body Parameters

None

partitionTableDiskLogicalPartition_get

GET users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/disks/{did}/partitions/{pid}/lpartitions/{lpid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 2.1

Retrieves the information of a logical partition.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • pid (required): the id of the partition
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance
  • lpid (required): the id of the logical partition
  • did (required): the id of the disk

HTTP Request Body Parameters

None

partitionTableDiskLogicalPartition_getAll

GET users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/disks/{did}/partitions/{pid}/lpartitions

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 2.1

Retrieves all the logical partitions in a physical partition.

A list of partition objects are returned.

You can use a search criteria to retrieve a subset of these partitions.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • pid (required): the id of the partition
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance
  • did (required): the id of the disk

HTTP Request Body Parameters

None

partitionTableDiskLogicalPartition_update

PUT users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/disks/{did}/partitions/{pid}/lpartitions/{lpid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 2.1

Updates a logical partition information in a physical partition.

Please refer to partition for a complete list of all the partition attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • pid (required): the id of the partition
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance
  • lpid (required): the id of the logical partition
  • did (required): the id of the disk

HTTP Request Body Parameters

A partition object

Example Request

curl "https://uforge.example.com/apiusers/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/disks/{did}/partitions/{pid}/lpartitions/{lpid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:partition xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>logicalPartition1Updated</name>
        <mpoint>/data</mpoint>
        <size>2048</size>
        <label>/data2</label>
        <fstype>ext4</fstype>
</ns0:partition>

See also

partitionTableDiskPartition_create

POST users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/disks/{did}/partitions

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 2.1

Creates a new physical partition in a disk.

Please refer to partition for a complete list of all the partition attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance
  • did (required): the id of the disk

HTTP Request Body Parameters

A partition object

Example Request

curl "https://uforge.example.com/apiusers/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/disks/{did}/partitions" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<partition xmlns:ns0="http://www.usharesoft.com/uforge">
        <fstype>lvm2</fstype>
</partition>

See also

partitionTableDiskPartition_delete

DELETE users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/disks/{did}/partitions/{pid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 2.1

Removes a physical partition from a disk.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • pid (required): the id of the partition
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance
  • did (required): the id of the disk

HTTP Request Body Parameters

None

partitionTableDiskPartition_deleteAll

DELETE users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/disks/{did}/partitions

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 2.1

Removes all the physical partitions from a disk.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance
  • did (required): the id of the disk

HTTP Request Body Parameters

None

partitionTableDiskPartition_get

GET users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/disks/{did}/partitions/{pid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 2.1

Retrieves the information of a physical partition in a disk.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • pid (required): the id of the partition
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance
  • did (required): the id of the disk

HTTP Request Body Parameters

None

partitionTableDiskPartition_getAll

GET users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/disks/{did}/partitions

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 2.1

Retrieves all the physical partitions in a disk.

A list of partition objects are returned.

You can use a search criteria to retrieve a subset of these partitions.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance
  • did (required): the id of the disk

HTTP Request Body Parameters

None

partitionTableDiskPartition_update

PUT users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/disks/{did}/partitions/{pid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 2.1

Updates a physical partition in a disk.

Please refer to partition for a complete list of all the partition attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • pid (required): the id of the partition
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance
  • did (required): the id of the disk

HTTP Request Body Parameters

A partition object

Appliance Partition Table Logical Group API Resources

partitionTableLogicalGroup_create

POST users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/groups

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 2.1

Creates a new logical group in a partitioning table.

Please refer to logicalGroup for a complete list of all the logical group attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance

HTTP Request Body Parameters

A logicalGroup object

Example Request

curl "https://uforge.example.com/apiusers/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/groups" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

See also

partitionTableLogicalGroup_delete

DELETE users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/groups/{gid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 2.1

Removes a logical group from a partitioning table.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • gid (required): the id of the logicalGroup
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

partitionTableLogicalGroup_deleteAll

DELETE users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/groups

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 2.1

Removes all the logical groups from a partitioning table.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

partitionTableLogicalGroup_get

GET users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/groups/{gid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 2.1

Retrieves the information of a logical group.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • gid (required): the id of the logicalGroup
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

partitionTableLogicalGroup_getAll

GET users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/groups

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 2.1

Retrieves all the logical groups for a partitioning table.

A list of logicalGroup objects are returned.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

partitionTableLogicalGroup_update

PUT users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/groups/{gid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 2.1

Updates the information of a logical group.

Please refer to logicalGroup for a complete list of all the logical group attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • gid (required): the id of the logicalGroup
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance

HTTP Request Body Parameters

A logicalGroup object

Example Request

curl "https://uforge.example.com/apiusers/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/groups/{gid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

See also

Appliance Partition Table Logical Volume API Resources

partitionTableLogicalVolume_create

POST users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/volumes

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 2.1

Creates a new logical volume in a partitioning table.

Please refer to logicalVolume for a complete list of all the logical volume attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance

HTTP Request Body Parameters

A logicalVolume object

Example Request

curl "https://uforge.example.com/apiusers/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/volumes" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

See also

partitionTableLogicalVolume_delete

DELETE users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/volumes/{vid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 2.1

Removes a logical volume from a partitioning table.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • vid (required): the id of the logicalVolume
  • uid (required): the user name (login name) of the user that created the appliance
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

partitionTableLogicalVolume_deleteAll

DELETE users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/volumes

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 2.1

Removes all the logical volumes from a partitioning table.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

partitionTableLogicalVolume_get

GET users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/volumes/{vid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 2.1

Retrieves the information of a logical volume.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • vid (required): the id of the logicalVolume
  • uid (required): the user name (login name) of the user that created the appliance
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

partitionTableLogicalVolume_getAll

GET users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/volumes

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 2.1

Retrieves all the logical volumes for a partitioning table.

A list of logicalVolume objects are returned.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user that created the appliance
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

partitionTableLogicalVolume_update

PUT users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/volumes/{vid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 2.1

Updates the information of a logical volume.

Please refer to logicalVolume for a complete list of all the logical volume attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • vid (required): the id of the logicalVolume
  • uid (required): the user name (login name) of the user that created the appliance
  • ptid (required): the id of the partitionTable
  • aid (required): the id of the appliance

HTTP Request Body Parameters

A logicalVolume object

Example Request

curl "https://uforge.example.com/apiusers/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/volumes/{vid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

See also

Appliance Software Component API Resources

  • applianceMySoftware_getAll: Retrieves all the 3rd party software components that have been added to the appliance from the user’s Software Library
  • applianceProject_getAll: Retrieves all the projects that have been added to the appliance from the Project Catalog

applianceMySoftware_getAll

GET /users/{uid}/appliances/{aid}/mysoftware

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Retrieves all the 3rd party software components that have been added to the appliance from the user’s Software Library.

This returns a list of mySoftware objects.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/mysoftware" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

applianceProject_getAll

GET /users/{uid}/appliances/{aid}/projects

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Retrieves all the projects that have been added to the appliance from the Project Catalog.

This returns a list of project objects.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/projects" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

Artifact Accounts API Resources

orgArtifactCredAccount_create

POST /orgs/{oid}/artifactaccounts

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Creates a new artifact account that can be used by all the users in the organization.

Please refer to artifactCredAccount for a complete list of all the artifact account attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: cloud_account_create

URI Parameters

  • oid (required): the id of the org

HTTP Request Body Parameters

A artifactCredAccount object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/artifactaccounts" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:artifactCredAccount xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>my-artifact-account</name>
        <host>myremoterepo.com</host>
        <type>ftp</type>
        <port>21</port>
        <login>admin</login>
        <password>adminpwd</password>
</ns0:artifactCredAccount>

See also

orgArtifactCredAccount_delete

DELETE /orgs/{oid}/artifactaccounts/{caid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.6

Remove an artifact account from an organization.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: cloud_account_delete

URI Parameters

HTTP Request Body Parameters

None

orgArtifactCredAccount_get

GET /orgs/{oid}/artifactaccounts/{caid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Retrieve information of an artifact account.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: software_upload

URI Parameters

HTTP Request Body Parameters

None

orgArtifactCredAccount_getAll

GET /orgs/{oid}/artifactaccounts

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Retrieves all organization artifact accounts. These accounts can be used by all the users in the organization

A list of artifactCredAccount objects are returned. You can use a search criteria to retrieve a subset of these artifact accounts.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: cloud_account_access

URI Parameters

  • oid (required): the id of the org

HTTP Request Body Parameters

None

orgArtifactCredAccount_update

PUT /orgs/{oid}/artifactaccounts/{caid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Update the meta-data of an artifact account.

Please refer to artifactCredAccount for a complete list of all the artifact account attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: cloud_account_edit

URI Parameters

HTTP Request Body Parameters

A artifactCredAccount object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/artifactaccounts/{caid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:artifactCredAccount xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>my-artifact-account-update</name>
        <host>myremoterepo-update.com</host>
        <type>ftp</type>
        <port>21</port>
        <login>admin-update</login>
        <password>adminpwd-update</password>
</ns0:artifactCredAccount>

See also

userArtifactCredAccount_create

POST /users/{uid}/artifactaccounts

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Creates a new artifact account for an user.

Please refer to artifactCredAccount for a complete list of all the artifact account attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: cloud_account_create

URI Parameters

  • uid (required): the id of the user

HTTP Request Body Parameters

A artifactCredAccount object

Example Request

curl "https://uforge.example.com/api/users/{uid}/artifactaccounts" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:artifactCredAccount xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>my-artifact-account</name>
        <host>myremoterepo.com</host>
        <type>ftp</type>
        <port>21</port>
        <login>admin</login>
        <password>adminpwd</password>
</ns0:artifactCredAccount>

See also

userArtifactCredAccount_delete

DELETE /users/{uid}/artifactaccounts/{caid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.6

Remove an artifact account from an user.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: cloud_account_delete

URI Parameters

HTTP Request Body Parameters

None

userArtifactCredAccount_get

GET /users/{uid}/artifactaccounts/{caid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Retrieve information of an artifact account.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: software_upload

URI Parameters

HTTP Request Body Parameters

None

userArtifactCredAccount_getAll

GET /users/{uid}/artifactaccounts

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Retrieve all artifact accounts for a user.

A list of artifactCredAccount objects are returned. You can use a search criteria to retrieve a subset of these artifact accounts.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: cloud_account_access

URI Parameters

  • uid (required): the id of the user

HTTP Request Body Parameters

None

userArtifactCredAccount_update

PUT /users/{uid}/artifactaccounts/{caid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Update the meta-data of an artifact account.

Please refer to artifactCredAccount for a complete list of all the artifact account attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: cloud_account_edit

URI Parameters

HTTP Request Body Parameters

A artifactCredAccount object

Example Request

curl "https://uforge.example.com/api/users/{uid}/artifactaccounts/{caid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:artifactCredAccount xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>my-artifact-account-update</name>
        <host>myremoterepo-update.com</host>
        <type>ftp</type>
        <port>21</port>
        <login>admin-update</login>
        <password>adminpwd-update</password>
</ns0:artifactCredAccount>

See also

Blueprint API Resources

blueprintPipelineStatus_get

GET /users/{uid}/blueprints/{bpid}/preparations/{plid}/status

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.8

Retrieves preparation status

Security Summary

  • Requires Authentication: true
  • Entitlements Required: deployments_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • plid (required): the id of the pipeline
  • bpid (required): the id of the blueprint

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/blueprints/{bpid}/preparations/{plid}/status" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

blueprintPipeline_cancel

DELETE /users/{uid}/blueprints/{bpid}/preparations/{plid}/status

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.8

Cancel a running preparation.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: deployments_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • plid (required): the id of the pipeline
  • bpid (required): the id of the blueprint

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/blueprints/{bpid}/preparations/{plid}/status" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

blueprint_create

POST /users/{uid}/blueprints

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.fp4

Creates a blueprint in a user’s Blueprint Library.

Please refer to blueprint for a complete list of all the attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: deployments_access

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

A blueprint object

Example Request

curl "https://uforge.example.com/api/users/{uid}/blueprints" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

       <ns0:blueprint xmlns:ns0="http://www.usharesoft.com/uforge">
               <xsi:type></xsi:type>
               <name>My Blueprint</name>
               <description>My description</description>
               <version>7.0</version>
               <blueprintServices>
                       <blueprintService>
                               <serviceId>MariaDB</serviceId>
                               <minCores>2</minCores>
                               <minMemory>512</minMemory>
                               <config>
brooklyn.config:
http.port: 80
</config>
                               <applianceSummary>
                                       <uri>users/guest/appliance/204</uri>
                               </applianceSummary>
                       </blueprintService>
               </blueprintServices>
       </ns0:blueprint>

See also

blueprint_delete

DELETE /users/{uid}/blueprints/{bpid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.8.fp4

Removes a blueprint from a user’s Blueprint Library.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: deployments_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • bpid (required): the id of the blueprint

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/blueprints/{bpid}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

blueprint_deploy

POST /users/{uid}/blueprints/{bpid}/deployments

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.fp4

Deploys a blueprint.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: deployments_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • bpid (required): the id of the blueprint

HTTP Request Body Parameters

A blueprintDeployment object

Example Request

curl "https://uforge.example.com/api/users/{uid}/blueprints/{bpid}/deployments" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:blueprintDeployment xmlns:ns0="http://www.usharesoft.com/uforge">
        <xsi:type></xsi:type>
        <credAccountUri>users/guest/accounts/4</credAccountUri>
        <region>eu-west-2</region>
</ns0:blueprintDeployment>

See also

blueprint_get

GET /users/{uid}/blueprints/{bpid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.fp4

Retrieves a blueprint from a user’s Blueprint Library.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: deployments_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • bpid (required): the id of the blueprint

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/blueprints/{bpid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

blueprint_getAll

GET /users/{uid}/blueprints

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.fp4

Returns all the blueprints created by a particular user.

A list of blueprintSummary objects are returned.

Please refer to blueprintSummary for a complete list of all the attributes.

You can use a search criteria to retrieve a subset of these blueprints.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: deployments_access

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/blueprints" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

blueprint_predeploy

POST /users/{uid}/blueprints/{bpid}/predeploy

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.8

Returns the status of the appliances used for a blueprint.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: deployments_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • bpid (required): the id of the blueprint

HTTP Request Body Parameters

A blueprintDeployment object

Example Request

curl "https://uforge.example.com/api/users/{uid}/blueprints/{bpid}/predeploy" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:blueprintDeployment xmlns:ns0="http://www.usharesoft.com/uforge">
        <xsi:type></xsi:type>
        <credAccountUri>users/guest/accounts/4</credAccountUri>
        <region>eu-west-2</region>
</ns0:blueprintDeployment>

See also

blueprint_update

PUT /users/{uid}/blueprints/{bpid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.fp4

Updates a blueprint from a user’s Blueprint Library.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: deployments_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • bpid (required): the id of the blueprint

HTTP Request Body Parameters

A blueprint object

Example Request

curl "https://uforge.example.com/api/users/{uid}/blueprints/{bpid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

       <ns0:blueprint xmlns:ns0="http://www.usharesoft.com/uforge">
               <xsi:type></xsi:type>
               <name>My Blueprint</name>
               <description>My description</description>
               <version>7.0</version>
               <blueprintServices>
                       <blueprintService>
                               <serviceId>MariaDB</serviceId>
                               <minCores>2</minCores>
                               <minMemory>512</minMemory>
                               <config>
brooklyn.config:
http.port: 80
</config>
                               <applianceSummary>
                                       <uri>users/guest/appliance/204</uri>
                               </applianceSummary>
                       </blueprintService>
               </blueprintServices>
       </ns0:blueprint>

See also

pipeline_get

GET /users/{uid}/blueprints/{bpid}/preparations/{plid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.8

Retrieves a preparation from a blueprint

Security Summary

  • Requires Authentication: true
  • Entitlements Required: deployments_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • plid (required): the id of the pipeline
  • bpid (required): the id of the blueprint

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/blueprints/{bpid}/preparations/{plid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

pipeline_getAll

GET /users/{uid}/blueprints/{bpid}/preparations

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.8

Returns all the preparations created for a blueprint.

A list of pipeline objects are returned.

Please refer to pipeline for a complete list of all the attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: deployments_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • bpid (required): the id of the blueprint

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/blueprints/{bpid}/preparations" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

prepare

POST /users/{uid}/blueprints/{bpid}/preparations

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.8

Prepares a blueprint for deployment.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: deployments_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • bpid (required): the id of the blueprint

HTTP Request Body Parameters

A blueprintDeployment object

Example Request

curl "https://uforge.example.com/api/users/{uid}/blueprints/{bpid}/preparations" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:blueprintDeployment xmlns:ns0="http://www.usharesoft.com/uforge">
        <xsi:type></xsi:type>
        <credAccountUri>users/guest/accounts/4</credAccountUri>
        <region>eu-west-2</region>
</ns0:blueprintDeployment>

See also

Categories API Resources

categoryChild_create

POST /orgs/{oid}/categories/{cid}/subcategories

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.0

Creates a sub-category under an existing category.

Refer to category for all the mandatory and optional attributes.

Warning

Only administrators have the ability to create and manage categories

Security Summary

  • Requires Authentication: true
  • Entitlements Required: categories_administrate

URI Parameters

  • oid (required): the id of the org
  • cid (required): the id of the parent category

HTTP Request Body Parameters

A category object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/categories/{cid}/subcategories" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:category xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>Category Example</name>
        <type>PROJECT</type>
</ns0:category>

See also

category_create

POST /orgs/{oid}/categories

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.0

Creates a new category in an organization.

Refer to category for all the mandatory and optional attributes.

Warning

Only administrators have the ability to create and manage categories

Security Summary

  • Requires Authentication: true
  • Entitlements Required: categories_administrate

URI Parameters

  • oid (required): the id of the org

HTTP Request Body Parameters

A category object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/categories" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:category xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>Category Example</name>
        <type>PROJECT</type>
</ns0:category>

See also

category_delete

DELETE /orgs/{oid}/categories/{cid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.0

Deletes a category from an organization.

Warning

Only administrators have the ability to create and manage categories

Security Summary

  • Requires Authentication: true
  • Entitlements Required: categories_administrate

URI Parameters

  • oid (required): the id of the org
  • cid (required): the id of the category

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/categories/{cid}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

category_deleteAll

DELETE /orgs/{oid}/categories

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.0

Deletes all of the categories from an organization.

A subset of categories can be deleted by providing a list of category ids to delete as a set of query parameters in the request.

Warning

Only administrators have the ability to create and manage categories

Security Summary

  • Requires Authentication: true
  • Entitlements Required: categories_administrate

URI Parameters

  • oid (required): the id of the org

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/categories" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

category_get

GET /orgs/{oid}/categories/{cid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.0

Retrieves a category from an organization.

Note

This also provides any child categories (sub-categories) this category may have.

Security Summary

  • Requires Authentication: false
  • Entitlements Required: None

URI Parameters

  • oid (required): the id of the org
  • cid (required): the id of the category

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/categories/{cid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

category_getAll

GET /orgs/{oid}/categories

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.0

Retrieves all the categories from an organization.

A search criteria can be used to retrieve a subset of the categories in the organization.

Security Summary

  • Requires Authentication: false
  • Entitlements Required: None

URI Parameters

  • oid (required): the id of the org

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/categories" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

category_update

PUT /orgs/{oid}/categories/{cid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.0

Update an existing category.

Refer to category for all the mandatory and optional attributes.

Warning

Only administrators have the ability to create and manage categories

Security Summary

  • Requires Authentication: true
  • Entitlements Required: categories_administrate

URI Parameters

  • oid (required): the id of the org
  • cid (required): the id of the category

HTTP Request Body Parameters

A category object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/categories/{cid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:category xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>New name</name>
        <type>PROJECT</type>
</ns0:category>

See also

Containers API Resources

containerTemplateImageGeneration_cancel

DELETE /users/{uid}/mysoftware/{msid}/templates/{tid}/images/{tiid}/status

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.9

Cancels a running generation of a machine image generated from a container template.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_generate

URI Parameters

  • uid (required): the user name (login name) of the user
  • msid (required): the id of the mySoftware
  • tiid (required): the id of the image
  • tid (required): the id of the containerTemplate

HTTP Request Body Parameters

None

containerTemplateImageGeneration_get

GET /users/{uid}/mysoftware/{msid}/templates/{tid}/images/{tiid}/status

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.9

Retrieves the generation status of a machine image generated from a container template.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • msid (required): the id of the mySoftware
  • tiid (required): the id of the image
  • tid (required): the id of the containerTemplate

HTTP Request Body Parameters

None

containerTemplateImagePkg_getAll

GET /users/{uid}/mysoftware/{msid}/templates/{tid}/images/{tiid}/pkgs

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.12

Retrieves all the native packages contained in the machine image.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • msid (required): the id of the mySoftware
  • tiid (required): the id of the image
  • tid (required): the id of the containerTemplate

HTTP Request Body Parameters

None

containerTemplateImagePublish_cancel

DELETE /users/{uid}/mysoftware/{msid}/templates/{tid}/images/{tiid}/pimages/{ptiid}/cancel

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.9

Cancels a running publish of a machine image generated from a container template.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_publish

URI Parameters

HTTP Request Body Parameters

None

containerTemplateImagePublish_get

GET /users/{uid}/mysoftware/{msid}/templates/{tid}/images/{tiid}/pimages/{ptiid}/status

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.9

Retrieves the publish status of a machine image generated from a container template.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_publish

URI Parameters

HTTP Request Body Parameters

None

containerTemplateImagePublished_delete

DELETE /users/{uid}/mysoftware/{msid}/templates/{tid}/images/{tiid}/pimages/{ptiid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.8.9

Deletes a published machine image for a container template.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_publish

URI Parameters

HTTP Request Body Parameters

None

containerTemplateImagePublished_get

GET /users/{uid}/mysoftware/{msid}/templates/{tid}/images/{tiid}/pimages/{ptiid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.9

Retrieves a published machine image for a container template.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_publish

URI Parameters

HTTP Request Body Parameters

None

containerTemplateImage_delete

DELETE /users/{uid}/mysoftware/{msid}/templates/{tid}/images/{tiid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.8.9

Deletes a machine image generated from a container template.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • msid (required): the id of the mySoftware
  • tiid (required): the id of the image
  • tid (required): the id of the containerTemplate

HTTP Request Body Parameters

None

containerTemplateImage_download

GET /users/{uid}/mysoftware/{msid}/templates/{tid}/images/{itid}/downloads

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 3.8.9

Downloads a generated machine image.

This request is the same as containerTemplateImage_downloadFile

Note

You can only download a generated machine image if the initial generation request included the compress flag. For more information, see containerTemplate_generate.

The machine image can be downloaded without authentication if an downloadId is added as a query parameter. To retrieve the downloadId, use containerTemplateImage_get.

Note

The downloadId can only be used once, afterwards it expires, and a new downloadId must be retrieved.

Security Summary

  • Requires Authentication: false
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user
  • msid (required): the id of the mySoftware
  • itid (required): the id of the image
  • tid (required): the id of the containerTemplate

HTTP Request Body Parameters

None

containerTemplateImage_downloadFile

GET /users/{uid}/mysoftware/{msid}/templates/{tid}/images/{itid}/downloads/{fileName}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 3.8.9

Downloads a generated machine image.

This request is the same as containerTemplateImage_download

Note

You can only download a generated machine image if the initial generation request included the compress flag. For more information, see containerTemplate_generate.

The machine image can be downloaded without authentication if an downloadId is added as a query parameter. To retrieve the downloadId, use containerTemplateImage_get.

Note

The downloadId can only be used once, afterwards it expires, and a new downloadId must be retrieved.

Security Summary

  • Requires Authentication: false
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user
  • msid (required): the id of the mySoftware
  • fileName (required): the file name of the machine image
  • itid (required): the id of the image
  • tid (required): the id of the containerTemplate

HTTP Request Body Parameters

None

containerTemplateImage_get

GET /users/{uid}/mysoftware/{msid}/templates/{tid}/images/{tiid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.9

Retrieves the meta-data of a machine image from a container template.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • msid (required): the id of the mySoftware
  • tiid (required): the id of the image
  • tid (required): the id of the containerTemplate

HTTP Request Body Parameters

None

containerTemplateImage_publish

POST /users/{uid}/mysoftware/{msid}/templates/{tid}/images/{tiid}/pimages

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.9

Publishes a generated machine image to a target cloud environment.

The response body is a publish image ticket that provides the meta-data of the published machine image. The actual publication is done asynchronously. To poll the status of this publication, use scanPublishedImageStatus_get.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_publish

URI Parameters

  • uid (required): the user name (login name) of the user
  • msid (required): the id of the mySoftware
  • tiid (required): the id of the image
  • tid (required): the id of the containerTemplate

HTTP Request Body Parameters

A publishImage object

containerTemplateTargetFormat_getAll

GET /users/{uid}/mysoftware/{msid}/templates/{tid}/formats

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.9

Retrieves all target formats compatible with the container template.

Retrieves all target formats available for the user and evaluates the restriction rule in order to list only the target formats that are compatible with the container template.

A list of targetFormat objects are returned.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

containerTemplate_create

POST /users/{uid}/mysoftware/{msid}/templates

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.9

Creates a container template.

A container template is an object representing a software bundle to containerize.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • msid (required): the id of the mySoftware

HTTP Request Body Parameters

A containerTemplate object

containerTemplate_delete

DELETE /users/{uid}/mysoftware/{msid}/templates/{tid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.8.9

Deletes a container template.

Warning

this also deletes all associated machine images that have been generated from this container template

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

containerTemplate_generate

POST /users/{uid}/mysoftware/{msid}/templates/{tid}/images

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.9

Request to generate a machine image from a container template.

This response body is an image ticket that provides the meta-data of the machine image that is to be generated. The actual generation is done asynchronously. To poll the status of this generation, use machineImageStatus_get.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_generate

URI Parameters

HTTP Request Body Parameters

A image object

containerTemplate_get

GET /users/{uid}/mysoftware/{msid}/templates/{tid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.9

Gets the information for a container template.

A container template is an object representing a software bundle to containerize.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

containerTemplate_getAll

GET /users/{uid}/mysoftware/{msid}/templates

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.9

Retrieves all container templates available for a software component.

A list of containerTemplate objects are returned.

A search criteria can be used to retrieve a subset of these container templates.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • msid (required): the id of the mySoftware

HTTP Request Body Parameters

None

Deployments API Resources

  • activityGet: Returns an activity for a given user, deployment and activity
  • deployment_get: Returns the information for a deployment
  • deployment_getAll: Returns a list of the deployments for a specific user
  • deployment_getDeployStatus: Returns the status of a deployment
  • deployment_terminate: Stops a machine in the cloud environnement and removes it from the list of deployments
  • effectorPost: Trigger an effector for a given user, deployment, entity and effector
  • effectorsGet: Returns a list of effector for a given user, deployment and entity
  • entityGet: Returns an entity for a given user, deployment and activity

activityGet

GET /users/{uid}/deployments/{deploymentId}/entities/{entityId}/activities/{activityId}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.8fp13

Returns an activity for a given user, deployment and activity.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: deployments_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • activityId (required): activity id of the activity
  • deploymentId (required): deployment id of the deployment
  • entityId (required): entity id of the entity

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/deployments/{deploymentId}/entities/{entityId}/activities/{activityId}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

deployment_get

GET /users/{uid}/deployments/{did}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.7.fp6

Returns the information for a deployment.

A deployment is the instantiation of a deployment.

Currently a deployment is a single instance of a software stack. To deploy a published machine image, refer to machineImagePublished_deploy.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: deployments_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • did (required): the id of the deployment

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/deployments/{did}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

deployment_getAll

GET /users/{uid}/deployments

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.7.fp6

Returns a list of the deployments for a specific user.

A deployment is the instantiation of a deployment.

Currently a deployment is a single instance of a software stack. To deploy a published machine image, refer to machineImagePublished_deploy.

A list of deployment objects are returned.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: deployments_access

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/deployments" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

deployment_getDeployStatus

GET /users/{uid}/deployments/{did}/status

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.7.fp6

Returns the status of a deployment.

A deployment is the instantiation of a deployment.

Currently a deployment is a single instance of a software stack. To deploy a published machine image, refer to machineImagePublished_deploy.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: deployments_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • did (required): the id of the deployment

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/deployments/{did}/status" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

deployment_terminate

DELETE /users/{uid}/deployments/{did}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.7.fp6

Stops a machine in the cloud environnement and removes it from the list of deployments.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: deployments_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • did (required): the id of the deployment

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/deployments/{did}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

effectorPost

POST /users/{uid}/deployments/{deploymentId}/entities/{entityId}/effectors//{effectorName}

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.8fp13

Trigger an effector for a given user, deployment, entity and effector.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: deployments_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • deploymentId (required): deployment id of the deployment
  • entityId (required): entity id of the entity
  • effectorName (required): effector name of the deployment

HTTP Request Body Parameters

A string value

Example Request

curl "https://uforge.example.com/api/users/{uid}/deployments/{deploymentId}/entities/{entityId}/effectors//{effectorName}" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<parameters xmlns:ns0="http://www.usharesoft.com/uforge">
        <key1>value</key1>
        <key2>
                <attribute1>value</attribute1>
                <attribute2>true</attribute2>
        </key2>
</parameters>

See also

effectorsGet

GET /users/{uid}/deployments/{deploymentId}/entities/{entityId}/effectors

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.8fp13

Returns a list of effector for a given user, deployment and entity.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: deployments_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • deploymentId (required): deployment id of the deployment
  • entityId (required): entity id of the entity

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/deployments/{deploymentId}/entities/{entityId}/effectors" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

entityGet

GET /users/{uid}/deployments/{deploymentId}/entities/{entityId}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.8fp13

Returns an entity for a given user, deployment and activity.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: deployments_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • activityId (optional):
  • deploymentId (required): the deployment id
  • entityId (required): entity id of the entity

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/deployments/{deploymentId}/entities/{entityId}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

Machine Image API Resources

applianceImage_publish

POST /users/{uid}/appliances/{aid}/images/{itid}/pimages

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 2.0

Request to publish (register) a generated machine image to a target cloud environment.

The response body is a publish image ticket that provides the meta-data of the published machine image. The actual publication is done asynchronously. To poll the status of this publication, use machineImagePublishedStatus_getAll.

This request is similar to machineImage_publish

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_publish

URI Parameters

  • uid (required): the user name (login name) of the user
  • itid (required): the id of the image
  • aid (required): the id of the appliance

HTTP Request Body Parameters

A publishImage object

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/images/{itid}/pimages" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:publishImage xmlns:ns0="http://www.usharesoft.com/uforge">
        <xsi:type></xsi:type>
        <applianceUri>users/root/appliances/4</applianceUri>
        <credAccount>
                <xsi:type></xsi:type>
                <targetPlatform>
                        <name>openstack</name>
                </targetPlatform>
                <glanceUrl>http://ip:9292</glanceUrl>
                <keystoneUrl>http://ip:5000</keystoneUrl>
                <login>username</login>
                <password>password</password>
                <keystoneVersion>v3</keystoneVersion>
        </credAccount>
        <imageUri>users/root/appliances/4/images/7</imageUri>
        <keystoneDomain>Keystone Domain Example</keystoneDomain>
        <keystoneProject>Keystone Project Example</keystoneProject>
        <displayName>Machine Image Name Example</displayName>
        <publicImage>true</publicImage>
</ns0:publishImage>

See also

machineImageFile_download

GET /users/{uid}/appliances/{aid}/images/{itid}/files/{filepath : .+}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 3.7.7

Downloads a file of a generated PXE image.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user
  • filepath (required): the path to the file to download
  • itid (required): the id of the image
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/images/{itid}/files/{filepath : .+}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

machineImageGeneration_cancel

DELETE /users/{uid}/appliances/{aid}/images/{itid}/status

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Cancels a running generation of a machine image.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_generate

URI Parameters

  • uid (required): the user name (login name) of the user
  • itid (required): the id of the image
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

machineImagePkg_getAll

GET /users/{uid}/appliances/{aid}/images/{itid}/pkgs

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.2

Retrieves all the native packages contained in the machine image.

This list includes all the native packages in the appliance’s os profile that this machine image was created from as well as all the packages added after resolving package dependencies during the generation phase.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • itid (required): the id of the image
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

machineImagePublish_cancel

DELETE /users/{uid}/appliances/{aid}/images/{itid}/pimages/{pitid}/cancel

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats: application/xml application/json
  • Since: UForge 2.0

Cancels a running publish of a machine image to a target environment.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_publish

URI Parameters

  • uid (required): the user name (login name) of the User
  • itid (required): the id of the image
  • aid (required): the id of the Appliance
  • pitid (required): the id of the publishImage

HTTP Request Body Parameters

None

machineImagePublishedStatus_get

GET /users/{uid}/appliances/{aid}/images/{itid}/pimages/{pitid}/status

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 2.0

Retrieve the publish status of a published machine image for an appliance.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_publish

URI Parameters

  • uid (required): the user name (login name) of the user
  • itid (required): the id of the image
  • aid (required): the id of the appliance
  • pitid (required): the id of the publishImage

HTTP Request Body Parameters

None

machineImagePublishedStatus_getAll

GET /users/{uid}/appliances/{aid}/pimages/statuses

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 2.0

Retrieve the publish status of all the published machine images for an appliance.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

machineImagePublished_delete

DELETE /users/{uid}/appliances/{aid}/images/{itid}/pimages/{pitid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 2.0

Removes a published machine image from an appliance.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_publish

URI Parameters

  • uid (required): the user name (login name) of the User
  • itid (required): the id of the image
  • aid (required): the id of the Appliance
  • pitid (required): the id of the publishImage

HTTP Request Body Parameters

None

machineImagePublished_deleteAll

DELETE /users/{uid}/appliances/{aid}/pimages

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 2.0

Removes all published machine images for an appliance.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

machineImagePublished_deploy

POST /users/{uid}/appliances/{aid}/images/{itid}/pimages/{pitid}/deploys

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.7.6

Deploy a new machine from an image published to a target environment.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: deployments_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • itid (required): the id of the image
  • aid (required): the id of the appliance
  • pitid (required): the id of the publishImage

HTTP Request Body Parameters

A deployment object

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/images/{itid}/pimages/{pitid}/deploys" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:deployment xmlns:ns0="http://www.usharesoft.com/uforge">
        <xsi:type></xsi:type>
        <name>My Deployment</name>
        <instances>
                <instance>
                        <cores>1</cores>
                        <memory>1024</memory>
                </instance>
        </instances>
</ns0:deployment>

See also

machineImagePublished_download

GET /users/{uid}/appliances/{aid}/pimages/{pitid}/downloads

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 3.0

Downloads a published machine image.

This request is the same as machineImage_downloadFile

Note

You can only download a published machine image if the initial machine image generation request included the compress flag. For more information, see machineImage_generate.

The published machine image can be downloaded without authentication if an downloadId is added as a query parameter. To retrieve the downloadId, use machineImagePublished_getAll.

Note

The downloadId can only be used once, afterwards it expires, and a new downloadId must be retrieved.

Security Summary

  • Requires Authentication: false
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user
  • aid (required): the id of the appliance
  • pitid (required): the id of the publishImage

HTTP Request Body Parameters

None

machineImagePublished_get

GET /users/{uid}/appliances/{aid}/images/{itid}/pimages/{pitid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 2.0

Retrieve a published machine image for an appliance.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the User
  • itid (required): the id of the image
  • aid (required): the id of the Appliance
  • pitid (required): the id of the publishImage

HTTP Request Body Parameters

None

machineImagePublished_getAll

GET /users/{uid}/appliances/{aid}/pimages

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 2.0

Retrieve all the published machine images for an appliance.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

machineImageStatus_get

GET /users/{uid}/appliances/{aid}/images/{itid}/status

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Retrieves the generation status of a machine image.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • itid (required): the id of the image
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

machineImageStatus_getAll

GET /users/{uid}/appliances/{aid}/images/statuses

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Retrieves the generation status of all the machine images for an appliance.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

machineImage_delete

DELETE /users/{uid}/appliances/{aid}/images/{itid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 1.0

Deletes a machine image generated from an appliance.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • itid (required): the id of the image
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

machineImage_deleteAll

DELETE /users/{uid}/appliances/{aid}/images

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 1.0

Deletes all the machine images from an appliance.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

machineImage_download

GET /users/{uid}/appliances/{aid}/images/{itid}/downloads

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 1.0

Downloads a generated machine image.

This request is the same as machineImage_downloadFile

Note

You can only download a generated machine image if the initial generation request included the compress flag. For more information, see machineImage_generate.

The machine image can be downloaded without authentication if an downloadId is added as a query parameter. To retrieve the downloadId, use machineImage_get.

Note

The downloadId can only be used once, afterwards it expires, and a new downloadId must be retrieved.

Security Summary

  • Requires Authentication: false
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user
  • itid (required): the id of the image
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

machineImage_downloadFile

GET /users/{uid}/appliances/{aid}/images/{itid}/downloads/{fileName}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 1.0

Downloads a generated machine image.

This request is the same as machineImage_download

Note

You can only download a generated machine image if the initial generation request included the compress flag. For more information, see machineImage_generate.

The machine image can be downloaded without authentication if an downloadId is added as a query parameter. To retrieve the downloadId, use machineImage_get.

Note

The downloadId can only be used once, afterwards it expires, and a new downloadId must be retrieved.

Security Summary

  • Requires Authentication: false
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user
  • fileName (required): the file name of the machine image
  • itid (required): the id of the image
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/images/{itid}/downloads/{fileName}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

machineImage_generate

POST /users/{uid}/appliances/{aid}/images

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Request to generate a machine image from an appliance.

This response body is an image ticket that provides the meta-data of the machine image that is to be generated. The actual generation is done asynchronously. To poll the status of this generation, use machineImageStatus_get.

Once complete, the machine image can be downloaded if the compressed flag was provided in the request.

To cancel a generation use machineImageGeneration_cancel

Note

to generate a machine image, the appliance must have as a minimum an os profile.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_generate

URI Parameters

  • uid (required): the user name (login name) of the user
  • aid (required): the id of the appliance

HTTP Request Body Parameters

A image object

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/images" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:image xmlns:ns0="http://www.usharesoft.com/uforge">
        <compress>true</compress>
        <targetFormat>
                <name>VirtualBox</name>
        </targetFormat>
        <installProfile>
                <memorySize>512</memorySize>
        </installProfile>
</ns0:image>

See also

machineImage_get

GET /users/{uid}/appliances/{aid}/images/{itid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Retrieves the meta-data of a machine image.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • itid (required): the id of the image
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

machineImage_getAll

GET /users/{uid}/appliances/{aid}/images

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Returns all of the machine images of an appliance.

You can specify a search criteria to retrieve a subset of the machine images of an appliance.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

machineImage_getPlatformTools

GET /users/{uid}/appliances/{aid}/images/platformtools/{tfid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.3

Retrieves the platform tools that match the appliance and image format.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_generate

URI Parameters

  • uid (required): the user name (login name) of the user
  • tfid (required): the format id of the image
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

machineImage_publish

POST /users/{uid}/appliances/{aid}/pimages

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 2.0

Request to publish (register) a generated machine image to a target cloud environment.

The response body is a publish image ticket that provides the meta-data of the published machine image. The actual publication is done asynchronously. To poll the status of this publication, use machineImagePublishedStatus_getAll.

This request is similar to applianceImage_publish

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_publish

URI Parameters

  • uid (required): the user name (login name) of the user
  • aid (required): the id of the appliance

HTTP Request Body Parameters

A publishImage object

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/pimages" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:publishImage xmlns:ns0="http://www.usharesoft.com/uforge">
        <xsi:type></xsi:type>
        <applianceUri>users/root/appliances/4</applianceUri>
        <credAccount>
                <xsi:type></xsi:type>
                <targetPlatform>
                        <name>openstack</name>
                </targetPlatform>
                <glanceUrl>http://ip:9292</glanceUrl>
                <keystoneUrl>http://ip:5000</keystoneUrl>
                <login>username</login>
                <password>password</password>
                <keystoneVersion>v2.0</keystoneVersion>
        </credAccount>
        <imageUri>users/root/appliances/4/images/7</imageUri>
        <instances></instances>
        <displayName>Machine Image Name Example</displayName>
        <publicImage>false</publicImage>
        <tenantName>mytenantname</tenantName>
</ns0:publishImage>

See also

machineImage_regenerate

POST /users/{uid}/appliances/{aid}/images/{itid}

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.2

Request to re-generate a machine image from a previous generation request. The meta-data of the previous generation request will be re-used.

This response body is a new image ticket providing the meta-data of the machine image that is to be generated. The actual generation is done asynchronously. To poll the status of this generation, use machineImageStatus_get.

Once complete, the machine image can be downloaded if the compressed flag was provided in the request.

To cancel a generation use machineImageGeneration_cancel

Note

to generate a machine image, the appliance must have as a minimum an os profile.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_generate

URI Parameters

  • uid (required): the user name (login name) of the user
  • itid (required): the id of the image
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None

platformTool_getSoftware

GET /orgs/{oid}/platformtools/{sbid}/pkgs

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.3

Retrieves a list of software components (libs, drivers etc) that will be automatically injected when generating a machine image for this target environment.

A list of packages objects are returned.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_generate

URI Parameters

HTTP Request Body Parameters

None

pxeBootScript_download

GET /users/{uid}/pxe

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json application/octet-stream
  • Since: UForge 3.7.7

Returns a pxe script listing all the images accessible to a given user.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/pxe" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

scanImage_getPlatformTools

GET /users/{uid}/scannedinstances/{siid}/scans/{sid}/images/platformtools/{tfid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.3

Retrieves a list of software components (libs, drivers etc) for the scanned system that will be automatically injected when generating a machine image for this target environment.

A list of softwareBundle objects are returned.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_generate

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • tfid (required): the format id of the image
  • sid (required): the id of the scan

HTTP Request Body Parameters

None

scanPublishedImage_deploy

POST /users/{uid}/scannedinstances/{siid}/scans/{sid}/images/{itid}/pimages/{pitid}/deploys

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.7.6

Deploy a new machine from an image published to a target environment.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: deployments_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • itid (required): the id of the image
  • pitid (required): the id of the publishImage
  • sid (required): the id of the scan

HTTP Request Body Parameters

A deployment object

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/images/{itid}/pimages/{pitid}/deploys" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:deployment xmlns:ns0="http://www.usharesoft.com/uforge">
        <xsi:type></xsi:type>
        <name>My Deployment</name>
        <instances>
                <instance>
                        <cores>1</cores>
                        <memory>1024</memory>
                </instance>
        </instances>
</ns0:deployment>

See also

Machine Migration API Resources

migrationStatus_get

GET /users/{uid}/migrations/{mid}/status

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.2

Retrieve the current status of a Migration.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • mid (required): the id of the migration

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/migrations/{mid}/status" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

migration_cancel

DELETE /users/{uid}/migrations/{mid}/status

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.5

Cancel a running Migration.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • mid (required): the id of the migration

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/migrations/{mid}/status" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

migration_create

POST /users/{uid}/migrations

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.2

Creates a migration.

A migration is an object representing all stages to migrate a live running instance (physical machine, VM, container).

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

A migration object

Example Request

curl "https://uforge.example.com/api/users/{uid}/migrations" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

See also

migration_delete

DELETE /users/{uid}/migrations/{mid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.8.2

Delete a finished migration.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • mid (required): the id of the migration

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/migrations/{mid}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

migration_deleteAll

DELETE /users/{uid}/migrations

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.8.3

Delete all finished migrations created by a particular user.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/migrations" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

migration_get

GET /users/{uid}/migrations/{mid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.2

Gets a migration.

A migration is an object representing all stages to migrate a live running instance (physical machine, VM, container).

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • mid (required): the id of the migration

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/migrations/{mid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

migration_getAll

GET /users/{uid}/migrations

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.2

Gets all the migrations created by a particular user.

A list of migration objects are returned.

You can use a search criteria to retrieve a subset of these migrations.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/migrations" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

Machine Scan API Resources

scanFileArchive_download

GET /users/{uid}/scannedinstances/{siid}/scans/{sid}/files

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 3.4

Downloads an archive containing all the files found on file system after scanning a live system.

This includes binaries, configuration files, log files and any other files found.

The compareWith query parameter can be used to compare all the files of another scan report, only the differences will be added to the archive.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • sid (required): the id of the scan

HTTP Request Body Parameters

None

scanFileGetDelta

GET /users/{uid}/scannedinstances/{siid}/scans/{sid}/files//delta

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json text/plain
  • Since: UForge 3.8.9

Retrieves all the files added and modified on file system after scanning a live system.

A list of scannedFile objects are returned.

A set of query parameters can be used to retrieve a subset of these files.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • sid (required): the id of the scan

HTTP Request Body Parameters

None

scanFile_getAll

GET /users/{uid}/scannedinstances/{siid}/scans/{sid}/files

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json text/plain
  • Since: UForge 3.4

Retrieves all the files found on file system after scanning a live system.

A list of scannedFile objects are returned.

A set of query parameters can be used to retrieve a subset of these files.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • sid (required): the id of the scan

HTTP Request Body Parameters

None

scanInstallProfile_get

GET /users/{uid}/scannedinstances/{siid}/scans/{sid}/installProfile

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Retrieves the meta-data of the install profile from a scan.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • sid (required): the id of the scan

HTTP Request Body Parameters

None

scanOverlay_download

GET /users/{uid}/scannedinstances/{siid}/scans/{sid}/overlay

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 3.4

Downloads the overlay archive. The overlay archive includes all the packages and files not already known by the UForge platform. This overlay is created on the live system during the scan process.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • sid (required): the id of the scan

HTTP Request Body Parameters

None

scanOverlay_upload

POST /users/{uid}/scannedinstances/{siid}/scans/{sid}/overlay

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats:
  • Since: UForge 3.4

Uploads the overlay from the live system. The overlay archive includes all the packages and files not already known by the UForge platform. This overlay is created on the live system during the scan process.

This request is similar to scanOverlay_uploadChunk

Warning

This request is used by the uforge-scan binary, normally you should not use this request via APIs

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • sid (required): the id of the scan

HTTP Request Body Parameters

The file to upload.

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/overlay" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@binaryFilePath"

See also

scanOverlay_uploadChunk

POST /users/{uid}/scannedinstances/{siid}/scans/{sid}/overlay

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats:
  • Since: UForge 3.4

Uploads the overlay from the live system. The overlay archive includes all the packages and files not already known by the UForge platform. This overlay is created on the live system during the scan process.

This request is similar to scanOverlay_upload

Warning

This request is used by the uforge-scan binary, normally you should not use this request via APIs

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • sid (required): the id of the scan

HTTP Request Body Parameters

The file to upload.

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/overlay" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@binaryFilePath"

See also

scanPackageBinary_getAll

GET /users/{uid}/scannedinstances/{siid}/scans/{sid}/packages/{pid}/bin

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 3.4

Downloads a package binary.

The package can be downloaded without authentication if an downloadToken is added as a query parameter. To retrieve the downloadToken, use scanPackage_getAll.

Note

The downloadToken can only be used once, afterwards it expires, and a new downloadToken must be retrieved.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • pid (required): the id of the scannedPackage to be downloaded
  • sid (required): the id of the scan

HTTP Request Body Parameters

None

scanPackageFile_get

GET /users/{uid}/scannedinstances/{siid}/scans/{sid}/packages/{pid}/files

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Retrieves the list of files from a native package found from a scan.

A list of scannedFile objects are returned.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

HTTP Request Body Parameters

None

scanPackage_getAll

GET /users/{uid}/scannedinstances/{siid}/scans/{sid}/packages

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Retrieves all the native package information from a scan report.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • sid (required): the id of the scan

HTTP Request Body Parameters

None

scanPartition_upload

POST /users/{uid}/scannedinstances/{siid}/scans/{sid}/rawparts/{fileName}

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Uploads an entire file partition. This is used when scanning Windows based systems.

Warning

This request is used by the uforge-scan binary, normally you should not use this request via APIs

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • fileName (required): the file name of the partition to upload
  • siid (required): the id of the scannedInstance
  • sid (required): the id of the scan

HTTP Request Body Parameters

The file to upload.

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/rawparts/{fileName}" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@binaryFilePath"

See also

scanSync_create

POST /users/{uid}/scannedinstances/{siid}/scans/{sid}/sync

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.7.7

Creates a scanSync object.

A scanSync is an object that contains all the information required to synchronize files from a source to a target instance (or machine or workload).

Please refer to scanSync for a complete list of all the scanSync attributes.

Note

This POST request does not require any HTTP body. All the information is passed via the URL request.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • sid (required): the id of the scan

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/sync" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

scanSync_get

GET /users/{uid}/scannedinstances/{siid}/scans/{sid}/sync/{ssid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.7.7

Returns the meta-data of the scanSync object.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • ssid (required): the id of the scanSync
  • sid (required): the id of the scan

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/sync/{ssid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

scanSync_getFiles

GET /users/{uid}/scannedinstances/{siid}/scans/{sid}/sync/{ssid}/files

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: text/plain application/xml application/json
  • Since: UForge 3.7.7

Returns all full paths of files to be synchronized from a source to a target instance.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • ssid (required): the id of the scanSync
  • sid (required): the id of the scan

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/sync/{ssid}/files" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

scan_cancel

DELETE /users/{uid}/scannedinstances/{siid}/scans/{sid}/status

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Cancels the current processing of the scan report.

Warning

This does not stop the scan process on the live machine. This will have to be done separately.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • sid (required): the id of the scan

HTTP Request Body Parameters

None

scan_create

POST /users/{uid}/scannedinstances/{siid}/scans

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Creates a new scan to a parent scanned instance. This is a scan report of a live system. The scan report is created by the uforge-scan binary that is added and run on the live system separately.

This request is similar to scan_create

Warning

This request is used by the uforge-scan binary, normally you should not use this request via APIs

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance

HTTP Request Body Parameters

The file to upload.

scan_delete

DELETE /users/{uid}/scannedinstances/{siid}/scans/{sid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.4

Removes a scan from a parent scanned instance. The scan report and related uploaded overlays are deleted.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • sid (required): the id of the scan

HTTP Request Body Parameters

None

scan_get

GET /users/{uid}/scannedinstances/{siid}/scans/{sid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Retrieves the meta-data of a scan. This includes all the native packages, filesystem layout and install profile of the live system that was scanned.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • sid (required): the id of the scan

HTTP Request Body Parameters

None

scan_multipartCreate

POST /users/{uid}/scannedinstances/{siid}/scans

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Creates a new scan to a parent scanned instance. This is a scan report of a live system. The scan report is created by the uforge-scan binary that is added and run on the live system separately.

This request is similar to scan_create

Warning

This request is used by the uforge-scan binary, normally you should not use this request via APIs

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance

HTTP Request Body Parameters

The file to upload.

scan_update

PUT /users/{uid}/scannedinstances/{siid}/scans/{sid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Updates a scan object.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • sid (required): the id of the scan

HTTP Request Body Parameters

A scan object

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

See also

scannedInstanceScan_deleteAll

DELETE /users/{uid}/scannedinstances/{siid}/scans

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.4

Removes all the scans from a parent scanned instance. All the scan reports and related uploaded overlays are deleted.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance

HTTP Request Body Parameters

None

scannedInstanceScan_getAll

GET /users/{uid}/scannedinstances/{siid}/scans

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Retrieves all the scans for a scanned instance. A scan is a report detailing all the information found when scanning a live system.

A scanned instance is an object representing a live running instance (physical machine, VM, container). Each time the system is scanned, the scan report is stored under the scanned instance object.

A list of scan objects are returned.

You can use a search criteria to retrieve a subset of these scans.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance

HTTP Request Body Parameters

None

userScan_deleteAll

DELETE /users/{uid}/scans

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.4

Removes all the scans for the user. All the scan reports and related uploaded overlays are deleted.

You can use a set of query parameters to remove a subset of scan objects

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

userScan_getAll

GET /users/{uid}/scans

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Retrieves all the scans belonging to a user. A scan is a report detailing all the information found when scanning a live system.

A list of scan objects are returned.

You can use a set of query parameters to retrieve a subset of the scan object list

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

Machine Scan Import API Resources

scanImportToGoldenStatus_get

GET /users/{uid}/scannedinstances/{siid}/scans/{sid}/goldens//status

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.7.fp5

Retrieves all the scan import to golden ticket status of a scan report that has been transformed or in the process of being transformed to a golden-image.

You can use the query parameter i to retrieve a subset of the status tickets.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • sid (required): the id of the scan

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/goldens//status" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

scanImportToGolden_cancel

DELETE /users/{uid}/scannedinstances/{siid}/scans/{sid}/goldens/{iid}/status

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.fp2

Cancels the process to import a scan report as a new golden-image.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • iid (required): the id of the scanImport
  • sid (required): the id of the scan

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/goldens/{iid}/status" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

scanImportToGolden_delete

DELETE /users/{uid}/scannedinstances/{siid}/scans/{sid}/goldens/{sitgid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.7.fp5

Removes a scan import to golden ticket.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • sid (required): the id of the scan
  • sitgid (required): the id of the scanImport to remove

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/goldens/{sitgid}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

scanImportToGolden_getAll

GET /users/{uid}/scannedinstances/{siid}/scans/{sid}/goldens

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.7.fp5

Retrieves all the scan import tickets of a scan report that has been transformed to a golden-image.

By importing a scan report as a golden a new golden-image object is created for the scan’s distribution.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • sid (required): the id of the scan

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/goldens" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

scanImportToGolden_import

POST /users/{uid}/scannedinstances/{siid}/scans/{sid}/goldens

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.7.fp5

Request to import a scan report to your Appliance Library, creating a new golden-image.

This response body is an scan import ticket that provides the meta-data of the golden image to be created from the scan report. The actual import is done asynchronously. To poll the status of this import, use scanImportToGoldenStatus_get.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • sid (required): the id of the scan

HTTP Request Body Parameters

A scanImport object

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/goldens" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:scanImport xmlns:ns0="http://www.usharesoft.com/uforge">
        <importedObjectName>Import Example</importedObjectName>
        <importedObjectVersion>1.0</importedObjectVersion>
        <orgUri>orgs/1</orgUri>
</ns0:scanImport>

See also

scanImportToTemplateStatus_get

GET /users/{uid}/scannedinstances/{siid}/scans/{sid}/imports/status/

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Retrieves all the scan import ticket statuses of a scan report that has been transformed or in the process of being transformed to an appliance.

You can use the query parameter i to retrieve a subset of the status tickets.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • sid (required): the id of the scan

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/imports/status/" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

scanImportToTemplate_cancel

DELETE /users/{uid}/scannedinstances/{siid}/scans/{sid}/imports/{iid}/status

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Cancels the process to import a scan report to your Appliance Library.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • iid (required): the id of the scanImport
  • sid (required): the id of the scan

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/imports/{iid}/status" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

scanImportToTemplate_delete

DELETE /users/{uid}/scannedinstances/{siid}/scans/{sid}/imports/{iid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.4

Removes a scan import ticket.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • iid (required): the id of the scanImport to remove
  • sid (required): the id of the scan

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/imports/{iid}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

scanImportToTemplate_getAll

GET /users/{uid}/scannedinstances/{siid}/scans/{sid}/imports

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Retrieves all the scan import tickets of a scan report that has been transformed to an appliance.

By importing a scan report a new appliance object is created to your Appliance Library.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • sid (required): the id of the scan

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/imports" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

scanImportToTemplate_import

POST /users/{uid}/scannedinstances/{siid}/scans/{sid}/imports

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Request to import a scan report to your Appliance Library, creating a new appliance.

This response body is an scan import ticket that provides the meta-data of the appliance to be created from the scan report. The actual import is done asynchronously. To poll the status of this import, use scanImportToTemplateStatus_get.

To cancel an import use scanImportToTemplate_cancel

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • sid (required): the id of the scan

HTTP Request Body Parameters

A scanImport object

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/imports" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:scanImport xmlns:ns0="http://www.usharesoft.com/uforge">
        <importedObjectName>Import Example</importedObjectName>
        <importedObjectVersion>1.0</importedObjectVersion>
        <orgUri>orgs/1</orgUri>
</ns0:scanImport>

See also

Machine Scan Instance API Resources

scanInstance_create

POST /users/{uid}/scannedinstances

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Creates a scanned instance.

A scanned instance is an object representing a live running instance (physical machine, VM, container). Each time the system is scanned, the scan report is stored under the scanned instance object.

Please refer to scannedInstance for a complete list of all the scanned instance attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

A scannedInstance object

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:scannedInstance xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>Example Scan</name>
        <distribution>
                <name>CentOS</name>
                <version>6.7</version>
                <arch>x86_64</arch>
        </distribution>
</ns0:scannedInstance>

See also

scanInstance_delete

DELETE /users/{uid}/scannedinstances/{siid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.4

Remove a scanned instance.

Warning

this deletes all the child scan reports and overlay files under this scanned instance.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

scanInstance_deleteAll

DELETE /users/{uid}/scannedinstances

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.4

Removes all the scanned instances for a user.

Warning

this deletes all the child scan reports and overlay files.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

scanInstance_get

GET /users/{uid}/scannedinstances/{siid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Retrieve a scanned instance.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

scanInstance_getAll

GET /users/{uid}/scannedinstances

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Retrieves all the scanned instances.

A scanned instance is an object representing a live running instance (physical machine, VM, container). Each time the system is scanned, the scan report is stored under the scanned instance object.

A list of scannedInstance objects are returned.

You can use a set of query parameters to retrieve a subset of these scanned instances. This includes: - name: retrieves the scanned instance with a specific name - ids: retrieves a list of scanned instances that matches the id list provided - index: - max: - orderBy: a field name contained in scannedInstance to order by - asc: boolean to determine to sort the list in ascending order (if false, sort in descending order)

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

Misc API Resources

distributionRepository_getAll

GET /distributions/{did}/repositories

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.8

Retrieves all the repositories for a distribution based on an organization.

A list of repository objects are returned.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_administrate

URI Parameters

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/distributions/{did}/repositories" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

OS API Resources

  • osAccess_update: Changes the state of the operating system
  • osLicense_download: Downloads the license file for an operating system
  • osLogo_download: Downloads the logo of an operating system
  • osLogo_downloadFile: Downloads the logo of an operating system
  • osPkgUpdates_getAll: Retrieves all the updates related to packages in an operating system
  • osPkg_get: Retrieves the meta-data of a package from an operating system
  • osPkg_getAll: Retrieves all the native packages for an operating system
  • os_create: Registers a new operating system in an organization
  • os_get: Retrieves the meta-data of an operating system
  • os_getAll: Retrieves all the operating system registered on the platform
  • os_update: Updates the meta-data information of an operating system

osAccess_update

PUT /distributions/{id}/changeActiveStatus

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Changes the state of the operating system.

If the operating system is marked active, then it is ready to be used by users of the platform. This mechanism can be used to disable the entire operating system from use without changing user permissions.

Warning

users are provided authorization to use an operating system via a separate access mechanism.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_os_administrate

URI Parameters

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/distributions/{id}/changeActiveStatus" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

osLicense_download

GET /distributions/{id}/license

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 1.0

Downloads the license file for an operating system.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/distributions/{id}/license" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

osLogo_download

GET /distributions/{id}/logo

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 1.0

Downloads the logo of an operating system.

This request is the same as osLogo_downloadFile.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/distributions/{id}/logo" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

osLogo_downloadFile

GET /distributions/{id}/logo/{fileName}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 1.0

Downloads the logo of an operating system.

This request is the same as osLogo_download.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • fileName (required): the file name of the logo
  • id (required): the id of the distribution

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/distributions/{id}/logo/{fileName}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

osPkgUpdates_getAll

GET /distributions/{id}/pkgs/{pid}/updateinfo

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.5

Retrieves all the updates related to packages in an operating system.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/distributions/{id}/pkgs/{pid}/updateinfo" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

osPkg_get

GET /distributions/{id}/pkgs/{pid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.5

Retrieves the meta-data of a package from an operating system.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/distributions/{id}/pkgs/{pid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

osPkg_getAll

GET /distributions/{id}/pkgs

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.5

Retrieves all the native packages for an operating system.

A list of package objects are returned.

You can use a search criteria to retrieve a subset of these packages.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/distributions/{id}/pkgs" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

os_create

POST /distributions/{oid}/{name}/{version}

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Registers a new operating system in an organization.

Note

This POST request does not require any HTTP body. All the information is passed via the URL request as a set of query parameters.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_os_administrate

URI Parameters

  • name (required): the name of the operating system
  • oid (required): the id of the org
  • version (required): the version of the operating system

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/distributions/{oid}/{name}/{version}" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

os_get

GET /distributions/{id}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Retrieves the meta-data of an operating system.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/distributions/{id}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

os_getAll

GET /distributions

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.5

Retrieves all the operating system registered on the platform.

A list of distribution objects are returned.

You can use a search criteria to retrieve a subset of these operating systems.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

None HTTP Request Body Parameters ~~~~~~~~~~~~~~~~~~~~~~~~~~~~

None

Example Request

curl "https://uforge.example.com/api/distributions" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

os_update

PUT /distributions/{id}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Updates the meta-data information of an operating system.

Please refer to distribProfile for a complete list of all the os attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_os_administrate

URI Parameters

HTTP Request Body Parameters

A distribution object

Example Request

curl "https://uforge.example.com/api/distributions/{id}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:distribution xmlns:ns0="http://www.usharesoft.com/uforge">
        <active>false</active>
</ns0:distribution>

See also

OS Milestone API Resources

osMilestone_create

POST /distributions/{id}/milestones

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.5

Creates a milestone for an operating system.

Please refer to milestone for a complete list of all the milestone attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

HTTP Request Body Parameters

A milestone object

Example Request

curl "https://uforge.example.com/api/distributions/{id}/milestones" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:milestone xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>Milestone Example</name>
        <date>2016-06-17T08:31:08.000Z</date>
        <source>test</source>
</ns0:milestone>

See also

osMilestone_delete

DELETE /distributions/{id}/milestones/{mid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.5

Removes a milestone from an operating system.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/distributions/{id}/milestones/{mid}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

osMilestone_get

GET /distributions/{id}/milestones/{mid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.5

Retrieves the meta-data of a milestone.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/distributions/{id}/milestones/{mid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

osMilestone_getAll

GET /distributions/{id}/milestones

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.5

Retrieves the list of milestones registered for an operating system.

Returns a list milestone objects.

A set of query parameters can be used to retrieve a subset of these milestones.

Security Summary

  • Requires Authentication: false
  • Entitlements Required: None

URI Parameters

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/distributions/{id}/milestones" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

osMilestone_update

PUT /distributions/{id}/milestones/{mid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.5

Updates the meta-data information of a milestone.

Please refer to milestone for a complete list of all the milestone attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

HTTP Request Body Parameters

A milestone object

Example Request

curl "https://uforge.example.com/api/distributions/{id}/milestones/{mid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:milestone xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>Milestone Example Updated</name>
        <source>official</source>
</ns0:milestone>

See also

OS Template API Resources

osTemplatePkgs_get

GET /distributions/{id}/profiles/{prid}/pkgs

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Retrieves the list of native packages for an OS template.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/distributions/{id}/profiles/{prid}/pkgs" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

osTemplate_create

POST /distributions/{id}/profiles

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Creates a new OS template for an operating system. An OS template groups together packages from the operating system that can be re-used in as an OS profile when creating and managing appliances.

Please refer to distribProfile for a complete list of all the OS template attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_os_profiles_administrate

URI Parameters

HTTP Request Body Parameters

A distribProfile object

Example Request

curl "https://uforge.example.com/api/distributions/{id}/profiles" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:distribProfile xmlns:ns0="http://www.usharesoft.com/uforge">
        <description>This distribution contains the minimal amount of services</description>
        <name>Template Example</name>
</ns0:distribProfile>

See also

osTemplate_delete

DELETE /distributions/{id}/profiles/{prid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.6

Removes an OS template from an operating system.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_os_profiles_administrate

URI Parameters

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/distributions/{id}/profiles/{prid}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

osTemplate_get

GET /distributions/{id}/profiles/{prid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Retrieves the meta-data of an OS template.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/distributions/{id}/profiles/{prid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

osTemplate_getAll

GET /distributions/{id}/profiles

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Retrieves all the templates available for an operating system. An OS template groups together packages from the operating system that can be re-used in as an OS profile when creating an managing appliances.

A list of distribution objects are returned.

A search criteria can be used to retrieve a subset of these templates.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/distributions/{id}/profiles" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

osTemplate_update

PUT /distributions/{id}/profiles/{prid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Updates the meta-data information of an OS template.

Please refer to distribProfile for a complete list of all the OS template attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_os_profiles_administrate

URI Parameters

HTTP Request Body Parameters

A distribProfile object

Example Request

curl "https://uforge.example.com/api/distributions/{id}/profiles/{prid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:distribProfile xmlns:ns0="http://www.usharesoft.com/uforge">
        <description>This is an updated description</description>
        <name>Template Example - Updated</name>
</ns0:distribProfile>

See also

OS Template Applications API Resources

winApplications_get

GET /distributions/{id}/profiles/{prid}/applications/{appid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.7.fp3

Retrieves a windows application.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/distributions/{id}/profiles/{prid}/applications/{appid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

winApplications_getAll

GET /distributions/{id}/profiles/{prid}/applications

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.7.fp3

Retrievesa list of windows application.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/distributions/{id}/profiles/{prid}/applications" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

winServices_get

GET /distributions/{id}/profiles/{prid}/services/{sid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.7.fp3

Retrieves a windows service.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/distributions/{id}/profiles/{prid}/services/{sid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

winServices_getAll

GET /distributions/{id}/profiles/{prid}/services

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.7.fp3

Retrieves a list of windows service.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

Organization API Resources

  • orgCompany_getAll: Retrieves all the company information for an organization
  • orgLicense_download: Downloads a license file from an organization
  • orgLicense_getAll: Retrieves all the licenses registered in an organization
  • orgMember_getAll: Retrieves all the users that are members of an organization
  • orgMember_remove: Removes an user from an organization
  • orgMember_update: Adds or updates (the privileges of) an user to an organization
  • orgOSWindows_add: Adds a new Microsoft Windows base machine image (golden image) to a Microsoft Windows operating system
  • orgOSWindows_delete: Delete a new Microsoft Windows base machine image (golden image) to a Microsoft Windows operating system
  • orgOSWindows_getAll: Retrieves all the machine images (golden images) that have been registered for a Microsoft Windows operating system
  • orgOS_add: Registers a new operating system to an organization
  • orgOS_getAll: Retrieves all the operating systems for an organization
  • orgOS_update: Updates the operating systems available for an Organization
  • org_create: Creates a new organization
  • org_get: Retrieves the information of an organization
  • org_getAll: Retrieves all the organizations on the platform

orgCompany_getAll

GET /orgs/{oid}/companies

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Retrieves all the company information for an organization.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_administrate

URI Parameters

  • oid (required): the id of the org

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/companies" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

orgLicense_download

GET /orgs/{oid}/licenses/{slid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 1.0

Downloads a license file from an organization.

Security Summary

  • Requires Authentication: false
  • Entitlements Required: None

URI Parameters

  • slid (required): the id of the license to download
  • oid (required): the id of the org

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/licenses/{slid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

orgLicense_getAll

GET /orgs/{oid}/licenses

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Retrieves all the licenses registered in an organization.

Security Summary

  • Requires Authentication: false
  • Entitlements Required: None

URI Parameters

  • oid (required): the id of the org

HTTP Request Body Parameters

None

orgMember_getAll

GET /orgs/{oid}/members

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.3

Retrieves all the users that are members of an organization.

A list of user objects are returned.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_members_administrate

URI Parameters

  • oid (required): the id of the org

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/members" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

orgMember_remove

DELETE /orgs/{oid}/members/{uid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.3

Removes an user from an organization.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_members_administrate

URI Parameters

  • uid (required): the user name (login name) of the user
  • oid (required): the id of the org

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/members/{uid}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

orgMember_update

PUT /orgs/{oid}/members/{uid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.3

Adds or updates (the privileges of) an user to an organization.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_members_administrate

URI Parameters

  • uid (required): the user name (login name) of the user
  • oid (required): the id of the org

HTTP Request Body Parameters

A user object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/members/{uid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:user xmlns:ns0="http://www.usharesoft.com/uforge">
        <loginName>example</loginName>
        <active>false</active>
</ns0:user>

See also

orgOSWindows_add

POST /orgs/{oid}/distributions/{did}/goldens

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.5.1

Adds a new Microsoft Windows base machine image (golden image) to a Microsoft Windows operating system. This operating system is registered to an organization. This uploads the golden image to the platform.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_administrate

URI Parameters

  • oid (required): the id of the org
  • did (required): the id of the distribution

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/distributions/{did}/goldens" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

orgOSWindows_delete

DELETE /orgs/{oid}/distributions/{did}/goldens

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.5.1

Delete a new Microsoft Windows base machine image (golden image) to a Microsoft Windows operating system.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_administrate

URI Parameters

  • oid (required): the id of the org
  • did (required): the id of the distribution

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/distributions/{did}/goldens" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

orgOSWindows_getAll

GET /orgs/{oid}/distributions/{did}/goldens

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.5.1

Retrieves all the machine images (golden images) that have been registered for a Microsoft Windows operating system.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_administrate

URI Parameters

  • oid (required): the id of the org
  • did (required): the id of the distribution

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/distributions/{did}/goldens" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

orgOS_add

POST /orgs/{oid}/distributions

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: N/A

Registers a new operating system to an organization.

Please refer to distribution for a complete list of all the os attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_os_administrate

URI Parameters

  • oid (required): the id of the org

HTTP Request Body Parameters

A distribution object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/distributions" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

See also

orgOS_getAll

GET /orgs/{oid}/distributions

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.2

Retrieves all the operating systems for an organization.

A list of distribution objects are returned. You can use a set of query parameters to retrieve a subset of these operating systems:

  • name: filter by operating system name, for example CentOS
  • version: filter by operating system version, for example 7.0
  • arch: filter by operating system architecture, for example x86

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • oid (required): the id of the org

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/distributions" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

orgOS_update

PUT /orgs/{oid}/distributions

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.3

Updates the operating systems available for an Organization. This can be to:

  • enable or disable one or more operating systems available in the organization
  • add or remove one or more operating systems as ‘default’ operating systems.

When an OS is flagged as ‘default’ then any new user created/added to the organization will be automatically given access to this operating systems.

..warning:: If you add an operating system as default, all existing users will NOT automatically be given access to this operating system, you will need to do this explicitly for each user.

If an operating system has been flagged inactive globally then this operating system will no longer be available for the organization.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_os_administrate

URI Parameters

  • oid (required): the id of the org

HTTP Request Body Parameters

A distributions object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/distributions" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:distributions xmlns:ns0="http://www.usharesoft.com/uforge">
        <distributions>
                <distribution>
                        <active>true</active>
                        <uri>distributions/1</uri>
                        <preselected>false</preselected>
                        <visible>true</visible>
                </distribution>
        </distributions>
</ns0:distributions>

See also

org_create

POST /orgs

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.3

Creates a new organization.

Please refer to org for a complete list of all the organization attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_administrate

URI Parameters

None HTTP Request Body Parameters ~~~~~~~~~~~~~~~~~~~~~~~~~~~~

A org object

Example Request

curl "https://uforge.example.com/api/orgs" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:org xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>Org Name Example</name>
</ns0:org>

See also

org_get

GET /orgs/{oid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Retrieves the information of an organization.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • oid (required): the id of the org

HTTP Request Body Parameters

None

org_getAll

GET /orgs

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Retrieves all the organizations on the platform.

A list of org objects are returned.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_administrate

URI Parameters

None HTTP Request Body Parameters ~~~~~~~~~~~~~~~~~~~~~~~~~~~~

None

Project API Resources

projectArtifact_addChild

POST /orgs/{oid}/projects/{pid}/artifacts/{said}/subsoftwareartifacts

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Creates a child in a software artifact.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: software_upload

URI Parameters

HTTP Request Body Parameters

A softwareArtifact object

projectArtifact_addOrRemoveFileFromCache

PUT /orgs/{oid}/projects/{pid}/artifacts/{said}/fetch

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats:
  • Since: UForge 3.6

Add or remove a file of an artifact from the cache. Note, if this file is a directory all sub-directories and files will be added or deleted.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: software_upload

URI Parameters

HTTP Request Body Parameters

The file to upload.

projectArtifact_create

POST /orgs/{oid}/projects/{pid}/artifacts

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Create a new artifact inside a project. This only creates the meta-data for the artifact, please use projectArtifact_upload to upload the file(s).

Please refer to softwareFile, bootScript or osPackage for a complete list of all the software artifact attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_projects_administrate

URI Parameters

  • pid (required): the id of the project
  • oid (required): the id of the org

HTTP Request Body Parameters

A softwareArtifact object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/projects/{pid}/artifacts" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:softwareFile xmlns:ns0="http://www.usharesoft.com/uforge">
        <size>10</size>
        <name>artifact</name>
        <fullName>artifact</fullName>
        <origName>artifact</origName>
        <shortTag>softwarefile</shortTag>
</ns0:softwareFile>

See also

projectArtifact_createFromRemoteServer

GET /orgs/{oid}/projects/{pid}/artifacts/fetch

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Create an artifact and download all contents from remote endpoint. This fetches all the directories and files found from this endpoint. Sub directories are re-created locally.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: software_upload

URI Parameters

  • pid (required): the id of the project
  • oid (required): the id of the org

HTTP Request Body Parameters

None

projectArtifact_delete

DELETE /orgs/{oid}/projects/{pid}/artifacts/{said}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 1.0

Removes a software artifact from a project.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_projects_administrate

URI Parameters

HTTP Request Body Parameters

None

projectArtifact_deleteAll

DELETE /orgs/{oid}/projects/{pid}/artifacts

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 1.0

Removes all the software artifacts from a project.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_projects_administrate

URI Parameters

  • pid (required): the id of the project
  • oid (required): the id of the org

HTTP Request Body Parameters

None

projectArtifact_download

GET /orgs/{oid}/projects/{pid}/artifacts/{said}/bin

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 1.0

Downloads the software artifact binary or archive.

This request is the same as projectArtifact_downloadFile.

The software artifact binary can be downloaded without authentication if an downloadId is added as a query parameter. To retrieve the downloadId, use projectArtifact_get.

Note

The downloadId can only be used once, afterwards it expires, and a new downloadId must be retrieved.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_projects_administrate

URI Parameters

HTTP Request Body Parameters

None

projectArtifact_downloadFile

GET /orgs/{oid}/projects/{pid}/artifacts/{said}/bin/{fileName}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 1.0

Downloads the software artifact binary or archive.

This request is the same as projectArtifact_download.

The software artifact binary can be downloaded without authentication if an downloadId is added as a query parameter. To retrieve the downloadId, use projectArtifact_get.

Note

The downloadId can only be used once, afterwards it expires, and a new downloadId must be retrieved.

Security Summary

  • Requires Authentication: false
  • Entitlements Required: None

URI Parameters

  • fileName (required): the file name of the binary to upload
  • pid (required): the id of the project
  • oid (required): the id of the org
  • said (required): the id of the softwareArtifact

HTTP Request Body Parameters

None

projectArtifact_get

GET /orgs/{oid}/projects/{pid}/artifacts/{said}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Retrieves the information of a software artifact contained in a project. This only retrieves the meta-data of the project. If you wish to download the binaries, please use projectArtifact_download.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_projects_administrate

URI Parameters

HTTP Request Body Parameters

None

projectArtifact_getAll

GET /orgs/{oid}/projects/{pid}/artifacts

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Retrieves all software artifacts and files for a project. This may include os packages, bootscripts and software files (archives, files etc).

A list of softwareArtifact (softwareFile, bootScript or osPackage) objects are returned.

You can filter software artifact files by name when using the query parameter filename.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_projects_administrate

URI Parameters

  • pid (required): the id of the project
  • oid (required): the id of the org

HTTP Request Body Parameters

None

projectArtifact_update

PUT /orgs/{oid}/projects/{pid}/artifacts/{said}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Updates the information of a software artifact in a project. This only updates the meta-data for the software artifact. Please use projectArtifact_upload to upload the file(s).

Please refer to softwareArtifact (softwareFile, bootScript or osPackage) for a complete list of all the software artifact attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: software_upload

URI Parameters

HTTP Request Body Parameters

A softwareArtifact object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/projects/{pid}/artifacts/{said}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:softwareFile xmlns:ns0="http://www.usharesoft.com/uforge">
        <size>10</size>
        <name>artifact</name>
        <fullName>artifact</fullName>
        <origName>artifact</origName>
        <shortTag>softwarefile</shortTag>
</ns0:softwareFile>

See also

projectArtifact_updateAll

PUT /orgs/{oid}/projects/{pid}/artifacts

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Updates the information of a set of artifact contained in a project. This only updates the meta-data for the artifact. Please use projectArtifact_upload to upload the file(s).

Please refer to softwareArtifact (softwareFile, bootScript or osPackage) for a complete list of all the software artifact attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_projects_administrate

URI Parameters

  • pid (required): the id of the project
  • oid (required): the id of the org

HTTP Request Body Parameters

A softwareArtifacts object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/projects/{pid}/artifacts" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:softwareArtifacts xmlns:ns0="http://www.usharesoft.com/uforge">
        <softwareArtifacts>
                <softwareFile>
                        <dbId>603</dbId>
                        <size>10</size>
                        <name>artifact-update</name>
                        <fullName>artifact-update</fullName>
                        <origName>artifact-update</origName>
                </softwareFile>
        </softwareArtifacts>
</ns0:softwareArtifacts>

See also

projectArtifact_upload

POST /orgs/{oid}/projects/{pid}/artifacts/{said}/bin/{fileName}

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Uploads a binary file to a software artifact.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_projects_administrate

URI Parameters

  • fileName (required): the file name of the binary to upload
  • pid (required): the id of the project
  • oid (required): the id of the org
  • said (required): the id of the softwareArtifact

HTTP Request Body Parameters

The file to upload.

projectLicense_delete

DELETE /orgs/{oid}/projects/{pid}/licenses/{lid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Remove a license file from a project.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_projects_administrate

URI Parameters

  • lid (required): the id of the license
  • pid (required): the id of the project
  • oid (required): the id of the org

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/projects/{pid}/licenses/{lid}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

projectLicense_download

GET /orgs/{oid}/projects/{pid}/licenses/{lid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 1.0

Downloads the license of a project.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • lid (required): the id of the license
  • pid (required): the id of the project
  • oid (required): the id of the org

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/projects/{pid}/licenses/{lid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

projectLicense_upload

POST /orgs/{oid}/projects/{pid}/licenses/{lid}/{fileName}

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Uploads a license file for a project. This request is similar to projectLicense_uploadChunk

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_projects_administrate

URI Parameters

  • fileName (required): the file name of the license
  • lid (required): the id of the license
  • pid (required): the id of the project
  • oid (required): the id of the org

HTTP Request Body Parameters

The file to upload.

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/projects/{pid}/licenses/{lid}/{fileName}" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@binaryFilePath"

See also

projectLicense_uploadChunk

POST /orgs/{oid}/projects/{pid}/licenses/{lid}

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Uploads a license file for a project. This request is similar to projectLicense_upload

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_projects_administrate

URI Parameters

  • lid (required): the id of the license
  • pid (required): the id of the project
  • oid (required): the id of the org

HTTP Request Body Parameters

The file to upload.

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/projects/{pid}/licenses/{lid}" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@binaryFilePath"

See also

projectLogo_delete

DELETE /orgs/{oid}/projects/{pid}/logo/{logoId}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

This method deletes the logo

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_projects_administrate

URI Parameters

  • pid (required): the id of the project
  • oid (required): the id of the org
  • logoId (required): the id of the logo

HTTP Request Body Parameters

None

projectLogo_download

GET /orgs/{oid}/projects/{pid}/logo/{logoId}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 1.0

Downloads the logo file for the specified project.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • pid (required): the id of the project
  • oid (required): the id of the org
  • logoId (required): the id of the logo

HTTP Request Body Parameters

None

projectLogo_downloadFile

GET /orgs/{oid}/projects/{pid}/logo/{logoId}/{fileName}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 1.0

Downloads the logo file for the specified project.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • fileName (required): the name of the logo file
  • pid (required): the id of the project
  • oid (required): the id of the org
  • logoId (required): the id of the logo

HTTP Request Body Parameters

None

projectLogo_upload

POST /orgs/{oid}/projects/{pid}/logo/{logoId}/{fileName}

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Uploads a logo file for the specified project.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_projects_administrate

URI Parameters

  • fileName (required): the name of the logo file
  • pid (required): the id of the project
  • oid (required): the id of the org
  • logoId (required): the id of the logo

HTTP Request Body Parameters

The file to upload.

projectRestrictionOS_evaluate

POST /orgs/{oid}/projects/{pid}/restriction/{brid}/distributions

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.7

Evaluate the restriction rule to retrieve all distributions for which the project is designed for.

A list of distribution objects are returned.

Note

carriage return is not authorized in the restriction rule.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

A bundleRestriction object

projectRestriction_update

PUT /orgs/{oid}/projects/{pid}/restriction/{brid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.7

Updates the bundle restriction for a project.

This only updates the expression rule of the bundle restriction

Note

carriage return is not authorized in the restriction rule.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: software_upload

URI Parameters

HTTP Request Body Parameters

A bundleRestriction object

project_availableForImage

POST /orgs/{oid}/projects/{pid}/images

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.7.4

Gets the project if it’s available for the image that will be generated.

The project object is returned if available for image by parsing the restriction rule (return null if not).

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • pid (required): the id of the project
  • oid (required): the id of the org

HTTP Request Body Parameters

A image object

project_create

POST /orgs/{oid}/projects

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Create a new project in the Project Catalog.

Please refer to project for a complete list of all the software bundle attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: software_upload

URI Parameters

  • oid (required): the id of the org

HTTP Request Body Parameters

A project object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/projects" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:project xmlns:ns0="http://www.usharesoft.com/uforge">
        <category>
                <name>Blogging</name>
        </category>
        <company>
                <name>Maintainer Example</name>
        </company>
        <distributionUri>distributions/1</distributionUri>
        <license>
                <type>Custom</type>
        </license>
        <name>Project Example</name>
        <version>1.0</version>
        <shortTag>project</shortTag>
</ns0:project>

See also

project_delete

DELETE /orgs/{oid}/projects/{pid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Removes a project from the Project Catalog.

The project is not physically deleted from the database but marked as “obsolete”. Users will no longer be able to use this project in an appliance, however ensures that appliances currently using the project are not adversely affected.

Note

To force the physical deletion of a project, use the erase query parameter. In this case all the binaries and meta-data of a project are deleted.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_projects_administrate

URI Parameters

  • pid (required): the id of the project
  • oid (required): the id of the org

HTTP Request Body Parameters

None

project_get

GET /orgs/{oid}/projects/{pid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Retrieves the information of a project.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • pid (required): the id of the project
  • oid (required): the id of the org

HTTP Request Body Parameters

None

project_getAll

GET /orgs/{oid}/projects

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Retrieve all the projects registered for an operating system.

A list of project objects are returned.

You can use a search criteria to retrieve a subset of these projects.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • oid (required): the id of the org

HTTP Request Body Parameters

None

project_update

PUT /orgs/{oid}/projects/{pid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Updates the information of a project.

Please refer to project for a complete list of all the software bundle attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_projects_administrate

URI Parameters

  • pid (required): the id of the project
  • oid (required): the id of the org

HTTP Request Body Parameters

A project object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/projects/{pid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:project xmlns:ns0="http://www.usharesoft.com/uforge">
        <category>
                <name>Blogging</name>
        </category>
        <company>
                <name>Maintainer Example</name>
        </company>
        <distributionUri>distributions/1</distributionUri>
        <license>
                <type>Custom</type>
        </license>
        <name>Project Example</name>
        <version>1.0</version>
        <shortTag>project</shortTag>
</ns0:project>

See also

Repositories API Resources

repositoryOS_getAll

GET /orgs/{oid}/repositories/{rid}/distributions

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.5.1

Retrieve all distributions registered to a repository.

A list of repository objects are returned.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_administrate

URI Parameters

  • oid (required): the id of the org
  • rid (required): the id of the repository

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/repositories/{rid}/distributions" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

repositoryUpdateStatus_get

GET /orgs/{oid}/repositories/{rid}/updates/{uid}/status

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.7.fp3

Retrieves the status of a repository update.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_administrate

URI Parameters

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/repositories/{rid}/updates/{uid}/status" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

repositoryUpdate_create

POST /orgs/{oid}/repositories/{rid}/updates

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.7.fp3

Triggers a new package update process for a specific repository, within an organization.

This response body is a new update ticket providing the meta-data of the repository update that is to be triggered. The actual update is done asynchronously. To poll the status of this update, use repositoryUpdateStatus_get.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_administrate

URI Parameters

  • oid (required): the id of the org
  • rid (required): the id of the repository

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/repositories/{rid}/updates" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

repositoryUpdate_getAll

GET /orgs/{oid}/repositories/{rid}/updates

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.7.fp3

Returns all the updates for a repository.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_administrate

URI Parameters

  • oid (required): the id of the org
  • rid (required): the id of the repository

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/repositories/{rid}/updates" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

repository_create

POST /orgs/{oid}/repositories

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.5.1

Creates a new repository in an organization.

Please refer to repository for a complete list of all the repository attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_administrate

URI Parameters

  • oid (required): the id of the org

HTTP Request Body Parameters

A repository object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/repositories" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:repository xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>Example Repository</name>
        <url>http://example.com/repoUrl</url>
        <packagingType>RPM</packagingType>
        <coreRepository>true</coreRepository>
</ns0:repository>

See also

repository_delete

DELETE /orgs/{oid}/repositories/{rid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.5.1

Remove a repository from an organization.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_administrate

URI Parameters

  • oid (required): the id of the org
  • rid (required): the id of the repository

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/repositories/{rid}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

repository_getAll

GET /orgs/{oid}/repositories

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.5.1

Retrieves all the repositories for an organization.

A list of repository objects are returned.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_administrate

URI Parameters

  • oid (required): the id of the org

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/repositories" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

repository_update

PUT /orgs/{oid}/repositories/{rid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.5.1

Update the repository in an organisation.

Please refer to repository for a complete list of all the repository attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_administrate

URI Parameters

  • oid (required): the id of the org
  • rid (required): the id of the repository

HTTP Request Body Parameters

A repository object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/repositories/{rid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:repository xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>Example Repository - Updated</name>
        <url>http://example.com/newrepoUrl</url>
        <packagingType>RPM</packagingType>
        <coreRepository>true</coreRepository>
</ns0:repository>

See also

Roles and Entitlements API Resources

entitlement_getAll

GET /entitlements

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.2

Retrieves all the available entitlements available on the platform.

A list of entitlement objects are returned.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_administrate

URI Parameters

None HTTP Request Body Parameters ~~~~~~~~~~~~~~~~~~~~~~~~~~~~

None

Example Request

curl "https://uforge.example.com/api/entitlements" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

role_create

POST /orgs/{oid}/roles

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.2

Create a new role in an organization. A role contains one or more entitlements which determine the access rights to various features.

Please refer to role for a complete list of all the role attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_administrate

URI Parameters

  • oid (required): the id of the org

HTTP Request Body Parameters

A role object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/roles" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:role xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>Example Role</name>
</ns0:role>

See also

role_delete

DELETE /orgs/{oid}/roles/{rolename}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.2

Removes a role from the organization.

Note

if this role is currently assigned to a user, then the role is also removed automatically from the user.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_administrate

URI Parameters

  • rolename (required): the name of the role to be removed
  • oid (required): the id of the org

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/roles/{rolename}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

role_getAll

GET /orgs/{oid}/roles

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.2

Retrieves all the roles for an organization.

A list of role objects are returned.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_administrate

URI Parameters

  • oid (required): the id of the org

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/roles" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

role_update

PUT /orgs/{oid}/roles

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.2

Updates the information of a role.

Please refer to role for a complete list of all the role attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_administrate

URI Parameters

  • oid (required): the id of the org

HTTP Request Body Parameters

A role object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/roles" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:role xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>Example Role Updated</name>
</ns0:role>

See also

Scan Machine Image API Resources

scanImageGenerationStatus_get

GET /users/{uid}/scannedinstances/{siid}/scans/{sid}/images/{sitid}/status

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Retrieves the generation status of a machine image being generated.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_generate

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • sid (required): the id of the scan
  • sitid (required): the id of the image

HTTP Request Body Parameters

None

scanImageGeneration_cancel

DELETE /users/{uid}/scannedinstances/{siid}/scans/{sid}/images/{sitid}/status

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Cancels a running generation of a machine image from a scan.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_generate

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • sid (required): the id of the scan
  • sitid (required): the id of the image

HTTP Request Body Parameters

None

scanImageGeneration_delete

DELETE /users/{uid}/scannedinstances/{siid}/scans/{sid}/images/{sitid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.4

Deletes a machine image generated from a scan.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_generate

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • sid (required): the id of the scan
  • sitid (required): the id of the image

HTTP Request Body Parameters

None

scanImage_download

GET /users/{uid}/scannedinstances/{siid}/scans/{sid}/images/{itid}/downloads

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 3.4

Downloads a generated machine image from a scan.

This request is the same as scanImage_downloadFile

Note

You can only download a generated machine image if the initial generation request included the compress flag. For more information, see scanImage_generate.

The machine image can be downloaded without authentication if an downloadId is added as a query parameter. To retrieve the downloadId, use scanImage_get.

Note

The downloadId can only be used once, afterwards it expires, and a new downloadId must be retrieved.

Security Summary

  • Requires Authentication: false
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • itid (required): the id of the image
  • sid (required): the id of the scan

HTTP Request Body Parameters

None

scanImage_downloadFile

GET /users/{uid}/scannedinstances/{siid}/scans/{sid}/images/{itid}/downloads/{fileName}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 3.4

Downloads a generated machine image from a scan.

This request is the same as scanImage_download

Note

You can only download a generated machine image if the initial generation request included the compress flag. For more information, see scanImage_generate.

The machine image can be downloaded without authentication if an downloadId is added as a query parameter. To retrieve the downloadId, use scanImage_get.

Note

The downloadId can only be used once, afterwards it expires, and a new downloadId must be retrieved.

Security Summary

  • Requires Authentication: false
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user
  • fileName (required): the file name of the image to download
  • siid (required): the id of the scannedInstance
  • itid (required): the id of the image
  • sid (required): the id of the scan

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/images/{itid}/downloads/{fileName}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

scanImage_generate

POST /users/{uid}/scannedinstances/{siid}/scans/{sid}/images

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Request to generate a machine image from a scan.

This response body is an image ticket that provides the meta-data of the machine image that is to be generated. The actual generation is done asynchronously. To poll the status of this generation, use scanImageGenerationStatus_get.

Once complete, the machine image can be downloaded if the compressed flag was provided in the request.

To cancel a generation use scanImageGeneration_cancel

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_generate

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • sid (required): the id of the scan

HTTP Request Body Parameters

A image object

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/images" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:image xmlns:ns0="http://www.usharesoft.com/uforge">
        <compress>true</compress>
        <targetFormat>
                <name>VirtualBox</name>
        </targetFormat>
        <installProfile>
                <memorySize>512</memorySize>
        </installProfile>
</ns0:image>

See also

scanImage_get

GET /users/{uid}/scannedinstances/{siid}/scans/{sid}/images/{sitid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Retrieves the meta-data of a machine image generated from a scan.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_generate

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • sid (required): the id of the scan
  • sitid (required): the id of the image

HTTP Request Body Parameters

None

scanImage_getAll

GET /users/{uid}/scannedinstances/{siid}/scans/{sid}/images

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Returns all of the machine images generated from a scan.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_generate

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • sid (required): the id of the scan

HTTP Request Body Parameters

None

scanImage_publish

POST /users/{uid}/scannedinstances/{siid}/scans/{sid}/images/{itid}/pimages

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Request to publish (register) a generated machine image to a target cloud environment.

The response body is a publish image ticket that provides the meta-data of the published machine image. The actual publication is done asynchronously. To poll the status of this publication, use scanPublishedImageStatus_get.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_publish

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • itid (required): the id of the image to publish
  • sid (required): the id of the scan

HTTP Request Body Parameters

A publishImage object

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/images/{itid}/pimages" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:publishImage xmlns:ns0="http://www.usharesoft.com/uforge">
        <xsi:type></xsi:type>
        <applianceUri>users/root/appliances/4</applianceUri>
        <credAccount>
                <xsi:type></xsi:type>
                <targetPlatform>
                        <name>openstack</name>
                </targetPlatform>
                <glanceUrl>http://ip:9292</glanceUrl>
                <keystoneUrl>http://ip:5000</keystoneUrl>
                <login>username</login>
                <password>password</password>
                <keystoneVersion>v3</keystoneVersion>
        </credAccount>
        <imageUri>users/root/appliances/4/images/7</imageUri>
        <keystoneDomain>Keystone Domain Example</keystoneDomain>
        <keystoneProject>Keystone Project Example</keystoneProject>
        <displayName>Machine Image Name Example</displayName>
        <publicImage>true</publicImage>
</ns0:publishImage>

See also

scanPublishedImageStatus_get

GET /users/{uid}/scannedinstances/{siid}/scans/{sid}/images/{itid}/pimages/{pitid}/status

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Retrieve the publish status of all the published machine images for an appliance.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_publish

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • itid (required): the id of the image
  • pitid (required): the id of the publishImage
  • sid (required): the id of the scan

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/images/{itid}/pimages/{pitid}/status" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

scanPublishedImage_cancel

DELETE /users/{uid}/scannedinstances/{siid}/scans/{sid}/images/{itid}/pimages/{pitid}/cancel

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Cancel a publish of a machine image to a cloud environment.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_publish

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • itid (required): the id of the image
  • pitid (required): the id of the publishImage
  • sid (required): the id of the scan

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/images/{itid}/pimages/{pitid}/cancel" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

scanPublishedImage_delete

DELETE /users/{uid}/scannedinstances/{siid}/scans/{sid}/images/{itid}/pimages/{pitid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.4

Removes a published machine image from a scan.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_publish

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • itid (required): the id of the image
  • pitid (required): the id of the publishImage to delete
  • sid (required): the id of the scan

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/images/{itid}/pimages/{pitid}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

scanPublishedImage_get

GET /users/{uid}/scannedinstances/{siid}/scans/{sid}/images/{itid}/pimages/{pitid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Retrieve a published machine image for a scan.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_publish

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • itid (required): the id of the image
  • pitid (required): the id of the publishImage to delete
  • sid (required): the id of the scan

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/images/{itid}/pimages/{pitid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

Subscription Profile API Resources

subscriptionProfileAdmins_update

PUT /orgs/{oid}/subscriptions/{spid}/admins

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.5

Updates the administrators list for a subscription profile.

Any user listed in the subscription profile that is not specified in the new user list will be removed from the subscription profile.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_administrate

URI Parameters

HTTP Request Body Parameters

A userProfiles object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/subscriptions/{spid}/admins" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:users xmlns:ns0="http://www.usharesoft.com/uforge">
        <users>
                <user>
                        <loginName>guest</loginName>
                </user>
        </users>
</ns0:users>

See also

subscriptionProfileFormat_update

PUT /orgs/{oid}/subscriptions/{spid}/formats

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.5

Updates the machine image formats access rights list in a subscription profile.

Any machine image format listed in the subscription profile that is not specified in the new formats list will be removed from the subscription profile.

Warning

The formats provided must be part of the organization’s formats list and must be visible and active in the organization.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_administrate

URI Parameters

HTTP Request Body Parameters

A imageFormats object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/subscriptions/{spid}/formats" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:imageFormats xmlns:ns0="http://www.usharesoft.com/uforge">
        <imageFormats>
                <imageFormat>
                        <uri>orgs/1/formats/1</uri>
                </imageFormat>
        </imageFormats>
</ns0:imageFormats>

See also

subscriptionProfileOS_update

PUT /orgs/{oid}/subscriptions/{spid}/distros

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.5

Updates the operating system access rights list in a subscription profile.

Any operating system listed in the subscription profile that is not specified in the new operating system list will be removed from the subscription profile.

Warning

The operating systems provided must be part of the organization’s operating system list and must be visible and active in the organization.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_administrate

URI Parameters

HTTP Request Body Parameters

A distributions object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/subscriptions/{spid}/distros" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:distributions xmlns:ns0="http://www.usharesoft.com/uforge">
        <distributions>
                <distribution>
                        <uri>distributions/1</uri>
                </distribution>
        </distributions>
</ns0:distributions>

See also

subscriptionProfileQuotas_update

PUT /orgs/{oid}/subscriptions/{spid}/quotas

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.5

Updates the quotas in a subscription profile.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_administrate

URI Parameters

HTTP Request Body Parameters

A quotas object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/subscriptions/{spid}/quotas" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:quotas xmlns:ns0="http://www.usharesoft.com/uforge">
        <quotas>
                <quota>
                        <limit>-1</limit>
                        <type>generation</type>
                </quota>
                <quota>
                        <limit>10</limit>
                        <type>appliance</type>
                </quota>
                <quota>
                        <limit>-1</limit>
                        <type>scan</type>
                </quota>
                <quota>
                        <limit>-1</limit>
                        <type>diskusage</type>
                </quota>
        </quotas>
</ns0:quotas>

See also

subscriptionProfileRoles_update

PUT /orgs/{oid}/subscriptions/{spid}/roles

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.5

Updates the roles in a subscription profile.

Any role listed in the subscription profile that is not specified in the new role list will be removed from the subscription profile.

Warning

The roles provided must be already created in the organization.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_administrate

URI Parameters

HTTP Request Body Parameters

A roles object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/subscriptions/{spid}/roles" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:roles xmlns:ns0="http://www.usharesoft.com/uforge">
        <roles>
                <role>
                        <name>role1</name>
                </role>
        </roles>
</ns0:roles>

See also

subscriptionProfileTargetFormat_update

PUT /orgs/{oid}/subscriptions/{spid}/targetformats

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.5

Updates the target formats access rights list in a subscription profile.

Any target formats listed in the subscription profile that is not specified in the new target formats list will be removed from the subscription profile.

Warning

The target formats provided must be part of the organization and must be visible and active in the organization.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_administrate

URI Parameters

HTTP Request Body Parameters

A targetFormats object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/subscriptions/{spid}/targetformats" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:targetFormats xmlns:ns0="http://www.usharesoft.com/uforge">
        <targetFormats>
                <targetFormat>
                        <uri>orgs/1/targetformats/1</uri>
                </targetFormat>
        </targetFormats>
</ns0:targetFormats>

See also

subscriptionProfileTargetPlatform_update

PUT /orgs/{oid}/subscriptions/{spid}/targetplatforms

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.5

Updates the target platform access rights list in a subscription profile.

Any target platform listed in the subscription profile that is not specified in the new target platform list will be removed from the subscription profile.

Warning

The target platform provided must be part of the organization and must be visible and active in the organization.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_administrate

URI Parameters

HTTP Request Body Parameters

A targetPlatforms object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/subscriptions/{spid}/targetplatforms" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:targetPlatforms xmlns:ns0="http://www.usharesoft.com/uforge">
        <targetPlatforms>
                <targetPlatform>
                        <uri>orgs/1/targetplatforms/1</uri>
                </targetPlatform>
        </targetPlatforms>
</ns0:targetPlatforms>

See also

subscriptionProfile_create

POST /orgs/{oid}/subscriptions

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.5

Create a new subscription profile in an organization. A subscription profile describes a certain number of access parameters, and is used to customize the access rights automatically provided to new users being created on the platform.

Please refer to subscriptionProfile for a complete list of all the subscription profile attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_administrate

URI Parameters

  • oid (required): the id of the org

HTTP Request Body Parameters

A subscriptionProfile object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/subscriptions" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:subscriptionProfile xmlns:ns0="http://www.usharesoft.com/uforge">
        <active>true</active>
        <code>example</code>
        <description>Description example</description>
        <name>example</name>
</ns0:subscriptionProfile>

See also

subscriptionProfile_get

GET /orgs/{oid}/subscriptions/{spid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.5

Retrieve the information of a subscription profile.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

HTTP Request Body Parameters

None

subscriptionProfile_getAll

GET /orgs/{oid}/subscriptions

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.5

Retrieve all the subscription profiles for an organization.

A list of subscriptionProfile objects are returned.

Warning

This only returns the subscription profiles the requesting user is an administrator of.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • oid (required): the id of the org

HTTP Request Body Parameters

None

subscriptionProfile_remove

DELETE /orgs/{oid}/subscriptions/{spid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.5

Remove a subscription profile from an organization.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_administrate

URI Parameters

HTTP Request Body Parameters

None

subscriptionProfile_update

PUT /orgs/{oid}/subscriptions/{spid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.5

Update the information of a subscription profile.

Please refer to subscriptionProfile for a complete list of all the subscription profile attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_administrate

URI Parameters

HTTP Request Body Parameters

A subscriptionProfile object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/subscriptions/{spid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:subscriptionProfile xmlns:ns0="http://www.usharesoft.com/uforge">
        <active>true</active>
        <code>example2</code>
        <description>Description example</description>
        <name>example</name>
</ns0:subscriptionProfile>

See also

Target Format API Resources

primitiveFormat_getAll

GET /orgs/{oid}/formats

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Retrieve all the primitive image formats in an organisation. A primitive format is a supported machine image format supported natively by the platform. Primitive formats can be extended (for rebranding) by using target formats.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_formats_administrate

URI Parameters

  • oid (required): the id of the org

HTTP Request Body Parameters

None

primitiveFormat_update

PUT /orgs/{oid}/formats

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Updates the access rights for a primitive format in an organization. If a primitive format has been flagged inactive globally then this primitive format will no longer be available in the organization.

Note

When a primitive format is flagged as default then any new user created or added to the organization will be automatically given access to this primitive format.

Warning

If you add a primitive format as default, all existing users will NOT automatically be given access to this primitive format. You will need to do this explicitly.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_formats_administrate

URI Parameters

  • oid (required): the id of the org

HTTP Request Body Parameters

A imageFormats object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/formats" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:imageFormats xmlns:ns0="http://www.usharesoft.com/uforge">
        <imageFormats>
                <imageFormat>
                        <access>true</access>
                        <active>true</active>
                        <preselected>true</preselected>
                        <uri>format/5</uri>
                </imageFormat>
                <imageFormat>
                        <access>true</access>
                        <active>true</active>
                        <preselected>true</preselected>
                        <uri>format/7</uri>
                </imageFormat>
        </imageFormats>
</ns0:imageFormats>

See also

targetFormatLogo_delete

DELETE /orgs/{oid}/targetformats/{tfid}/logo/{logoId}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Remove an uploaded logo from a target format.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_formats_administrate

URI Parameters

  • oid (required): the id of the org
  • tfid (required): the id of the targetFormat
  • logoId (required): the id of the target format logo

HTTP Request Body Parameters

None

targetFormatLogo_download

GET /orgs/{oid}/targetformats/{tfid}/logo/{logoId}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 3.6

Download the logo from a target format.

This is similar to targetFormatLogo_downloadFile

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • oid (required): the id of the org
  • tfid (required): the id of the targetFormat
  • logoId (required): the id of the target format logo

HTTP Request Body Parameters

None

targetFormatLogo_downloadFile

GET /orgs/{oid}/targetformats/{tfid}/logo/{logoId}/{fileName}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 3.6

Download the logo from a target format.

This is similar to targetFormatLogo_downloadFile

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • fileName (required): the name of the logo binary
  • oid (required): the id of the org
  • tfid (required): the id of the targetFormat
  • logoId (required): the id of the target format logo

HTTP Request Body Parameters

None

targetFormatLogo_upload

POST /orgs/{oid}/targetformats/{tfid}/logo/{logoId}/{fileName}

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Upload a logo for a target format.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_formats_administrate

URI Parameters

  • fileName (required): the name of the logo binary
  • oid (required): the id of the org
  • tfid (required): the id of the targetFormat
  • logoId (required): the id of the target format logo

HTTP Request Body Parameters

The file to upload.

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/targetformats/{tfid}/logo/{logoId}/{fileName}" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@binaryFilePath"

See also

targetFormat_addTargetPlatform

POST /orgs/{oid}/targetformats/{tfid}/targetplatforms

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Adds the target format to a target platform. This is equivalent to targetPlatform_addFormat.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_formats_administrate

URI Parameters

  • oid (required): the id of the org
  • tfid (required): the id of the targetFormat

HTTP Request Body Parameters

A targetPlatform object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/targetformats/{tfid}/targetplatforms" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

See also

targetFormat_create

POST /orgs/{oid}/targetformats

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Creates a new target format in an organization. This is a format used to generate machine images. A target format is extends a primitive format type supported by the platform e.g. AMI, VHD, Hyper-V etc.

Please refer to targetFormat for a complete list of all the target format attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_formats_administrate

URI Parameters

  • oid (required): the id of the org

HTTP Request Body Parameters

A targetFormat object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/targetformats" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:targetFormat xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>My VBox</name>
        <format>
                <name>vbox</name>
        </format>
        <category>
                <name>Virtual</name>
        </category>
        <type>virtual</type>
        <imageInfos>When you will have generated your image, please add it to VirtualBox by doing: Machine > Add. Then select the .xml file.</imageInfos>
</ns0:targetFormat>

See also

targetFormat_delete

DELETE /orgs/{oid}/targetformats/{tfid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.6

Remove a target format from an organization.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_formats_administrate

URI Parameters

  • oid (required): the id of the org
  • tfid (required): the id of the targetFormat

HTTP Request Body Parameters

None

targetFormat_get

GET /orgs/{oid}/targetformats/{tfid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Retrieve the information of a target format. This is a format used to generate machine images.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • oid (required): the id of the org
  • tfid (required): the id of the targetFormat

HTTP Request Body Parameters

None

targetFormat_getAll

GET /orgs/{oid}/targetformats

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Retrieves all the target formats for an organization.

A list of targetFormat objects are returned. You can use a search criteria to retrieve a subset of these target formats.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_formats_administrate

URI Parameters

  • oid (required): the id of the org

HTTP Request Body Parameters

None

targetFormat_getAllTargetPlatforms

GET /orgs/{oid}/targetformats/{tfid}/targetplatforms

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Retrieves all the target platforms where this target format is used.

A list of targetPlatform objects are returned.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_formats_administrate

URI Parameters

  • oid (required): the id of the org
  • tfid (required): the id of the targetFormat

HTTP Request Body Parameters

None

targetFormat_removeTargetPlatform

DELETE /orgs/{oid}/targetformats/{tfid}/targetplatforms/{tpid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Removes the provided target format from a target platform. This is equivalent to targetPlatform_removeFormat.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_formats_administrate

URI Parameters

  • tpid (required): the id targetplatform-object object
  • oid (required): the id of the org
  • tfid (required): the id of the targetFormat to remove

HTTP Request Body Parameters

None

targetFormat_update

PUT /orgs/{oid}/targetformats/{tfid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Updates the information of a target format.

Please refer to targetFormat for a complete list of all the target format attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_formats_administrate

URI Parameters

  • oid (required): the id of the org
  • tfid (required): the id of the targetFormat

HTTP Request Body Parameters

A targetFormat object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/targetformats/{tfid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<targetFormat xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>{name-targetFormat}</name>
        <format>
                <name>{name-format}</name>
        </format>
        <category>
                <name>{name-targetFormatCategory}</name>
        </category>
        <type>cloud</type>
        <credAccountType>openstack</credAccountType>
</targetFormat>

See also

targetFormat_updateAccess

PUT /orgs/{oid}/targetformats

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Updates one or more target formats in an organization. This can be either to enable or disable a target format; add or remove a target format or update the default target format list. If a target format has been flagged inactive globally then this target format will no longer be available in the organization.

Note

When a target format is flagged as default then any new user created or added to the organization will be automatically given access to this target format.

Warning

If you add a target format as default, all existing users will NOT automatically be given access to this target format. You will need to do this explicitly.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_formats_administrate

URI Parameters

  • oid (required): the id of the org

HTTP Request Body Parameters

A targetFormats object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/targetformats" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:targetFormats xmlns:ns0="http://www.usharesoft.com/uforge">
        <targetFormats>
                <targetFormat>
                        <access>true</access>
                        <active>true</active>
                        <uri>orgs/1/targetFormats/4</uri>
                </targetFormat>
                <targetFormat>
                        <access>false</access>
                        <active>false</active>
                        <uri>orgs/1/targetFormats/5</uri>
                </targetFormat>
        </targetFormats>
</ns0:targetFormats>

See also

Target Platform API Resources

targetPlatformLogo_delete

DELETE /orgs/{oid}/targetplatforms/{tpid}/logo/{logoId}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Remove an uploaded logo from a target platform.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_formats_administrate

URI Parameters

  • tpid (required): the id of the targetPlatform
  • oid (required): the id of the org
  • logoId (required): the id of the target platform logo

HTTP Request Body Parameters

None

targetPlatformLogo_download

GET /orgs/{oid}/targetplatforms/{tpid}/logo/{logoId}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 3.6

Download the logo from a target platform.

This is similar to targetPlatformLogo_downloadFile

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • tpid (required): the id of the targetPlatform
  • oid (required): the id of the org
  • logoId (required): the id of the target platform logo

HTTP Request Body Parameters

None

targetPlatformLogo_downloadFile

GET /orgs/{oid}/targetplatforms/{tpid}/logo/{logoId}/{fileName}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 3.6

Download the logo from a target platform.

This is similar to targetPlatformLogo_download

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • tpid (required): the id of the targetPlatform
  • fileName (required): the file name of the logo to download
  • oid (required): the id of the org
  • logoId (required): the id of the target platform logo

HTTP Request Body Parameters

None

targetPlatformLogo_upload

POST /orgs/{oid}/targetplatforms/{tpid}/logo/{logoId}/{fileName}

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Upload a logo for a target platform.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_formats_administrate

URI Parameters

  • tpid (required): the id of the targetPlatform
  • fileName (required): the file name of the logo to download
  • oid (required): the id of the org
  • logoId (required): the id of the target platform logo

HTTP Request Body Parameters

The file to upload.

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/targetplatforms/{tpid}/logo/{logoId}/{fileName}" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@binaryFilePath"

See also

targetPlatform_addFormat

POST /orgs/{oid}/targetplatforms/{tpid}/targetformats

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Add a target format to a target platform.

Please refer to targetFormat for a complete list of all the target format attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_formats_administrate

URI Parameters

HTTP Request Body Parameters

A targetFormat object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/targetplatforms/{tpid}/targetformats" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:targetFormat xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>My VBox</name>
</ns0:targetFormat>

See also

targetPlatform_create

POST /orgs/{oid}/targetplatforms

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Creates a new target platform in an organization.

Please refer to targetPlatform for a complete list of all the target platform attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_formats_administrate

URI Parameters

  • oid (required): the id of the org

HTTP Request Body Parameters

A targetPlatform object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/targetplatforms" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:targetPlatform xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>My OpenStack</name>
        <type>openstack</type>
        <accountInfos>Please find your My OpenStack credentials at the following URL http://provider/myAccount/OpenStackSettings</accountInfos>
</ns0:targetPlatform>

See also

targetPlatform_delete

DELETE /orgs/{oid}/targetplatforms/{tpid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.6

Remove a target platform from an organization.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_formats_administrate

URI Parameters

HTTP Request Body Parameters

None

targetPlatform_get

GET /orgs/{oid}/targetplatforms/{tpid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Retrieves the information of a target platform. A target platform describes an environment where the platform can publish/register a generated machine image to. It can contain one or more target formats.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

HTTP Request Body Parameters

None

targetPlatform_getAll

GET /orgs/{oid}/targetplatforms

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Retrieves all the target platforms for an organization.

A list of targetPlatform objects are returned. You can use a search criteria to retrieve a subset of these target platforms.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_formats_administrate

URI Parameters

  • oid (required): the id of the org

HTTP Request Body Parameters

None

targetPlatform_getAllFormats

GET /orgs/{oid}/targetplatforms/{tpid}/targetformats

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Retrieves all the target formats for a target platform.

A list of targetFormat objects are returned.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_formats_administrate

URI Parameters

HTTP Request Body Parameters

None

targetPlatform_removeFormat

DELETE /orgs/{oid}/targetplatforms/{tpid}/targetformats/{tfid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Removes a target format from a target platform.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_formats_administrate

URI Parameters

HTTP Request Body Parameters

None

targetPlatform_update

PUT /orgs/{oid}/targetplatforms/{tpid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Update the meta-data of a target platform.

Please refer to targetPlatform for a complete list of all the target platform attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_formats_administrate

URI Parameters

HTTP Request Body Parameters

A targetPlatform object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/targetplatforms/{tpid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<targetPlatform xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>{name-targetPlatform}</name>
        <type>openstack</type>
</targetPlatform>

See also

targetPlatform_updateAccess

PUT /orgs/{oid}/targetplatforms

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Updates one or more target platforms in an organization. This can be either to enable or disable a target platform; add or remove a target platform or update the default target platform list. If a target platform has been flagged inactive globally then this target platform will no longer be available in the organization.

Note

When a target platform is flagged as default then any new user created or added to the organization will be automatically given access to this target platform.

Warning

If you add a platform format as default, all existing users will NOT automatically be given access to this target platform. You will need to do this explicitly.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_formats_administrate

URI Parameters

  • oid (required): the id of the org

HTTP Request Body Parameters

A targetPlatforms object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/targetplatforms" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:targetPlatforms xmlns:ns0="http://www.usharesoft.com/uforge">
        <targetPlatforms>
                <targetPlatform>
                        <access>true</access>
                        <active>true</active>
                        <uri>orgs/1/targetPlatforms/4</uri>
                </targetPlatform>
                <targetPlatform>
                        <access>false</access>
                        <active>false</active>
                        <uri>orgs/1/targetPlatforms/5</uri>
                </targetPlatform>
        </targetPlatforms>
</ns0:targetPlatforms>

See also

UForge Platform API Resources

uforgeStatus_get

GET /status

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml text/plain application/json
  • Since: UForge 3.4

Retrieves the status of the platform. This is a helper resource to determine if the platform web services are up and running.

Security Summary

  • Requires Authentication: false
  • Entitlements Required: None

URI Parameters

None HTTP Request Body Parameters ~~~~~~~~~~~~~~~~~~~~~~~~~~~~

None

Example Request

curl "https://uforge.example.com/api/status" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

User API Resources

userAdminStatus_change

PUT /users/{uid}/orgs/{oid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.3

Change the administration status of a user in an organization.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: user_administrate

URI Parameters

  • uid (required): the user name (login name) of the user
  • oid (required): the name of the organization

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/orgs/{oid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

userOrg_getAll

GET /users/{uid}/orgs

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 2.1

Retrieves the list of organization an user is a member or administrator of.

A list of org objects are returned.

You can use the query parameter name to filter the organization list returned.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/orgs" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

userOrg_remove

DELETE /users/{uid}/orgs/{oid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.3

Remove an user from an organization.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: user_administrate

URI Parameters

  • uid (required): the user name (login name) of the user
  • oid (required): the name of the organization

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/orgs/{oid}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

user_create

POST /users

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Creates a new user on the platform.

As part of the creation the user will be assigned to an organization and be setup using a subscription profile. If not subscription profile is specified, the default subscription profile will be used. A creation code os also specified, allowing user creation to be tracked. Other access rights including being an administrator of the organization can be specified as part of the creation.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

None HTTP Request Body Parameters ~~~~~~~~~~~~~~~~~~~~~~~~~~~~

A user object

Example Request

curl "https://uforge.example.com/api/users" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:user xmlns:ns0="http://www.usharesoft.com/uforge">
        <loginName>example</loginName>
        <active>true</active>
        <email>example@example.com</email>
        <creationCode>default</creationCode>
        <password>example</password>
</ns0:user>

See also

user_get

GET /users/{uid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Retrieves the information of an user.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

user_getAll

GET /users

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Retrieves all the users in the platform. A list of user objects are returned.

You can use a search criteria or a set of query parameters to retrieve a subset of the users.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: user_administrate

URI Parameters

None HTTP Request Body Parameters ~~~~~~~~~~~~~~~~~~~~~~~~~~~~

None

Example Request

curl "https://uforge.example.com/api/users" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

user_update

PUT /users/{uid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Updates the information of an user.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: user_administrate,user_profile_edit

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

A user object

Example Request

curl "https://uforge.example.com/api/users/{uid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:user xmlns:ns0="http://www.usharesoft.com/uforge">
        <loginName>guest</loginName>
        <active>true</active>
        <email>example2@example.com</email>
</ns0:user>

See also

User Cloud Account API Resources

cloudAccountCert_create

POST /users/{uid}/accounts/{caid}/certs

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 2.0

Creates a new certificate for a cloud account.

This provides the meta-data of the certificate as well as the certificate contents. If the certificate is a file, then please use cloudAccountCert_upload.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: cloud_account_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • caid (required): the id of the credAccount

HTTP Request Body Parameters

A certificate object

Example Request

curl "https://uforge.example.com/api/users/{uid}/accounts/{caid}/certs" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:certificate xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>x509 cert for Amazon EC2</name>
        <type>x509</type>
        <certStr>certifacte-content</certStr>
</ns0:certificate>

See also

cloudAccountCert_delete

DELETE /users/{uid}/accounts/{caid}/certs/{certid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 2.0

Remove a certificate file from a user’s cloud account.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: cloud_account_delete

URI Parameters

  • uid (required): the user name (login name) of the user
  • caid (required): the id of the credAccount
  • certid (required): the id of the certificate

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/accounts/{caid}/certs/{certid}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

cloudAccountCert_download

GET /users/{uid}/accounts/{caid}/certs/{certid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 2.0

Downloads a certificate from an user’s cloud account.

The certificate can be downloaded without authentication if an downloadId is added as a query parameter. To retrieve the downloadId, use cloudAccount_get.

Note

The downloadId can only be used once, afterwards it expires, and a new downloadId must be retrieved.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • caid (required): the id of the credAccount
  • certid (required): the id of the certificate

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/accounts/{caid}/certs/{certid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

cloudAccountCert_upload

POST /users/{uid}/accounts/{caid}/certs/{certid}/{fileName}

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 2.0

Uploads a certificate to a user’s cloud account.

Note

If you wish to replace a certificate, then prior to uploading please delete the current certificate by using cloudAccountCert_delete.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: cloud_account_create,cloud_account_edit

URI Parameters

  • uid (required): the user name (login name) of the user
  • fileName (required): the file name of the certificate
  • caid (required): the id of the credAccount
  • certid (required): the id of the certificate

HTTP Request Body Parameters

The file to upload.

Example Request

curl "https://uforge.example.com/api/users/{uid}/accounts/{caid}/certs/{certid}/{fileName}" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@binaryFilePath"

See also

cloudAccountResources_get

GET /users/{uid}/accounts/{caid}/resources

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 2.0

Retrieves any dynamic resource information from the tagret cloud environment.

The cloud account information is used with the target cloud’s APIs to retrieve any resource information that is required to register generated machine images to the target cloud environment.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_publish,migration_publish

URI Parameters

  • uid (required): the user name (login name) of the user
  • caid (required): the id of the credAccount

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/accounts/{caid}/resources" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

cloudAccount_create

POST /users/{uid}/accounts

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 2.0

Creates a new cloud account for an user.

Please refer to credAccount for a complete list of all the cloud account attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: cloud_account_create

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

A credAccount object

Example Request

curl "https://uforge.example.com/api/users/{uid}/accounts" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:credAccount xmlns:ns0="http://www.usharesoft.com/uforge">
        <xsi:type></xsi:type>
        <name>OpenStack Example</name>
        <targetPlatform>
                <name>OpenStack</name>
                <type>openstack</type>
        </targetPlatform>
        <glanceUrl>http://ip:9292</glanceUrl>
        <keystoneUrl>http://ip:5000</keystoneUrl>
        <login>username</login>
        <password>password</password>
        <keystoneVersion>v3</keystoneVersion>
</ns0:credAccount>

See also

cloudAccount_delete

DELETE /users/{uid}/accounts/{caid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 2.0

Removes a cloud account from a user.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: cloud_account_delete

URI Parameters

  • uid (required): the user name (login name) of the user
  • caid (required): the id of the credAccount

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/accounts/{caid}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

cloudAccount_get

GET /users/{uid}/accounts/{caid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 2.0

Retrieve the information of a cloud account.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user
  • caid (required): the id of the credAccount

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/accounts/{caid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

cloudAccount_getAll

GET /users/{uid}/accounts

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 2.0

Retrieves all the cloud accounts for an user.

A list of credAccount objects are returned. You can use a search criteria to retrieve a subset of these cloud accounts.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/accounts" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

cloudAccount_update

PUT /users/{uid}/accounts/{caid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 2.0

Updates the meta-data of a cloud account.

Please refer to credAccount for a complete list of all the cloud account attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: cloud_account_create,cloud_account_edit

URI Parameters

  • uid (required): the user name (login name) of the user
  • caid (required): the id of the credAccount

HTTP Request Body Parameters

A credAccount object

Example Request

curl "https://uforge.example.com/api/users/{uid}/accounts/{caid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:credAccount xmlns:ns0="http://www.usharesoft.com/uforge">
        <xsi:type></xsi:type>
        <name>OpenStack Example Update</name>
        <glanceUrl>http://ip:9292</glanceUrl>
        <keystoneUrl>http://ip:5000</keystoneUrl>
        <login>username</login>
        <password>password</password>
        <keystoneVersion>v3</keystoneVersion>
</ns0:credAccount>

See also

machineImagePublished_getAccount

GET /users/{uid}/appliances/{aid}/images/{itid}/pimages/{pitid}/accounts/{caid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.7.7

Returns the information of a cloud account.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user
  • itid (required): the id of the image
  • caid (required): the id of the credAccount
  • aid (required): the id of the appliance
  • pitid (required): the id of the publishImage

HTTP Request Body Parameters

None

machineImagePublished_getAccountResources

GET /users/{uid}/appliances/{aid}/images/{itid}/pimages/{pitid}/accounts/{caid}/resources

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.7.7

Returns any dynamic resource information from the target cloud environment.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user
  • itid (required): the id of the image
  • caid (required): the id of the credAccount
  • aid (required): the id of the appliance
  • pitid (required): the id of the publishImage

HTTP Request Body Parameters

None

scanPublishedImage_getAccount

GET /users/{uid}/scannedinstances/{siid}/scans/{sid}/images/{itid}/pimages/{pitid}/accounts/{caid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.7.7

Returns the information of a cloud account.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • itid (required): the id of the image
  • caid (required): the id of the credAccount
  • pitid (required): the id of the publishImage
  • sid (required): the id of the scan

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/images/{itid}/pimages/{pitid}/accounts/{caid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

scanPublishedImage_getAccountResources

GET /users/{uid}/scannedinstances/{siid}/scans/{sid}/images/{itid}/pimages/{pitid}/accounts/{caid}/resources

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.7.7

Returns any dynamic resource information from the target cloud environment.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user
  • siid (required): the id of the scannedInstance
  • itid (required): the id of the image
  • caid (required): the id of the credAccount
  • pitid (required): the id of the publishImage
  • sid (required): the id of the scan

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/images/{itid}/pimages/{pitid}/accounts/{caid}/resources" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

User Machine Image API Resources

userMachineImagePublishedStatus_getAll

GET /users/{uid}/pimages/status

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.2.1

Retrieves the current status of published machine images owned by a user.

A list of status objects are returned.

The img query parameter can be used to retrieve a subset of published machine images status.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_generate

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/pimages/status" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

userMachineImagePublished_getAll

GET /users/{uid}/pimages

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.2.1

Retrieves all the machine images that have been published by an user.

A published machine image is a machine image that has been uploaded and registered to a virtual or cloud environment.

A list of publishImage objects are returned.

The img query parameter can be used to retrieve a subset of published machine images.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_generate

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/pimages" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

userMachineImageStatus_get

GET /users/{uid}/images/status

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.2.1

Retrieves all the machine images status that have been generated by an user.

A list of status objects are returned.

The img query parameter can be used to retrieve a subset of machine images status.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_generate

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/images/status" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

userMachineImage_getAll

GET /users/{uid}/images

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.2.1

Retrieves all the machine images that have been generated by an user.

A list of image objects are returned.

The img query parameter can be used to retrieve a subset of machine images.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_generate

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/images" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

User OS API Resources

  • userOS_getAll: Retrieves all the operating systems the user has access to
  • userOS_update: Updates the list of operating systems the user has access to

userOS_getAll

GET /users/{uid}/distros

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.2

Retrieves all the operating systems the user has access to.

A list of appliance objects are returned.

You can use a search criteria to retrieve a subset of these appliances.

Warning

The operating systems available for a user not only depends on the access rights given for the user but also the access rights of the operating system in the organization.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/distros" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

userOS_update

PUT /users/{uid}/distros

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.2

Updates the list of operating systems the user has access to.

Please refer to distribProfile for a complete list of all the operating system attributes.

Warning

Any operating system that the user currently has access to that is not specified in the new operating system list will be removed, this effectively de-activates those operating systems for the user.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_os_administrate

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

A distributions object

Example Request

curl "https://uforge.example.com/api/users/{uid}/distros" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:distributions xmlns:ns0="http://www.usharesoft.com/uforge">
        <distributions>
                <distribution>
                        <active>true</active>
                        <uri>distributions/43</uri>
                        <visible>true</visible>
                </distribution>
        </distributions>
</ns0:distributions>

See also

User Profile API Resources

userAvatar_delete

DELETE /users/{uid}/photo/{photoId}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.0

Removes an uploaded avatar photo for an user.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: user_profile_edit

URI Parameters

  • uid (required): the user name (login name) of the user
  • photoId (required): the id of the logo

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/photo/{photoId}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

userAvatar_download

GET /users/{uid}/photo/{photoId}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 3.0

Downloads the avatar photo for an user.

This request is similar to userAvatar_downloadFile

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user
  • photoId (required): the id of the logo

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/photo/{photoId}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

userAvatar_downloadFile

GET /users/{uid}/photo/{photoId}/{fileName}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 3.0

Downloads the avatar photo for an user.

This request is similar to userAvatar_download

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user
  • fileName (required): the file name of the photo to download
  • photoId (required): the id of the logo

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/photo/{photoId}/{fileName}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

userAvatar_upload

POST /users/{uid}/photo/{photoId}/{fileName}

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.0

Uploads an avatar photo for an user.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: user_profile_edit

URI Parameters

  • uid (required): the user name (login name) of the user
  • fileName (required): the file name of the photo to download
  • photoId (required): the id of the logo

HTTP Request Body Parameters

The file to upload.

Example Request

curl "https://uforge.example.com/api/users/{uid}/photo/{photoId}/{fileName}" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@binaryFilePath"

See also

userPassword_reset

PUT /users/forgotpassword

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats:
  • Since: UForge 1.0

Resets 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.

Security Summary

  • Requires Authentication: false
  • Entitlements Required: None

URI Parameters

None HTTP Request Body Parameters ~~~~~~~~~~~~~~~~~~~~~~~~~~~~

A user object

Example Request

curl "https://uforge.example.com/api/users/forgotpassword" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:user xmlns:ns0="http://www.usharesoft.com/uforge">
        <loginName>{newuser-login-name}</loginName>
        <email>{newuser-login-name}@company.com</email>
</ns0:user>

See also

User Quota and Usage API Resources

userQuotas_get

GET /users/{uid}/quotas

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Retrieves the quotas for an user.

A list of quota objects are returned.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/quotas" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

userQuotas_update

PUT /users/{uid}/quotas

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Updates the quotas of an user.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

A quotas object

Example Request

curl "https://uforge.example.com/api/users/{uid}/quotas" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:quotas xmlns:ns0="http://www.usharesoft.com/uforge">
        <quotas>
                <quota>
                        <limit>-1</limit>
                        <type>generation</type>
                </quota>
                <quota>
                        <limit>10</limit>
                        <type>appliance</type>
                </quota>
                <quota>
                        <limit>-1</limit>
                        <type>scan</type>
                </quota>
                <quota>
                        <limit>-1</limit>
                        <type>diskusage</type>
                </quota>
        </quotas>
</ns0:quotas>

See also

userStats_get

GET /users/{uid}/stats

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Retrieve statistics for an user.

A list of userStats objects are returned. The statistics data includes:

  • Current summary usage information.
  • User’s quota.
  • Appliance activity. This is timeline of appliances created and machine images generated from those appliances. It includes a breakdown of operating systems used for the appliances and machine image formats of the machine images.
  • Scan activity. This is the timeline of live machine scans created and machine images generated from those scans. It includes a breakdown of the operating systems detected as part of the scan and machine image formats of the machine images.
  • User’s disk usage. This is the disk storage used for the user’s software components (in the Software Library); machine images and scan meta-data.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/stats" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

userUsage_get

GET /users/{uid}/usage

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Retrieve a user’s usage of the platform.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/usage" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

User Roles and Entitlements API Resources

userRoles_getAll

GET /users/{uid}/roles

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Retrieves all the roles for an user.

A list of role objects are returned.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/roles" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

userRoles_update

PUT /users/{uid}/roles

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Updates the roles for an user. Any new role in the list will be added to the user. Any role already provided to the user, but no longer in the new list will be removed.

Please refer to role for a complete list of all the role attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: user_create

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

A roles object

Example Request

curl "https://uforge.example.com/api/users/{uid}/roles" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:roles xmlns:ns0="http://www.usharesoft.com/uforge">
        <roles>
                <role>
                        <name>role1</name>
                </role>
        </roles>
</ns0:roles>

See also

User SSH Keys API Resources

sshKey_create

POST /users/{uid}/sshkeys

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Creates a new public ssh key.

Please refer to sshKey for a complete list of all the public ssh key attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

A sshKey object

Example Request

curl "https://uforge.example.com/api/users/{uid}/sshkeys" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:sshKey xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>SSHKey Example</name>
        <publicKey>ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAgEA8IMiRk5buQk0UuH0+XxCeVHz7hO9ViXHtFMrVVJsNq+ECk1J8f+ehKFPa/ir4P8tIp+1CkkYOB/uyjDj1LLEQsqJgXC0TDp2i3kPyG7A6OnQ82EpPf7h5SNdPjFKnMRzBNNh7e0l65Zyi17opmVxgd95Nvb1FJtE6ebIdEgfT6E79mcJ0WBYzzQPCKjhHkkbU/bocR6dfkD3s9tf19JqZ0QkgV8f/QBb9Rp0aJ3Cp2X3bql1Hokoqqjhqsw/ZgfR1b1XrqlGrUgLqSSZxJUYAf5pRf/TsEs50TUJoWvjVxy0AWFIpmAJWj5T2yZeZAqDTeAuFIN4zlitwCAHNPVo85oEDS8PhPe4dcDPSAotyznizKb8/Ble2F5dqf3gibA9XiqPrtIySfewSt7vTjxNgy/iGwL842H1iHKKW0+2UBihWZene922ZXDMiB0r6WzbgidGD1eYEHT6dW+gNdpyD9HD1RmxU9YddE7e8eDKIOE+NLT3jYbRP4XY0vabcdefXQLZJ6qW0Agp4DDj6pkxd9dv6DJx9ZMCIKJlYhos9RNEujoRX2rk4uADwMSeAprJux0CtCJRghk5ztJLe1nIWYeMlbb3pCzW4bXemw/KjrosMaHQ0jKhOgPeHhlGb2xMo2b3KcFXpoYvd3BeSDDwdJ7uOT+TDAEt0Ui3F+M8= test@example.com</publicKey>
</ns0:sshKey>

See also

sshKey_delete

DELETE /users/{uid}/sshkeys/{sshid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.4

Removes an ssh key from an user.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user
  • sshid (required): the id of the sshKey

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/sshkeys/{sshid}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

sshKey_get

GET /users/{uid}/sshkeys/{sshid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Retrieves a public SSH key for an user.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user
  • sshid (required): the id of the sshKey

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/sshkeys/{sshid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

sshKey_getAll

GET /users/{uid}/sshkeys

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Retrieves all the publish SSH keys for an user.

A list of sshKey objects are returned.

The query parameter name can be used to search for a subset of ssh keys.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/sshkeys" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

User Software Library API Resources

mySoftwareArtifact_add

POST /users/{uid}/mysoftware/{msid}/artifacts

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Adds a new software artifact to a software component. This only creates the meta-data for the software artifact, please use mySoftwareArtifact_upload to upload the file(s).

Please refer to softwareArtifact for a complete list of all the software artifact attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: software_upload

URI Parameters

  • uid (required): the id of the user
  • msid (required): the id of the mySoftware

HTTP Request Body Parameters

A softwareArtifact object

Example Request

curl "https://uforge.example.com/api/users/{uid}/mysoftware/{msid}/artifacts" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:softwareFile xmlns:ns0="http://www.usharesoft.com/uforge">
        <size>10</size>
        <name>artifact</name>
        <fullName>artifact</fullName>
        <origName>artifact</origName>
        <shortTag>softwarefile</shortTag>
</ns0:softwareFile>

See also

mySoftwareArtifact_addChild

POST /users/{uid}/mysoftware/{msid}/artifacts/{said}/subsoftwareartifacts

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Creates a child to a the software artifact (it will be a sub-software artifact) of the software component.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: software_upload

URI Parameters

HTTP Request Body Parameters

A softwareArtifact object

mySoftwareArtifact_addOrRemoveFileFromCache

PUT /users/{uid}/mysoftware/{msid}/artifacts/{said}/fetch

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats:
  • Since: UForge 3.6

Add or remove a file of an artifact (and all the files of the hierarchy if artifact is a folder) from cache.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: software_upload

URI Parameters

HTTP Request Body Parameters

The file to upload.

mySoftwareArtifact_createFromRemoteServer

GET /users/{uid}/mysoftware/{msid}/artifacts/fetch

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Create an artifact (and all the hierarchy if artifact is a folder) and download the file from remote repository corresponding to artifact account or directly with URL.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: software_upload

URI Parameters

  • uid (required): the id of the user
  • msid (required): the id of the mySoftware

HTTP Request Body Parameters

None

mySoftwareArtifact_delete

DELETE /users/{uid}/mysoftware/{msid}/artifacts/{said}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.6

Removes a software artifact binary from a software component.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: software_upload

URI Parameters

HTTP Request Body Parameters

None

mySoftwareArtifact_deleteAll

DELETE /users/{uid}/mysoftware/{msid}/artifacts

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.6

Removes all the software artifact binaries from a software component.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: software_upload

URI Parameters

  • uid (required): the id of the user
  • msid (required): the id of the mySoftware

HTTP Request Body Parameters

None

mySoftwareArtifact_download

GET /users/{uid}/mysoftware/{msid}/artifacts/{said}/bin

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 3.6

Downloads the software artifact binary or archive.

This request is the same as mySoftwareArtifact_downloadFile.

The software artifact binary can be downloaded without authentication if an downloadId is added as a query parameter. To retrieve the downloadId, use projectArtifact_get.

Note

The downloadId can only be used once, afterwards it expires, and a new downloadId must be retrieved.

Security Summary

  • Requires Authentication: false
  • Entitlements Required: None

URI Parameters

HTTP Request Body Parameters

None

mySoftwareArtifact_downloadFile

GET /users/{uid}/mysoftware/{msid}/artifacts/{said}/bin/{fileName}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 3.6

Downloads the software artifact binary or archive.

This request is the same as mySoftwareArtifact_download.

The software artifact binary can be downloaded without authentication if an downloadId is added as a query parameter. To retrieve the downloadId, use mySoftwareArtifact_get.

Note

The downloadId can only be used once, afterwards it expires, and a new downloadId must be retrieved.

Security Summary

  • Requires Authentication: false
  • Entitlements Required: None

URI Parameters

  • uid (required): the id of the user
  • msid (required): the id of the mySoftware
  • fileName (required): the file name of the binary to upload
  • said (required): the id of the softwareArtifact

HTTP Request Body Parameters

None

mySoftwareArtifact_get

GET /users/{uid}/mysoftware/{msid}/artifacts/{said}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Retrieves the information of a software artifact contained in a software component.

This only retrieves the meta-data of the project. If you wish to download the binaries, please use mySoftwareArtifact_download.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

mySoftwareArtifact_getAll

GET /users/{uid}/mysoftware/{msid}/artifacts

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Retrieves all software artifacts and files for a software component.

This may include os packages, bootscripts and software files (archives, files etc).

A list of softwareArtifact (softwareFile, bootScript or osPackage) objects are returned.

You can filter software artifact files by name when using the query parameter filename.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the id of the user
  • msid (required): the id of the mySoftware

HTTP Request Body Parameters

None

mySoftwareArtifact_update

PUT /users/{uid}/mysoftware/{msid}/artifacts/{said}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Updates the information of a software artifact in a software component.

This only updates the meta-data for the software artifact, please use mySoftwareArtifact_upload to upload the file(s).

Please refer to package for a complete list of all the software artifact attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: software_upload

URI Parameters

HTTP Request Body Parameters

A softwareArtifact object

Example Request

curl "https://uforge.example.com/api/users/{uid}/mysoftware/{msid}/artifacts/{said}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:softwareFile xmlns:ns0="http://www.usharesoft.com/uforge">
        <size>10</size>
        <name>artifact</name>
        <fullName>artifact</fullName>
        <origName>artifact</origName>
        <shortTag>softwarefile</shortTag>
</ns0:softwareFile>

See also

mySoftwareArtifact_updateAll

PUT /users/{uid}/mysoftware/{msid}/artifacts

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Updates the information of a set of artifact contained in a software component. This only updates the meta-data for the artifact, please use mySoftwareArtifact_upload to upload the file(s).

Please refer to softwareArtifact (softwareFile, bootScript or osPackage) for a complete list of all the software artifact attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: software_upload

URI Parameters

  • uid (required): the id of the user
  • msid (required): the id of the mySoftware

HTTP Request Body Parameters

A softwareArtifacts object

Example Request

curl "https://uforge.example.com/api/users/{uid}/mysoftware/{msid}/artifacts" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:softwareArtifacts xmlns:ns0="http://www.usharesoft.com/uforge">
        <softwareArtifacts>
                <softwareFile>
                        <dbId>603</dbId>
                        <size>10</size>
                        <name>artifact-update</name>
                        <fullName>artifact-update</fullName>
                        <origName>artifact-update</origName>
                </softwareFile>
        </softwareArtifacts>
</ns0:softwareArtifacts>

See also

mySoftwareArtifact_upload

POST /users/{uid}/mysoftware/{msid}/artifacts/{said}/bin/{fileName}

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Uploads a binary file to a software artifact.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: software_upload

URI Parameters

  • uid (required): the id of the user
  • msid (required): the id of the mySoftware
  • fileName (required): the file name of the binary to upload
  • said (required): the id of the softwareArtifact

HTTP Request Body Parameters

The file to upload.

mySoftwareExportStatus_get

GET /users/{uid}/mysoftware/{msid}/exports/{eid}/status

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Retrieve the current status of exporting a software bundle.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: software_upload

URI Parameters

  • uid (required): the user name (login name) of the user
  • eid (required): the id of the export ticket (provided after softwareBundleExport)
  • msid (required): the id of the mySoftware being exported

HTTP Request Body Parameters

None

mySoftwareExport_delete

DELETE /users/{uid}/mysoftware/{msid}/exports/{eid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.6

Deletes the export ticket and associated archive of an exported software bundle export metadata (archive).

Note

This does not delete the source software bundle.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: software_upload

URI Parameters

  • uid (required): the user name (login name) of the user
  • eid (required): the id of the export ticket (provided after softwareBundleExport)
  • msid (required): the id of the mySoftware

HTTP Request Body Parameters

None

mySoftwareExport_download

GET /users/{uid}/mysoftware/{msid}/exports/{eid}/downloads

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 3.6

Downloads the archive of an exported software bundle. The archive contains the meta-data file of the mySoftware.

An archive can be used with the hammr command-line tool.

Warning

you can only download an archive once the creation of the archive is complete. Use mySoftwareExportStatus_get to check the status of an export prior to a download request.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: software_upload

URI Parameters

  • uid (required): the user name (login name) of the user
  • eid (required): the id of the export ticket (provided after softwareBundleExport)
  • msid (required): the id of the mySoftware

HTTP Request Body Parameters

None

mySoftwareLicense_delete

DELETE /users/{uid}/mysoftware/{msid}/licenses/{lid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Remove a license file from a software component.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: software_upload

URI Parameters

  • uid (required): the id of the user
  • msid (required): the id of the mySoftware
  • lid (required): the id of the license

HTTP Request Body Parameters

None

mySoftwareLicense_download

GET /users/{uid}/mysoftware/{msid}/licenses/{lid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 3.6

Downloads the license of a software component.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the id of the user
  • msid (required): the id of the mySoftware
  • lid (required): the id of the license

HTTP Request Body Parameters

None

mySoftwareLicense_upload

POST /users/{uid}/mysoftware/{msid}/licenses/{lid}

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Uploads a license file for a software component. This request is similar to mySoftwareLicense_uploadFile

Security Summary

  • Requires Authentication: true
  • Entitlements Required: software_upload

URI Parameters

  • uid (required): the id of the user
  • msid (required): the id of the mySoftware
  • lid (required): the id of the license

HTTP Request Body Parameters

The file to upload.

mySoftwareLicense_uploadFile

POST /users/{uid}/mysoftware/{msid}/licenses/{lid}/{fileName}

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Uploads a license file for a software component. This request is similar to mySoftwareLicense_upload

Security Summary

  • Requires Authentication: true
  • Entitlements Required: software_upload

URI Parameters

  • uid (required): the id of the user
  • msid (required): the id of the mySoftware
  • fileName (required): the file name of the license to upload
  • lid (required): the id of the license

HTTP Request Body Parameters

The file to upload.

mySoftwareLogo_delete

DELETE /users/{uid}/mysoftware/{msid}/logo/{logoId}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

This method deletes the logo

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the id of the user
  • msid (required): the id of the mySoftware
  • logoId (required): the id of the logo

HTTP Request Body Parameters

None

mySoftwareLogo_download

GET /users/{uid}/mysoftware/{msid}/logo/{logoId}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 3.6

Downloads the logo file for the specified mysoftware.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • uid (required): the id of the user
  • msid (required): the id of the mySoftware
  • logoId (required): the id of the logo

HTTP Request Body Parameters

None

mySoftwareLogo_downloadFile

GET /users/{uid}/mysoftware/{msid}/logo/{logoId}/{fileName}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 3.6

Downloads the logo file for the specified mysoftware.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • uid (required): the id of the user
  • msid (required): the id of the mySoftware
  • fileName (required): the name of the logo file
  • logoId (required): the id of the logo

HTTP Request Body Parameters

None

mySoftwareLogo_upload

POST /users/{uid}/mysoftware/{msid}/logo/{logoId}/{fileName}

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Uploads a logo file for the specified software component.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the id of the user
  • msid (required): the id of the mySoftware
  • fileName (required): the name of the logo file
  • logoId (required): the id of the logo

HTTP Request Body Parameters

The file to upload.

mySoftwareRestrictionOS_evaluate

POST /users/{uid}/mysoftware/{msid}/restriction/{brid}/distributions

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.7

Evaluate the restriction rule to retrieve all distributions for which the software component is designed for.

A list of distribution objects are returned.

Note

carriage return is not authorized in the restriction rule.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

A bundleRestriction object

mySoftwareRestrictionOS_getAll

GET /users/{uid}/mysoftware/{msid}/restriction/{brid}/distributions

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.8.9

Retrieves all distributions compatible with the software component.

Retrieves all distributions available for the user and evaluates the restriction rule in order to list only the distributions that are compatible with the software component.

A list of distribution objects are returned.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

mySoftwareRestriction_update

PUT /users/{uid}/mysoftware/{msid}/restriction/{brid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.7

Updates the bundle restriction for a mySoftware.

This only updates the expression rule of the bundle restriction

Note

carriage return is not authorized in the restriction rule.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: software_upload

URI Parameters

HTTP Request Body Parameters

A bundleRestriction object

mySoftwareUsage_getAll

GET /users/{uid}/mysoftware/{msid}/appliances

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Retrieves all the appliance templates where a software component is includes.

A list of appliance objects are returned.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • msid (required): the id of the mySoftware

HTTP Request Body Parameters

None

mySoftware_availableForImage

POST /users/{uid}/mysoftware/{msid}/images

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.7.4

Gets the software component if it’s available for the image that will be generated. *

The mySoftware object is returned if available for image by parsing the restriction rule (return null if not).

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • msid (required): the id of the mySoftware

HTTP Request Body Parameters

A image object

mySoftware_clone

POST /users/{uid}/mysoftware/{msid}/clone

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Clones a new “My Software” object.

The cloned mySoftware object is returned.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: software_upload

URI Parameters

  • uid (required): the user name (login name) of the user
  • msid (required): the id of the mySoftware

HTTP Request Body Parameters

A mySoftware object

mySoftware_create

POST /users/{uid}/mysoftware

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Creates a new software component in a user’s Software library.

Once created, the user can upload software files (open source or proprietary). This software component can be added to one or more appliance templates.

Please refer to mySoftware for a complete list of all the my software attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: software_upload

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

A mySoftware object

mySoftware_delete

DELETE /users/{uid}/mysoftware/{msid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 1.0

Removes a software component from a user’s Software Library.

Warning

If any of the user’s appliance templates is using this software component, the software component will also be removed from the appliance template in question. In order to ensure no appliance templates are using this software component, use mySoftwareUsage_getAll

Security Summary

  • Requires Authentication: true
  • Entitlements Required: software_upload

URI Parameters

  • uid (required): the user name (login name) of the user
  • msid (required): the id of the mySoftware

HTTP Request Body Parameters

None

mySoftware_export

POST /users/{uid}/mysoftware/{msid}/exports

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Request to export the specified software bundle as an archive. This creates an export ticket that contains an archive that can be downloaded. The archive contains the meta-data file of the mySoftware.

An archive can be used with the hammr command-line tool.

The response body is an export software bundle ticket. To poll the status of this export, use applianceExportStatus_get. Once complete, the archive can be downloaded using applianceExport_download.

Note

No request body is required in this HTTP POST.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: software_upload

URI Parameters

  • uid (required): the user name (login name) of the user
  • msid (required): the id of the mySoftware to be exported

HTTP Request Body Parameters

None

mySoftware_get

GET /users/{uid}/mysoftware/{msid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Gets the information for a software component in a user’s Software Library.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • msid (required): the id of the mySoftware

HTTP Request Body Parameters

None

mySoftware_getAll

GET /users/{uid}/mysoftware

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Gets all the user’s software components from their Software Library.

A list of mySoftware objects are returned.

You can use a search criteria to retrieve a subset of these software components.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

mySoftware_update

PUT /users/{uid}/mysoftware/{msid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Updates the meta-data information of a software component.

Please refer to mySoftware for a complete list of all the my software attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: software_upload

URI Parameters

  • uid (required): the user name (login name) of the user
  • msid (required): the id of the mySoftware

HTTP Request Body Parameters

A mySoftware object

softwareBundleImportStatus_get

GET /users/{uid}/bundleimports/{sbid}/status

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Retrieve the current status of importing a software bundle archive.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

softwareBundleImport_get

GET /users/{uid}/bundleimports/{sbid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: 3.6

Retrieve a software bundle import ticket meta-data.

This object is created automatically when a request to import a software bundle archive is sent to the platform. See softwareBundle_import for more information.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

softwareBundleImport_upload

POST /users/{uid}/bundleimports/{sbid}/uploads

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Upload the software bundle archive.

In order to upload an archive, a software bundle import ticket must first be created by using softwareBundle_import.

Once the upload is complete, the platform extracts the archive and creates a software bundle from the archive contents. This is an asynchronous job. To get the status of this import, use softwareBundleImportStatus_get

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

The file to upload.

softwareBundle_import

POST /users/{uid}/bundleimports

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Requests to import a software bundle archive. This creates a software bundle import ticket that contains the meta-data information on the software bundle that will be created from the archive. Once this ticket is created, the archive can be uploaded using softwareBundleImport_upload.

An archive can be used with the hammr command-line tool.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

User Target Platforms and Formats API Resources

userFormats_getAll

GET /users/{uid}/formats

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.2

Retrieves all the target formats available for an user.

A list of targetFormat objects are returned.

You can use a search criteria to retrieve a subset of these target formats.

Warning

The target formats available for a user not only depends on the access rights given for the user but also the access rights of the target format in the organization.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

userFormats_update

PUT /users/{uid}/formats

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.2

Updates the list of machine image formats that an user has access to.

Please refer to imageFormat for a complete list of all the image format attributes.

Warning

Any image format that the user currently has access to that is not specified in the new target format list will be removed, this effectively de-activates those image formats for the user.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_formats_administrate

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

A imageFormats object

Example Request

curl "https://uforge.example.com/api/users/{uid}/formats" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:imageFormats xmlns:ns0="http://www.usharesoft.com/uforge">
        <imageFormats>
                <imageFormat>
                        <access>true</access>
                        <active>true</active>
                        <uri>format/5</uri>
                </imageFormat>
                <imageFormat>
                        <access>true</access>
                        <active>true</active>
                        <uri>format/7</uri>
                </imageFormat>
        </imageFormats>
</ns0:imageFormats>

See also

userTargetFormat_getAll

GET /users/{uid}/targetformats

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Retrieves all the target formats accessible by an user.

A list of targetPlatform objects are returned.

You can use a search criteria to retrieve a subset of these target platforms.

Warning

The target platforms available for a user not only depends on the access rights given for the user but also the access rights of the target platform in the organization.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_generate

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/targetformats" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

userTargetFormat_update

PUT /users/{uid}/targetformats

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Updates the list of target formats that an user has has access to.

Please refer to targetFormat for a complete list of all the target format attributes.

Warning

Any target format that the user currently has access to that is not specified in the new target format list will be removed, this effectively de-activates those target formats for the user.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_formats_administrate

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

A targetFormats object

Example Request

curl "https://uforge.example.com/api/users/{uid}/targetformats" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:targetFormats xmlns:ns0="http://www.usharesoft.com/uforge">
        <targetFormats>
                <targetFormat>
                        <uri>orgs/1/targetformats/1</uri>
                </targetFormat>
        </targetFormats>
</ns0:targetFormats>

See also

userTargetPlatformFormat_getAll

GET /users/{uid}/targetplatforms/{tpid}/targetformats

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Retrieves all the target formats in a target platform that the user has access to.

A list of targetFormat objects are returned.

You can use a search criteria to retrieve a subset of these target platforms.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_generate

URI Parameters

  • uid (required): the user name (login name) of the user
  • tpid (required): the id of the targetPlatform

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/targetplatforms/{tpid}/targetformats" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

userTargetPlatforms_getAll

GET /users/{uid}/targetplatforms

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Retrieves all the target platforms available for an user.

A list of targetPlatform objects are returned.

You can use a search criteria to retrieve a subset of these target platforms.

Warning

The target platforms available for a user not only depends on the access rights given for the user but also the access rights of the target platform in the organization.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_generate

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/targetplatforms" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

userTargetPlatforms_update

PUT /users/{uid}/targetplatforms

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Updates the list of target platforms that an user has access to.

Please refer to targetPlatform for a complete list of all the target platform attributes.

Warning

Any target platform that the user currently has access to that is not specified in the new target platform list will be removed, this effectively de-activates those target platforms for the user.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_formats_administrate

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

A targetPlatforms object

Example Request

curl "https://uforge.example.com/api/users/{uid}/targetplatforms" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:targetPlatforms xmlns:ns0="http://www.usharesoft.com/uforge">
        <targetPlatforms>
                <targetPlatform>
                        <access>true</access>
                        <active>true</active>
                        <uri>orgs/1/targetPlatforms/4</uri>
                </targetPlatform>
                <targetPlatform>
                        <access>false</access>
                        <active>false</active>
                        <uri>orgs/1/targetPlatforms/5</uri>
                </targetPlatform>
        </targetPlatforms>
</ns0:targetPlatforms>

See also

Workspace API Resources

userWorkspace_create

POST /users/{uid}/workspaces

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Creates a new workspace in an organization.

This request is similar to workspace_create

Please refer to workspace for a complete list of all the workspace attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: workspace_create

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

A workspace object

Example Request

curl "https://uforge.example.com/api/users/{uid}/workspaces" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:workspace xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>Workspace Example</name>
</ns0:workspace>

See also

userWorkspace_getAll

GET /users/{uid}/workspaces

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Retrieves all the workspaces a user is a member or administrator of.

A list of workspace objects are returned.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/workspaces" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

workspace_create

POST /orgs/{oid}/workspaces

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Creates a new workspace in an organization.

This request is similar to userWorkspace_create

Please refer to workspace for a complete list of all the workspace attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: workspace_create

URI Parameters

  • oid (required): the id of the org

HTTP Request Body Parameters

A workspace object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/workspaces" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:workspace xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>Workspace Example</name>
</ns0:workspace>

See also

workspace_delete

DELETE /orgs/{oid}/workspaces/{wid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.3.2

Removes a workspace from an organization.

Warning

all the appliance templates shared in the workspace are also deleted.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • wid (required): the id of the workspace
  • oid (required): the id of the org

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/workspaces/{wid}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

workspace_get

GET /orgs/{oid}/workspaces/{wid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Retrieves the information of a workspace.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • wid (required): the id of the workspace
  • oid (required): the id of the org

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/workspaces/{wid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

workspace_getAll

GET /orgs/{oid}/workspaces

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Retrieves all the workspace in an organization.

A list of workspace objects are returned.

You can use a search criteria to retrieve a subset of these workspaces.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • oid (required): the id of the org

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/workspaces" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

Workspace Comments API Resources

workspaceComment_create

POST /orgs/{oid}/workspaces/{wid}/comments

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Posts a comment to a workspace.

Please refer to comment for a complete list of all the comment attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • wid (required): the id of the workspace
  • oid (required): the id of the org

HTTP Request Body Parameters

A comment object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/workspaces/{wid}/comments" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:comment xmlns:ns0="http://www.usharesoft.com/uforge">
        <message>Comment Example</message>
        <type>QUESTION</type>
</ns0:comment>

See also

workspaceComment_delete

DELETE /orgs/{oid}/workspaces/{wid}/comments/{cid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.3.2

Removes a comment from a workspace.

This deletes the comment and all replies under this comment.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • wid (required): the id of the workspace
  • oid (required): the id of the org
  • cid (required): the id of the comment

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/workspaces/{wid}/comments/{cid}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

workspaceComment_deleteAll

DELETE /orgs/{oid}/workspaces/{wid}/comments

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.3.2

Removes all the comments for a workspace.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • wid (required): the id of the workspace
  • oid (required): the id of the org

HTTP Request Body Parameters

None

workspaceComment_dislike

DELETE /orgs/{oid}/workspaces/{wid}/comments/{cid}/likes

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.6

Dislike a comment in a workspace.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • wid (required): the id of the workspace
  • oid (required): the id of the org
  • cid (required): the id of the comment

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/workspaces/{wid}/comments/{cid}/likes" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

workspaceComment_get

GET /orgs/{oid}/workspaces/{wid}/comments/{cid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Retrieve a comment from a workspace.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • wid (required): the id of the workspace
  • oid (required): the id of the org
  • cid (required): the id of the comment

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/workspaces/{wid}/comments/{cid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

workspaceComment_like

POST /orgs/{oid}/workspaces/{wid}/comments/{cid}/likes

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Like a comment in a workspace.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • wid (required): the id of the workspace
  • oid (required): the id of the org
  • cid (required): the id of the comment

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/workspaces/{wid}/comments/{cid}/likes" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

workspaceComment_reply

POST /orgs/{oid}/workspaces/{wid}/comments/{cid}/replies

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Create a reply to a comment in a workspace.

Please refer to comment for a complete list of all the comment attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • wid (required): the id of the workspace
  • oid (required): the id of the org
  • cid (required): the id of the comment to reply to

HTTP Request Body Parameters

A comment object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/workspaces/{wid}/comments/{cid}/replies" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:comment xmlns:ns0="http://www.usharesoft.com/uforge">
        <message>Example Reply</message>
        <type>REPLY</type>
</ns0:comment>

See also

workspaceComment_reportAbuse

POST /orgs/{oid}/workspaces/{wid}/comments/{cid}/abuses

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Report a comment is abusive. ..note:: This does not change or remove the message contents of a comment, but notifies the platform administrators to moderate the comment

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • wid (required): the id of the workspace
  • oid (required): the id of the org
  • cid (required): the id of the comment

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/workspaces/{wid}/comments/{cid}/abuses" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

workspaceComment_update

PUT /orgs/{oid}/workspaces/{wid}/comments/{cid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Updates the information of a comment.

This can include flagging the comment as abusive.

Note

you cannot change the contents of the original comment message using this request.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • wid (required): the id of the workspace
  • oid (required): the id of the org
  • cid (required): the id of the comment

HTTP Request Body Parameters

A comment object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/workspaces/{wid}/comments/{cid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:comment xmlns:ns0="http://www.usharesoft.com/uforge">
        <abused>true</abused>
        <message>initial message</message>
</ns0:comment>

See also

workspaceComments_getAll

GET /orgs/{oid}/workspaces/{wid}/comments

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Retrieves all the comments posted in a workspace.

A list of comment objects are returned.

You can use a search criteria to retrieve a subset of these comments.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • wid (required): the id of the workspace
  • oid (required): the id of the org

HTTP Request Body Parameters

None

Workspace Members API Resources

workspaceMember_delete

DELETE /orgs/{oid}/workspaces/{wid}/memberships/{mid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.3.2

Removes a user as a member of a workspace.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • wid (required): the id of the workspace
  • mid (required): the id of the membership
  • oid (required): the id of the org

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/workspaces/{wid}/memberships/{mid}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

workspaceMember_deleteList

DELETE /orgs/{oid}/workspaces/{wid}/memberships

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.3.2

Removes one or more users as members of a workspace.

The list of users can be a list of emails or login names. This is specified as a set of query parameters.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • wid (required): the id of the workspace
  • oid (required): the id of the org

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/workspaces/{wid}/memberships" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

workspaceMember_getAll

GET /orgs/{oid}/workspaces/{wid}/memberships

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Retrieves all the members of a workspace. This includes all pending invitations.

A list of membership objects are returned.

You can use the query parameter user to search for a particular user that has been invited or member of the workspace.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • wid (required): the id of the workspace
  • oid (required): the id of the org

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/workspaces/{wid}/memberships" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also

workspaceMember_invite

POST /orgs/{oid}/workspaces/{wid}/memberships

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Invites one or more users to become members of a workspace.

Please refer to membership for a complete list of all the membership attributes.

You can invite people, based on their UForge login name or email address, though the user must already have an account and its membership to this workspace can’t already be in accepted or declined state.

By default, the invitee will have a Collaborator role inside the workspace. You can specify a specific role in each Membership instance. Please refer to workspaceMember_update to change the role of a workspace member.

An email notification is sent to inform that the user has been invited to a workspace.

Users invited to the workspace must accept or decline the invitation before doing any action inside the workspace.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • wid (required): the id of the workspace
  • oid (required): the id of the org

HTTP Request Body Parameters

A memberships object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/workspaces/{wid}/memberships" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:memberships xmlns:ns0="http://www.usharesoft.com/uforge">
        <memberships>
                <membership>
                        <userEmail>guest@usharesoft.com</userEmail>
                </membership>
        </memberships>
        <msg>Hi, I have created this workspace Workspace Example where we can collaborate and share some of our templates. Please join!</msg>
</ns0:memberships>

See also

workspaceMember_update

PUT /orgs/{oid}/workspaces/{wid}/memberships/{mid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Updates the membership role of an user in a workspace.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • wid (required): the id of the workspace
  • mid (required): the id of the membership
  • oid (required): the id of the org

HTTP Request Body Parameters

A membership object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/workspaces/{wid}/memberships/{mid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:membership xmlns:ns0="http://www.usharesoft.com/uforge">
        <role>Collaborator</role>
        <userEmail>example@example.com</userEmail>
</ns0:membership>

See also

workspaceMember_updateList

PUT /orgs/{oid}/workspaces/{wid}/memberships

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Updates the membership roles of one or more users in a workspace.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • wid (required): the id of the workspace
  • oid (required): the id of the org

HTTP Request Body Parameters

A memberships object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/workspaces/{wid}/memberships" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:memberships xmlns:ns0="http://www.usharesoft.com/uforge">
        <membership>
                <role>Collaborator</role>
                <userEmail>example@example.com</userEmail>
        </membership>
        <membership>
                <role>Administrator</role>
                <userEmail>example2@example.com</userEmail>
        </membership>
</ns0:memberships>

See also

Workspace Template API Resources

workspaceTemplateInstallProfile_get

GET /orgs/{oid}/workspaces/{wid}/templates/{tid}/installProfile

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Receives the installation profile for a shared appliance template.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

workspaceTemplateLogo_delete

DELETE /orgs/{oid}/workspaces/{wid}/templates/{tid}/logo/{lid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.3.2

Removes a logo from an appliance template in a workspace.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • wid (required): the id of the workspace
  • lid (required): the id of the logo
  • oid (required): the id of the org
  • tid (required): the id of the galleryTemplate

HTTP Request Body Parameters

None

workspaceTemplateLogo_download

GET /orgs/{oid}/workspaces/{wid}/templates/{tid}/logo/{lid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: */*
  • Since: UForge 3.3.2

Downloads a logo for an appliance template in a workspace.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

  • wid (required): the id of the workspace
  • lid (required): the id of the logo
  • oid (required): the id of the org
  • tid (required): the id of the galleryTemplate

HTTP Request Body Parameters

None

workspaceTemplateLogo_upload

POST /orgs/{oid}/workspaces/{wid}/templates/{tid}/logo/{lid}/{fileName}

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Uploads a logo for an appliance template in a workspace.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • fileName (required): the file name of the logo to upload
  • wid (required): the id of the workspace
  • lid (required): the id of the logo
  • oid (required): the id of the org
  • tid (required): the id of the galleryTemplate

HTTP Request Body Parameters

The file to upload.

workspaceTemplateOSApplications_get

GET /orgs/{oid}/workspaces/{wid}/templates/{tid}/osprofile/{ospid}/applications

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Receives all applications contained in the shared appliance template.

A list of package objects are returned.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

workspaceTemplateOSPartitionTable_get

GET /orgs/{oid}/workspaces/{wid}/templates/{tid}/osprofile/{ospid}/partitionTable

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Receives the partition table contained in the shared appliance template.

A list of package objects are returned.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

workspaceTemplateOSPkgs_get

GET /orgs/{oid}/workspaces/{wid}/templates/{tid}/osprofile/{ospid}/pkgs

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Receives all the native packages contained in the shared appliance template.

A list of package objects are returned.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

workspaceTemplateOSServices_get

GET /orgs/{oid}/workspaces/{wid}/templates/{tid}/osprofile/{ospid}/services

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Receives all services contained in the shared appliance template.

A list of package objects are returned.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

workspaceTemplateProjects_get

GET /orgs/{oid}/workspaces/{wid}/templates/{tid}/projects

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Retrieves all the project components for a shared appliance template.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

workspaceTemplateShare_cancel

DELETE /orgs/{oid}/workspaces/{wid}/templates/{tid}/status

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Cancels the current sharing process (import) of an appliance template to a workspace.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

workspaceTemplateStats_get

GET /orgs/{oid}/workspaces/{wid}/templates/{tid}/stats

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Retrieves the statistics for a shared appliance template in a workspace.

A list of galleryTemplateStatistics objects are returned.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • wid (required): the workspace id the template belongs to
  • oid (required): the Organization id
  • tid (required): the template id

HTTP Request Body Parameters

None

workspaceTemplateStatus_get

GET /orgs/{oid}/workspaces/{wid}/templates/{tid}/status

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Retrieves the status of an appliance template being shared to a workspace.

When a user wishes to share an appliance template to a workspace, this is an asynchronous process. Getting the status allows you to check if the share has successfully finished.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

workspaceTemplateStudio_get

GET /orgs/{oid}/workspaces/{wid}/templates/{tid}/oas/{oaspkgid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Retrieves the UForge Studio package information of a shared appliance template.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • wid (required): the id of the workspace
  • oid (required): the id of the org
  • tid (required): the id of the galleryTemplate
  • oaspkgid (required): the id of the UForge Studio package

HTTP Request Body Parameters

None

workspaceTemplate_delete

DELETE /orgs/{oid}/workspaces/{wid}/templates/{tid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.3.2

Removes an appliance template from a workspace.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

workspaceTemplate_get

GET /orgs/{oid}/workspaces/{wid}/templates/{tid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Retrieves the information of an appliance template in a workspace.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

workspaceTemplate_getAll

GET /orgs/{oid}/workspaces/{wid}/templates

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Retrieves all the appliance templates shared in a workspace.

A list of galleryTemplate objects are returned.

You can use a search criteria to retrieve a subset of these shared appliance templates.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • wid (required): the id of the workspace
  • oid (required): the id of the org

HTTP Request Body Parameters

None

workspaceTemplate_share

POST /orgs/{oid}/workspaces/{wid}/templates

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Requests to add an appliance from a user’s Appliance Library to a workspace.

This allows users to share their private appliance templates with other users via a workspace.

The response body is a gallery template that provides the meta-data of the new appliance template being shared. The actual process is done asynchronously. To poll the status, use workspaceTemplateStatus_get.

Once complete, the appliance template is available for other users.

To cancel the process use workspaceTemplateShare_cancel

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • wid (required): the id of the workspace
  • oid (required): the id of the org

HTTP Request Body Parameters

A galleryTemplate object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/workspaces/{wid}/templates" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:galleryTemplate xmlns:ns0="http://www.usharesoft.com/uforge">
        <description>This is a description example when sharing a template.</description>
        <name>Appliance Example</name>
        <version>1.0</version>
        <allowComments>true</allowComments>
        <applianceUri>users/root/appliances/6</applianceUri>
        <publisher>user</publisher>
</ns0:galleryTemplate>

See also

workspaceTemplate_update

PUT /orgs/{oid}/workspaces/{wid}/templates/{tid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Updates the information of an appliance template in a workspace.

Please refer to galleryTemplate for a complete list of all the template attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

A galleryTemplate object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/workspaces/{wid}/templates/{tid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:galleryTemplate xmlns:ns0="http://www.usharesoft.com/uforge">
        <name>Modified name</name>
        <version>1.0</version>
        <description>Example</description>
</ns0:galleryTemplate>

See also

workspaceTemplate_vote

POST /orgs/{oid}/workspaces/{wid}/templates/{tid}/vote

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Post a rating for a shared appliance template. The valid rating numbers is between 1 and 5.

If the user has already voted then their current vote value will be updated.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

A voteStat object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/workspaces/{wid}/templates/{tid}/vote" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:voteStat xmlns:ns0="http://www.usharesoft.com/uforge">
        <rating>3</rating>
</ns0:voteStat>

See also

Workspace Template Comments API Resources

workspaceTemplateComment_create

POST /orgs/{oid}/workspaces/{wid}/templates/{tid}/comments

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Posts a comment to a shared appliance template in a workspace.

Please refer to comment for a complete list of all the comment attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

A comment object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/workspaces/{wid}/templates/{tid}/comments" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:comment xmlns:ns0="http://www.usharesoft.com/uforge">
        <message>Comment Example</message>
        <type>QUESTION</type>
</ns0:comment>

See also

workspaceTemplateComment_delete

DELETE /orgs/{oid}/workspaces/{wid}/templates/{tid}/comments/{cid}

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.3.2

Removes a comment from a shared appliance template.

This deletes the comment and all replies under this comment.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

workspaceTemplateComment_deleteAll

DELETE /orgs/{oid}/workspaces/{wid}/templates/{tid}/comments

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.3.2

Removes all the comments for a shared appliance template.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

workspaceTemplateComment_dislike

DELETE /orgs/{oid}/workspaces/{wid}/templates/{tid}/comments/{cid}/likes

Summary

  • Method: DELETE
  • Response Code: 204 / 200
  • Response Formats:
  • Since: UForge 3.6

Dislike a comment in a workspace.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

workspaceTemplateComment_get

GET /orgs/{oid}/workspaces/{wid}/templates/{tid}/comments/{cid}

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Retrieve a comment from a workspace.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

HTTP Request Body Parameters

None

workspaceTemplateComment_getAll

GET /orgs/{oid}/workspaces/{wid}/templates/{tid}/comments

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Retrieves all the comments posted in a shared appliance template.

A list of comment objects are returned.

You can use a search criteria to retrieve a subset of these comments.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

HTTP Request Body Parameters

None

workspaceTemplateComment_like

POST /orgs/{oid}/workspaces/{wid}/templates/{tid}/comments/{cid}/likes

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.6

Like a comment in a workspace.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

workspaceTemplateComment_reply

POST /orgs/{oid}/workspaces/{wid}/templates/{tid}/comments/{cid}/replies

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Create a reply to a comment.

Please refer to comment for a complete list of all the comment attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • wid (required): the id of the workspace
  • oid (required): the id of the org
  • tid (required): the id of the galleryTemplate
  • cid (required): the id of the comment to reply to

HTTP Request Body Parameters

A comment object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/workspaces/{wid}/templates/{tid}/comments/{cid}/replies" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:comment xmlns:ns0="http://www.usharesoft.com/uforge">
        <message>Example Reply</message>
        <type>REPLY</type>
</ns0:comment>

See also

workspaceTemplateComment_reportAbuse

POST /orgs/{oid}/workspaces/{wid}/templates/{tid}/comments/{cid}/abuses

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Report a comment is abusive. ..note:: This does not change or remove the message contents of a comment, but notifies the platform administrators to moderate the comment

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

None

workspaceTemplateComment_update

PUT /orgs/{oid}/workspaces/{wid}/templates/{tid}/comments/{cid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Updates the information of a comment.

This can include flagging the comment as abusive.

Note

you cannot change the contents of the original comment message using this request.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

A comment object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/workspaces/{wid}/templates/{tid}/comments/{cid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:comment xmlns:ns0="http://www.usharesoft.com/uforge">
        <message>Initial message</message>
        <abused>true</abused>
</ns0:comment>

See also

Trademarks

UForge is a registered trademark of UShareSoft, a Fujitsu company.

LINUX is a registered trademark of Linus Torvalds.

Microsoft and Windows are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.

Oracle, Java, and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle Corporation and/or its affiliates.

Apache Ant, Ant, and Apache are trademarks of The Apache Software Foundation.

UNIX is a registered trademark of the Open Group in the United States and in other countries.

Other company names and product names are trademarks or registered trademarks of their respective owners.

High Risk Activity

The Customer acknowledges and agrees that the Product is designed, developed and manufactured as contemplated for general use, including without limitation, general office use, personal use, household use, and ordinary industrial use, but is not designed, developed and manufactured as contemplated for use accompanying fatal risks or dangers that, unless extremely high safety is secured, could lead directly to death, personal injury, severe physical damage or other loss (hereinafter “High Safety Required Use”), including without limitation, nuclear reaction control in nuclear facility, aircraft flight control, air traffic control, mass transport control, medical life support system, missile launch control in weapon system. The Customer shall not use the Product without securing the sufficient safety required for the High Safety Required Use. In addition, FUJITSU (or other affiliate’s name) shall not be liable against the Customer and/or any third party for any claims or damages arising in connection with the High Safety Required Use of the Product.

Export Restrictions

Exportation/release of this document may require necessary procedures in accordance with the regulations of your resident country and/or US export control laws.