Account
SoftLayer_Account

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.

Methods


addAchInformation
addReferralPartnerPaymentOption
areVdrUpdatesBlockedForBilling	This method returns true if VDR updates are blocked so billing can run for this account.
cancelPayPalTransaction	Cancel the PayPal Payment Request process.
completePayPalTransaction	Complete the PayPal Payment Request process and receive confirmation message.
countHourlyInstances	Retrieve the number of hourly services on an account that are active, plus any pending orders with hourly services attached.
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.
getAbuseEmails	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.
getAccountBackupHistory	This method provides a history of account backups.
getAccountContacts	Retrieve Array
getAccountLinks	Retrieve Array
getAccountManagedResourcesFlag	Retrieve a flag indicating that the account has a managed resource.
getAccountStatus	Retrieve an account's status presented in a more detailed data type.
getAccountTraitValue	Get the specific trait by its key
getActiveAccountDiscountBillingItem	Retrieve the billing item associated with an account's monthly discount.
getActiveAddresses	Retrieve the active address(es) that belong to an account.
getActiveBillingAgreements	Retrieve all billing agreements for an account
getActiveOutletPackages	Get the active Outlet SoftLayer_Product_Packages from which one can order a server.
getActivePackages	Get the Active SoftLayer_Product_Packages from which one can order a server.
getActiveVirtualLicenses	Retrieve the virtual software licenses controlled by an account
getAdcLoadBalancers	Retrieve an account's associated load balancers.
getAddresses	Retrieve all the address(es) that belong to an account.
getAggregatedUptimeGraph	Returns URL uptime data for your account
getAllBillingItems	Retrieve the billing items that will be on an account's next invoice.
getAllCommissionBillingItems	Retrieve the billing items that will be on an account's next invoice.
getAllRecurringTopLevelBillingItems	Retrieve the billing items that will be on an account's next invoice.
getAllRecurringTopLevelBillingItemsUnfiltered	Retrieve the billing items that will be on an account's next invoice. Does not consider associated items.
getAllSubnetBillingItems	Retrieve the billing items that will be on an account's next invoice.
getAllTopLevelBillingItems	Retrieve the billing items that will be on an account's next invoice.
getAllTopLevelBillingItemsUnfiltered	Retrieve the billing items that will be on an account's next invoice. Does not consider associated items.
getApplicationDeliveryControllers	Retrieve an account's associated application delivery controller records.
getAttributeByType	Retrieve an account attribute by type keyname.
getAttributes	Retrieve the account attribute values for a SoftLayer customer account.
getAuxiliaryNotifications
getAvailablePublicNetworkVlans	Retrieve the private network VLANs assigned to an account.
getAverageArchiveUsageMetricDataByDate	Returns the average disk usage for all archive repositories for the timeframe based on the parameters provided.
getAveragePublicUsageMetricDataByDate	Returns the average disk usage for all public repositories for the timeframe based on the parameters provided.
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.
getBandwidthAllotments	Retrieve the bandwidth allotments for an account.
getBandwidthAllotmentsOverAllocation	Retrieve the bandwidth allotments for an account currently over allocation.
getBandwidthAllotmentsProjectedOverAllocation	Retrieve the bandwidth allotments for an account projected to go over allocation.
getBareMetalInstances	Retrieve an account's associated bare metal computing instance objects.
getBillingAgreements	Retrieve all billing agreements for an account
getBillingInfo	Retrieve an account's billing information.
getBlockDeviceTemplateGroups	Retrieve block device groups for an account
getBrand	Retrieve Array
getBrandAccountFlag	Retrieve Array
getBrandKeyName	Retrieve the brand key name.
getCdnAccounts	Retrieve an account's associated CDN accounts.
getClosedTickets	Retrieve all closed tickets associated with an account.
getCurrentBackupStatisticsGraph	This method retrieves a pie chart for today's backup statistics.
getCurrentTicketStatisticsGraph
getCurrentUser	Retrieve the current API user's record.
getDatacentersWithSubnetAllocations	Retrieve datacenters which contain subnets that the account has access to route.
getDiskUsageMetricDataByDate	Retrieve the metric data for disk space usage for a storage repository.
getDiskUsageMetricImageByDate	Retrieve an image of the disk usage data on a Cloud Computing Instance image for the time range you provide.
getDisplaySupportRepresentativeAssignments	Retrieve the SoftLayer employees that an account is assigned to.
getDomainRegistrations	Retrieve Array
getDomains	Retrieve the DNS domains associated with an account.
getDomainsWithoutSecondaryDnsRecords	Retrieve the DNS domains associated with an account that were not created as a result of a secondary DNS zone transfer.
getEvaultMasterUsers	Retrieve an account's master EVault user. This is only used when an account has EVault service.
getEvaultNetworkStorage	Retrieve an account's associated EVault storage volumes.
getExecutiveSummaryPdf	This method provides an executive summary PDF for managed hosting services.
getExpiredSecurityCertificates	Retrieve stored security certificates that are expired (ie. SSL)
getGlobalLoadBalancerAccounts	Retrieve the global load balancer accounts for a softlayer customer account.
getHardware	Retrieve an account's associated hardware objects.
getHardwareOverBandwidthAllocation	Retrieve an account's associated hardware objects currently over bandwidth allocation.
getHardwareProjectedOverBandwidthAllocation	Retrieve an account's associated hardware objects projected to go over bandwidth allocation.
getHardwareWithCpanel	Retrieve all hardware associated with an account that has the cPanel web hosting control panel installed.
getHardwareWithHelm	Retrieve all hardware associated with an account that has the Helm web hosting control panel installed.
getHardwareWithMcafee	Retrieve all hardware associated with an account that has McAfee software components.
getHardwareWithMcafeeAntivirusRedhat	Retrieve all hardware associated with an account that has McAfee AntiVirus for Redhat software components.
getHardwareWithMcafeeAntivirusWindows	Retrieve all hardware associated with an account that has McAfee AntiVirus for Windows software components.
getHardwareWithMcafeeIntrusionDetectionSystem	Retrieve all hardware associated with an account that has McAfee Intrusion Detection System software components.
getHardwareWithPlesk	Retrieve all hardware associated with an account that has the Plesk web hosting control panel installed.
getHardwareWithQuantastor	Retrieve all hardware associated with an account that has the QuantaStor storage system installed.
getHardwareWithUrchin	Retrieve all hardware associated with an account that has the Urchin web traffic analytics package installed.
getHardwareWithWindows	Retrieve all hardware associated with an account that is running a version of the Microsoft Windows operating system.
getHasEvaultBareMetalRestorePluginFlag	Retrieve return 1 if one of the account's hardware has the EVault Bare Metal Restore Plugin otherwise 0.
getHasPendingOrder	Retrieve the number of orders in a PENDING status for a SoftLayer customer account.
getHasR1softBareMetalRestorePluginFlag	Retrieve return 1 if one of the account's hardware has an installation of R1Soft CDP otherwise 0.
getHistoricalBackupGraph
getHistoricalBandwidthGraph	This method returns a line graph of bandwidth statistics.
getHistoricalTicketGraph	This method returns a pie chart of ticket statistics for the given dates.
getHistoricalUptimeGraph	This method returns a SoftLayer_Container_Account_Graph_Outputs object for the specified date range.
getHourlyBareMetalInstances	Retrieve an account's associated hourly bare metal computing instance objects.
getHourlyVirtualGuests	Retrieve an account's associated hourly virtual guest objects.
getHubNetworkStorage	Retrieve an account's associated CloudLayer Storage volumes.
getInternalNotes	Retrieve Array
getInvoices	Retrieve an account's associated billing invoices.
getIscsiNetworkStorage	Retrieve an account's associated iSCSI storage volumes.
getLargestAllowedSubnetCidr
getLastFiveClosedAbuseTickets	Retrieve the five most recently closed abuse tickets associated with an account.
getLastFiveClosedAccountingTickets	Retrieve the five most recently closed accounting tickets associated with an account.
getLastFiveClosedOrbitTickets	Retrieve the five most recently closed tickets that do not belong to The Planet associated with an account.
getLastFiveClosedOtherTickets	Retrieve the five most recently closed tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account.
getLastFiveClosedSalesTickets	Retrieve the five most recently closed sales tickets associated with an account.
getLastFiveClosedSupportTickets	Retrieve the five most recently closed support tickets associated with an account.
getLastFiveClosedTickets	Retrieve the five most recently closed tickets associated with an account.
getLatestBillDate	Retrieve an account's most recent billing date.
getLatestRecurringInvoice	Retrieve an account's latest recurring invoice.
getLatestRecurringPendingInvoice	Retrieve an account's latest recurring pending invoice.
getLegacyBandwidthAllotments	Retrieve the legacy bandwidth allotments for an account.
getLoadBalancers	Retrieve an account's associated load balancers.
getLockboxNetworkStorage	Retrieve an account's associated Lockbox storage volumes.
getMasterUser	Retrieve an account's master user.
getMediaDataTransferRequests	Retrieve an account's media transfer service requests.
getMonthlyBareMetalInstances	Retrieve an account's associated monthly bare metal computing instance objects.
getMonthlyVirtualGuests	Retrieve an account's associated monthly virtual guest objects.
getNasNetworkStorage	Retrieve an account's associated NAS storage volumes.
getNetworkHardware	Retrieve an account's associated network hardware.
getNetworkMessageDeliveryAccounts	Retrieve Array
getNetworkMonitorDownHardware	Retrieve hardware which is currently experiencing a service failure.
getNetworkMonitorDownVirtualGuests	Retrieve virtual guest which is currently experiencing a service failure.
getNetworkMonitorRecoveringHardware	Retrieve hardware which is currently recovering from a service failure.
getNetworkMonitorRecoveringVirtualGuests	Retrieve virtual guest which is currently recovering from a service failure.
getNetworkMonitorUpHardware	Retrieve hardware which is currently online.
getNetworkMonitorUpVirtualGuests	Retrieve virtual guest which is currently online.
getNetworkStorage	Retrieve an account's associated StorageLayer storage volumes. This includes Lockbox, NAS, EVault, and iSCSI volumes.
getNetworkTunnelContexts	Retrieve iPSec network tunnels for an account.
getNetworkVlanSpan	Retrieve whether or not an account has automatic private VLAN spanning enabled.
getNetworkVlans	Retrieve all network VLANs assigned to an account.
getNetworkVrfs	Retrieve an accounts Virtual Routing and Forwarding objects.
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.
getNextInvoiceExcel	Retrieve the next billing period's invoice. Note, this should be considered preliminary as you may add, remove, change billing items on your account.
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.
getNextInvoiceTopLevelBillingItems	Retrieve the billing items that will be on an account's next invoice.
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.
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.
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.
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.
getNextInvoiceTotalRecurringAmountBeforeAccountDiscount	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.
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.
getNextInvoiceTotalTaxableRecurringAmount	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.
getNextInvoiceZeroFeeItemCounts
getObject	Retrieve a SoftLayer_Account record.
getOpenAbuseTickets	Retrieve the open abuse tickets associated with an account.
getOpenAccountingTickets	Retrieve the open accounting tickets associated with an account.
getOpenOtherTickets	Retrieve the open tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account.
getOpenSalesTickets	Retrieve the open sales tickets associated with an account.
getOpenSupportTickets	Retrieve the open support tickets associated with an account.
getOpenTickets	Retrieve all open tickets associated with an account.
getOpenTicketsWaitingOnCustomer	Retrieve all open tickets associated with an account last edited by an employee.
getOrphanBillingItems	Retrieve the billing items that have no parent billing item. These are items that don't necessarily belong to a single server.
getOwnedBrands	Retrieve Array
getPaymentProcessors	Retrieve Array
getPendingInvoice	Retrieve an account's latest open (pending) invoice.
getPendingInvoiceTopLevelItems	Retrieve a list of top-level invoice items that are on an account's currently pending invoice.
getPendingInvoiceTotalAmount	Retrieve the total amount of this invoice.
getPendingInvoiceTotalOneTimeAmount	Retrieve the total one-time charges for this invoice. This is the sum of one-time charges + setup fees + labor fees. This does not include taxes.
getPendingInvoiceTotalOneTimeTaxAmount	Retrieve a sum of all the taxes related to one time charges for this invoice.
getPendingInvoiceTotalRecurringAmount	Retrieve the total Recurring amount of this invoice. This amount does not include taxes or one time charges.
getPendingInvoiceTotalRecurringTaxAmount	Retrieve the total amount of the recurring taxes on this invoice.
getPermissionGroups	Retrieve an account's permission groups.
getPermissionRoles	Retrieve an account's user roles.
getPortableStorageVolumes	Retrieve Array
getPptpVpnUsers	Retrieve an account's associated portal users with PPTP VPN access.
getPriceRestrictions	Retrieve the item price that an account is restricted to.
getPriorityOneTickets	Retrieve all priority one tickets associated with an account.
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.
getPrivateBlockDeviceTemplateGroups	Retrieve private block device groups for an account
getPrivateNetworkVlans	Retrieve the private network VLANs assigned to an account.
getPrivateNetworkVrfs	Retrieve all private network VRFs associated with an account.
getPrivateSubnets	Retrieve all private subnets associated with an account.
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.
getPublicNetworkVlans	Retrieve the public network VLANs assigned to an account.
getPublicNetworkVrfs	Retrieve all public network VRFs associated with an account.
getPublicSubnets	Retrieve all public network subnets associated with an account.
getQuotes	Retrieve an account's associated billing orders or quotes.
getReferralPartner	Retrieve the Referral Partner for this account, if any.
getReferralPartnerCommissionForecast
getReferralPartnerCommissionHistory
getReferralPartnerCommissionPending
getReferredAccounts	Retrieve if this is a account is a referral partner, the accounts this referral partner has referred
getRemoteManagementCommandRequests	Retrieve remote management command requests for an account
getRouters	Retrieve all Routers that an accounts VLANs reside on
getRwhoisData	Retrieve an account's reverse WHOIS data. This data is used when making SWIP requests.
getSalesforceAccountLink	Retrieve Array
getSecondaryDomains	Retrieve the secondary DNS records for a SoftLayer customer account.
getSecurityCertificates	Retrieve stored security certificates (ie. SSL)
getSecurityScanRequests	Retrieve an account's vulnerability scan requests.
getServiceBillingItems	Retrieve the service billing items that will be on an account's next invoice.
getShipments	Retrieve shipments that belong to the customer's account.
getSslVpnUsers	Retrieve an account's associated portal users with SSL VPN access.
getStandardPoolVirtualGuests	Retrieve an account's virtual guest objects that are hosted on a user provisioned hypervisor.
getSubnets	Retrieve all network subnets associated with an account.
getSupportRepresentatives	Retrieve the SoftLayer employees that an account is assigned to.
getTags	Retrieve Array
getTechIncubatorProgramInfo	This method retrieves the Technology Incubator Program information for your account.
getTickets	Retrieve an account's associated tickets.
getTicketsClosedInTheLastThreeDays	Retrieve tickets closed within the last 72 hours or last 10 tickets, whichever is less, associated with an account.
getTicketsClosedToday	Retrieve tickets closed today associated with an account.
getTranscodeAccounts	Retrieve an account's associated Transcode account.
getUpgradeRequests	Retrieve an account's associated upgrade requests.
getUsers	Retrieve an account's portal users.
getValidSecurityCertificateEntries
getValidSecurityCertificates	Retrieve stored security certificates that are not expired (ie. SSL)
getVdrUpdatesInProgressFlag	Retrieve return 0 if vpn updates are currently in progress on this account otherwise 1.
getVirtualDedicatedRacks	Retrieve the virtual dedicated racks for this account.
getVirtualDiskImages	Retrieve an account's associated computing instance virtual disk images.
getVirtualGuests	Retrieve an account's associated virtual guest objects.
getVirtualGuestsOverBandwidthAllocation	Retrieve an account's associated virtual guest objects currently over bandwidth allocation.
getVirtualGuestsProjectedOverBandwidthAllocation	Retrieve an account's associated virtual guest objects currently over bandwidth allocation.
getVirtualGuestsWithCpanel	Retrieve all virtual guests associated with an account that has the cPanel web hosting control panel installed.
getVirtualGuestsWithMcafee	Retrieve all virtual guests associated with an account that have McAfee software components.
getVirtualGuestsWithMcafeeAntivirusRedhat	Retrieve all virtual guests associated with an account that have McAfee AntiVirus for Redhat software components.
getVirtualGuestsWithMcafeeAntivirusWindows	Retrieve all virtual guests associated with an account that has McAfee AntiVirus for Windows software components.
getVirtualGuestsWithMcafeeIntrusionDetectionSystem	Retrieve all virtual guests associated with an account that has McAfee Intrusion Detection System software components.
getVirtualGuestsWithPlesk	Retrieve all virtual guests associated with an account that has the Plesk web hosting control panel installed.
getVirtualGuestsWithQuantastor	Retrieve all virtual guests associated with an account that have the QuantaStor storage system installed.
getVirtualGuestsWithUrchin	Retrieve all virtual guests associated with an account that has the Urchin web traffic analytics package installed.
getVirtualPrivateRack	Retrieve the virtual private rack for this account.
getVirtualStorageArchiveRepositories	Retrieve an account's associated computing instance archived storage repositories.
getVirtualStoragePublicRepositories	Retrieve an account's associated computing instance public storage repositories.
getWindowsUpdateStatus	Retrieve a list of an account's hardware's Windows Update status.
hasAttribute	Determine if an account has a given attribute.
hourlyInstanceLimit	Retrieve the number of hourly services that an account is allowed to have
requestCreditCardChange	Retrieve the record data associated with the submission of a Credit Card Change Request.
requestManualPayment	Retrieve the record data associated with the submission of a Manual Payment Request.
setVlanSpan	Set the flag that enables or disables automatic private network VLAN spanning for a SoftLayer customer account.
updateVpnUsersForResource	Creates or updates a user VPN access privileges for a server on account.
getActivePrivateHostedCloudPackages	Get the Active SoftLayer_Product_Packages from which one can order private hosted cloud configurations.
getDisablePaymentProcessingFlag	Retrieve a flag indicating whether payments are processed for this account.
getGlobalIpRecords	Retrieve Array
getIpAddresses	Retrieve Array
getLastCancelledServerBillingItem	Retrieve the most recent cancelled server billing item.
getOwnedHardwareGenericComponentModels	Retrieve Array
getPrivateIpAddresses	Retrieve Array
getPublicIpAddresses	Retrieve Array
getResourceGroups	Retrieve an account's associated top-level resource groups.
getAlternateCreditCardData
getMessageQueueAccounts	Retrieve an account's associated Message Queue accounts.
getOrders	Retrieve an account's associated billing orders excluding upgrades.
removeAlternateCreditCard
swapCreditCards
getHourlyServiceBillingItems	Retrieve hourly service billing items that will be on an account's next invoice.
getActivePackagesByAttribute	Get the Active SoftLayer_Product_Packages from which one can order configurations.
getPendingCreditCardChangeRequestData	Retrieve details of all credit card change requests which have not been processed by a SoftLayer agent.
getPendingEvents	Retrieve Array
getOpenCancellationRequests	Retrieve an open ticket requesting cancellation of this server, if one exists.
getNextInvoiceIncubatorExemptTotal	Retrieve the total amount of exempt from incubator credit for the account's next invoice.
getPreviousRecurringRevenue	Retrieve the total amount of this invoice.
getActiveAlarms	Get all active alarms on this account.
requestManualPaymentUsingCreditCardOnFile	Retrieve the record data associated with the submission of a Manual
validateManualPaymentAmount	Ensure the amount requested for a manual payment is valid.
getFacilityLogs	Retrieve logs of who entered a colocation area which is assigned to this account, or when a user under this account enters a datacenter.
getAffiliateId	Retrieve Array
getHasIderaBareMetalRestorePluginFlag	Retrieve return 1 if one of the account's hardware has an installation of Idera Server Backup otherwise 0.
getPostProvisioningHooks	Retrieve customer specified URIs that are downloaded onto a newly provisioned or reloaded server. If the URI is sent over https it will be executed directly on the server.
activatePartner
getActiveNotificationSubscribers	Retrieve Array
getNotificationSubscribers	Retrieve Array
getSubnetRegistrationDetails	Retrieve Array
getSubnetRegistrations	Retrieve Array
getActiveColocationContainers	Retrieve the account's active top level colocation containers.

Primary links

AccountSoftLayer_Account

Overview

Methods

Account
SoftLayer_Account