Skip to main content

SoftLayer API Python Client

https://github.com/softlayer/softlayer-python/workflows/Tests/badge.svg https://github.com/softlayer/softlayer-python/workflows/documentation/badge.svg https://badge.fury.io/py/SoftLayer.svg https://coveralls.io/repos/github/softlayer/softlayer-python/badge.svg?branch=master https://snapcraft.io//slcli/badge.svg

This library provides a simple Python client to interact with SoftLayer’s XML-RPC API.

A command-line interface is also included and can be used to manage various SoftLayer products and services.

Documentation

Documentation for the Python client is available at Read the Docs .

Additional API documentation can be found on the SoftLayer Development Network:

Installation

Install via pip:

$ pip install softlayer

Or you can install from source. Download source and run:

$ python setup.py install

Another (safer) method of installation is to use the published snap. Snaps are available for any Linux OS running snapd, the service that runs and manage snaps. Snaps are “auto-updating” packages and will not disrupt the current versions of libraries and software packages on your Linux-based system. To learn more, please visit: https://snapcraft.io/

To install the slcli snap:

$ sudo snap install slcli

(or to get the latest release)

$ sudo snap install slcli --edge

The most up-to-date version of this library can be found on the SoftLayer GitHub public repositories at http://github.com/softlayer. For questions regarding the use of this library please post to Stack Overflow at https://stackoverflow.com/ and your posts with “SoftLayer” so our team can easily find your post. To report a bug with this library please create an Issue on github.

InsecurePlatformWarning Notice

This library relies on the requests library to make HTTP requests. On Python versions below Python 2.7.9, requests has started emitting a security warning (InsecurePlatformWarning) due to insecurities with creating SSL connections. To resolve this, upgrade to Python 2.7.9+ or follow the instructions here: http://stackoverflow.com/a/29099439.

Basic Usage

Advanced Usage

You can automatically set some parameters via environment variables with by using the SLCLI prefix. For example

$ export SLCLI_VERBOSE=3
$ export SLCLI_FORMAT=json
$ slcli vs list

is equivalent to

$ slcli -vvv --format=json vs list

Getting Help

Bugs and feature requests about this library should have a GitHub issue opened about them.

Issues with the Softlayer API itself should be addressed by opening a ticket.

Examples

A curated list of examples on how to use this library can be found at SLDN

Development

To get started working with this project please read the CONTRIBUTING document.

You can quickly test local changes by running the ‘./slcli’ file, which will load the local softlayer-python code instead of the system’s softlayer-python codebase.

Debugging

To get the exact API call that this library makes, you can do the following.

For the CLI, just use the -vvv option. If you are using the REST endpoint, this will print out a curl command that you can use, if using XML, this will print the minimal python code to make the request without the softlayer library.

$ slcli -vvv vs list

If you are using the library directly in python, you can do something like this.

import SoftLayer
import logging

class invoices():

    def __init__(self):
        self.client = SoftLayer.Client()
        debugger = SoftLayer.DebugTransport(self.client.transport)
        self.client.transport = debugger

    def main(self):
        mask = "mask[id]"
        account = self.client.call('Account', 'getObject', mask=mask);
        print("AccountID: %s" % account['id'])

    def debug(self):
        for call in self.client.transport.get_last_calls():
            print(self.client.transport.print_reproduceable(call))

if __name__ == "__main__":
    main = example()
    main.main()
    main.debug()

System Requirements

  • Python 3.8, 3.9, or 3.10.

  • A valid SoftLayer API username and key.

  • A connection to SoftLayer’s private network is required to use our private network API endpoints.

Python 3.6 Support

As of version 6.0.0 SoftLayer-Python will no longer support python3.6, which is End of Life as of 2022. If you cannot install python 3.8+ for some reason, you will need to use a version of softlayer-python <= 6.0.0

Python 2.7 Support

As of version 5.8.0 SoftLayer-Python will no longer support python2.7, which is End Of Life as of 2020 . If you cannot install python 3.6+ for some reason, you will need to use a version of softlayer-python <= 5.7.2

Python Packages

  • prettytable >= 2.5.0

  • click >= 8.0.4

  • requests >= 2.32.2

  • prompt_toolkit >= 2

  • pygments >= 2.0.0

  • urllib3 >= 1.24

  • rich == 12.3.0

NOTE If ptable (not prettytable) is installed, this will cause issues rendering tables.

Metadata

Release files for SoftLayer 6.2.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for SoftLayer 6.2.4
File Size Uploaded Provenance Actions
softlayer-6.2.4.tar.gz 498.8 kB Without provenance Details for softlayer-6.2.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for SoftLayer 6.2.4
File Interpreter ABI Platform Actions
SoftLayer-6.2.4-py2.py3-none-any.whl Python 3, Python 2 none any Details for SoftLayer-6.2.4-py2.py3-none-any.whl

Total release size: 1.3 MB

Release files / softlayer-6.2.4.tar.gz

Download URL softlayer-6.2.4.tar.gz
Size 498.8 kB
Tags Source
SHA-256 checksum
How to use checksums
0ed5cdde4e85589b5605be29127547c79fbac0a6ae0276fc3471015a9e13bd5a
BLAKE2b-256 checksum
How to use checksums
4eaf6b5c3a03bee013b5a9bc78bea7f0c04d9e25ad935863ffbdcc522b8ba042
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.0 CPython/3.12.4

Release files / SoftLayer-6.2.4-py2.py3-none-any.whl

Download URL SoftLayer-6.2.4-py2.py3-none-any.whl
Size 753.9 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
788f14e9cb0c728857e39ce9256c56bff2ced0fe932144e25db749994d70b569
BLAKE2b-256 checksum
How to use checksums
56ada38f12d65138a988e88b13a8d53645ce7c2b5acab84520ca84d364f21a5b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.0 CPython/3.12.4

Security for SoftLayer 6.2.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

6.2.4 This release

2 release files No provenance

5.6.1

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page