Metadata-Version: 2.4
Name: ionoscloud_vpn
Version: 1.0.0b1
Summary: IONOS Cloud VPN Gateway API
License: NoLicense
License-File: LICENSE
Keywords: OpenAPI,OpenAPI-Generator,IONOS Cloud VPN Gateway API
Author: IONOS Cloud Support
Author-email: support@cloud.ionos.com
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-vpn
The Managed VPN Gateway service provides secure and scalable connectivity, enabling encrypted communication between your IONOS cloud resources in a VDC and remote networks (on-premises, multi-cloud, private LANs in other VDCs etc).

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

- API version: 1.0.0
- Package version: 1.0.0-beta.1
- Generator version: 7.13.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://docs.ionos.com/support/general-information/contact-information](https://docs.ionos.com/support/general-information/contact-information)

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

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

### Tests

Execute `pytest` to run the tests.

## Getting Started

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

```python

import ionoscloud_vpn
from ionoscloud_vpn.rest import ApiException
from pprint import pprint
import os

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


# Enter a context with an instance of the API client
with ionoscloud_vpn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud_vpn.IPSecGatewaysApi(api_client)
    gateway_id = '66a114c7-2ddd-5119-9ddf-5a789f5a5a44' # str | The ID (UUID) of the IPSecGateway.

    try:
        # Delete IPSecGateway
        api_instance.ipsecgateways_delete(gateway_id)
    except ApiException as e:
        print("Exception when calling IPSecGatewaysApi->ipsecgateways_delete: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://vpn.de-fra.ionos.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*IPSecGatewaysApi* | [**ipsecgateways_delete**](docs/api/IPSecGatewaysApi.md#ipsecgateways_delete) | **DELETE** /ipsecgateways/{gatewayId} | Delete IPSecGateway
*IPSecGatewaysApi* | [**ipsecgateways_find_by_id**](docs/api/IPSecGatewaysApi.md#ipsecgateways_find_by_id) | **GET** /ipsecgateways/{gatewayId} | Retrieve IPSecGateway
*IPSecGatewaysApi* | [**ipsecgateways_get**](docs/api/IPSecGatewaysApi.md#ipsecgateways_get) | **GET** /ipsecgateways | Retrieve all IPSecGateways
*IPSecGatewaysApi* | [**ipsecgateways_post**](docs/api/IPSecGatewaysApi.md#ipsecgateways_post) | **POST** /ipsecgateways | Create IPSecGateway
*IPSecGatewaysApi* | [**ipsecgateways_put**](docs/api/IPSecGatewaysApi.md#ipsecgateways_put) | **PUT** /ipsecgateways/{gatewayId} | Ensure IPSecGateway
*IPSecTunnelsApi* | [**ipsecgateways_tunnels_delete**](docs/api/IPSecTunnelsApi.md#ipsecgateways_tunnels_delete) | **DELETE** /ipsecgateways/{gatewayId}/tunnels/{tunnelId} | Delete IPSecTunnel
*IPSecTunnelsApi* | [**ipsecgateways_tunnels_find_by_id**](docs/api/IPSecTunnelsApi.md#ipsecgateways_tunnels_find_by_id) | **GET** /ipsecgateways/{gatewayId}/tunnels/{tunnelId} | Retrieve IPSecTunnel
*IPSecTunnelsApi* | [**ipsecgateways_tunnels_get**](docs/api/IPSecTunnelsApi.md#ipsecgateways_tunnels_get) | **GET** /ipsecgateways/{gatewayId}/tunnels | Retrieve all IPSecTunnels
*IPSecTunnelsApi* | [**ipsecgateways_tunnels_post**](docs/api/IPSecTunnelsApi.md#ipsecgateways_tunnels_post) | **POST** /ipsecgateways/{gatewayId}/tunnels | Create IPSecTunnel
*IPSecTunnelsApi* | [**ipsecgateways_tunnels_put**](docs/api/IPSecTunnelsApi.md#ipsecgateways_tunnels_put) | **PUT** /ipsecgateways/{gatewayId}/tunnels/{tunnelId} | Ensure IPSecTunnel
*WireguardGatewaysApi* | [**wireguardgateways_delete**](docs/api/WireguardGatewaysApi.md#wireguardgateways_delete) | **DELETE** /wireguardgateways/{gatewayId} | Delete WireguardGateway
*WireguardGatewaysApi* | [**wireguardgateways_find_by_id**](docs/api/WireguardGatewaysApi.md#wireguardgateways_find_by_id) | **GET** /wireguardgateways/{gatewayId} | Retrieve WireguardGateway
*WireguardGatewaysApi* | [**wireguardgateways_get**](docs/api/WireguardGatewaysApi.md#wireguardgateways_get) | **GET** /wireguardgateways | Retrieve all WireguardGateways
*WireguardGatewaysApi* | [**wireguardgateways_post**](docs/api/WireguardGatewaysApi.md#wireguardgateways_post) | **POST** /wireguardgateways | Create WireguardGateway
*WireguardGatewaysApi* | [**wireguardgateways_put**](docs/api/WireguardGatewaysApi.md#wireguardgateways_put) | **PUT** /wireguardgateways/{gatewayId} | Ensure WireguardGateway
*WireguardPeersApi* | [**wireguardgateways_peers_delete**](docs/api/WireguardPeersApi.md#wireguardgateways_peers_delete) | **DELETE** /wireguardgateways/{gatewayId}/peers/{peerId} | Delete WireguardPeer
*WireguardPeersApi* | [**wireguardgateways_peers_find_by_id**](docs/api/WireguardPeersApi.md#wireguardgateways_peers_find_by_id) | **GET** /wireguardgateways/{gatewayId}/peers/{peerId} | Retrieve WireguardPeer
*WireguardPeersApi* | [**wireguardgateways_peers_get**](docs/api/WireguardPeersApi.md#wireguardgateways_peers_get) | **GET** /wireguardgateways/{gatewayId}/peers | Retrieve all WireguardPeers
*WireguardPeersApi* | [**wireguardgateways_peers_post**](docs/api/WireguardPeersApi.md#wireguardgateways_peers_post) | **POST** /wireguardgateways/{gatewayId}/peers | Create WireguardPeer
*WireguardPeersApi* | [**wireguardgateways_peers_put**](docs/api/WireguardPeersApi.md#wireguardgateways_peers_put) | **PUT** /wireguardgateways/{gatewayId}/peers/{peerId} | Ensure WireguardPeer


## Documentation For Models

 - [Connection](docs/models/Connection.md)
 - [DayOfTheWeek](docs/models/DayOfTheWeek.md)
 - [ESPEncryption](docs/models/ESPEncryption.md)
 - [Error](docs/models/Error.md)
 - [ErrorMessagesInner](docs/models/ErrorMessagesInner.md)
 - [IKEEncryption](docs/models/IKEEncryption.md)
 - [IPSecGateway](docs/models/IPSecGateway.md)
 - [IPSecGatewayCreate](docs/models/IPSecGatewayCreate.md)
 - [IPSecGatewayEnsure](docs/models/IPSecGatewayEnsure.md)
 - [IPSecGatewayMetadata](docs/models/IPSecGatewayMetadata.md)
 - [IPSecGatewayRead](docs/models/IPSecGatewayRead.md)
 - [IPSecGatewayReadList](docs/models/IPSecGatewayReadList.md)
 - [IPSecPSK](docs/models/IPSecPSK.md)
 - [IPSecTunnel](docs/models/IPSecTunnel.md)
 - [IPSecTunnelAuth](docs/models/IPSecTunnelAuth.md)
 - [IPSecTunnelCreate](docs/models/IPSecTunnelCreate.md)
 - [IPSecTunnelEnsure](docs/models/IPSecTunnelEnsure.md)
 - [IPSecTunnelMetadata](docs/models/IPSecTunnelMetadata.md)
 - [IPSecTunnelRead](docs/models/IPSecTunnelRead.md)
 - [IPSecTunnelReadList](docs/models/IPSecTunnelReadList.md)
 - [Links](docs/models/Links.md)
 - [MaintenanceWindow](docs/models/MaintenanceWindow.md)
 - [Metadata](docs/models/Metadata.md)
 - [Pagination](docs/models/Pagination.md)
 - [ResourceStatus](docs/models/ResourceStatus.md)
 - [WireguardEndpoint](docs/models/WireguardEndpoint.md)
 - [WireguardGateway](docs/models/WireguardGateway.md)
 - [WireguardGatewayCreate](docs/models/WireguardGatewayCreate.md)
 - [WireguardGatewayEnsure](docs/models/WireguardGatewayEnsure.md)
 - [WireguardGatewayMetadata](docs/models/WireguardGatewayMetadata.md)
 - [WireguardGatewayRead](docs/models/WireguardGatewayRead.md)
 - [WireguardGatewayReadList](docs/models/WireguardGatewayReadList.md)
 - [WireguardPeer](docs/models/WireguardPeer.md)
 - [WireguardPeerCreate](docs/models/WireguardPeerCreate.md)
 - [WireguardPeerEnsure](docs/models/WireguardPeerEnsure.md)
 - [WireguardPeerMetadata](docs/models/WireguardPeerMetadata.md)
 - [WireguardPeerRead](docs/models/WireguardPeerRead.md)
 - [WireguardPeerReadList](docs/models/WireguardPeerReadList.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

support@cloud.ionos.com



