API reference overview
The SoftLayer® Application Programming Interface is the development interface that gives developers and system administrators direct interaction with IBM Cloud backend system. The SoftLayer API powers many of the features in the IBM Cloud console, which typically means if an interaction is possible in the IBM Cloud console, it can also be run in the API. Because you can programmatically interact with all portions of the IBM Cloud environment within the API, SoftLayer API can automate tasks. For example, you can use the SoftLayer_Virtual_Guest/createObject API to deploy a virtual server instance.
The SoftLayer API is a Remote Procedure Call system. Each call involves sending data to an API endpoint and receiving structured data in return. The format that is used to send and receive data with the SoftLayer API depends on which implementation of the API you choose. The SoftLayer API currently uses SOAP, XML-RPC, or REST for data transmission.
For more information about the SoftLayer API and virtual server APIs, see the following resources in the SoftLayer® Development Network:
- SoftLayer API Overview
- Getting Started with the SoftLayer API
- API Reference: Virtual_Guest::createObject
- API Reference: Product_Order::placeOrder
For API usage examples, see the following resources:
- Understanding and building an order using the SoftLayer API order CLI
- SoftLayer API Examples - Release Notes
- Python examples