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

areVdrUpdatesBlockedForBilling

This method returns true if VDR updates are blocked so billing can run for this account.

  • returns
boolean
  • parameters
None


cancelPayPalTransaction

Cancel the PayPal Payment Request process.

  • returns
boolean
  • parameters
string token
string payerId


completePayPalTransaction

Complete the PayPal Payment Request process and receive confirmation message.

  • returns
string
  • parameters
string token
string payerId


getAbuseEmail

Retrieve an email address that is responsible for abuse and legal inquiries on behalf of an account. For instance, new legal and abuse tickets are sent to this address.

  • returns
string
  • parameters
None


getActiveOutletPackages

Get the active Outlet SoftLayer_Product_Packages from which one can order a server.

  • returns
SoftLayer_Product_PackageArray
  • parameters
None


getActivePackages

Get the Active SoftLayer_Product_Packages from which one can order a server.

  • returns
SoftLayer_Product_PackageArray
  • parameters
None


getActiveVirtualLicenses

Retrieve the virtual software licenses controlled by an account

  • returns
SoftLayer_Software_VirtualLicenseArray
  • parameters
None


getAllBillingItems

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

  • returns
SoftLayer_Billing_ItemArray
  • parameters
None


getAllRecurringTopLevelBillingItems

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

  • returns
SoftLayer_Billing_ItemArray
  • parameters
None


getAllRecurringTopLevelBillingItemsUnfiltered

Retrieve the billing items that will be on an account's next invoice. Does not consider associated items.

  • returns
SoftLayer_Billing_ItemArray
  • parameters
None


getAllSubnetBillingItems

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

  • returns
SoftLayer_Billing_ItemArray
  • parameters
None


getAllTopLevelBillingItems

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

  • returns
SoftLayer_Billing_ItemArray
  • parameters
None


getAllTopLevelBillingItemsUnfiltered

Retrieve the billing items that will be on an account's next invoice. Does not consider associated items.

  • returns
SoftLayer_Billing_ItemArray
  • parameters
None


getApplicationDeliveryControllers

Retrieve an account's associated application delivery controller records.

  • returns
SoftLayer_Network_Application_Delivery_ControllerArray
  • parameters
None


getAttributeByType

Retrieve an account attribute by type keyname.

  • returns
SoftLayer_Account_Attribute
  • parameters
string attributeType


getAttributes

Retrieve the account attribute values for a SoftLayer customer account.

  • returns
SoftLayer_Account_AttributeArray
  • parameters
None


getBalance

Retrieve the account balance of a SoftLayer customer account. An account's balance is the amount of money owed to SoftLayer by the account holder, returned as a floating point number with two decimal places, measured in US Dollars ($USD). A negative account balance means the account holder has overpaid and is owed money by SoftLayer.

  • returns
decimal
  • parameters
None


getBandwidthAllotments

Retrieve the bandwidth allotments for an account.

  • returns
SoftLayer_Network_Bandwidth_Version1_AllotmentArray
  • parameters
None


getBareMetalInstances

Retrieve an account's associated bare metal computing instance objects.

  • returns
SoftLayer_HardwareArray
  • parameters
None


getBillingInfo

Retrieve an account's billing information.

  • returns
SoftLayer_Billing_Info
  • parameters
None


getBlockDeviceTemplateGroups

Retrieve block device groups for an account

  • returns
SoftLayer_Virtual_Guest_Block_Device_Template_GroupArray
  • parameters
None


getCdnAccounts

Retrieve an account's associated CDN accounts.

  • returns
SoftLayer_Network_ContentDelivery_AccountArray
  • 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


getDomainsWithoutSecondaryDnsRecords

Retrieve the DNS domains associated with an account that were not created as a result of a secondary DNS zone transfer.

  • 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


getGlobalLoadBalancerAccounts

Retrieve the global load balancer accounts for a softlayer customer account.

  • returns
