FAQ

This page refers to Version 1 of the SoftLayer API. Please head to the SoftLayer Development Network Wiki for the most up to date documentation of the current SoftLayer API.

Below are some frequently asked questions pertaining to the SoftLayer API:

  • What is the SoftLayer API?
    The SoftLayer API was developed in-house to give you the choice of taking control of your hosted servers using any program capable of handling the XML-based SOAP network protocol. Our API is a flexible cross-platform framework allowing software conceived for different purposes to communicate meaningfully, which in turn allows you to interface with and remotely manage your servers using the application of your choice. This API may be used in tandem with our management portal, in lieu of it, or not at all. We are all about choice and enabling you to take control of your own server management process. Our optional API directly represents this philosophy.
  • How do I use the SoftLayer API?
    The API was developed with flexibility in mind. You will need a security key, which can be generated in the customer portal. Next you will need your programming language of choice, any language could be used as long as it supports SOAP or XML-RPC protocols. Finally you will need the API connection string(s). These simple steps allow integration into your current business and technical infrastructure for ease of management by your organization. Please review the “SoftLayer API Guide” available in the Downloads Section for a complete overview of available operations and connection information.
  • What protocols do the SoftLayer API support?
    Currently the API supports SOAP and XML-RPC. Additional protocols are being evaluated, based on customer request.
  • What is the address of the SoftLayer API server?
    SOAP
    http://api.service.softlayer.com/soap/v1/SL-Service.html
    http://api.service.softlayer.com/soap/v1/SL-Service.wsdl
    XML-RPC
    http://api.service.softlayer.com/xmlrpc/v1/SL-Service.html
  • Why is the SoftLayer API server on the private network?
    The API is currently available on the private network to provide an additional layer of security.
  • What credentials are required to access the SoftLayer API?
    To access the SoftLayer API you will need to be connected to the SoftLayer private network, a valid portal username, and a security key.
  • How do I generate an auth-key?
    A security key can be generated in the customer portal by the master account user.
  • Where can I go for help?
    There are example scripts and articles pertaining to the API located here on the SLDN website. Additionally, we have setup a community forum specifically for API user and developers in the Softlayer Forums.

For additional information, including downloadable examples and documentation visit the Downloads Section.