"SoftLayer_" prefix removed for readability.
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.
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 Supported account flag.
Disable the VPN Config Requires VPN Manage attribute, creating it if necessary.
Edit an account’s information.
Turn on the EU Supported account flag.
Enable the VPN Config Requires VPN Manage attribute, creating it if necessary.
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.
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.
This method provides a history of account backups.
The account contacts on an account.
The account software licenses owned by an account
An account’s status presented in a more detailed data type.
Get the specific trait by its key
The billing item associated with an account’s monthly discount.
The active account software licenses owned by an account
The active address(es) that belong to an account.
All active agreements for an account
All billing agreements for an account
The account’s active top level colocation containers.
[Deprecated] Please use SoftLayer_Account::activeFlexibleCreditEnrollments.
DEPRECATED. This method will return nothing.
Retrieve the active SoftLayer_Product_Package objects from which you can order a server, service or software.
[DEPRECATED] 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.
[DEPRECATED] This method pulls all the active private hosted cloud packages. This will give you a basic description of the packages that are currently active and from which you can order private hosted cloud configurations.
An account’s non-expired quotes.
Active reserved capacity agreements for an account
The virtual software licenses controlled by an account
An account’s associated load balancers.
All the address(es) that belong to an account.
An affiliate identifier associated with the customer account.
The billing items that will be on an account’s next invoice.
The billing items that will be on an account’s next invoice.
The billing items that will be on an account’s next invoice.
The billing items that will be on an account’s next invoice. Does not consider associated items.
The billing items that will be on an account’s next invoice.
All billing items of an account.
The billing items that will be on an account’s next invoice. Does not consider associated items.
Indicates whether this account is allowed to silently migrate to use IBMid Authentication.
Flag indicating if this account can be linked with Bluemix.
An account’s associated application delivery controller records.
Retrieve an account attribute by type key name.
The account attribute values for a SoftLayer customer account.
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.
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 …
The bandwidth allotments for an account.
The bandwidth allotments for an account currently over allocation.
The bandwidth allotments for an account projected to go over allocation.
An account’s associated bare metal server objects.
All billing agreements for an account
An account’s billing information.
Private template group objects (parent and children) and the shared template group objects (parent only) for an account.
Flag indicating whether this account is restricted from performing a self-service brand migration by updating their credit card details.
The Platform account link associated with this SoftLayer account, if one exists.
Returns true if this account is linked to IBM Bluemix, false if not.
The brand keyName.
The Business Partner details for the account. Country Enterprise Code, Channel, Segment, Reseller Level.
[DEPRECATED] All accounts may order VLANs.
An account’s active carts.
All closed tickets associated with an account.
Retrieve the current API user’s record.
Datacenters which contain subnets that the account has access to route.
An account’s associated virtual dedicated host objects.
Get a collection of dedicated hosts that are valid for a given image template.
A flag indicating whether payments are processed for this account.
The SoftLayer employees that an account is assigned to.
The DNS domains associated with an account.
The DNS domains associated with an account that were not created as a result of a secondary DNS zone transfer.
Boolean flag dictating whether or not this account has the EU Supported flag. This flag indicates that this account uses IBM Cloud services to process EU citizen’s personal data.
The total capacity of Legacy EVault Volumes on an account, in GB.
An account’s master EVault user. This is only used when an account has EVault service.
An account’s associated EVault storage volumes.
Stored security certificates that are expired (ie. SSL)
Logs of who entered a colocation area which is assigned to this account, or when a user under this account enters a datacenter.
All of the account’s current and former Flexible Credit enrollments.
[DEPRECATED] Please use SoftLayer_Account::getFlexibleCreditProgramsInfo. This is no longer an accurate representation of discounts.
This method retrieves information on all of your Flexible Credit Program enrollments for your account.
Timestamp representing the point in time when an account is required to link with PaaS.
An account’s associated hardware objects.
An account’s associated hardware objects currently over bandwidth allocation.
Get a collection of managed hardware pools.
An account’s associated hardware objects projected to go over bandwidth allocation.
All hardware associated with an account that has the cPanel web hosting control panel installed.
All hardware associated with an account that has the Helm web hosting control panel installed.
All hardware associated with an account that has McAfee Secure software components.
All hardware associated with an account that has McAfee Secure AntiVirus for Redhat software components.
All hardware associated with an account that has McAfee Secure AntiVirus for Windows software components.
All hardware associated with an account that has McAfee Secure Intrusion Detection System software components.
All hardware associated with an account that has the Plesk web hosting control panel installed.
All hardware associated with an account that has the QuantaStor storage system installed.
All hardware associated with an account that has the Urchin web traffic analytics package installed.
All hardware associated with an account that is running a version of the Microsoft Windows operating system.
Return 1 if one of the account’s hardware has the EVault Bare Metal Server Restore Plugin otherwise 0.
Return 1 if one of the account’s hardware has an installation of Idera Server Backup otherwise 0.
The number of orders in a PENDING status for a SoftLayer customer account.
Return 1 if one of the account’s hardware has an installation of R1Soft CDP otherwise 0.
An account’s associated hourly bare metal server objects.
Hourly service billing items that will be on an account’s next invoice.
An account’s associated hourly virtual guest objects.
An account’s associated Virtual Storage volumes.
Unique identifier for a customer used throughout IBM.
Indicates whether this account requires IBMid authentication.
This key is deprecated and should not be used.
An in progress request to switch billing systems.
Account attribute flag indicating internal cci host account.
Account attribute flag indicating account creates internal image templates.
Account attribute flag indicating restricted account.
An account’s associated billing invoices.
An account’s associated iSCSI storage volumes.
Computes the number of available public secondary IP addresses, augmented by the provided number of hosts, before overflow of the allowed host to IP address ratio occurs. The result is aligned to the nearest subnet size that could be accommodated in full.
0 is returned if an overflow is detected.
The use of $locationId has been deprecated.
The most recently canceled billing item.
The most recent cancelled server billing item.
The five most recently closed abuse tickets associated with an account.
The five most recently closed accounting tickets associated with an account.
The five most recently closed tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account.
The five most recently closed sales tickets associated with an account.
The five most recently closed support tickets associated with an account.
The five most recently closed tickets associated with an account.
An account’s most recent billing date.
An account’s latest recurring invoice.
An account’s latest recurring pending invoice.
[DEPRECATED] The legacy bandwidth allotments for an account.
The total capacity of Legacy iSCSI Volumes on an account, in GB.
An account’s associated load balancers.
The total capacity of Legacy lockbox Volumes on an account, in GB.
An account’s associated Lockbox storage volumes.
An account’s master user.
An account’s media transfer service requests.
[DEPRECATED] - An accounts metric tracking object. This object records all periodic polled data available to this account.
Flag indicating whether this account is restricted to the IBM Cloud portal.
An account’s associated monthly bare metal server objects.
An account’s associated monthly virtual guest objects.
An account’s associated NAS storage volumes.
Get a collection of active NetApp software account license keys.
[Deprecated] Whether or not this account can define their own networks.
All network gateway devices on this account.
An account’s associated network hardware.
Hardware which is currently experiencing a service failure.
Virtual guest which is currently experiencing a service failure.
Hardware which is currently recovering from a service failure.
Virtual guest which is currently recovering from a service failure.
Hardware which is currently online.
Virtual guest which is currently online.
An account’s associated storage volumes. This includes Lockbox, NAS, EVault, and iSCSI volumes.
An account’s Network Storage groups.
IPSec network tunnels for an account.
Whether or not an account has automatic private VLAN spanning enabled.
All network VLANs assigned to an account.
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 …
Retrieve the next billing period’s invoice. Note, this should be considered preliminary as you may add, remove, change billing items on your account.
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.
The total recurring charge amount of an account’s next invoice eligible for account discount measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.
The billing items that will be on an account’s next invoice.
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.
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.
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.
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.
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.
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.
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.
The open abuse tickets associated with an account.
The open accounting tickets associated with an account.
The open billing tickets associated with an account.
An open ticket requesting cancellation of this server, if one exists.
The open tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account.
An account’s recurring invoices.
The open sales tickets associated with an account.
An account’s associated Openstack related Object Storage accounts.
The open support tickets associated with an account.
All open tickets associated with an account.
All open tickets associated with an account last edited by an employee.
An account’s associated billing orders excluding upgrades.
The billing items that have no parent billing item. These are items that don’t necessarily belong to a single server.
Retrieve details of all credit card change requests which have not been processed by a SoftLayer agent.
An account’s latest open (pending) invoice.
A list of top-level invoice items that are on an account’s currently pending invoice.
The total amount of an account’s pending invoice, if one exists.
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.
The sum of all the taxes related to one time charges for an account’s pending invoice, if one exists.
The total recurring amount of an account’s pending invoice, if one exists.
The total amount of the recurring taxes on an account’s pending invoice, if one exists.
An account’s permission groups.
An account’s user roles.
An account’s associated virtual placement groups.
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.
(Deprecated) Boolean flag dictating whether or not this account supports PPTP VPN Access.
An account’s associated portal users with PPTP VPN access. (Deprecated)
The total recurring amount for an accounts previous revenue.
The item price that an account is restricted to.
All priority one tickets associated with an account.
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.
Private and shared template group objects (parent only) for an account.
The private network VLANs assigned to an account.
All private subnets associated with an account.
Boolean flag indicating whether or not this account is a Proof of Concept account.
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.
The public network VLANs assigned to an account.
All public network subnets associated with an account.
An account’s quotes.
The Referral Partner for this account, if any.
Flag indicating if the account was referred.
If this is a account is a referral partner, the accounts this referral partner has referred
Remote management command requests for an account
The Replication events for all Network Storage volumes on an account.
Indicates whether newly created users under this account will be associated with IBMid via an email requiring a response, or not.
All reserved capacity agreements for an account
The reserved capacity groups owned by this account.
All Routers that an accounts VLANs reside on
DEPRECATED
The SAML configuration for this account.
The secondary DNS records for a SoftLayer customer account.
Stored security certificates (ie. SSL)
The security groups belonging to this account.
An account’s vulnerability scan requests.
The service billing items that will be on an account’s next invoice.
Get the collection of template group objects that have been shared with this account.
Shipments that belong to the customer’s account.
Customer specified SSH keys that can be implemented onto a newly provisioned or reloaded server.
An account’s associated portal users with SSL VPN access.
An account’s virtual guest objects that are hosted on a user provisioned hypervisor.
All network subnets associated with an account.
The SoftLayer employees that an account is assigned to.
The active support subscriptions for this account.
A flag indicating to suppress invoices.
This method retrieves the Technology Incubator Program information for your account.
Account attribute flag indicating test account.
Get the acceptance status of the applicable third-party policies.
An account’s associated tickets.
Tickets closed within the last 72 hours or last 10 tickets, whichever is less, associated with an account.
Tickets closed today associated with an account.
An account’s associated upgrade requests.
An account’s portal users.
Retrieve a list of valid (non-expired) security certificates without the sensitive certificate information. This allows non-privileged users to view and select security certificates when configuring associated services.
Stored security certificates that are not expired (ie. SSL)
DEPRECATED - Return 0 if VDR updates are currently in progress on this account otherwise 1.
The bandwidth pooling for this account.
An account’s associated virtual server virtual disk images.
An account’s associated virtual guest objects.
An account’s associated virtual guest objects currently over bandwidth allocation.
An account’s associated virtual guest objects currently over bandwidth allocation.
All virtual guests associated with an account that has the cPanel web hosting control panel installed.
All virtual guests associated with an account that have McAfee Secure software components.
All virtual guests associated with an account that have McAfee Secure AntiVirus for Redhat software components.
All virtual guests associated with an account that has McAfee Secure AntiVirus for Windows software components.
All virtual guests associated with an account that has McAfee Secure Intrusion Detection System software components.
All virtual guests associated with an account that has the Plesk web hosting control panel installed.
All virtual guests associated with an account that have the QuantaStor storage system installed.
All virtual guests associated with an account that has the Urchin web traffic analytics package installed.
The bandwidth pooling for this account.
An account’s associated virtual server archived storage repositories.
An account’s associated virtual server public storage repositories.
Get a collection of active VMware software account license keys.
An account’s associated VPC configured virtual guest objects.
Retrieve a list of an account’s hardware’s Windows Update status.
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
Initiate Payer Authentication
Determines if the account is considered an active VMware customer and as such eligible to order VMware restricted products. This result is cached for up to 60 seconds.
Returns true if this account is eligible for the local currency program, false otherwise.
Returns true if this account is eligible to link with PaaS. False otherwise.
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.
This method manually starts a synchronize operation for the current IBMid-authenticated user population of a linked account pair. “Manually” means “independent of an account link operation”.
[DEPRECATED] Creates or updates a user VPN access privileges for a server on account.
Validates SoftLayer account information. Will return an error if any field is not valid.
Ensure the amount requested for a manual payment is valid.