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

This service enables a partner account that has been created but is currently inactive. This restricted service is only available for certain accounts. Please contact support for questions.
This method returns true if Bandwidth Pooling updates are blocked so billing can run for this account.
Cancel the PayPal Payment Request process.
Complete the PayPal Payment Request process and receive confirmation message.
Retrieve the number of hourly services on an account that are active, plus any pending orders with hourly services attached.
Create a new user record, optionally skipping the IBMid email ("silently").
Turn off the EU localized processing flag.
Turn on the EU localized processing flag.
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.
Retrieve email addresses that are responsible for abuse and legal inquiries on behalf of an account. For instance, new legal and abuse tickets are sent to these addresses.
Retrieve the account contacts on an account.
Retrieve the account software licenses owned by an account
Retrieve an account's status presented in a more detailed data type.
Get the specific trait by its key
Retrieve the billing item associated with an account's monthly discount.
Retrieve the active account software licenses owned by an account
Retrieve the active address(es) that belong to an account.
Retrieve all billing agreements for an account
Retrieve the account's active top level colocation containers.
Retrieve account's currently active Flexible Credit enrollment.
Get the active Outlet SoftLayer_Product_Packages from which one can order a server.
Retrieve the active [[SoftLayer_Product_Package]] objects from which you can order a server, service or software.
[<strong>DEPRECATED</strong>] Retrieve the active [[SoftLayer_Product_Package]] objects from which you can order a server, service or software filtered by an attribute type ([[SoftLayer_Product_Package_Attribute_Type]]) on the package.
Get the Active SoftLayer_Product_Packages from which one can order private hosted cloud configurations.
Retrieve an account's non-expired quotes.
Retrieve the virtual software licenses controlled by an account
Retrieve all the address(es) that belong to an account.
Retrieve an affiliate identifier associated with the customer account.
Returns URL uptime data for your account
Retrieve the billing items that will be on an account's next invoice.
Retrieve the billing items that will be on an account's next invoice.
Retrieve indicates whether this account is allowed to silently migrate to use IBMid Authentication.
Retrieve flag indicating if this account can be linked with Bluemix.
Retrieve the billing items that will be on an account's next invoice.
Retrieve the billing items that will be on an account's next invoice. Does not consider associated items.
Retrieve the billing items that will be on an account's next invoice.
Retrieve all billing items of an account.
Retrieve the billing items that will be on an account's next invoice. Does not consider associated items.
Retrieve an account attribute by type key name.
Retrieve the account attribute values for a SoftLayer customer account.
Retrieve the public network VLANs assigned to an account.
Returns the average disk usage for all archive repositories for the timeframe based on the parameters provided.
Returns the average disk usage for all public repositories for the timeframe based on the parameters provided.
Retrieve an account's associated bare metal server objects.
Retrieve all billing agreements for an account
Retrieve an account's billing information.
Retrieve this field is deprecated and should not be used.
Retrieve the Bluemix account link associated with this SoftLayer account, if one exists.
Retrieve returns true if this account is linked to IBM Bluemix, false if not.
Retrieve the brand keyName.
Retrieve the Business Partner details for the account. Country Enterprise Code, Channel ID, and Segment ID.
Retrieve indicating whether this account can order additional Vlans.
Retrieve an account's active carts.
Retrieve an account's associated CDN accounts.
Retrieve all closed tickets associated with an account.
This method retrieves a pie chart for today's backup statistics.
Retrieve the current API user's record.
Retrieve datacenters which contain subnets that the account has access to route.
Retrieve an account's associated virtual dedicated host objects.
Retrieve a flag indicating whether payments are processed for this account.
Retrieve the metric data for disk space usage for a storage repository from the Metric Tracking Object System and the Legacy Data Warehouse.
Retrieve the metric data for disk space usage for a storage repository from the Legacy Data Warehouse.
Retrieve the metric data for disk space usage for a storage repository from the Metric Tracking Object System.
Retrieve an image of the disk usage data on a [[SoftLayer_Virtual_Guest|Cloud Computing Instance]] image for the time range you provide.
Retrieve the SoftLayer employees that an account is assigned to.
Retrieve the DNS domains associated with an account.
Retrieve the DNS domains associated with an account that were not created as a result of a secondary DNS zone transfer.
Retrieve the total capacity of Legacy EVault Volumes on an account, in GB.
Retrieve an account's master EVault user. This is only used when an account has EVault service.
Retrieve an account's associated EVault storage volumes.
This method provides an executive summary PDF for managed hosting services.
Retrieve stored security certificates that are expired (ie. SSL)
Retrieve logs of who entered a colocation area which is assigned to this account, or when a user under this account enters a datacenter.
Retrieve all of the account's current and former Flexible Credit enrollments.
This method retrieves the Flexible Credit Program information for your account.
Retrieve an account's associated hardware objects.
Retrieve an account's associated hardware objects currently over bandwidth allocation.
Get a collection of managed hardware pools.
Retrieve an account's associated hardware objects projected to go over bandwidth allocation.
Retrieve all hardware associated with an account that has the cPanel web hosting control panel installed.
Retrieve all hardware associated with an account that has the Helm web hosting control panel installed.
Retrieve all hardware associated with an account that has McAfee Secure software components.
Retrieve all hardware associated with an account that has McAfee Secure AntiVirus for Redhat software components.
Retrieve all hardware associated with an account that has McAfee Secure AntiVirus for Windows software components.
Retrieve all hardware associated with an account that has McAfee Secure Intrusion Detection System software components.
Retrieve all hardware associated with an account that has the Plesk web hosting control panel installed.
Retrieve all hardware associated with an account that has the QuantaStor storage system installed.
Retrieve all hardware associated with an account that has the Urchin web traffic analytics package installed.
Retrieve all hardware associated with an account that is running a version of the Microsoft Windows operating system.
Retrieve return 1 if one of the account's hardware has the EVault Bare Metal Server Restore Plugin otherwise 0.
Retrieve return 1 if one of the account's hardware has an installation of Idera Server Backup otherwise 0.
Retrieve the number of orders in a PENDING status for a SoftLayer customer account.
Retrieve return 1 if one of the account's hardware has an installation of R1Soft CDP otherwise 0.
This method returns a line graph of bandwidth statistics.
This method returns a pie chart of ticket statistics for the given dates.
This method returns a SoftLayer_Container_Account_Graph_Outputs object for the specified date range.
Retrieve an account's associated hourly bare metal server objects.
Retrieve hourly service billing items that will be on an account's next invoice.
Retrieve an account's associated hourly virtual guest objects.
Retrieve an account's associated Virtual Storage volumes.
Retrieve unique identifier for a customer used throughout IBM.
Retrieve indicates whether this account requires IBMid authentication.
Retrieve timestamp representing the point in time when an account is required to use IBMid authentication.
Retrieve an in progress request to switch billing systems.
Retrieve an account's associated billing invoices.
Retrieve an account's associated iSCSI storage volumes.
Retrieve the most recently canceled billing item.
Retrieve the most recent cancelled server billing item.
Retrieve the five most recently closed abuse tickets associated with an account.
Retrieve the five most recently closed accounting tickets associated with an account.
Retrieve the five most recently closed tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account.
Retrieve the five most recently closed sales tickets associated with an account.
Retrieve the five most recently closed support tickets associated with an account.
Retrieve the five most recently closed tickets associated with an account.
Retrieve an account's most recent billing date.
Retrieve an account's latest recurring invoice.
Retrieve an account's latest recurring pending invoice.
Retrieve the total capacity of Legacy iSCSI Volumes on an account, in GB.
Retrieve the total capacity of Legacy lockbox Volumes on an account, in GB.
Retrieve an account's associated Lockbox storage volumes.
Retrieve an account's master user.
Retrieve an account's associated Message Queue accounts.
Retrieve an account's associated monthly bare metal server objects.
Retrieve an account's associated monthly virtual guest objects.
Retrieve an account's associated NAS storage volumes.
Retrieve whether or not this account can define their own networks.
Retrieve all network gateway devices on this account.
Retrieve an account's associated network hardware.
Retrieve hardware which is currently experiencing a service failure.
Retrieve virtual guest which is currently experiencing a service failure.
Retrieve hardware which is currently recovering from a service failure.
Retrieve virtual guest which is currently recovering from a service failure.
Retrieve hardware which is currently online.
Retrieve virtual guest which is currently online.
Retrieve an account's associated storage volumes. This includes Lockbox, NAS, EVault, and iSCSI volumes.
Retrieve an account's Network Storage groups.
Retrieve iPSec network tunnels for an account.
Retrieve all network VLANs assigned to an account.
Retrieve whether or not an account has automatic private VLAN spanning enabled.
Retrieve the next billing period's invoice. Note, this should be considered preliminary as you may add, remove, change billing items on your account.
Retrieve the pre-tax total amount exempt from incubator credit for the account's next invoice. This field is now deprecated and will soon be removed. Please update all references to instead use nextInvoiceTotalAmount
Retrieve the next billing period's invoice. Note, this should be considered preliminary as you may add, remove, change billing items on your account.
Retrieve the next billing period's detailed invoice. Note, this should be considered preliminary as you may add, remove, change billing items on your account.
Retrieve the billing items that will be on an account's next invoice.
Retrieve the pre-tax 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.
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.
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.
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.
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.
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.
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.
Retrieve a SoftLayer_Account record.
Retrieve the open abuse tickets associated with an account.
Retrieve the open accounting tickets associated with an account.
Retrieve the open billing tickets associated with an account.
Retrieve the open tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account.
Retrieve an account's recurring invoices.
Retrieve the open sales tickets associated with an account.
Retrieve an account's associated Openstack related Object Storage accounts.
Retrieve the open support tickets associated with an account.
Retrieve all open tickets associated with an account.
Retrieve all open tickets associated with an account last edited by an employee.
Retrieve an account's associated billing orders excluding upgrades.
Retrieve the billing items that have no parent billing item. These are items that don't necessarily belong to a single server.
Retrieve an account's latest open (pending) invoice.
Retrieve a list of top-level invoice items that are on an account's currently pending invoice.
Retrieve the total amount of an account's pending invoice, if one exists.
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.
Retrieve the sum of all the taxes related to one time charges for an account's pending invoice, if one exists.
Retrieve the total recurring amount of an account's pending invoice, if one exists.
Retrieve the total amount of the recurring taxes on an account's pending invoice, if one exists.
Retrieve an account's permission groups.
Retrieve an account's user roles.
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.
Retrieve an account's associated portal users with PPTP VPN access.
Retrieve the total recurring amount for an accounts previous revenue.
Retrieve all priority one tickets associated with an account.
Retrieve the private network VLANs assigned to an account.
Retrieve all private subnets associated with an account.
Retrieve the public network VLANs assigned to an account.
Retrieve all public network subnets associated with an account.
Retrieve an account's quotes.
Retrieve the Referral Partner for this account, if any.
Retrieve if this is a account is a referral partner, the accounts this referral partner has referred
Retrieve the Replication events for all Network Storage volumes on an account.
Retrieve indicates whether newly created users under this account will be associated with IBMid via an email requiring a response, or not.
Retrieve an account's associated top-level resource groups.
Retrieve all Routers that an accounts VLANs reside on
Retrieve an account's reverse WHOIS data. This data is used when making SWIP requests.
Retrieve the SAML configuration for this account.
Retrieve all scale groups on this account.
Retrieve the secondary DNS records for a SoftLayer customer account.
Retrieve stored security certificates (ie. SSL)
Retrieve the security groups belonging to this account.
Retrieve an account's vulnerability scan requests.
Retrieve the service billing items that will be on an account's next invoice.
Retrieve shipments that belong to the customer's account.
Retrieve customer specified SSH keys that can be implemented onto a newly provisioned or reloaded server.
Retrieve an account's associated portal users with SSL VPN access.
Retrieve an account's virtual guest objects that are hosted on a user provisioned hypervisor.
Retrieve all network subnets associated with an account.
Retrieve the SoftLayer employees that an account is assigned to.
Retrieve the active support subscriptions for this account.
Retrieve a flag indicating to suppress invoices.
This method retrieves the Technology Incubator Program information for your account.
Get the acceptance status of the applicable third-party policies.
Retrieve an account's associated tickets.
Retrieve tickets closed within the last 72 hours or last 10 tickets, whichever is less, associated with an account.
Retrieve tickets closed today associated with an account.
Retrieve an account's associated Transcode account.
Retrieve an account's associated upgrade requests.
Retrieve an account's portal users.
Retrieve stored security certificates that are not expired (ie. SSL)
Retrieve return 0 if vpn updates are currently in progress on this account otherwise 1.
Retrieve an account's associated virtual server virtual disk images.
Retrieve an account's associated virtual guest objects.
Retrieve an account's associated virtual guest objects currently over bandwidth allocation.
Retrieve an account's associated virtual guest objects currently over bandwidth allocation.
Retrieve all virtual guests associated with an account that has the cPanel web hosting control panel installed.
Retrieve all virtual guests associated with an account that have McAfee Secure software components.
Retrieve all virtual guests associated with an account that have McAfee Secure AntiVirus for Redhat software components.
Retrieve all virtual guests associated with an account that has McAfee Secure AntiVirus for Windows software components.
Retrieve all virtual guests associated with an account that has McAfee Secure Intrusion Detection System software components.
Retrieve all virtual guests associated with an account that has the Plesk web hosting control panel installed.
Retrieve all virtual guests associated with an account that have the QuantaStor storage system installed.
Retrieve all virtual guests associated with an account that has the Urchin web traffic analytics package installed.
Retrieve the bandwidth pooling for this account.
Retrieve an account's associated virtual server archived storage repositories.
Retrieve an account's associated virtual server public storage repositories.
Get a collection of active VMware software account license keys.
Determine if an account has a given attribute.
Retrieve the number of hourly services that an account is allowed to have
Retrieve the number of hourly bare metal servers that an account is allowed to have
This method will link this SoftLayer account with the provided external account.
Retrieve the record data associated with the submission of a Credit Card Change Request.
Retrieve the record data associated with the submission of a Manual Payment Request.
Retrieve the record data associated with the submission of a Manual Payment Request which charges the manual payment to a credit card already on file.
Set this account's abuse emails.
Set the number of desired servers in the pool
Set the flag that enables or disables automatic private network VLAN spanning for a SoftLayer customer account.
Creates or updates a user VPN access privileges for a server on account.
Validate a SoftLayer customer account.
Ensure the amount requested for a manual payment is valid.