SoftLayer_Network_LoadBalancer_Global_AccountArray
  • 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


getHasEvaultBareMetalRestorePluginFlag

Retrieve return 1 if one of the account's hardware has the EVault Bare Metal Restore Plugin otherwise 0.

  • returns
boolean
  • parameters
None


getHubNetworkStorage

Retrieve an account's associated CloudLayer Storage volumes.

  • returns
SoftLayer_Network_StorageArray
  • 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


getLatestBillDate

Retrieve an account's most recent billing date.

  • returns
dateTime
  • parameters
None


getLatestRecurringInvoice

Retrieve an account's latest recurring invoice.

  • returns
SoftLayer_Billing_Invoice
  • 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


getMasterUser

Retrieve an account's master user.

  • returns
SoftLayer_User_Customer
  • 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


getNetworkMonitorDownVirtualGuests

Retrieve virtual guest which is currently experiencing a service failure.

  • returns
SoftLayer_Virtual_GuestArray
  • parameters
None


getNetworkMonitorRecoveringHardware

Retrieve hardware which is currently recovering from a service failure.

  • returns
SoftLayer_HardwareArray
  • parameters
None


getNetworkMonitorRecoveringVirtualGuests

Retrieve virtual guest which is currently recovering from a service failure.

  • returns
SoftLayer_Virtual_GuestArray
  • parameters
None


getNetworkMonitorUpHardware

Retrieve hardware which is currently online.

  • returns
SoftLayer_HardwareArray
  • parameters
None


getNetworkMonitorUpVirtualGuests

Retrieve virtual guest which is currently online.

  • returns
SoftLayer_Virtual_GuestArray
  • 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

Retrieval: DEPRECATED - This information can be pulled directly through tapping keys now - DEPRECATED. 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_AllotmentArray
  • 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 data
  • parameters
None


getNextInvoiceTopLevelBillingItems

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

  • returns
SoftLayer_Billing_ItemArray
  • parameters
None


getNextInvoiceTotalAmount

Retrieve the total amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.

  • returns
decimal
  • parameters
None


getNextInvoiceTotalOneTimeAmount

Retrieve the total one-time charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.

  • returns
decimal
  • parameters
None


getNextInvoiceTotalOneTimeTaxAmount

Retrieve the total one-time tax amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.

  • returns
decimal
  • parameters
None


getNextInvoiceTotalRecurringAmount

Retrieve the total recurring charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.

  • returns
decimal
  • parameters
None


getNextInvoiceTotalRecurringTaxAmount

Retrieve the total recurring tax amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.

  • returns
decimal
  • 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


getOrphanBillingItems

Retrieve the billing items that have no parent billing item. These are items that don't necessarily belong to a single server.

  • returns
SoftLayer_Billing_ItemArray
  • parameters
None


getPendingInvoice

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

  • returns
SoftLayer_Billing_Invoice
  • parameters
None


getPendingInvoiceTopLevelItems

Retrieve a list of top-level invoice items that are on an account's currently pending invoice.

  • returns
SoftLayer_Billing_Invoice_ItemArray
  • parameters
None


getPendingInvoiceTotalAmount

Retrieve the total amount of an account's pending invoice, if one exists.

  • returns
decimal
  • parameters
None


getPendingInvoiceTotalOneTimeAmount

Retrieve the total one-time charges for an account's pending invoice, if one exists. In other words, it is the sum of one-time charges, setup fees, and labor fees. It does not include taxes.

  • returns
decimal
  • parameters
None


getPendingInvoiceTotalOneTimeTaxAmount

Retrieve the sum of all the taxes related to one time charges for an account's pending invoice, if one exists.

  • returns
decimal
  • parameters
None


getPendingInvoiceTotalRecurringAmount

Retrieve the total recurring amount of an account's pending invoice, if one exists.

  • returns
decimal
  • parameters
None


getPendingInvoiceTotalRecurringTaxAmount

