SoftLayer Account

From SoftLayer Development Network Wiki

Jump to: navigation, search

This page refers to the SoftLayer_Account service. For information on the SoftLayer_Account data type please see SoftLayer_Account (type).

Contents

Overview

Every SoftLayer customer has an account which is defined in the SoftLayer_Account service. SoftLayer accounts have users, hardware, and services such as storage and domains associated with them. The SoftLayer_Account service is a convenient way to obtain general information about your SoftLayer account. Use the data returned by these methods with other API services to get more detailed information about your services and to make changes to your servers and services.

SoftLayer customers are unable to change their company account information in the portal or the API. If you need to change this information please open a sales ticket in our customer portal and our account management staff will assist you.

Endpoints

SOAP WSDL http://api.service.softlayer.com/soap/v3/SoftLayer_Account?wsdl
XML-RPC http://api.service.softlayer.com/xmlrpc/v3/SoftLayer_Account

Methods

completePayPalTransaction

Complete the PayPal Payment Request process and receive confirmation message.

  • returns
string
  • parameters
string token
string payerId


getActiveVirtualLicenses

Retrieve the virtual software licenses controlled by an account

  • returns
SoftLayer_Software_VirtualLicenseArray
  • parameters
None


getBandwidthAllotments

Retrieve the bandwidth allotments for an account.

  • returns
SoftLayer_Network_Bandwidth_Version1_AllotmentArray
  • parameters
None


getBillingInfo

Retrieve an account's billing information.

  • returns
SoftLayer_Billing_Info
  • parameters
None


getClosedTickets

Retrieve all closed tickets associated with an account.

  • returns
SoftLayer_TicketArray
  • parameters
None


getDomains

Retrieve the DNS domains associated with an account.

  • returns
SoftLayer_Dns_DomainArray
  • parameters
None


getEvaultMasterUsers

Retrieve an account's master EVault user. This is only used when an account has EVault service.

  • returns
SoftLayer_Account_PasswordArray
  • parameters
None


getEvaultNetworkStorage

Retrieve an account's associated EVault storage volumes.

  • returns
SoftLayer_Network_StorageArray
  • parameters
None


getHardware

Retrieve an account's associated hardware objects.

  • returns
SoftLayer_HardwareArray
  • parameters
None


getHardwareWithCpanel

Retrieve all hardware associated with an account that has the cPanel web hosting control panel installed.

  • returns
SoftLayer_HardwareArray
  • parameters
None


getHardwareWithHelm

Retrieve all hardware associated with an account that has the Helm web hosting control panel installed.

  • returns
SoftLayer_HardwareArray
  • parameters
None


getHardwareWithPlesk

Retrieve all hardware associated with an account that has the Plesk web hosting control panel installed.

  • returns
SoftLayer_HardwareArray
  • parameters
None


getHardwareWithUrchin

Retrieve all hardware associated with an account that has the Urchin web traffic analytics package installed.

  • returns
SoftLayer_HardwareArray
  • parameters
None


getHardwareWithWindows

Retrieve all hardware associated with an account that is running a version of the Microsoft Windows operating system.

  • returns
SoftLayer_HardwareArray
  • parameters
None


getInvoices

Retrieve an account's associated billing invoices.

  • returns
SoftLayer_Billing_InvoiceArray
  • parameters
None


getIscsiNetworkStorage

Retrieve an account's associated iSCSI storage volumes.

  • returns
SoftLayer_Network_StorageArray
  • parameters
None


getLastFiveClosedAbuseTickets

Retrieve the five most recently closed abuse tickets associated with an account.

  • returns
SoftLayer_TicketArray
  • parameters
None


getLastFiveClosedAccountingTickets

Retrieve the five most recently closed accounting tickets associated with an account.

  • returns
SoftLayer_TicketArray
  • parameters
None


getLastFiveClosedOtherTickets

Retrieve the five most recently closed tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account.

  • returns
SoftLayer_TicketArray
  • parameters
None


getLastFiveClosedSalesTickets

Retrieve the five most recently closed sales tickets associated with an account.

  • returns
SoftLayer_TicketArray
  • parameters
None


getLastFiveClosedSupportTickets

Retrieve the five most recently closed support tickets associated with an account.

  • returns
SoftLayer_TicketArray
  • parameters
None


getLastFiveClosedTickets

Retrieve the five most recently closed tickets associated with an account.

  • returns
SoftLayer_TicketArray
  • parameters
None


getLoadBalancers

Retrieve an account's associated load balancers.

  • returns
SoftLayer_Network_LoadBalancer_VirtualIpAddressArray
  • parameters
None


getLockboxNetworkStorage

Retrieve an account's associated Lockbox storage volumes.

  • returns
SoftLayer_Network_StorageArray
  • parameters
None


getNasNetworkStorage

Retrieve an account's associated NAS storage volumes.

  • returns
SoftLayer_Network_StorageArray
  • parameters
None


getNetworkMonitorDownHardware

