Calling the SOAP Admin API and User API

There are multiple methods that you are able to invoke from the FCO Admin and User API
The following pages show how the Admin API and User API are represented using SOAP

SOAP Admin API Methods
SOAP User API Methods

SOAP Admin API Methods

Name	Description
addCurrency	This Operation will add new currency into the system.
addKey	This Operation will add keys to the given resource object.
addUserToCustomer	This function will add a user to a customer.
createAPIKeyUser	Create an API Key User for the specified customer.
createBillingEntity	This function will create a billing entity object.
createBlob	This function will create a blob.
createCluster	Create a record for the specified cluster
createCustomer	This function will create a customer, processing a promotion code if necessary.
createFDLCodeBlock	This function will create an FDL code block in the unsigned state.
createInterWorkingNetworking	This function will create an Internetworking VLAN for given inner and outer tags.
createInterworkingNetwork	This function will create an Internetworking VLAN.
createInvoice	This function will create and return a Invoice
createPaymentMethod	Creates a payment method
createPluggableResource	This function will start a job that will create a Pluggable Resource and return the job reference.
createProduct	This function will create a product
createProductOffer	This function will create and return a product offer.
createPromotion	This function will create and returns a promotion.
createPromotionCode	This function will create a promotion code.
createReferralPromoCode	This function will create a Referral promocode Object.
createReferralPromotion	This function will return a the newly created Referral promotion Object.
createServiceNetwork	This function will create a Service Network.
createStorageGroup	This function will create a storage group.
createTranslation	Create a Translation object.
createUser	This function starts a job that will create a user/contact with the given user details.
deleteAuthenticationToken	Revoke API access when using the specified authentication token.
deleteCluster	Removes the records for all resources in the specified cluster.
deleteCurrency	This Operation will delete given currency from the system.
deletePromoCode	This function will remove the given promotion code.
deleteReferralPromoCode	This function will remove the given referral promo code.
deleteResource	This Operation will delete an existing resource object.
describeResource	Gets the Product Component Types that define an resource.
doQuery	This function will query the database, aggregating and grouping results if relevant.
doUnitTransaction	This function will return a newly created Unit Transaction Object.
getAuthenticationToken	Gets an API authentication token for the specified User on the specified Customer.
getBlobContent	This function will return blob content for a given blob
getCompiledTranslationMap	Gets the compiled values of a Translation object.
getCustomer	This function will return the customer object for a customer given its UUID.
getExternalVMDetails	This function will get the external vm details.
getKeysByType	This Operation will return a list of resource keys for the given resource.
getLicenceInformation	This function will return an object containing the serialised licence object, the licence object in XML format, the number of currently active clusters and CPU codes and the maximum permitted numbers of active clusters and CPU cores.
getMeasuredValues	This function will return a list of measured values close to a given time stamp.
getResource	Gets a resource of the given type with the specified UUID.
getResourceTypes	This function will return list of available resource types.
getTranslationForUser	Get the Translation associated with the specified resource, either a User or a Billing Entity
getUser	This function returns details about existing User.
getVncForwarderDetails	Get the VNC Forwarder details for a specific VNC session key.
importExternalIPAddress	This function will import an external IP address.
importExternalSubnet	This function will import an external subnet.
importExternalVM	This function will allow you to import and external VM from a compatible hypervisor as a new server
invokeAction	This function will start a job that will invoke an action for a resouce.
invokeActionSync	This function will start a job that will invoke an action for a resouce.
invokeHypervisorAction	This function will start a job that will invoke a hypervisor specifiec action for a resouce.
listAdvertisedResources	This Operation will return list of resources after satisfying the filter conditions and that are advertised to either a billing entity or customer
listBillableResourceTypes	This function will return list of billable resource types.
listBillingEntities	This function searches for a list of billing entities matching a given search filter.
listCurrencies	This function searches for a list of currencies matching a given search filter.
listCustomer	This function searches for a list of existing customers.
listExternalVMs	List the external VMs for the given cluster
listInvoices	This function searches for a list of invoices matching a given search filter.
listPermissions	This function will fetch a list of permissions matching the specified filter conditions.
listProductOffers	This function searches for a list of product offers matching a given search filter.
listProductPurchases	This function searches for a list of product purchases matching a given search filter.
listProducts	This function will list the available products
listPromoCode	This function will return list of promotion codes which meets the filter criteria.
listReferralPromoCode	This function will return list of referral promocodes which meets the filter criteria.
listResources	This Operation will return list of resources after satisfying the filter conditions
listStatementDetail	This function searches for a list of statement details matching a given search filter.
listUnitTransactionSummary	This function searches for a list of unit transaction summaries matching a given search filter.
listUnitTransactions	This function searches for a list of unit transactions.
listUser	This function searches for a list of existing users.
listValidProductOffers	This function searches for a list of active product offers matching a given search filter.
lockUser	This function will move a user into the Locked group.
markInvoiceStatus	This function marks an existing invoice status either pending, paid, unpaid or void.
markProductPurchaseInactive	This function marks an existing product purchase as invalid.
mergeStorageGroup	This function will merge two existing storage groups.
migrateServer	This function will start a job to migrate a running server from one node to the specified compute node
modifyBlob	This function will modify the a blob.
modifyCluster	This function updates a cluster object with the supplied details.
modifyFDLCodeBlock	This function will modify the unsigned block of an existing FDL code block.
modifyPaymentMethod	This function will modify the state of a payment method.
modifyPaymentProvider	This function will modify the state of a payment provider.
modifyPluggableResource	This function will start a job that will modify a Pluggable Resource and return the job reference.
modifyProduct	This function will modify a products description or active state.
modifyProductOffer	This function will modify and return modified product offer.
modifyResource	This function will modify an existing resource object.
modifyServiceNetwork	This function will allow you to modify an existing service network
modifyStorageGroup	This function will modify an existing storage group.
modifyTranslation	Modify a Translation object.
openVNCConnection	This function will open virtual network connection for a given server.
processCallback	Handles a payment callback.
publishImage	This function will publish an image to a customer, Billing Entity or the platform as a whole.
publishResource	This function will publish an image to a Customer or a Billing Entity.
purchaseProduct	This function will create a new product purchase.
purchaseProductOffer	This function will purchase a product offer for the specified resource (normally being a customer).
purchaseUnits	This function will purchase the specified number of units using the payment method instance
refundTransaction	Refund a transaction, in part or in-full.
removeCluster	Removes the record for the specified cluster
removeImportedIPAddress	This function will remove an imported external IP address
removeImportedSubnet	This function will remove an imported subnet
removeKey	This Operation will remove keys from the given resource object.
removeUserFromCustomer	This function will remove a user from a customer.
renderInvoice	This function will return Invoice/Credit note PDF in Base64 format or in HTML fromat
renewAuthenticationToken	Manully renew an authentication trigger for the specified number of seconds.
resourceInvalidations	This function will return the resource which have been changed after a given time, specified by fromTime paramerter.
revokeImage	This function will revoke an image from an authoritative entity i.e. Customer or Billing.
revokeResource	This function will revoke a resource from an authoritative entity i.e. Customer or Billing.
sendEmail	This function will send out an email dependent upon the input parameters passed.
setKeysByType	This Operation will add a set of resource keys to the given resource.
setLinkedProductOffer	This function associates a chargeable product offer to a resource.
setOSProductOffer	This function asoociates a chargeable OS product offer to an image.
setServiceNetworkFirewallTemplate	This function will create, delete, or modify a firewall template attached to a service network.
signFDLCodeBlock	This function will start a job that will sign the specified FDL code block.
substituteAllProductPurchases	This function will substitute the existing purchases for a given product offer with another product offer.
unlockUser	This function will remove a user from the Locked group.
updateBillingEntity	This function updates a billing entity object with the supplied details.
updateCustomer	This function will update an existing customer using the supplied fields.
updateEmailTemplate	This function will update an email template object.
updatePromotion	This function will update an existing promotion object.
updateReferralPromoCode	This function will update an existing referral promo code with the changed field.
updateReferralPromotion	This function will update an existing ReferralPromotion with the changed fields
updateUser	This function will update a user's details
validateCustomer	This function sets the validation string to a customer.
verifyUserPassword	This Operation will verify a user's authentication details.
waitForJob	This function will wait for a job to complete.

