latest
Models
Powered By GitBook
Python SDK

Overview

The IONOS Cloud SDK for Python provides you with access to the IONOS Cloud API. The client library supports both simple and complex requests. It is designed for developers who are building applications in Python. The SDK for Python wraps the IONOS Cloud API. All API operations are performed over SSL and authenticated using your IONOS Cloud portal credentials. The API can be accessed within an instance running in IONOS Cloud or directly over the Internet from any application that can send an HTTPS request and receive an HTTPS response.

Getting Started

An IONOS account is required for access to the Cloud API; credentials from your registration are used to authenticate against the IONOS Cloud API.

Installation & Usage

pip install

Since this package is hosted on PyPI (https://pypi.org/) you can install it like this
1
pip install ionoscloud
Copied!
If the python package is hosted on a repository, you can install directly using:
1
pip install git+https://github.com/ionos-cloud/sdk-python.git
Copied!
(you may need to run pip with root permission: sudo pip install git+https://github.com/ionos-cloud/sdk-python.git)
Then import the package:
1
import ionoscloud
Copied!

Setuptools

Install via Setuptools.
1
python setup.py install --user
Copied!
(or sudo python setup.py install to install the package for all users)
Then import the package:
1
import ionoscloud
Copied!

Authentication

The username and password or the authentication token can be manually specified when initializing the SDK client:
1
configuration = ionoscloud.Configuration(
2
username = 'YOUR_USERNAME',
3
password = 'YOUR_PASSWORD'
4
)
5
client = ionoscloud.ApiClient(configuration)
Copied!
Environment variables can also be used; the SDK uses the following variables:
    IONOS_USERNAME - to specify the username used to login
    IONOS_PASSWORD - to specify the password
    IONOS_TOKEN - if an authentication token is being used
Warning: Make sure to follow the Information Security Best Practices when using credentials within your code or storing them in a file.

Depth

Many of the List or Get operations will accept an optional depth argument. Setting this to a value between 0 and 5 affects the amount of data that is returned. The details returned vary depending on the resource being queried, but it generally follows this pattern. By default, the SDK sets the depth argument to the maximum value.
Depth
Description
0
Only direct properties are included. Children are not included.
1
Direct properties and children's references are returned.
2
Direct properties and children's properties are returned.
3
Direct properties, children's properties, and descendants' references are returned.
4
Direct properties, children's properties, and descendants' properties are returned.
5
Returns all available properties.

Pretty

The operations will also accept an optional pretty argument. Setting this to a value of true or false controls whether the response is pretty-printed (with indentation and new lines). By default, the SDK sets the pretty argument to true.

Feature Reference

The IONOS Cloud SDK for Python aims to offer access to all resources in the IONOS Cloud API and also offers some additional features that make the integration easier:
    authentication for API calls
    handling of asynchronous requests

FAQ

    1.
    How can I open a bug/feature request?
Bugs & feature requests can be open on the repository issues: https://github.com/ionos-cloud/sdk-python/issues/new/choose
    1.
    Can I contribute to the Python SDK?
Pure SDKs are automatically generated using OpenAPI Generator and don’t support manual changes. If you need changes please open an issue and we’ll try to take care of it.
Last modified 3mo ago