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
Name |
Description |
---|---|
This Operation will add new currency into the system. |
|
This Operation will add keys to the given resource object. |
|
This function will add a user to a customer. |
|
Create an API Key User for the specified customer. |
|
This function will create a billing entity object. |
|
This function will create a blob. |
|
Create a record for the specified cluster |
|
This function will create a customer, processing a promotion code if necessary. |
|
This function will create an FDL code block in the unsigned state. |
|
This function will create an Internetworking VLAN for given inner and outer tags. |
|
This function will create an Internetworking VLAN. |
|
This function will create and return a Invoice |
|
Creates a payment method |
|
This function will start a job that will create a Pluggable Resource and return the job reference. |
|
This function will create a product |
|
This function will create and return a product offer. |
|
This function will create and returns a promotion. |
|
This function will create a promotion code. |
|
This function will create a Referral promocode Object. |
|
This function will return a the newly created Referral promotion Object. |
|
This function will create a Service Network. |
|
This function will create a storage group. |
|
Create a Translation object. |
|
This function starts a job that will create a user/contact with the given user details. |
|
Revoke API access when using the specified authentication token. |
|
Removes the records for all resources in the specified cluster. |
|
This Operation will delete given currency from the system. |
|
This function will remove the given promotion code. |
|
This function will remove the given referral promo code. |
|
This Operation will delete an existing resource object. |
|
Gets the Product Component Types that define an resource. |
|
This function will query the database, aggregating and grouping results if relevant. |
|
This function will return a newly created Unit Transaction Object. |
|
Gets an API authentication token for the specified User on the specified Customer. |
|
This function will return blob content for a given blob |
|
Gets the compiled values of a Translation object. |
|
This function will return the customer object for a customer given its UUID. |
|
This function will get the external vm details. |
|
This Operation will return a list of resource keys for the given resource. |
|
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. |
|
This function will return a list of measured values close to a given time stamp. |
|
Gets a resource of the given type with the specified UUID. |
|
This function will return list of available resource types. |
|
Get the Translation associated with the specified resource, either a User or a Billing Entity |
|
This function returns details about existing User. |
|
Get the VNC Forwarder details for a specific VNC session key. |
|
This function will import an external IP address. |
|
This function will import an external subnet. |
|
This function will allow you to import and external VM from a compatible hypervisor as a new server |
|
This function will start a job that will invoke an action for a resouce. |
|
This function will start a job that will invoke an action for a resouce. |
|
This function will start a job that will invoke a hypervisor specifiec action for a resouce. |
|
This Operation will return list of resources after satisfying the filter conditions and that are advertised to either a billing entity or customer |
|
This function will return list of billable resource types. |
|
This function searches for a list of billing entities matching a given search filter. |
|
This function searches for a list of currencies matching a given search filter. |
|
This function searches for a list of existing customers. |
|
List the external VMs for the given cluster |
|
This function searches for a list of invoices matching a given search filter. |
|
This function will fetch a list of permissions matching the specified filter conditions. |
|
This function searches for a list of product offers matching a given search filter. |
|
This function searches for a list of product purchases matching a given search filter. |
|
This function will list the available products |
|
This function will return list of promotion codes which meets the filter criteria. |
|
This function will return list of referral promocodes which meets the filter criteria. |
|
This Operation will return list of resources after satisfying the filter conditions |
|
This function searches for a list of statement details matching a given search filter. |
|
This function searches for a list of unit transaction summaries matching a given search filter. |
|
This function searches for a list of unit transactions. |
|
This function searches for a list of existing users. |
|
This function searches for a list of active product offers matching a given search filter. |
|
This function will move a user into the Locked group. |
|
This function marks an existing invoice status either pending, paid, unpaid or void. |
|
This function marks an existing product purchase as invalid. |
|
This function will merge two existing storage groups. |
|
This function will start a job to migrate a running server from one node to the specified compute node |
|
This function will modify the a blob. |
|
This function updates a cluster object with the supplied details. |
|
This function will modify the unsigned block of an existing FDL code block. |
|
This function will modify the state of a payment method. |
|
This function will modify the state of a payment provider. |
|
This function will start a job that will modify a Pluggable Resource and return the job reference. |
|
This function will modify a products description or active state. |
|
This function will modify and return modified product offer. |
|
This function will modify an existing resource object. |
|
This function will allow you to modify an existing service network |
|
This function will modify an existing storage group. |
|
Modify a Translation object. |
|
This function will open virtual network connection for a given server. |
|
Handles a payment callback. |
|
This function will publish an image to a customer, Billing Entity or the platform as a whole. |
|
This function will publish an image to a Customer or a Billing Entity. |
|
This function will create a new product purchase. |
|
This function will purchase a product offer for the specified resource (normally being a customer). |
|
This function will purchase the specified number of units using the payment method instance |
|
Refund a transaction, in part or in-full. |
|
Removes the record for the specified cluster |
|
This function will remove an imported external IP address |
|
This function will remove an imported subnet |
|
This Operation will remove keys from the given resource object. |
|
This function will remove a user from a customer. |
|
This function will return Invoice/Credit note PDF in Base64 format or in HTML fromat |
|
Manully renew an authentication trigger for the specified number of seconds. |
|
This function will return the resource which have been changed after a given time, specified by fromTime paramerter. |
|
This function will revoke an image from an authoritative entity i.e. Customer or Billing. |
|
This function will revoke a resource from an authoritative entity i.e. Customer or Billing. |
|
This function will send out an email dependent upon the input parameters passed. |
|
This Operation will add a set of resource keys to the given resource. |
|
This function associates a chargeable product offer to a resource. |
|
This function asoociates a chargeable OS product offer to an image. |
|
This function will create, delete, or modify a firewall template attached to a service network. |
|
This function will start a job that will sign the specified FDL code block. |
|
This function will substitute the existing purchases for a given product offer with another product offer. |
|
This function will remove a user from the Locked group. |
|
This function updates a billing entity object with the supplied details. |
|
This function will update an existing customer using the supplied fields. |
|
This function will update an email template object. |
|
This function will update an existing promotion object. |
|
This function will update an existing referral promo code with the changed field. |
|
This function will update an existing ReferralPromotion with the changed fields |
|
This function will update a user's details |
|
This function sets the validation string to a customer. |
|
This Operation will verify a user's authentication details. |
|
This function will wait for a job to complete. |
SOAP User API Methods
Name |
Description |
---|---|
This function will add an IP address to a network interface. |
|
This function will add keys to the given resource object. |
|
This function adds a resource on to the favourites list. |
|
This function adds a user to the specified group. |
|
This function will apply a firewall template to a given IP address. |
|
This function will attach a disk to an existing server. |
|
This function will attach a network interface to a given server. |
|
This function will attach an SSH key to a given server. |
|
This function will attach a subnet an existing network. |
|
This function will cancel a job. |
|
This function cancels an active purchase. This will only be applicable for UNIT purchaes |
|
Cancels a transaction. |
|
This function will change the state of (start, stop, kill or reboot) resources in the deployment instance. |
|
This function will change the state of (start, stop, kill or reboot) a server. |
|
This function will determine whether the specified actions would be permitted for a resource. |
|
This function will clone a snapshot resource. |
|
Create an API Key User for the current customer. |
|
This function will create a blob. |
|
This function will create a deployment template object. |
|
This function will create deployment template from deployment instance. |
|
This function will create a disk, and optionally attach it to a server. |
|
This function will create a firewall template. |
|
This function will create a new empty group. |
|
This function will create an image from a server or disk. |
|
This function will create a network. |
|
This function will create a network interface. |
|
Creates a payment method instance |
|
This function will start a job that will create a Pluggable Resource and return the job reference. |
|
This function will return a the newly created Referral promocode Object. |
|
This function will create an ssh key. |
|
This function will create a server using the supplied skeleton object. |
|
This function will create a snapshot object from a disk or a server. |
|
This function will create a subnet. |
|
This function will create a virtual data centre. |
|
Revoke API access when using the specified authentication token. |
|
This function will remove the given referral promo code. |
|
This function will delete an existing resource object. |
|
This function will remove a user from the specified group, or all groups if the group UUID is null. |
|
This function will deploy a template object. |
|
Gets the Product Component Types that define an resource. |
|
This function will detach a disk from an existing server. |
|
This function will detach a network interface from a given server. |
|
This function will detach an SSH key to a given server. |
|
This function will query the database, aggregating and grouping results if relevant. |
|
This function will do a dry run on the deployment instance to check if template can be deployed. |
|
This function will fetch a disk over the internet, using the parameters supplied. |
|
This function will fetch a resource (such as a disk, image or server) over the internet, using the parameters supplied. |
|
This function will fetch a server over the internet, using the parameters supplied. |
|
Gets an API authentication token for the currently authenticated user/customer combination. |
|
This function will return blob content for a given blob |
|
Gets the compiled value of a Translation object. |
|
This function returns the hypervisor specific settings for a cluster |
|
This function will return a list of measured values close to a given time stamp. |
|
Gets the product offer associated with the specified resource |
|
Gets a resource of the given type with the specified UUID. |
|
This function will return list of available resource types. |
|
Get the Translation associated with the authenticed User. |
|
This function will start a job that will invoke an action for a resouce. |
|
This function will start a job that will invoke an action for a resouce. |
|
This function will start a job that will invoke a hypervisor specifiec action for a resouce. |
|
This function will determine whether a specified action on a resource would be permitted. |
|
This function list current user's favourites list. Optionally can be filtered by resource type |
|
This function will fetch a list of permissions matching the specified filter conditions. |
|
This function will list the product purchases matching a given filter. |
|
This function will return list of referral promocodes which meets the filter criteria. |
|
List the resource keys for the given resource. |
|
This function will return list of resources after satisfying a filter. |
|
This function will list the statement details matching a given filter. |
|
This function will list the unit transaction summaries matching a given filter. |
|
This function will list the unit transactions matching a given filter. |
|
This function will move a user into the Locked group. |
|
This function will modify the a blob. |
|
This function will modify deployment instance. |
|
This function will modify deployment template. |
|
This function will modify a disk object. |
|
This function will modify a firewall. |
|
This function will modify a firewall template |
|
This function will modify a group. |
|
This function will modify an image. |
|
This function will modify an existing resource key for a given resource object. |
|
This function will modify a network object. |
|
This function will modify a network interface. |
|
This function will modify a payment method instance. |
|
This function will start a job that will modify a Pluggable Resource and return the job reference. |
|
This function will modify an existing resource object. |
|
This function will modify an ssh key. |
|
This function will modify an existing server object. |
|
This function will modify an existing snapshot. |
|
This function will modify a subnet. |
|
This function will modify virtual data centre. |
|
This function will open virtual network connection for a given server. |
|
This function marks an existing invoice status either pending,paid,unpaid or void. |
|
This function will publish an image to a Customer or a Billing Entity. |
|
This function will publish an image to a Customer or a Billing Entity. |
|
This function will purchase the specified number of units using the payment method instance. |
|
This function removes a resource on to the favourites list. |
|
This function will remove an IP address from a network interface. |
|
This function will remove keys from the given resource object. |
|
This function will return Invoice/Credit note PDF in Base64 format or in HTML fromat |
|
Manully renew an authentication trigger for the specified number of seconds. |
|
This function will return the resource which have been changed after a given time, specified by fromTime paramerter. |
|
Resumes a transaction which was awaiting interactive input. |
|
This function will revert all the changes of a resource object, back to its template. |
|
This function will revoke the publication of an image to a Customer or Billing Entity. |
|
This function will revoke the publication of an image/template to a Customer or Billing Entity. |
|
This function will set the capabilities for the specified group or user on a specific resource. |
|
This Operation will add a set of resource keys of user type to the given resource. |
|
Tests a payment method. |
|
This function will remove a user from the Locked group. |
|
This function will update an existing customer using the supplied fields. |
|
This function will update the metadata attached to a resource. |
|
This function will update a user's details. |
|
This function will wait for a job to complete. |