Metadata-Version: 2.4
Name: ionoscloud_object_storage_management
Version: 2.0.0b1
Summary: IONOS Cloud - Object Storage Management API
License: NoLicense
License-File: LICENSE
Keywords: OpenAPI,OpenAPI-Generator,IONOS Cloud - Object Storage Management API
Author: OpenAPI Generator Community
Author-email: team@openapitools.org
Requires-Python: >=3.9,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: pydantic (>=2)
Requires-Dist: python-dateutil (>=2.8.2)
Requires-Dist: typing-extensions (>=4.7.1)
Requires-Dist: urllib3 (>=2.1.0,<3.0.0)
Project-URL: Repository, https://github.com/ionos-cloud/sdk-python
Description-Content-Type: text/markdown

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


This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.1.0
- Package version: 2.0.0-beta.1
- Generator version: 7.13.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.9+

## Installation & Usage
### pip install

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

```sh
pip install git+https://github.com/ionos-cloud/sdk-python.git
```
(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:
```python
import ionoscloud_object_storage_management
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
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
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import ionoscloud_object_storage_management
from ionoscloud_object_storage_management.rest import ApiException
from pprint import pprint
import os

# Defining the host is optional and defaults to https://s3.ionos.com
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud_object_storage_management.Configuration(
    host = "https://s3.ionos.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): tokenAuth
configuration = ionoscloud_object_storage_management.Configuration(
    token = os.environ["IONOS_TOKEN"]
)


# Enter a context with an instance of the API client
with ionoscloud_object_storage_management.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud_object_storage_management.AccesskeysApi(api_client)
    accesskey_id = 'fb68d39a-5706-51b4-b2b2-7b4bf9cbf0af' # str | The ID (UUID) of the AccessKey.

    try:
        # Delete AccessKey
        api_instance.accesskeys_delete(accesskey_id)
    except ApiException as e:
        print("Exception when calling AccesskeysApi->accesskeys_delete: %s\n" % e)

```

## Documentation for API Endpoints

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

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


## Documentation For Models

 - [AccessKey](docs/models/AccessKey.md)
 - [AccessKeyCreate](docs/models/AccessKeyCreate.md)
 - [AccessKeyEnsure](docs/models/AccessKeyEnsure.md)
 - [AccessKeyRead](docs/models/AccessKeyRead.md)
 - [AccessKeyReadList](docs/models/AccessKeyReadList.md)
 - [Bucket](docs/models/Bucket.md)
 - [BucketCreate](docs/models/BucketCreate.md)
 - [BucketEnsure](docs/models/BucketEnsure.md)
 - [BucketRead](docs/models/BucketRead.md)
 - [BucketReadList](docs/models/BucketReadList.md)
 - [Error](docs/models/Error.md)
 - [ErrorMessagesInner](docs/models/ErrorMessagesInner.md)
 - [Links](docs/models/Links.md)
 - [Metadata](docs/models/Metadata.md)
 - [MetadataWithStatus](docs/models/MetadataWithStatus.md)
 - [MetadataWithSupportedRegions](docs/models/MetadataWithSupportedRegions.md)
 - [Pagination](docs/models/Pagination.md)
 - [Region](docs/models/Region.md)
 - [RegionCapability](docs/models/RegionCapability.md)
 - [RegionCreate](docs/models/RegionCreate.md)
 - [RegionEnsure](docs/models/RegionEnsure.md)
 - [RegionRead](docs/models/RegionRead.md)
 - [RegionReadList](docs/models/RegionReadList.md)
 - [StorageClass](docs/models/StorageClass.md)
 - [StorageClassCreate](docs/models/StorageClassCreate.md)
 - [StorageClassEnsure](docs/models/StorageClassEnsure.md)
 - [StorageClassRead](docs/models/StorageClassRead.md)
 - [StorageClassReadList](docs/models/StorageClassReadList.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="tokenAuth"></a>
### tokenAuth

- **Type**: Bearer authentication (JWT)


## Author