Retrieve hardware which is currently experiencing a service failure.

  • returns
SoftLayer_HardwareArray
  • parameters
None


getNetworkMonitorRecoveringHardware

Retrieve hardware which is currently recovering from a service failure.

  • returns
SoftLayer_HardwareArray
  • parameters
None


getNetworkMonitorUpHardware

Retrieve hardware which is currently online.

  • returns
SoftLayer_HardwareArray
  • parameters
None


getNetworkStorage

Retrieve an account's associated StorageLayer storage volumes. This includes Lockbox, NAS, EVault, and iSCSI volumes.

  • returns
SoftLayer_Network_StorageArray
  • parameters
None


getNetworkVlanSpan

Retrieve whether or not an account has automatic private VLAN spanning enabled.

  • returns
SoftLayer_Account_Network_Vlan_Span
  • parameters
None


getNetworkVlans

Retrieve all network VLANs assigned to an account.

  • returns
SoftLayer_Network_VlanArray
  • parameters
None


getNextBillingPublicAllotmentHardwareBandwidthDetails

Retrieve the allotments for this account and their servers for the next billing cycle. The public inbound and outbound 

                                   bandwidth is calculated for each server in addition to the daily average network traffic
                                   since the last billing date.
  • returns
SoftLayer_Network_Bandwidth_Version1_Usage_DetailArray
  • parameters
None


getNextInvoicePdf

Retrieve the next billing period's invoice. Note, this should be considered preliminary as you may add, remove, change billing items on your account.

  • returns
binary
  • parameters
None


getNextInvoiceTopLevelBillingItems

Retrieve the billing items that will be on an account's next invoice.

  • returns
SoftLayer_Billing_ItemArray
  • parameters
None


getObject

Retrieve a SoftLayer_Account record.

  • returns
SoftLayer_Account
  • parameters
None


getOpenTickets

Retrieve all open tickets associated with an account.

  • returns
SoftLayer_TicketArray
  • parameters
None


getPendingInvoice

Retrieve an account's latest open (pending) invoice.

  • returns
SoftLayer_Billing_Invoice
  • parameters
None


getPptpVpnUsers

Retrieve an account's associated portal users with PPTP VPN access.

  • returns
SoftLayer_User_CustomerArray
  • parameters
None


getPrivateAllotmentHardwareBandwidthDetails

Retrieve the allotments for this account and their servers. The private inbound and outbound 

                                   bandwidth is calculated for each server in addition to the daily average network traffic
                                   since the last billing date.
  • returns
SoftLayer_Network_Bandwidth_Version1_Usage_DetailArray
  • parameters
None


getPrivateNetworkVlans

Retrieve the private network VLANs assigned to an account.

  • returns
SoftLayer_Network_VlanArray
  • parameters
None


getPublicAllotmentHardwareBandwidthDetails

Retrieve the allotments for this account and their servers. The public inbound and outbound 

                                   bandwidth is calculated for each server in addition to the daily average network traffic
                                   since the last billing date.
  • returns
SoftLayer_Network_Bandwidth_Version1_Usage_DetailArray
  • parameters
None


getPublicNetworkVlans

Retrieve the public network VLANs assigned to an account.

  • returns
SoftLayer_Network_VlanArray
  • parameters
None


getRwhoisData

Retrieve an account's reverse WHOIS data. This data is used when making SWIP requests.

  • returns
SoftLayer_Network_Subnet_Rwhois_Data
  • parameters
None


getSslVpnUsers

Retrieve an account's associated portal users with SSL VPN access.

  • returns
SoftLayer_User_CustomerArray
  • parameters
None


getTickets

Retrieve an account's associated tickets.

  • returns
SoftLayer_TicketArray
  • parameters
None


getUsers

Retrieve an account's portal users.

  • returns
SoftLayer_User_CustomerArray
  • parameters
None


getVirtualPrivateRack

Retrieve the virtual private rack for this account.

  • returns
SoftLayer_Network_Bandwidth_Version1_Allotment
  • parameters
None


getWindowsUpdateStatus

Retrieve a list of an account's hardware's Windows Update status.

  • returns
SoftLayer_Container_Utility_Microsoft_Windows_UpdateServices_StatusArray
  • parameters
None


requestCreditCardChange

Retrieve the record data associated with the submission of a Credit Card Change Request.

  • returns
SoftLayer_Billing_Payment_Card_ChangeRequest
  • parameters
SoftLayer_Billing_Payment_Card_ChangeRequest request


requestManualPayment

Retrieve the record data associated with the submission of a Manual Payment Request.

  • returns
SoftLayer_Billing_Payment_Card_ManualPayment
  • parameters
SoftLayer_Billing_Payment_Card_ManualPayment request


setVlanSpan

Set the flag that enables or disables automatic private network VLAN spanning for a SoftLayer customer account.

  • returns
bool
  • parameters
bool enabled
Retrieved from "http://sldn.softlayer.com/wiki/index.php/SoftLayer_Account"
Personal tools