[](https://gitter.im/ionos-cloud/sdk-general)
[](https://sonarcloud.io/summary?id=sdk-python-object-storage-management)
[](https://sonarcloud.io/summary/new_code?id=sdk-python-object-storage-management)
[](https://sonarcloud.io/summary/new_code?id=sdk-python-object-storage-management)
[](https://sonarcloud.io/summary/new_code?id=sdk-python-object-storage-management)
[](https://sonarcloud.io/summary/new_code?id=sdk-python-object-storage-management)
[](https://sonarcloud.io/summary/new_code?id=sdk-python-object-storage-management)
[](https://github.com/ionos-cloud/sdk-python-object-storage-management/releases/latest)
[](https://github.com/ionos-cloud/sdk-python-object-storage-management/releases/latest)
[](https://pypi.org/project/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](https://pypi.org/) you can install it by using:
```bash
pip install ionoscloud-object-storage-management
```
If the python package is hosted on a repository, you can install directly using:
```bash
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:
```python
import ionoscloud_object_storage_management
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```bash
python setup.py install --user
```
or `sudo python setup.py install` to install the package for all users
Then import the package:
```python
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:
```python
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:
```python
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:
```python
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*
<details >
<summary title="Click to toggle">API Endpoints table</summary>
| Class | Method | HTTP request | Description |
| ------------- | ------------- | ------------- | ------------- |
| AccesskeysApi | [**accesskeys_delete**](docs/api/AccesskeysApi.md#accesskeys_delete) | **DELETE** /accesskeys/{accesskeyId} | Delete AccessKey |
| AccesskeysApi | [**accesskeys_find_by_id**](docs/api/AccesskeysApi.md#accesskeys_find_by_id) | **GET** /accesskeys/{accesskeyId} | Retrieve AccessKey |
| AccesskeysApi | [**accesskeys_get**](docs/api/AccesskeysApi.md#accesskeys_get) | **GET** /accesskeys | Retrieve all Accesskeys |
| AccesskeysApi | [**accesskeys_post**](docs/api/AccesskeysApi.md#accesskeys_post) | **POST** /accesskeys | Create AccessKey |
| AccesskeysApi | [**accesskeys_put**](docs/api/AccesskeysApi.md#accesskeys_put) | **PUT** /accesskeys/{accesskeyId} | Ensure AccessKey |
| AccesskeysApi | [**accesskeys_renew**](docs/api/AccesskeysApi.md#accesskeys_renew) | **PUT** /accesskeys/{accesskeyId}/renew | Ensure AccessKey |
| RegionsApi | [**regions_find_by_region**](docs/api/RegionsApi.md#regions_find_by_region) | **GET** /regions/{region} | Retrieve Region |
| RegionsApi | [**regions_get**](docs/api/RegionsApi.md#regions_get) | **GET** /regions | Retrieve all Regions |
</details>
## Documentation For Models
All URIs are relative to *https://s3.ionos.com*
<details >
<summary title="Click to toggle">API models list</summary>
- [AccessKey](docs/models/AccessKey)
- [AccessKeyCreate](docs/models/AccessKeyCreate)
- [AccessKeyEnsure](docs/models/AccessKeyEnsure)
- [AccessKeyRead](docs/models/AccessKeyRead)
- [AccessKeyReadList](docs/models/AccessKeyReadList)
- [AccessKeyReadListAllOf](docs/models/AccessKeyReadListAllOf)
- [Bucket](docs/models/Bucket)
- [BucketCreate](docs/models/BucketCreate)
- [BucketEnsure](docs/models/BucketEnsure)
- [BucketRead](docs/models/BucketRead)
- [BucketReadList](docs/models/BucketReadList)
- [BucketReadListAllOf](docs/models/BucketReadListAllOf)
- [Error](docs/models/Error)
- [ErrorMessages](docs/models/ErrorMessages)
- [Links](docs/models/Links)
- [Metadata](docs/models/Metadata)
- [MetadataWithStatus](docs/models/MetadataWithStatus)
- [MetadataWithStatusAllOf](docs/models/MetadataWithStatusAllOf)
- [MetadataWithSupportedRegions](docs/models/MetadataWithSupportedRegions)
- [MetadataWithSupportedRegionsAllOf](docs/models/MetadataWithSupportedRegionsAllOf)
- [Pagination](docs/models/Pagination)
- [Region](docs/models/Region)
- [RegionCapability](docs/models/RegionCapability)
- [RegionCreate](docs/models/RegionCreate)
- [RegionEnsure](docs/models/RegionEnsure)
- [RegionRead](docs/models/RegionRead)
- [RegionReadList](docs/models/RegionReadList)
- [RegionReadListAllOf](docs/models/RegionReadListAllOf)
- [StorageClass](docs/models/StorageClass)
- [StorageClassCreate](docs/models/StorageClassCreate)
- [StorageClassEnsure](docs/models/StorageClassEnsure)
- [StorageClassRead](docs/models/StorageClassRead)
- [StorageClassReadList](docs/models/StorageClassReadList)
- [StorageClassReadListAllOf](docs/models/StorageClassReadListAllOf)
[[Back to API list]](#documentation-for-api-endpoints) [[Back to Model list]](#documentation-for-models)
</details>
Raw data
{
"_id": null,
"home_page": "https://github.com/ionos-cloud/sdk-python-object-storage-management",
"name": "ionoscloud-object-storage-management",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, IONOS Cloud - Object Storage Management API",
"author": "Ionos Cloud",
"author_email": "sdk@cloud.ionos.com",
"download_url": "https://files.pythonhosted.org/packages/9d/8e/c4ae4731aad698ab8af7df7efc416cebcdadde55cda2105b40075ff614c3/ionoscloud-object-storage-management-1.0.0.tar.gz",
"platform": null,
"description": "[](https://gitter.im/ionos-cloud/sdk-general)\n[](https://sonarcloud.io/summary?id=sdk-python-object-storage-management)\n[](https://sonarcloud.io/summary/new_code?id=sdk-python-object-storage-management)\n[](https://sonarcloud.io/summary/new_code?id=sdk-python-object-storage-management)\n[](https://sonarcloud.io/summary/new_code?id=sdk-python-object-storage-management)\n[](https://sonarcloud.io/summary/new_code?id=sdk-python-object-storage-management)\n[](https://sonarcloud.io/summary/new_code?id=sdk-python-object-storage-management)\n[](https://github.com/ionos-cloud/sdk-python-object-storage-management/releases/latest)\n[](https://github.com/ionos-cloud/sdk-python-object-storage-management/releases/latest)\n[](https://pypi.org/project/ionoscloud-object-storage-management/)\n\n![Alt text](.github/IONOS.CLOUD.BLU.svg?raw=true \"Title\")\n\n\n# Python API client for ionoscloud_object_storage_management\n\nObject Storage Management API is a RESTful API that manages the object storage\nservice configuration for IONOS Cloud.\n\n\n## Overview\nThe 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.\n\n\n### Installation & Usage\n\n**Requirements:**\n- Python >= 3.5\n\n### pip install\n\nSince this package is hosted on [Pypi](https://pypi.org/) you can install it by using:\n\n```bash\npip install ionoscloud-object-storage-management\n```\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```bash\npip install git+https://github.com/ionos-cloud/sdk-python-object-storage-management.git\n```\n\nNote: you may need to run `pip` with root permission: `sudo pip install git+https://github.com/ionos-cloud/sdk-python-object-storage-management.git`\n\nThen import the package:\n\n```python\nimport ionoscloud_object_storage_management\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```bash\npython setup.py install --user\n```\n\nor `sudo python setup.py install` to install the package for all users\n\nThen import the package:\n\n```python\nimport ionoscloud_object_storage_management\n```\n\n> **_NOTE:_** The Python SDK does not support Python 2. It only supports Python >= 3.5.\n\n### Authentication\n\nAll available server URLs are:\n\n- *https://s3.ionos.com* - Production\n\nBy default, *https://s3.ionos.com* is used, however this can be overriden at authentication, either\nby setting the `IONOS_API_URL` environment variable or by specifying the `host` parameter when\ninitializing the sdk client.\n\nThe username and password **or** the authentication token can be manually specified when initializing the SDK client:\n\n```python\nconfiguration = ionoscloud_object_storage_management.Configuration(\n username='YOUR_USERNAME',\n password='YOUR_PASSWORD',\n token='YOUR_TOKEN',\n host='SERVER_API_URL'\n )\nclient = ionoscloud_object_storage_management.ApiClient(configuration)\n```\n\nEnvironment variables can also be used. This is an example of how one would do that:\n\n```python\nimport os\n\nconfiguration = ionoscloud_object_storage_management.Configuration(\n username=os.environ.get('IONOS_USERNAME'),\n password=os.environ.get('IONOS_PASSWORD'),\n token=os.environ.get('IONOS_TOKEN'),\n host=os.environ.get('IONOS_API_URL')\n )\nclient = ionoscloud_object_storage_management.ApiClient(configuration)\n```\n\n**Warning**: Make sure to follow the Information Security Best Practices when using credentials within your code or storing them in a file.\n\n\n### HTTP proxies\n\nYou can use http proxies by setting the following environment variables:\n- `IONOS_HTTP_PROXY` - proxy URL\n- `IONOS_HTTP_PROXY_HEADERS` - proxy headers\n\nEach 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:\n```\nConnection: Keep-Alive\nUser-Info: MyID\nUser-Group: my long\\nheader value\n```\n\n\n### Changing the base URL\n\nBase URL for the HTTP operation can be changed in the following way:\n\n```python\nimport os\n\nconfiguration = ionoscloud_object_storage_management.Configuration(\n username=os.environ.get('IONOS_USERNAME'),\n password=os.environ.get('IONOS_PASSWORD'),\n host=os.environ.get('IONOS_API_URL'),\n server_index=None,\n )\nclient = ionoscloud_object_storage_management.ApiClient(configuration)\n```\n\n## Certificate pinning:\n\nYou can enable certificate pinning if you want to bypass the normal certificate checking procedure,\nby doing the following:\n\nSet env variable IONOS_PINNED_CERT=<insert_sha256_public_fingerprint_here>\n\nYou can get the sha256 fingerprint most easily from the browser by inspecting the certificate.\n\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://s3.ionos.com*\n<details >\n <summary title=\"Click to toggle\">API Endpoints table</summary>\n\n\n| Class | Method | HTTP request | Description |\n| ------------- | ------------- | ------------- | ------------- |\n| AccesskeysApi | [**accesskeys_delete**](docs/api/AccesskeysApi.md#accesskeys_delete) | **DELETE** /accesskeys/{accesskeyId} | Delete AccessKey |\n| AccesskeysApi | [**accesskeys_find_by_id**](docs/api/AccesskeysApi.md#accesskeys_find_by_id) | **GET** /accesskeys/{accesskeyId} | Retrieve AccessKey |\n| AccesskeysApi | [**accesskeys_get**](docs/api/AccesskeysApi.md#accesskeys_get) | **GET** /accesskeys | Retrieve all Accesskeys |\n| AccesskeysApi | [**accesskeys_post**](docs/api/AccesskeysApi.md#accesskeys_post) | **POST** /accesskeys | Create AccessKey |\n| AccesskeysApi | [**accesskeys_put**](docs/api/AccesskeysApi.md#accesskeys_put) | **PUT** /accesskeys/{accesskeyId} | Ensure AccessKey |\n| AccesskeysApi | [**accesskeys_renew**](docs/api/AccesskeysApi.md#accesskeys_renew) | **PUT** /accesskeys/{accesskeyId}/renew | Ensure AccessKey |\n| RegionsApi | [**regions_find_by_region**](docs/api/RegionsApi.md#regions_find_by_region) | **GET** /regions/{region} | Retrieve Region |\n| RegionsApi | [**regions_get**](docs/api/RegionsApi.md#regions_get) | **GET** /regions | Retrieve all Regions |\n\n</details>\n\n## Documentation For Models\n\nAll URIs are relative to *https://s3.ionos.com*\n<details >\n<summary title=\"Click to toggle\">API models list</summary>\n\n - [AccessKey](docs/models/AccessKey)\n - [AccessKeyCreate](docs/models/AccessKeyCreate)\n - [AccessKeyEnsure](docs/models/AccessKeyEnsure)\n - [AccessKeyRead](docs/models/AccessKeyRead)\n - [AccessKeyReadList](docs/models/AccessKeyReadList)\n - [AccessKeyReadListAllOf](docs/models/AccessKeyReadListAllOf)\n - [Bucket](docs/models/Bucket)\n - [BucketCreate](docs/models/BucketCreate)\n - [BucketEnsure](docs/models/BucketEnsure)\n - [BucketRead](docs/models/BucketRead)\n - [BucketReadList](docs/models/BucketReadList)\n - [BucketReadListAllOf](docs/models/BucketReadListAllOf)\n - [Error](docs/models/Error)\n - [ErrorMessages](docs/models/ErrorMessages)\n - [Links](docs/models/Links)\n - [Metadata](docs/models/Metadata)\n - [MetadataWithStatus](docs/models/MetadataWithStatus)\n - [MetadataWithStatusAllOf](docs/models/MetadataWithStatusAllOf)\n - [MetadataWithSupportedRegions](docs/models/MetadataWithSupportedRegions)\n - [MetadataWithSupportedRegionsAllOf](docs/models/MetadataWithSupportedRegionsAllOf)\n - [Pagination](docs/models/Pagination)\n - [Region](docs/models/Region)\n - [RegionCapability](docs/models/RegionCapability)\n - [RegionCreate](docs/models/RegionCreate)\n - [RegionEnsure](docs/models/RegionEnsure)\n - [RegionRead](docs/models/RegionRead)\n - [RegionReadList](docs/models/RegionReadList)\n - [RegionReadListAllOf](docs/models/RegionReadListAllOf)\n - [StorageClass](docs/models/StorageClass)\n - [StorageClassCreate](docs/models/StorageClassCreate)\n - [StorageClassEnsure](docs/models/StorageClassEnsure)\n - [StorageClassRead](docs/models/StorageClassRead)\n - [StorageClassReadList](docs/models/StorageClassReadList)\n - [StorageClassReadListAllOf](docs/models/StorageClassReadListAllOf)\n\n\n[[Back to API list]](#documentation-for-api-endpoints) [[Back to Model list]](#documentation-for-models)\n\n</details>\n",
"bugtrack_url": null,
"license": null,
"summary": "Python SDK for the ionoscloud-object-storage-management API",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/ionos-cloud/sdk-python-object-storage-management"
},
"split_keywords": [
"openapi",
" openapi-generator",
" ionos cloud - object storage management api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "731519a43ed426cf58a1f9ebf8c48dc98906b180e18aeecdad666bc48d6bfd8d",
"md5": "ddc0b0f813a79ca28c28f96c0b16b805",
"sha256": "73b4ea75a5edf6c8b53d433a4dc91f218630f35aaf6196078c937a045669e3b0"
},
"downloads": -1,
"filename": "ionoscloud_object_storage_management-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ddc0b0f813a79ca28c28f96c0b16b805",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 94326,
"upload_time": "2024-11-25T14:48:40",
"upload_time_iso_8601": "2024-11-25T14:48:40.406791Z",
"url": "https://files.pythonhosted.org/packages/73/15/19a43ed426cf58a1f9ebf8c48dc98906b180e18aeecdad666bc48d6bfd8d/ionoscloud_object_storage_management-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9d8ec4ae4731aad698ab8af7df7efc416cebcdadde55cda2105b40075ff614c3",
"md5": "79a13c56d70b5c9b363fc0ff3bc24fa4",
"sha256": "6acad674334d21eb724931ff0b3eac96757e6e9608173ddc85b81ef837f4583c"
},
"downloads": -1,
"filename": "ionoscloud-object-storage-management-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "79a13c56d70b5c9b363fc0ff3bc24fa4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 47141,
"upload_time": "2024-11-25T14:48:42",
"upload_time_iso_8601": "2024-11-25T14:48:42.399764Z",
"url": "https://files.pythonhosted.org/packages/9d/8e/c4ae4731aad698ab8af7df7efc416cebcdadde55cda2105b40075ff614c3/ionoscloud-object-storage-management-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-25 14:48:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ionos-cloud",
"github_project": "sdk-python-object-storage-management",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "certifi",
"specs": [
[
">=",
"14.05.14"
]
]
},
{
"name": "future",
"specs": []
},
{
"name": "six",
"specs": [
[
">=",
"1.10"
]
]
},
{
"name": "python_dateutil",
"specs": [
[
">=",
"2.5.3"
]
]
},
{
"name": "setuptools",
"specs": [
[
">=",
"21.0.0"
]
]
},
{
"name": "urllib3",
"specs": [
[
">=",
"1.15.1"
]
]
},
{
"name": "asn1crypto",
"specs": [
[
">=",
"1.5.1"
]
]
},
{
"name": "pydantic",
"specs": [
[
">=",
"1.10.5"
],
[
"<",
"2"
]
]
}
],
"tox": true,
"lcname": "ionoscloud-object-storage-management"
}
JSON
