ionoscloud-api-gateway 1.0.1

IONOS Cloud - API Gateway

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

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:

import ionoscloud_api_gateway

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_api_gateway

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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	DELETE /gateways/{apigatewayId}	Delete Gateway
APIGatewaysApi	apigateways_find_by_id	GET /gateways/{apigatewayId}	Retrieve Gateway
APIGatewaysApi	apigateways_get	GET /gateways	Retrieve all Apigateways
APIGatewaysApi	apigateways_post	POST /gateways	Create Gateway
APIGatewaysApi	apigateways_put	PUT /gateways/{apigatewayId}	Ensure Gateway
RoutesApi	apigateways_routes_delete	DELETE /gateways/{apigatewayId}/routes/{routeId}	Delete Route
RoutesApi	apigateways_routes_find_by_id	GET /gateways/{apigatewayId}/routes/{routeId}	Retrieve Route
RoutesApi	apigateways_routes_get	GET /gateways/{apigatewayId}/routes	Retrieve all Routes
RoutesApi	apigateways_routes_post	POST /gateways/{apigatewayId}/routes	Create Route
RoutesApi	apigateways_routes_put	PUT /gateways/{apigatewayId}/routes/{routeId}	Ensure Route

Documentation For Models

• Error
• ErrorMessagesInner
• Gateway
• GatewayCreate
• GatewayCustomDomainsInner
• GatewayEnsure
• GatewayRead
• GatewayReadList
• Links
• Metadata
• MetadataWithEndpoint
• MetadataWithStatus
• Pagination
• Route
• RouteCreate
• RouteEnsure
• RouteRead
• RouteReadList
• RouteUpstreamsInner

Documentation For Authorization

Authentication schemes defined for the API:

tokenAuth

• Type: Bearer authentication (JWT)

Author