-
activatePartner
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.
-
addAchInformation
-
addReferralPartnerPaymentOption
-
areVdrUpdatesBlockedForBilling
This method indicates whether or not Bandwidth Pooling updates are blocked for the account so the billing cycle can run. Generally, accounts are restricted from moving servers in or out of Bandwidth Pools from 12:00 CST on the day prior to billing, until the billing batch completes, sometime after midnight the day of actual billing for the account.
-
cancelPayPalTransaction
Cancel the PayPal Payment Request process. During the process of submitting a PayPal payment request, the customer is redirected to PayPal to confirm the request. If the customer elects to cancel the payment from PayPal, they are returned to SoftLayer where the manual payment record is updated to a status of canceled.
-
completePayPalTransaction
Complete the PayPal Payment Request process and receive confirmation message. During the process of submitting a PayPal payment request, the customer is redirected to PayPal to confirm the request. Once confirmed, PayPal returns the customer to SoftLayer where an attempt is made to finalize the transaction. A status message regarding the attempt is returned to the calling function.
-
countHourlyInstances
Retrieve the number of hourly services on an account that are active, plus any pending orders with hourly services attached.
-
createUser
Create a new Customer user record in the SoftLayer customer portal. This is a wrapper around the Customer::createObject call, please see the documentation of that API. This wrapper adds the feature of the 'silentlyCreate' option, which bypasses the IBMid invitation email process. False (the default) goes through the IBMid invitation email process, which creates the IBMid/SoftLayer Single-Sign-On (SSO) user link when the invitation is accepted (meaning the email has been received, opened, and the link(s) inside the email have been clicked to complete the process). True will silently (no email) create the IBMid/SoftLayer user SSO link immediately. Either case will use the value in the template object 'email' field to indicate the IBMid to use. This can be the username or, if unique, the email address of an IBMid. In the silent case, the IBMid must already exist. In the non-silent invitation email case, the IBMid can be created during this flow, by specifying an email address to be used to create the IBMid.All the features and restrictions of createObject apply to this API as well. In addition, note that the 'silentlyCreate' flag is ONLY valid for IBMid-authenticated accounts.
-
disableEuSupport
<p style='color:red'><strong>Warning</strong>: If you remove the EU Supported account flag, you are removing the restriction that limits Processing activities to EU personnel.</p>
-
disableVpnConfigRequiresVpnManageAttribute
Disables the VPN_CONFIG_REQUIRES_VPN_MANAGE attribute on the account. If the attribute does not exist for the account, it will be created and set to false.
-
editAccount
This method will edit the account's information. Pass in a SoftLayer_Account template with the fields to be modified. Certain changes to the account will automatically create a ticket for manual review. This will be returned with the SoftLayer_Container_Account_Update_Response.<br> <br> The following fields are editable:<br> <br> <ul> <li>companyName</li> <li>firstName</li> <li>lastName</li> <li>address1</li> <li>address2</li> <li>city</li> <li>state</li> <li>country</li> <li>postalCode</li> <li>email</li> <li>officePhone</li> <li>alternatePhone</li> <li>faxPhone</li> <li>abuseEmails.email</li> <li>billingInfo.vatId</li> </ul>
-
enableEuSupport
<p> If you select the EU Supported option, the most common Support issues will be limited to IBM Cloud staff located in the EU. In the event your issue requires non-EU expert assistance, it will be reviewed and approval given prior to any non-EU intervention. Additionally, in order to support and update the services, cross-border Processing of your data may still occur. Please ensure you take the necessary actions to allow this Processing, as detailed in the <strong><a href='http://www-03.ibm.com/software/sla/sladb.nsf/sla/bm-6605-12'>Cloud Service Terms</a></strong>. A standard Data Processing Addendum is available <strong><a href='https://www-05.ibm.com/support/operations/zz/en/dpa.html'>here</a></strong>. </p>
<p> <strong>Important note (you will only see this once):</strong> Orders using the API will proceed without additional notifications. The terms related to selecting products, services, or locations outside the EU apply to API orders. Users you create and API keys you generate will have the ability to order products, services, and locations outside of the EU. It is your responsibility to educate anyone you grant access to your account on the consequences and requirements if they make a selection that is not in the EU Supported option. In order to meet EU Supported requirements, the current PPTP VPN solution will no longer be offered or supported. </p>
<p> If PPTP has been selected as an option for any users in your account by itself (or in combination with another VPN offering), you will need to disable PPTP before selecting the EU Supported account feature. For more information on VPN changes, click <strong><a href='http://knowledgelayer.softlayer.com/procedure/activate-or-deactivate-pptp-vpn-access-user'> here</a></strong>. </p>
-
enableVpnConfigRequiresVpnManageAttribute
Enables the VPN_CONFIG_REQUIRES_VPN_MANAGE attribute on the account. If the attribute does not exist for the account, it will be created and set to true.
-
getAbuseEmail
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
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.
-
getAccountBackupHistory
This method returns an array of SoftLayer_Container_Network_Storage_Evault_WebCc_JobDetails objects for the given start and end dates. Start and end dates should be be valid ISO 8601 dates. The backupStatus can be one of null, 'success', 'failed', or 'conflict'. The 'success' backupStatus returns jobs with a status of 'COMPLETED', the 'failed' backupStatus returns jobs with a status of 'FAILED', while the 'conflict' backupStatus will return jobs that are not 'COMPLETED' or 'FAILED'.
-
getAccountContacts
The account contacts on an account.
-
getAccountLicenses
The account software licenses owned by an account
-
getAccountLinks
-
getAccountStatus
An account's status presented in a more detailed data type.
-
getAccountTraitValue
This method pulls an account trait by its key.
-
getActiveAccountDiscountBillingItem
The billing item associated with an account's monthly discount.
-
getActiveAccountLicenses
The active account software licenses owned by an account
-
getActiveAddresses
The active address(es) that belong to an account.
-
getActiveAgreements
All active agreements for an account
-
getActiveBillingAgreements
All billing agreements for an account
-
getActiveCatalystEnrollment
-
getActiveColocationContainers
The account's active top level colocation containers.
-
getActiveFlexibleCreditEnrollment
[Deprecated] Please use SoftLayer_Account::activeFlexibleCreditEnrollments.
-
getActiveFlexibleCreditEnrollments
-
getActiveNotificationSubscribers
-
getActiveOutletPackages
This is deprecated and will not return any results.
-
getActivePackages
This method will return the [SoftLayer_Product_Package](/reference/datatypes/SoftLayer_Product_Package) objects from which you can order a bare metal server, virtual server, service (such as CDN or Object Storage) or other software. Once you have the package you want to order from, you may query one of various endpoints from that package to get specific information about its products and pricing. See [SoftLayer_Product_Package::getCategories](/reference/services/SoftLayer_Product_Package/getCategories) or [SoftLayer_Product_Package::getItems](/reference/services/SoftLayer_Product_Package/getItems) for more information.
Packages that have been retired will not appear in this result set.
-
getActivePackagesByAttribute
<strong>This method is deprecated and should not be used in production code.</strong>
This method will return the [SoftLayer_Product_Package](/reference/datatypes/SoftLayer_Product_Package) objects from which you can order a bare metal server, virtual server, service (such as CDN or Object Storage) or other software filtered by an attribute type associated with the package. Once you have the package you want to order from, you may query one of various endpoints from that package to get specific information about its products and pricing. See [SoftLayer_Product_Package::getCategories](/reference/services/SoftLayer_Product_Package/getCategories) or [SoftLayer_Product_Package::getItems](/reference/services/SoftLayer_Product_Package/getItems) for more information.
-
getActivePrivateHostedCloudPackages
[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.
-
getActiveQuotes
An account's non-expired quotes.
-
getActiveReservedCapacityAgreements
Active reserved capacity agreements for an account
-
getActiveVirtualLicenses
The virtual software licenses controlled by an account
-
getAdcLoadBalancers
An account's associated load balancers.
-
getAddresses
All the address(es) that belong to an account.
-
getAffiliateId
An affiliate identifier associated with the customer account.
-
getAllBillingItems
The billing items that will be on an account's next invoice.
-
getAllCommissionBillingItems
The billing items that will be on an account's next invoice.
-
getAllowIbmIdSilentMigrationFlag
Indicates whether this account is allowed to silently migrate to use IBMid Authentication.
-
getAllowsBluemixAccountLinkingFlag
Flag indicating if this account can be linked with Bluemix.
-
getAllRecurringTopLevelBillingItems
The billing items that will be on an account's next invoice.
-
getAllRecurringTopLevelBillingItemsUnfiltered
The billing items that will be on an account's next invoice. Does not consider associated items.
-
getAllSubnetBillingItems
The billing items that will be on an account's next invoice.
-
getAllTopLevelBillingItems
All billing items of an account.
-
getAllTopLevelBillingItemsUnfiltered
The billing items that will be on an account's next invoice. Does not consider associated items.
-
getAlternateCreditCardData
-
getApplicationDeliveryControllers
An account's associated application delivery controller records.
-
getAttributeByType
Retrieve a single [SoftLayer_Account_Attribute](/reference/datatypes/SoftLayer_Account_Attribute) record by its [SoftLayer_Account_Attribute_Type](/reference/datatypes/SoftLayer_Account_Attribute_Type) key name.
-
getAttributes
The account attribute values for a SoftLayer customer account.
-
getAuxiliaryNotifications
-
getAvailablePublicNetworkVlans
The public network VLANs assigned to an account.
-
getAverageArchiveUsageMetricDataByDate
Returns the average disk space usage for all archive repositories.
-
getAveragePublicUsageMetricDataByDate
Returns the average disk space usage for all public repositories.
-
getBalance
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
The bandwidth allotments for an account.
-
getBandwidthAllotmentsOverAllocation
The bandwidth allotments for an account currently over allocation.
-
getBandwidthAllotmentsProjectedOverAllocation
The bandwidth allotments for an account projected to go over allocation.
-
getBandwidthList
-
getBareMetalInstances
An account's associated bare metal server objects.
-
getBillingAgreements
All billing agreements for an account
-
getBillingInfo
An account's billing information.
-
getBlockDeviceTemplateGroups
Private template group objects (parent and children) and the shared template group objects (parent only) for an account.
-
getBlockSelfServiceBrandMigration
Flag indicating whether this account is restricted from performing a self-service brand migration by updating their credit card details.
-
getBluemixAccountId
-
getBluemixAccountLink
The Platform account link associated with this SoftLayer account, if one exists.
-
getBluemixLinkedFlag
Returns true if this account is linked to IBM Bluemix, false if not.
-
getBrand
-
getBrandAccountFlag
-
getBrandKeyName
The brand keyName.
-
getBusinessPartner
The Business Partner details for the account. Country Enterprise Code, Channel, Segment, Reseller Level.
-
getCanOrderAdditionalVlansFlag
[DEPRECATED] All accounts may order VLANs.
-
getCarts
An account's active carts.
-
getCatalystEnrollments
-
getClosedTickets
All closed tickets associated with an account.
-
getCurrentUser
Retrieve the user record of the user calling the SoftLayer API.
-
getDatacentersWithSubnetAllocations
Datacenters which contain subnets that the account has access to route.
-
getDedicatedHosts
An account's associated virtual dedicated host objects.
-
getDedicatedHostsForImageTemplate
This returns a collection of dedicated hosts that are valid for a given image template.
-
getDisablePaymentProcessingFlag
A flag indicating whether payments are processed for this account.
-
getDisplaySupportRepresentativeAssignments
The SoftLayer employees that an account is assigned to.
-
getDomains
The DNS domains associated with an account.
-
getDomainsWithoutSecondaryDnsRecords
The DNS domains associated with an account that were not created as a result of a secondary DNS zone transfer.
-
getEuSupportedFlag
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.
-
getEvaultCapacityGB
The total capacity of Legacy EVault Volumes on an account, in GB.
-
getEvaultMasterUsers
An account's master EVault user. This is only used when an account has EVault service.
-
getEvaultNetworkStorage
An account's associated EVault storage volumes.
-
getExpiredSecurityCertificates
Stored security certificates that are expired (ie. SSL)
-
getFacilityLogs
Logs of who entered a colocation area which is assigned to this account, or when a user under this account enters a datacenter.
-
getFileBlockBetaAccessFlag
-
getFlexibleCreditEnrollments
All of the account's current and former Flexible Credit enrollments.
-
getFlexibleCreditProgramInfo
[DEPRECATED] Please use SoftLayer_Account::getFlexibleCreditProgramsInfo.
This method will return a [SoftLayer_Container_Account_Discount_Program](/reference/datatypes/SoftLayer_Container_Account_Discount_Program) object containing the Flexible Credit Program information for this account. To be considered an active participant, the account must have an enrollment record with a monthly credit amount set and the current date must be within the range defined by the enrollment and graduation date. The forNextBillCycle parameter can be set to true to return a SoftLayer_Container_Account_Discount_Program object with information with relation to the next bill cycle. The forNextBillCycle parameter defaults to false. Please note that all discount amount entries are reported as pre-tax amounts and the legacy tax fields in the [SoftLayer_Container_Account_Discount_Program](/reference/datatypes/SoftLayer_Container_Account_Discount_Program) are deprecated.
-
getFlexibleCreditProgramsInfo
This method will return a [SoftLayer_Container_Account_Discount_Program_Collection](/reference/datatypes/SoftLayer_Container_Account_Discount_Program_Collection) object containing information on all of the Flexible Credit Programs your account is enrolled in. To be considered an active participant, the account must have at least one enrollment record with a monthly credit amount set and the current date must be within the range defined by the enrollment and graduation date. The forNextBillCycle parameter can be set to true to return a SoftLayer_Container_Account_Discount_Program_Collection object with information with relation to the next bill cycle. The forNextBillCycle parameter defaults to false. Please note that all discount amount entries are reported as pre-tax amounts.
-
getForcePaasAccountLinkDate
Timestamp representing the point in time when an account is required to link with PaaS.
-
getGlobalIpRecords
-
getGlobalIpv4Records
-
getGlobalIpv6Records
-
getHardware
An account's associated hardware objects.
-
getHardwareOverBandwidthAllocation
An account's associated hardware objects currently over bandwidth allocation.
-
getHardwarePools
Return a collection of managed hardware pools.
-
getHardwareProjectedOverBandwidthAllocation
An account's associated hardware objects projected to go over bandwidth allocation.
-
getHardwareWithCpanel
All hardware associated with an account that has the cPanel web hosting control panel installed.
-
getHardwareWithHelm
All hardware associated with an account that has the Helm web hosting control panel installed.
-
getHardwareWithMcafee
All hardware associated with an account that has McAfee Secure software components.
-
getHardwareWithMcafeeAntivirusRedhat
All hardware associated with an account that has McAfee Secure AntiVirus for Redhat software components.
-
getHardwareWithMcafeeAntivirusWindows
All hardware associated with an account that has McAfee Secure AntiVirus for Windows software components.
-
getHardwareWithMcafeeIntrusionDetectionSystem
All hardware associated with an account that has McAfee Secure Intrusion Detection System software components.
-
getHardwareWithPlesk
All hardware associated with an account that has the Plesk web hosting control panel installed.
-
getHardwareWithQuantastor
All hardware associated with an account that has the QuantaStor storage system installed.
-
getHardwareWithUrchin
All hardware associated with an account that has the Urchin web traffic analytics package installed.
-
getHardwareWithWindows
All hardware associated with an account that is running a version of the Microsoft Windows operating system.
-
getHasEvaultBareMetalRestorePluginFlag
Return 1 if one of the account's hardware has the EVault Bare Metal Server Restore Plugin otherwise 0.
-
getHasIderaBareMetalRestorePluginFlag
Return 1 if one of the account's hardware has an installation of Idera Server Backup otherwise 0.
-
getHasPendingOrder
The number of orders in a PENDING status for a SoftLayer customer account.
-
getHasR1softBareMetalRestorePluginFlag
Return 1 if one of the account's hardware has an installation of R1Soft CDP otherwise 0.
-
getHourlyBareMetalInstances
An account's associated hourly bare metal server objects.
-
getHourlyServiceBillingItems
Hourly service billing items that will be on an account's next invoice.
-
getHourlyVirtualGuests
An account's associated hourly virtual guest objects.
-
getHubNetworkStorage
An account's associated Virtual Storage volumes.
-
getIbmCustomerNumber
Unique identifier for a customer used throughout IBM.
-
getIbmIdAuthenticationRequiredFlag
Indicates whether this account requires IBMid authentication.
-
getIbmIdMigrationExpirationTimestamp
This key is deprecated and should not be used.
-
getInProgressExternalAccountSetup
An in progress request to switch billing systems.
-
getInternalCciHostAccountFlag
Account attribute flag indicating internal cci host account.
-
getInternalImageTemplateCreationFlag
Account attribute flag indicating account creates internal image templates.
-
getInternalNotes
-
getInternalRestrictionFlag
Account attribute flag indicating restricted account.
-
getInvoices
An account's associated billing invoices.
-
getIpAddresses
-
getIscsiIsolationDisabled
-
getIscsiNetworkStorage
An account's associated iSCSI storage volumes.
-
getLargestAllowedSubnetCidr
Computes the number of available public secondary IP addresses, aligned to a subnet size.
-
getLastCanceledBillingItem
The most recently canceled billing item.
-
getLastCancelledServerBillingItem
The most recent cancelled server billing item.
-
getLastFiveClosedAbuseTickets
The five most recently closed abuse tickets associated with an account.
-
getLastFiveClosedAccountingTickets
The five most recently closed accounting tickets associated with an account.
-
getLastFiveClosedOtherTickets
The five most recently closed tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account.
-
getLastFiveClosedSalesTickets
The five most recently closed sales tickets associated with an account.
-
getLastFiveClosedSupportTickets
The five most recently closed support tickets associated with an account.
-
getLastFiveClosedTickets
The five most recently closed tickets associated with an account.
-
getLatestBillDate
An account's most recent billing date.
-
getLatestRecurringInvoice
An account's latest recurring invoice.
-
getLatestRecurringPendingInvoice
An account's latest recurring pending invoice.
-
getLegacyBandwidthAllotments
[DEPRECATED] The legacy bandwidth allotments for an account.
-
getLegacyIscsiCapacityGB
The total capacity of Legacy iSCSI Volumes on an account, in GB.
-
getLoadBalancers
An account's associated load balancers.
-
getLockboxCapacityGB
The total capacity of Legacy lockbox Volumes on an account, in GB.
-
getLockboxNetworkStorage
An account's associated Lockbox storage volumes.
-
getManualPaymentsUnderReview
-
getMasterUser
An account's master user.
-
getMediaDataTransferRequests
An account's media transfer service requests.
-
getMetricTrackingObject
[DEPRECATED] - An accounts metric tracking object. This object records all periodic polled data available to this account.
-
getMigratedToIbmCloudPortalFlag
Flag indicating whether this account is restricted to the IBM Cloud portal.
-
getMonthlyBareMetalInstances
An account's associated monthly bare metal server objects.
-
getMonthlyVirtualGuests
An account's associated monthly virtual guest objects.
-
getNasNetworkStorage
An account's associated NAS storage volumes.
-
getNetAppActiveAccountLicenseKeys
This returns a collection of active NetApp software account license keys.
-
getNetworkCreationFlag
[Deprecated] Whether or not this account can define their own networks.
-
getNetworkGateways
All network gateway devices on this account.
-
getNetworkHardware
An account's associated network hardware.
-
getNetworkMessageDeliveryAccounts
-
getNetworkMonitorDownHardware
Hardware which is currently experiencing a service failure.
-
getNetworkMonitorDownVirtualGuests
Virtual guest which is currently experiencing a service failure.
-
getNetworkMonitorRecoveringHardware
Hardware which is currently recovering from a service failure.
-
getNetworkMonitorRecoveringVirtualGuests
Virtual guest which is currently recovering from a service failure.
-
getNetworkMonitorUpHardware
Hardware which is currently online.
-
getNetworkMonitorUpVirtualGuests
Virtual guest which is currently online.
-
getNetworkStorage
An account's associated storage volumes. This includes Lockbox, NAS, EVault, and iSCSI volumes.
-
getNetworkStorageGroups
An account's Network Storage groups.
-
getNetworkTunnelContexts
IPSec network tunnels for an account.
-
getNetworkVlans
All network VLANs assigned to an account.
-
getNetworkVlanSpan
Whether or not an account has automatic private VLAN spanning enabled.
-
getNextBillingPublicAllotmentHardwareBandwidthDetails
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
Return an account's next invoice in a Microsoft excel format. The 'next invoice' is what a customer will be billed on their next invoice, assuming no changes are made. Currently this does not include Bandwidth Pooling charges.
-
getNextInvoiceIncubatorExemptTotal
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
-
getNextInvoicePdf
Return an account's next invoice in PDF format. The 'next invoice' is what a customer will be billed on their next invoice, assuming no changes are made. Currently this does not include Bandwidth Pooling charges.
-
getNextInvoicePdfDetailed
Return an account's next invoice detailed portion in PDF format. The 'next invoice' is what a customer will be billed on their next invoice, assuming no changes are made. Currently this does not include Bandwidth Pooling charges.
-
getNextInvoiceRecurringAmountEligibleForAccountDiscount
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.
-
getNextInvoiceTopLevelBillingItems
The billing items that will be on an account's next invoice.
-
getNextInvoiceTotalAmount
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.
-
getNextInvoiceTotalOneTimeAmount
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
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
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
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
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
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
-
getNotificationSubscribers
-
getObject
getObject retrieves the SoftLayer_Account object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Account service. You can only retrieve the account that your portal user is assigned to.
-
getOpenAbuseTickets
The open abuse tickets associated with an account.
-
getOpenAccountingTickets
The open accounting tickets associated with an account.
-
getOpenBillingTickets
The open billing tickets associated with an account.
-
getOpenCancellationRequests
An open ticket requesting cancellation of this server, if one exists.
-
getOpenOtherTickets
The open tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account.
-
getOpenRecurringInvoices
An account's recurring invoices.
-
getOpenSalesTickets
The open sales tickets associated with an account.
-
getOpenStackAccountLinks
-
getOpenStackObjectStorage
An account's associated Openstack related Object Storage accounts.
-
getOpenSupportTickets
The open support tickets associated with an account.
-
getOpenTickets
All open tickets associated with an account.
-
getOpenTicketsWaitingOnCustomer
All open tickets associated with an account last edited by an employee.
-
getOrders
An account's associated billing orders excluding upgrades.
-
getOrphanBillingItems
The billing items that have no parent billing item. These are items that don't necessarily belong to a single server.
-
getOwnedBrands
-
getOwnedHardwareGenericComponentModels
-
getPaymentProcessors
-
getPendingCreditCardChangeRequestData
Before being approved for general use, a credit card must be approved by a SoftLayer agent. Once a credit card change request has been either approved or denied, the change request will no longer appear in the list of pending change requests. This method will return a list of all pending change requests as well as a portion of the data from the original request.
-
getPendingEvents
-
getPendingInvoice
An account's latest open (pending) invoice.
-
getPendingInvoiceTopLevelItems
A list of top-level invoice items that are on an account's currently pending invoice.
-
getPendingInvoiceTotalAmount
The total amount of an account's pending invoice, if one exists.
-
getPendingInvoiceTotalOneTimeAmount
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.
-
getPendingInvoiceTotalOneTimeTaxAmount
The sum of all the taxes related to one time charges for an account's pending invoice, if one exists.
-
getPendingInvoiceTotalRecurringAmount
The total recurring amount of an account's pending invoice, if one exists.
-
getPendingInvoiceTotalRecurringTaxAmount
The total amount of the recurring taxes on an account's pending invoice, if one exists.
-
getPermissionGroups
An account's permission groups.
-
getPermissionRoles
An account's user roles.
-
getPlacementGroups
An account's associated virtual placement groups.
-
getPortableStorageVolumes
-
getPostProvisioningHooks
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.
-
getPptpVpnAllowedFlag
(Deprecated) Boolean flag dictating whether or not this account supports PPTP VPN Access.
-
getPptpVpnUsers
An account's associated portal users with PPTP VPN access. (Deprecated)
-
getPreviousRecurringRevenue
The total recurring amount for an accounts previous revenue.
-
getPriceRestrictions
The item price that an account is restricted to.
-
getPriorityOneTickets
All priority one tickets associated with an account.
-
getPrivateAllotmentHardwareBandwidthDetails
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
Private and shared template group objects (parent only) for an account.
-
getPrivateIpAddresses
-
getPrivateNetworkVlans
The private network VLANs assigned to an account.
-
getPrivateSubnets
All private subnets associated with an account.
-
getProofOfConceptAccountFlag
Boolean flag indicating whether or not this account is a Proof of Concept account.
-
getPublicAllotmentHardwareBandwidthDetails
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.
-
getPublicIpAddresses
-
getPublicNetworkVlans
The public network VLANs assigned to an account.
-
getPublicSubnets
All public network subnets associated with an account.
-
getQuotes
An account's quotes.
-
getRecentEvents
-
getReferralPartner
The Referral Partner for this account, if any.
-
getReferralPartnerCommissionForecast
-
getReferralPartnerCommissionHistory
-
getReferralPartnerCommissionPending
-
getReferredAccountFlag
Flag indicating if the account was referred.
-
getReferredAccounts
If this is a account is a referral partner, the accounts this referral partner has referred
-
getRegulatedWorkloads
-
getRemoteManagementCommandRequests
Remote management command requests for an account
-
getReplicationEvents
The Replication events for all Network Storage volumes on an account.
-
getRequireSilentIBMidUserCreation
Indicates whether newly created users under this account will be associated with IBMid via an email requiring a response, or not.
-
getReservedCapacityAgreements
All reserved capacity agreements for an account
-
getReservedCapacityGroups
The reserved capacity groups owned by this account.
-
getRouters
All Routers that an accounts VLANs reside on
-
getRwhoisData
DEPRECATED
-
getSamlAuthentication
The SAML configuration for this account.
-
getSecondaryDomains
The secondary DNS records for a SoftLayer customer account.
-
getSecurityCertificates
Stored security certificates (ie. SSL)
-
getSecurityGroups
The security groups belonging to this account.
-
getSecurityLevel
-
getSecurityScanRequests
An account's vulnerability scan requests.
-
getServiceBillingItems
The service billing items that will be on an account's next invoice.
-
getSharedBlockDeviceTemplateGroups
This method returns the [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/datatypes/SoftLayer_Virtual_Guest_Block_Device_Template_Group) objects that have been shared with this account
-
getShipments
Shipments that belong to the customer's account.
-
getSshKeys
Customer specified SSH keys that can be implemented onto a newly provisioned or reloaded server.
-
getSslVpnUsers
An account's associated portal users with SSL VPN access.
-
getStandardPoolVirtualGuests
An account's virtual guest objects that are hosted on a user provisioned hypervisor.
-
getSubnetRegistrationDetails
-
getSubnetRegistrations
-
getSubnets
All network subnets associated with an account.
-
getSupportRepresentatives
The SoftLayer employees that an account is assigned to.
-
getSupportSubscriptions
The active support subscriptions for this account.
-
getSupportTier
-
getSuppressInvoicesFlag
A flag indicating to suppress invoices.
-
getTags
-
getTechIncubatorProgramInfo
This method will return a SoftLayer_Container_Account_Discount_Program object containing the Technology Incubator Program information for this account. To be considered an active participant, the account must have an enrollment record with a monthly credit amount set and the current date must be within the range defined by the enrollment and graduation date. The forNextBillCycle parameter can be set to true to return a SoftLayer_Container_Account_Discount_Program object with information with relation to the next bill cycle. The forNextBillCycle parameter defaults to false.
-
getTestAccountAttributeFlag
Account attribute flag indicating test account.
-
getThirdPartyPoliciesAcceptanceStatus
Returns multiple [SoftLayer_Container_Policy_Acceptance](/reference/datatypes/SoftLayer_Container_Policy_Acceptance) that represent the acceptance status of the applicable third-party policies for this account.
-
getTickets
An account's associated tickets.
-
getTicketsClosedInTheLastThreeDays
Tickets closed within the last 72 hours or last 10 tickets, whichever is less, associated with an account.
-
getTicketsClosedToday
Tickets closed today associated with an account.
-
getUpgradeRequests
An account's associated upgrade requests.
-
getUsers
An account's portal users.
-
getValidSecurityCertificateEntries
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.
-
getValidSecurityCertificates
Stored security certificates that are not expired (ie. SSL)
-
getVdrUpdatesInProgressFlag
DEPRECATED - Return 0 if VDR updates are currently in progress on this account otherwise 1.
-
getVirtualDedicatedRacks
The bandwidth pooling for this account.
-
getVirtualDiskImages
An account's associated virtual server virtual disk images.
-
getVirtualGuests
An account's associated virtual guest objects.
-
getVirtualGuestsOverBandwidthAllocation
An account's associated virtual guest objects currently over bandwidth allocation.
-
getVirtualGuestsProjectedOverBandwidthAllocation
An account's associated virtual guest objects currently over bandwidth allocation.
-
getVirtualGuestsWithCpanel
All virtual guests associated with an account that has the cPanel web hosting control panel installed.
-
getVirtualGuestsWithMcafee
All virtual guests associated with an account that have McAfee Secure software components.
-
getVirtualGuestsWithMcafeeAntivirusRedhat
All virtual guests associated with an account that have McAfee Secure AntiVirus for Redhat software components.
-
getVirtualGuestsWithMcafeeAntivirusWindows
All virtual guests associated with an account that has McAfee Secure AntiVirus for Windows software components.
-
getVirtualGuestsWithMcafeeIntrusionDetectionSystem
All virtual guests associated with an account that has McAfee Secure Intrusion Detection System software components.
-
getVirtualGuestsWithPlesk
All virtual guests associated with an account that has the Plesk web hosting control panel installed.
-
getVirtualGuestsWithQuantastor
All virtual guests associated with an account that have the QuantaStor storage system installed.
-
getVirtualGuestsWithUrchin
All virtual guests associated with an account that has the Urchin web traffic analytics package installed.
-
getVirtualPrivateRack
The bandwidth pooling for this account.
-
getVirtualStorageArchiveRepositories
An account's associated virtual server archived storage repositories.
-
getVirtualStoragePublicRepositories
An account's associated virtual server public storage repositories.
-
getVmWareActiveAccountLicenseKeys
This returns a collection of active VMware software account license keys.
-
getVpcVirtualGuests
An account's associated VPC configured virtual guest objects.
-
getVpnConfigRequiresVPNManageFlag
-
getWindowsUpdateStatus
Retrieve a list of an account's hardware's Windows Update status. This list includes which servers have available updates, which servers require rebooting due to updates, which servers have failed retrieving updates, and which servers have failed to communicate with the SoftLayer private Windows Software Update Services server.
-
hasAttribute
Determine if an account has an [SoftLayer_Account_Attribute](/reference/datatypes/SoftLayer_Account_Attribute) associated with it. hasAttribute() returns false if the attribute does not exist or if it does not have a value.
-
hourlyInstanceLimit
This method will return the limit (number) of hourly services the account is allowed to have.
-
hourlyServerLimit
This method will return the limit (number) of hourly bare metal servers the account is allowed to have.
-
initiatePayerAuthentication
Initiates Payer Authentication and provides data that is required for payer authentication enrollment and device data collection.
-
isActiveVmwareCustomer
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.
-
isEligibleForLocalCurrencyProgram
Returns true if this account is eligible for the local currency program, false otherwise.
-
isEligibleToLinkWithPaas
Returns true if this account is eligible to link with PaaS. False otherwise.
-
linkExternalAccount
This method will link this SoftLayer account with the provided external account.
-
removeAlternateCreditCard
-
requestCreditCardChange
Retrieve the record data associated with the submission of a Credit Card Change Request. Softlayer customers are permitted to request a change in Credit Card information. Part of the process calls for an attempt by SoftLayer to submit at $1.00 charge to the financial institution backing the credit card as a means of verifying that the information provided in the change request is valid. The data associated with this change request returned to the calling function.
If the onlyChangeNicknameFlag parameter is set to true, the nickname of the credit card will be changed immediately without requiring approval by an agent. To change the nickname of the active payment method, pass the empty string for paymentRoleName. To change the nickname for the alternate credit card, pass ALTERNATE_CREDIT_CARD as the paymentRoleName. vatId must be set, but the value will not be used and the empty string is acceptable.
-
requestManualPayment
Retrieve the record data associated with the submission of a Manual Payment Request. Softlayer customers are permitted to request a manual one-time payment at a minimum amount of $2.00. Customers may submit a Credit Card Payment (Mastercard, Visa, American Express) or a PayPal payment. For Credit Card Payments, SoftLayer engages the credit card financial institution to submit the payment request. The financial institution's response and other data associated with the transaction are returned to the calling function. In the case of PayPal Payments, SoftLayer engages the PayPal system to initiate the PayPal payment sequence. The applicable data generated during the request is returned to the calling function.
-
requestManualPaymentUsingCreditCardOnFile
Retrieve the record data associated with the submission of a Manual Payment Request for a manual payment using a credit card which is on file and does not require an approval process. Softlayer customers are permitted to request a manual one-time payment at a minimum amount of $2.00. Customers may use an existing Credit Card on file (Mastercard, Visa, American Express). SoftLayer engages the credit card financial institution to submit the payment request. The financial institution's response and other data associated with the transaction are returned to the calling function. The applicable data generated during the request is returned to the calling function.
-
saveInternalCostRecovery
-
setAbuseEmails
Set this account's abuse emails. Takes an array of email addresses as strings.
-
setManagedPoolQuantity
Set the total number of servers that are to be maintained in the given pool. When a server is ordered a new server will be put in the pool to replace the server that was removed to fill an order to maintain the desired pool availability quantity.
-
setVlanSpan
Set the flag that enables or disables automatic private network VLAN spanning for a SoftLayer customer account. Enabling VLAN spanning allows an account's servers to talk on the same broadcast domain even if they reside within different private vlans.
-
SoftLayer_Account
The SoftLayer_Account data type contains general information relating to a single SoftLayer customer account. Personal information in this type such as names, addresses, and phone numbers are assigned to the account only and not to users belonging to the account. The SoftLayer_Account data type contains a number of relational properties that are used by the SoftLayer customer portal to quickly present a variety of account related services to it's users.
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.
-
SoftLayer_Account
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.
-
swapCreditCards
-
syncCurrentUserPopulationWithPaas
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'.
-
updateVpnUsersForResource
[DEPRECATED] This method has been deprecated and will simply return false.
-
validate
This method will validate the following account fields. Included are the allowed characters for each field.<br> <strong>Company Name (required):</strong> alphabet, numbers, space, period, dash, octothorpe, forward slash, comma, colon, at sign, ampersand, underscore, apostrophe, parenthesis, exclamation point. Maximum length: 100 characters. (Note: may not contain an email address)<br> <strong>First Name (required):</strong> alphabet, space, period, dash, comma, apostrophe. Maximum length: 30 characters.<br> <strong>Last Name (required):</strong> alphabet, space, period, dash, comma, apostrophe. Maximum length: 30 characters.<br> <strong>Email (required):</strong> Validates e-mail addresses against the syntax in RFC 822.<br> <strong>Address 1 (required):</strong> alphabet, numbers, space, period, dash, octothorpe, forward slash, comma, colon, at sign, ampersand, underscore, apostrophe, parentheses. Maximum length: 100 characters. (Note: may not contain an email address)<br> <strong>Address 2:</strong> alphabet, numbers, space, period, dash, octothorpe, forward slash, comma, colon, at sign, ampersand, underscore, apostrophe, parentheses. Maximum length: 100 characters. (Note: may not contain an email address)<br> <strong>City (required):</strong> alphabet, numbers, space, period, dash, apostrophe, forward slash, comma, parenthesis. Maximum length: 100 characters.<br> <strong>State (required if country is US, Brazil, Canada or India):</strong> Must be valid Alpha-2 ISO 3166-1 state code for that country.<br> <strong>Postal Code (required if country is US or Canada):</strong> Accepted characters are alphabet, numbers, dash, space. Maximum length: 50 characters.<br> <strong>Country (required):</strong> alphabet, numbers. Must be valid Alpha-2 ISO 3166-1 country code.<br> <strong>Office Phone (required):</strong> alphabet, numbers, space, period, dash, parenthesis, plus sign. Maximum length: 100 characters.<br> <strong>Alternate Phone:</strong> alphabet, numbers, space, period, dash, parenthesis, plus sign. Maximum length: 100 characters.<br> <strong>Fax Phone:</strong> alphabet, numbers, space, period, dash, parenthesis, plus sign. Maximum length: 20 characters.<br>
-
validateManualPaymentAmount
This method checks global and account specific requirements and returns true if the dollar amount entered is acceptable for this account and false otherwise. Please note the dollar amount is in USD.