Metadata-Version: 2.4
Name: ionoscloud_api_gateway
Version: 1.0.1
Summary: IONOS Cloud - API Gateway
License: NoLicense
License-File: LICENSE
Keywords: OpenAPI,OpenAPI-Generator,IONOS Cloud - API Gateway
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-api-gateway
API Gateway is an application that acts as a \"front door\" for backend services and APIs, handling client requests and routing them to the appropriate backend.


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

- API version: 0.0.1
- Package version: 1.0.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_api_gateway
```

### 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_api_gateway
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

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

```python

import ionoscloud_api_gateway
from ionoscloud_api_gateway.rest import ApiException
from pprint import pprint
import os

# Defining the host is optional and defaults to https://apigateway.de-txl.ionos.com
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud_api_gateway.Configuration(
    host = "https://apigateway.de-txl.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_api_gateway.Configuration(
    token = os.environ["IONOS_TOKEN"]
)


# Enter a context with an instance of the API client
with ionoscloud_api_gateway.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud_api_gateway.APIGatewaysApi(api_client)
    apigateway_id = '0620c174-dd3c-5eb4-87c8-e2b516553a00' # str | The ID (UUID) of the Gateway.

    try:
        # Delete Gateway
        api_instance.apigateways_delete(apigateway_id)
    except ApiException as e:
        print("Exception when calling APIGatewaysApi->apigateways_delete: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://apigateway.de-txl.ionos.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*APIGatewaysApi* | [**apigateways_delete**](docs/api/APIGatewaysApi.md#apigateways_delete) | **DELETE** /gateways/{apigatewayId} | Delete Gateway
*APIGatewaysApi* | [**apigateways_find_by_id**](docs/api/APIGatewaysApi.md#apigateways_find_by_id) | **GET** /gateways/{apigatewayId} | Retrieve Gateway
*APIGatewaysApi* | [**apigateways_get**](docs/api/APIGatewaysApi.md#apigateways_get) | **GET** /gateways | Retrieve all Apigateways
*APIGatewaysApi* | [**apigateways_post**](docs/api/APIGatewaysApi.md#apigateways_post) | **POST** /gateways | Create Gateway
*APIGatewaysApi* | [**apigateways_put**](docs/api/APIGatewaysApi.md#apigateways_put) | **PUT** /gateways/{apigatewayId} | Ensure Gateway
*RoutesApi* | [**apigateways_routes_delete**](docs/api/RoutesApi.md#apigateways_routes_delete) | **DELETE** /gateways/{apigatewayId}/routes/{routeId} | Delete Route
*RoutesApi* | [**apigateways_routes_find_by_id**](docs/api/RoutesApi.md#apigateways_routes_find_by_id) | **GET** /gateways/{apigatewayId}/routes/{routeId} | Retrieve Route
*RoutesApi* | [**apigateways_routes_get**](docs/api/RoutesApi.md#apigateways_routes_get) | **GET** /gateways/{apigatewayId}/routes | Retrieve all Routes
*RoutesApi* | [**apigateways_routes_post**](docs/api/RoutesApi.md#apigateways_routes_post) | **POST** /gateways/{apigatewayId}/routes | Create Route
*RoutesApi* | [**apigateways_routes_put**](docs/api/RoutesApi.md#apigateways_routes_put) | **PUT** /gateways/{apigatewayId}/routes/{routeId} | Ensure Route


## Documentation For Models

 - [Error](docs/models/Error.md)
 - [ErrorMessagesInner](docs/models/ErrorMessagesInner.md)
 - [Gateway](docs/models/Gateway.md)
 - [GatewayCreate](docs/models/GatewayCreate.md)
 - [GatewayCustomDomainsInner](docs/models/GatewayCustomDomainsInner.md)
 - [GatewayEnsure](docs/models/GatewayEnsure.md)
 - [GatewayRead](docs/models/GatewayRead.md)
 - [GatewayReadList](docs/models/GatewayReadList.md)
 - [Links](docs/models/Links.md)
 - [Metadata](docs/models/Metadata.md)
 - [MetadataWithEndpoint](docs/models/MetadataWithEndpoint.md)
 - [MetadataWithStatus](docs/models/MetadataWithStatus.md)
 - [Pagination](docs/models/Pagination.md)
 - [Route](docs/models/Route.md)
 - [RouteCreate](docs/models/RouteCreate.md)
 - [RouteEnsure](docs/models/RouteEnsure.md)
 - [RouteRead](docs/models/RouteRead.md)
 - [RouteReadList](docs/models/RouteReadList.md)
 - [RouteUpstreamsInner](docs/models/RouteUpstreamsInner.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