Retrieve the total amount of the recurring taxes on an account's pending invoice, if one exists.

  • returns
decimal
  • parameters
None


getPptpVpnUsers

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

  • returns
SoftLayer_User_CustomerArray
  • parameters
None


getPrivateAllotmentHardwareBandwidthDetails

Retrieval: DEPRECATED - This information can be pulled directly through tapping keys now - DEPRECATED. 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_AllotmentArray
  • parameters
None


getPrivateNetworkVlans

Retrieve the private network VLANs assigned to an account.

  • returns
SoftLayer_Network_VlanArray
  • parameters
None


getPrivateSubnets

Retrieve all private subnets associated with an account.

  • returns
SoftLayer_Network_SubnetArray
  • parameters
None


getPublicAllotmentHardwareBandwidthDetails

Retrieval: DEPRECATED - This information can be pulled directly through tapping keys now - DEPRECATED. 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_AllotmentArray
  • parameters
None


getPublicNetworkVlans

Retrieve the public network VLANs assigned to an account.

  • returns
SoftLayer_Network_VlanArray
  • parameters
None


getPublicSubnets

Retrieve all public network subnets associated with an account.

  • returns
SoftLayer_Network_SubnetArray
  • parameters
None


getQuotes

Retrieve an account's associated billing orders or quotes.

  • returns
SoftLayer_Billing_Order_QuoteArray
  • 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


getSecondaryDomains

Retrieve the secondary DNS records for a SoftLayer customer account.

  • returns
SoftLayer_Dns_SecondaryArray
  • parameters
None


getSecurityScanRequests

Retrieve an account's vulnerability scan requests.

  • returns
SoftLayer_Network_Security_Scanner_RequestArray
  • parameters
None


getServiceBillingItems

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

  • returns
SoftLayer_Billing_ItemArray
  • parameters
None


getSslVpnUsers

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

  • returns
SoftLayer_User_CustomerArray
  • parameters
None


getSupportRepresentatives

Retrieve the SoftLayer employees that an account is assigned to.

  • returns
SoftLayer_User_EmployeeArray
  • parameters
None


getTickets

Retrieve an account's associated tickets.

  • returns
SoftLayer_TicketArray
  • parameters
None


getTranscodeAccounts

Retrieve an account's associated Transcode account.

  • returns
SoftLayer_Network_Media_Transcode_AccountArray
  • parameters
None


getUpgradeRequests

Retrieve an account's associated upgrade requests.

  • returns
SoftLayer_Product_Upgrade_RequestArray
  • parameters
None


getUsers

Retrieve an account's portal users.

  • returns
SoftLayer_User_CustomerArray
  • parameters
None


getVdrUpdatesInProgressFlag

Retrieve return 0 if vpn updates are currently in progress on this account otherwise 1.

  • returns
boolean
  • parameters
None


getVirtualDiskImages

Retrieve an account's associated computing instance virtual disk images.

  • returns
SoftLayer_Virtual_Disk_ImageArray
  • parameters
None


getVirtualGuests

Retrieve an account's associated virtual guest objects.

  • returns
SoftLayer_Virtual_GuestArray
  • parameters
None


getVirtualPrivateRack

Retrieve the virtual private rack for this account.

  • returns
SoftLayer_Network_Bandwidth_Version1_Allotment
  • parameters
None


getVirtualStorageArchiveRepositories

Retrieve an account's associated computing instance archived storage repositories.

  • returns
SoftLayer_Virtual_Storage_RepositoryArray
  • 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


hasAttribute

Determine if an account has a given attribute.

  • returns
boolean
  • parameters
string attributeType


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
boolean
  • parameters
boolean enabled


updateVpnUsersForResource

Creates or updates a user VPN access privileges for a server on account.

  • returns
boolean
  • parameters
integer objectId
string objectType
Retrieved from "http://sldn.softlayer.com/wiki/index.php/SoftLayer_Account"
Personal tools