ionoscloud-object-storage-management

Python API client for ionoscloud_object_storage_management

Object Storage Management API is a RESTful API that manages the object storage service configuration for IONOS Cloud.

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. 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.

Installation & Usage

Requirements:

• Python >= 3.5

pip install

Since this package is hosted on Pypi you can install it by using:

pip install ionoscloud-object-storage-management

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/ionos-cloud/sdk-python-object-storage-management.git

Note: you may need to run pip with root permission: sudo pip install git+https://github.com/ionos-cloud/sdk-python-object-storage-management.git

Then import the package:

import ionoscloud_object_storage_management

Setuptools

Install via Setuptools.

python setup.py install --user

or sudo python setup.py install to install the package for all users

Then import the package:

import ionoscloud_object_storage_management

NOTE: The Python SDK does not support Python 2. It only supports Python >= 3.5.

Authentication

All available server URLs are:

• https://s3.ionos.com - Production

By default, https://s3.ionos.com is used, however this can be overriden at authentication, either by setting the IONOS_API_URL environment variable or by specifying the host parameter when initializing the sdk client.

The username and password or the authentication token can be manually specified when initializing the SDK client:

configuration = ionoscloud_object_storage_management.Configuration(
                username='YOUR_USERNAME',
                password='YOUR_PASSWORD',
                token='YOUR_TOKEN',
                host='SERVER_API_URL'
                )
client = ionoscloud_object_storage_management.ApiClient(configuration)

Environment variables can also be used. This is an example of how one would do that:

import os

configuration = ionoscloud_object_storage_management.Configuration(
                username=os.environ.get('IONOS_USERNAME'),
                password=os.environ.get('IONOS_PASSWORD'),
                token=os.environ.get('IONOS_TOKEN'),
                host=os.environ.get('IONOS_API_URL')
                )
client = ionoscloud_object_storage_management.ApiClient(configuration)

Warning: Make sure to follow the Information Security Best Practices when using credentials within your code or storing them in a file.

HTTP proxies

You can use http proxies by setting the following environment variables:

• IONOS_HTTP_PROXY - proxy URL
• IONOS_HTTP_PROXY_HEADERS - proxy headers

Each line in IONOS_HTTP_PROXY_HEADERS represents one header, where the header name and value is separated by a colon. Newline characters within a value need to be escaped. See this example:

Connection: Keep-Alive
User-Info: MyID
User-Group: my long\nheader value

Changing the base URL

Base URL for the HTTP operation can be changed in the following way:

import os

configuration = ionoscloud_object_storage_management.Configuration(
                username=os.environ.get('IONOS_USERNAME'),
                password=os.environ.get('IONOS_PASSWORD'),
                host=os.environ.get('IONOS_API_URL'),
                server_index=None,
                )
client = ionoscloud_object_storage_management.ApiClient(configuration)

Certificate pinning:

You can enable certificate pinning if you want to bypass the normal certificate checking procedure, by doing the following:

Set env variable IONOS_PINNED_CERT=<insert_sha256_public_fingerprint_here>

You can get the sha256 fingerprint most easily from the browser by inspecting the certificate.

Documentation for API Endpoints

All URIs are relative to https://s3.ionos.com

API Endpoints table

Class	Method	HTTP request	Description
AccesskeysApi	accesskeys_delete	DELETE /accesskeys/{accesskeyId}	Delete AccessKey
AccesskeysApi	accesskeys_find_by_id	GET /accesskeys/{accesskeyId}	Retrieve AccessKey
AccesskeysApi	accesskeys_get	GET /accesskeys	Retrieve all Accesskeys
AccesskeysApi	accesskeys_post	POST /accesskeys	Create AccessKey
AccesskeysApi	accesskeys_put	PUT /accesskeys/{accesskeyId}	Ensure AccessKey
AccesskeysApi	accesskeys_renew	PUT /accesskeys/{accesskeyId}/renew	Ensure AccessKey
RegionsApi	regions_find_by_region	GET /regions/{region}	Retrieve Region
RegionsApi	regions_get	GET /regions	Retrieve all Regions

Documentation For Models

All URIs are relative to https://s3.ionos.com

API models list

• AccessKey
• AccessKeyCreate
• AccessKeyEnsure
• AccessKeyRead
• AccessKeyReadList
• AccessKeyReadListAllOf
• Bucket
• BucketCreate
• BucketEnsure
• BucketRead
• BucketReadList
• BucketReadListAllOf
• Error
• ErrorMessages
• Links
• Metadata
• MetadataWithStatus
• MetadataWithStatusAllOf
• MetadataWithSupportedRegions
• MetadataWithSupportedRegionsAllOf
• Pagination
• Region
• RegionCapability
• RegionCreate
• RegionEnsure
• RegionRead
• RegionReadList
• RegionReadListAllOf
• StorageClass
• StorageClassCreate
• StorageClassEnsure
• StorageClassRead
• StorageClassReadList
• StorageClassReadListAllOf

[Back to API list] [Back to Model list]