SOAP User API Methods

Name	Description
addIP	This function will add an IP address to a network interface.
addKey	This function will add keys to the given resource object.
addToFavourites	This function adds a resource on to the favourites list.
addUserToGroup	This function adds a user to the specified group.
applyFirewallTemplate	This function will apply a firewall template to a given IP address.
attachDisk	This function will attach a disk to an existing server.
attachNetworkInterface	This function will attach a network interface to a given server.
attachSSHKey	This function will attach an SSH key to a given server.
attachSubnet	This function will attach a subnet an existing network.
cancelJob	This function will cancel a job.
cancelProductPurchase	This function cancels an active purchase. This will only be applicable for UNIT purchaes
cancelTransaction	Cancels a transaction.
changeDeploymentInstanceStatus	This function will change the state of (start, stop, kill or reboot) resources in the deployment instance.
changeServerStatus	This function will change the state of (start, stop, kill or reboot) a server.
checkPermissions	This function will determine whether the specified actions would be permitted for a resource.
cloneResource	This function will clone a snapshot resource.
createAPIKeyUser	Create an API Key User for the current customer.
createBlob	This function will create a blob.
createDeploymentTemplate	This function will create a deployment template object.
createDeploymentTemplateFromInstance	This function will create deployment template from deployment instance.
createDisk	This function will create a disk, and optionally attach it to a server.
createFirewallTemplate	This function will create a firewall template.
createGroup	This function will create a new empty group.
createImage	This function will create an image from a server or disk.
createNetwork	This function will create a network.
createNetworkInterface	This function will create a network interface.
createPaymentMethodInstance	Creates a payment method instance
createPluggableResource	This function will start a job that will create a Pluggable Resource and return the job reference.
createReferralPromoCode	This function will return a the newly created Referral promocode Object.
createSSHKey	This function will create an ssh key.
createServer	This function will create a server using the supplied skeleton object.
createSnapshot	This function will create a snapshot object from a disk or a server.
createSubnet	This function will create a subnet.
createVDC	This function will create a virtual data centre.
deleteAuthenticationToken	Revoke API access when using the specified authentication token.
deleteReferralPromoCode	This function will remove the given referral promo code.
deleteResource	This function will delete an existing resource object.
deleteUserFromGroup	This function will remove a user from the specified group, or all groups if the group UUID is null.
deployTemplate	This function will deploy a template object.
describeResource	Gets the Product Component Types that define an resource.
detachDisk	This function will detach a disk from an existing server.
detachNetworkInterface	This function will detach a network interface from a given server.
detachSSHKey	This function will detach an SSH key to a given server.
doQuery	This function will query the database, aggregating and grouping results if relevant.
dryRunTemplate	This function will do a dry run on the deployment instance to check if template can be deployed.
fetchDisk	This function will fetch a disk over the internet, using the parameters supplied.
fetchResource	This function will fetch a resource (such as a disk, image or server) over the internet, using the parameters supplied.
fetchServer	This function will fetch a server over the internet, using the parameters supplied.
getAuthenticationToken	Gets an API authentication token for the currently authenticated user/customer combination.
getBlobContent	This function will return blob content for a given blob
getCompiledTranslationMap	Gets the compiled value of a Translation object.
getHypervisorConfig	This function returns the hypervisor specific settings for a cluster
getMeasuredValues	This function will return a list of measured values close to a given time stamp.
getProductOfferForResource	Gets the product offer associated with the specified resource
getResource	Gets a resource of the given type with the specified UUID.
getResourceTypes	This function will return list of available resource types.
getTranslationForUser	Get the Translation associated with the authenticed User.
invokeAction	This function will start a job that will invoke an action for a resouce.
invokeActionSync	This function will start a job that will invoke an action for a resouce.
invokeHypervisorAction	This function will start a job that will invoke a hypervisor specifiec action for a resouce.
isPermitted	This function will determine whether a specified action on a resource would be permitted.
listFavourites	This function list current user's favourites list. Optionally can be filtered by resource type
listPermissions	This function will fetch a list of permissions matching the specified filter conditions.
listProductPurchases	This function will list the product purchases matching a given filter.
listReferralPromoCode	This function will return list of referral promocodes which meets the filter criteria.
listResourceKeysForResource	List the resource keys for the given resource.
listResources	This function will return list of resources after satisfying a filter.
listStatementDetail	This function will list the statement details matching a given filter.
listUnitTransactionSummary	This function will list the unit transaction summaries matching a given filter.
listUnitTransactions	This function will list the unit transactions matching a given filter.
lockUser	This function will move a user into the Locked group.
modifyBlob	This function will modify the a blob.
modifyDeploymentInstance	This function will modify deployment instance.
modifyDeploymentTemplate	This function will modify deployment template.
modifyDisk	This function will modify a disk object.
modifyFirewall	This function will modify a firewall.
modifyFirewallTemplate	This function will modify a firewall template
modifyGroup	This function will modify a group.
modifyImage	This function will modify an image.
modifyKey	This function will modify an existing resource key for a given resource object.
modifyNetwork	This function will modify a network object.
modifyNetworkInterface	This function will modify a network interface.
modifyPaymentMethodInstance	This function will modify a payment method instance.
modifyPluggableResource	This function will start a job that will modify a Pluggable Resource and return the job reference.
modifyResource	This function will modify an existing resource object.
modifySSHKey	This function will modify an ssh key.
modifyServer	This function will modify an existing server object.
modifySnapshot	This function will modify an existing snapshot.
modifySubnet	This function will modify a subnet.
modifyVDC	This function will modify virtual data centre.
openVNCConnection	This function will open virtual network connection for a given server.
payInvoice	This function marks an existing invoice status either pending,paid,unpaid or void.
publishImage	This function will publish an image to a Customer or a Billing Entity.
publishResource	This function will publish an image to a Customer or a Billing Entity.
purchaseUnits	This function will purchase the specified number of units using the payment method instance.
removeFromFavourites	This function removes a resource on to the favourites list.
removeIP	This function will remove an IP address from a network interface.
removeKey	This function will remove keys from the given resource object.
renderInvoice	This function will return Invoice/Credit note PDF in Base64 format or in HTML fromat
renewAuthenticationToken	Manully renew an authentication trigger for the specified number of seconds.
resourceInvalidations	This function will return the resource which have been changed after a given time, specified by fromTime paramerter.
resumeTransaction	Resumes a transaction which was awaiting interactive input.
revertToResource	This function will revert all the changes of a resource object, back to its template.
revokeImage	This function will revoke the publication of an image to a Customer or Billing Entity.
revokeResource	This function will revoke the publication of an image/template to a Customer or Billing Entity.
setPermissions	This function will set the capabilities for the specified group or user on a specific resource.
setUserKeys	This Operation will add a set of resource keys of user type to the given resource.
testPaymentMethod	Tests a payment method.
unlockUser	This function will remove a user from the Locked group.
updateCustomer	This function will update an existing customer using the supplied fields.
updateMetadata	This function will update the metadata attached to a resource.
updateUser	This function will update a user's details.
waitForJob	This function will wait for a job to complete.

Page tree

Calling the SOAP Admin API and User API