Skip to content

Commit 2fe653c

Browse files
ionoscloudsdkionoscloudsdk
committed
auto-generated version 1.0.0
1 parent 368b1fb commit 2fe653c

File tree

112 files changed

+8883
-183
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

112 files changed

+8883
-183
lines changed

‎README.md

Lines changed: 49 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
![CI](https://github.com/ionos-cloud/sdk-resources/workflows/[%20CI%20]%20DNS%20/%20Python/badge.svg)
21
[![Gitter](https://img.shields.io/gitter/room/ionos-cloud/sdk-general)](https://gitter.im/ionos-cloud/sdk-general)
32
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=sdk-python-dns&metric=alert_status)](https://sonarcloud.io/summary?id=sdk-python-dns)
43
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=sdk-python-dns&metric=bugs)](https://sonarcloud.io/summary/new_code?id=sdk-python-dns)
@@ -15,7 +14,7 @@
1514

1615
# Python API client for ionoscloud_dns
1716

18-
DNS API Specification
17+
Cloud DNS service helps IONOS Cloud customers to automate DNS Zone and Record management.
1918

2019

2120
## Overview
@@ -137,12 +136,26 @@ All URIs are relative to *https://dns.de-fra.ionos.com*
137136

138137
| Class | Method | HTTP request | Description |
139138
| ------------- | ------------- | ------------- | ------------- |
140-
| RecordsApi | [**records_get**](docs/api/RecordsApi.md#records_get) | **GET** /records | Retrieve all records |
139+
| DNSSECApi | [**zones_keys_delete**](docs/api/DNSSECApi.md#zones_keys_delete) | **DELETE** /zones/{zoneId}/keys | Delete a DNSSEC key |
140+
| DNSSECApi | [**zones_keys_get**](docs/api/DNSSECApi.md#zones_keys_get) | **GET** /zones/{zoneId}/keys | Retrieve a DNSSEC key |
141+
| DNSSECApi | [**zones_keys_post**](docs/api/DNSSECApi.md#zones_keys_post) | **POST** /zones/{zoneId}/keys | Create a DNSSEC key |
142+
| QuotaApi | [**quota_get**](docs/api/QuotaApi.md#quota_get) | **GET** /quota | Retrieve resources quota |
143+
| RecordsApi | [**records_get**](docs/api/RecordsApi.md#records_get) | **GET** /records | Retrieve all records from primary zones |
144+
| RecordsApi | [**secondaryzones_records_get**](docs/api/RecordsApi.md#secondaryzones_records_get) | **GET** /secondaryzones/{secondaryZoneId}/records | Retrieve records for a secondary zone |
141145
| RecordsApi | [**zones_records_delete**](docs/api/RecordsApi.md#zones_records_delete) | **DELETE** /zones/{zoneId}/records/{recordId} | Delete a record |
142146
| RecordsApi | [**zones_records_find_by_id**](docs/api/RecordsApi.md#zones_records_find_by_id) | **GET** /zones/{zoneId}/records/{recordId} | Retrieve a record |
143147
| RecordsApi | [**zones_records_get**](docs/api/RecordsApi.md#zones_records_get) | **GET** /zones/{zoneId}/records | Retrieve records |
144148
| RecordsApi | [**zones_records_post**](docs/api/RecordsApi.md#zones_records_post) | **POST** /zones/{zoneId}/records | Create a record |
145149
| RecordsApi | [**zones_records_put**](docs/api/RecordsApi.md#zones_records_put) | **PUT** /zones/{zoneId}/records/{recordId} | Ensure a record |
150+
| SecondaryZonesApi | [**secondaryzones_axfr_get**](docs/api/SecondaryZonesApi.md#secondaryzones_axfr_get) | **GET** /secondaryzones/{secondaryZoneId}/axfr | Get status of zone transfer |
151+
| SecondaryZonesApi | [**secondaryzones_axfr_put**](docs/api/SecondaryZonesApi.md#secondaryzones_axfr_put) | **PUT** /secondaryzones/{secondaryZoneId}/axfr | Start zone transfer |
152+
| SecondaryZonesApi | [**secondaryzones_delete**](docs/api/SecondaryZonesApi.md#secondaryzones_delete) | **DELETE** /secondaryzones/{secondaryZoneId} | Delete a secondary zone |
153+
| SecondaryZonesApi | [**secondaryzones_find_by_id**](docs/api/SecondaryZonesApi.md#secondaryzones_find_by_id) | **GET** /secondaryzones/{secondaryZoneId} | Retrieve a secondary zone |
154+
| SecondaryZonesApi | [**secondaryzones_get**](docs/api/SecondaryZonesApi.md#secondaryzones_get) | **GET** /secondaryzones | Retrieve secondary zones |
155+
| SecondaryZonesApi | [**secondaryzones_post**](docs/api/SecondaryZonesApi.md#secondaryzones_post) | **POST** /secondaryzones | Create a secondary zone |
156+
| SecondaryZonesApi | [**secondaryzones_put**](docs/api/SecondaryZonesApi.md#secondaryzones_put) | **PUT** /secondaryzones/{secondaryZoneId} | Ensure a secondary zone |
157+
| ZoneFilesApi | [**zones_zonefile_get**](docs/api/ZoneFilesApi.md#zones_zonefile_get) | **GET** /zones/{zoneId}/zonefile | Retrieve a zone file |
158+
| ZoneFilesApi | [**zones_zonefile_put**](docs/api/ZoneFilesApi.md#zones_zonefile_put) | **PUT** /zones/{zoneId}/zonefile | Updates a zone with a file |
146159
| ZonesApi | [**zones_delete**](docs/api/ZonesApi.md#zones_delete) | **DELETE** /zones/{zoneId} | Delete a zone |
147160
| ZonesApi | [**zones_find_by_id**](docs/api/ZonesApi.md#zones_find_by_id) | **GET** /zones/{zoneId} | Retrieve a zone |
148161
| ZonesApi | [**zones_get**](docs/api/ZonesApi.md#zones_get) | **GET** /zones | Retrieve zones |
@@ -157,25 +170,58 @@ All URIs are relative to *https://dns.de-fra.ionos.com*
157170
<details >
158171
<summary title="Click to toggle">API models list</summary>
159172

173+
- [Algorithm](docs/models/Algorithm)
174+
- [CommonZone](docs/models/CommonZone)
175+
- [CommonZoneRead](docs/models/CommonZoneRead)
176+
- [CommonZoneReadList](docs/models/CommonZoneReadList)
177+
- [DnssecKey](docs/models/DnssecKey)
178+
- [DnssecKeyCreate](docs/models/DnssecKeyCreate)
179+
- [DnssecKeyParameters](docs/models/DnssecKeyParameters)
180+
- [DnssecKeyReadList](docs/models/DnssecKeyReadList)
181+
- [DnssecKeyReadListMetadata](docs/models/DnssecKeyReadListMetadata)
160182
- [Error](docs/models/Error)
161183
- [ErrorMessages](docs/models/ErrorMessages)
184+
- [KeyData](docs/models/KeyData)
185+
- [KeyParameters](docs/models/KeyParameters)
186+
- [KskBits](docs/models/KskBits)
162187
- [Links](docs/models/Links)
163188
- [Metadata](docs/models/Metadata)
189+
- [MetadataForSecondaryZoneRecords](docs/models/MetadataForSecondaryZoneRecords)
164190
- [MetadataWithStateFqdnZoneId](docs/models/MetadataWithStateFqdnZoneId)
165191
- [MetadataWithStateFqdnZoneIdAllOf](docs/models/MetadataWithStateFqdnZoneIdAllOf)
166192
- [MetadataWithStateNameservers](docs/models/MetadataWithStateNameservers)
167193
- [MetadataWithStateNameserversAllOf](docs/models/MetadataWithStateNameserversAllOf)
194+
- [NsecParameters](docs/models/NsecParameters)
168195
- [ProvisioningState](docs/models/ProvisioningState)
196+
- [Quota](docs/models/Quota)
197+
- [QuotaDetail](docs/models/QuotaDetail)
169198
- [Record](docs/models/Record)
170199
- [RecordCreate](docs/models/RecordCreate)
171200
- [RecordEnsure](docs/models/RecordEnsure)
172201
- [RecordRead](docs/models/RecordRead)
173202
- [RecordReadList](docs/models/RecordReadList)
203+
- [SecondaryZone](docs/models/SecondaryZone)
204+
- [SecondaryZoneAllOf](docs/models/SecondaryZoneAllOf)
205+
- [SecondaryZoneCreate](docs/models/SecondaryZoneCreate)
206+
- [SecondaryZoneEnsure](docs/models/SecondaryZoneEnsure)
207+
- [SecondaryZoneRead](docs/models/SecondaryZoneRead)
208+
- [SecondaryZoneReadAllOf](docs/models/SecondaryZoneReadAllOf)
209+
- [SecondaryZoneReadList](docs/models/SecondaryZoneReadList)
210+
- [SecondaryZoneReadListAllOf](docs/models/SecondaryZoneReadListAllOf)
211+
- [SecondaryZoneRecordRead](docs/models/SecondaryZoneRecordRead)
212+
- [SecondaryZoneRecordReadList](docs/models/SecondaryZoneRecordReadList)
213+
- [SecondaryZoneRecordReadListMetadata](docs/models/SecondaryZoneRecordReadListMetadata)
174214
- [Zone](docs/models/Zone)
215+
- [ZoneAllOf](docs/models/ZoneAllOf)
175216
- [ZoneCreate](docs/models/ZoneCreate)
176217
- [ZoneEnsure](docs/models/ZoneEnsure)
177218
- [ZoneRead](docs/models/ZoneRead)
219+
- [ZoneReadAllOf](docs/models/ZoneReadAllOf)
178220
- [ZoneReadList](docs/models/ZoneReadList)
221+
- [ZoneReadListAllOf](docs/models/ZoneReadListAllOf)
222+
- [ZoneTransferPrimaryIpStatus](docs/models/ZoneTransferPrimaryIpStatus)
223+
- [ZoneTransferPrimaryIpsStatus](docs/models/ZoneTransferPrimaryIpsStatus)
224+
- [ZskBits](docs/models/ZskBits)
179225

180226

181227
[[Back to API list]](#documentation-for-api-endpoints) [[Back to Model list]](#documentation-for-models)

‎docs/api/DNSSECApi.md

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
# DNSSECApi
2+
3+
All URIs are relative to *https://dns.de-fra.ionos.com*
4+
5+
| Method | HTTP request | Description |
6+
| ------------- | ------------- | ------------- |
7+
| [**zones_keys_delete**](DNSSECApi.md#zones_keys_delete) | **DELETE** /zones/{zoneId}/keys | Delete a DNSSEC key |
8+
| [**zones_keys_get**](DNSSECApi.md#zones_keys_get) | **GET** /zones/{zoneId}/keys | Retrieve a DNSSEC key |
9+
| [**zones_keys_post**](DNSSECApi.md#zones_keys_post) | **POST** /zones/{zoneId}/keys | Create a DNSSEC key |
10+
11+
12+
# **zones_keys_delete**
13+
> object zones_keys_delete(zone_id)
14+
15+
Delete a DNSSEC key
16+
17+
Disable DNSSEC keys and remove associated DNSKEY records for your DNS zone.
18+
19+
### Example
20+
21+
### Parameters
22+
23+
| Name | Type | Description | Notes |
24+
| ------------- | ------------- | ------------- | ------------- |
25+
| **zone_id** | **str**| The ID (UUID) of the DNS zone. | |
26+
27+
### Return type
28+
29+
**object**
30+
31+
### Authorization
32+
33+
tokenAuth
34+
35+
### HTTP request headers
36+
37+
- **Content-Type**: Not defined
38+
- **Accept**: application/json
39+
40+
# **zones_keys_get**
41+
> DnssecKeyReadList zones_keys_get(zone_id)
42+
43+
Retrieve a DNSSEC key
44+
45+
Get DNSSEC keys for your DNS zone.
46+
47+
### Example
48+
49+
### Parameters
50+
51+
| Name | Type | Description | Notes |
52+
| ------------- | ------------- | ------------- | ------------- |
53+
| **zone_id** | **str**| The ID (UUID) of the DNS zone. | |
54+
55+
### Return type
56+
57+
[**DnssecKeyReadList**](../models/DnssecKeyReadList.md)
58+
59+
### Authorization
60+
61+
tokenAuth
62+
63+
### HTTP request headers
64+
65+
- **Content-Type**: Not defined
66+
- **Accept**: application/json
67+
68+
# **zones_keys_post**
69+
> object zones_keys_post(zone_id, dnssec_key_create)
70+
71+
Create a DNSSEC key
72+
73+
Enable DNSSEC keys and create associated DNSKEY records for your DNS zone.
74+
75+
### Example
76+
77+
### Parameters
78+
79+
| Name | Type | Description | Notes |
80+
| ------------- | ------------- | ------------- | ------------- |
81+
| **zone_id** | **str**| The ID (UUID) of the DNS zone. | |
82+
| **dnssec_key_create** | [**DnssecKeyCreate**](../models/DnssecKeyCreate.md)| Enable DNSSEC request. | |
83+
84+
### Return type
85+
86+
**object**
87+
88+
### Authorization
89+
90+
tokenAuth
91+
92+
### HTTP request headers
93+
94+
- **Content-Type**: application/json
95+
- **Accept**: application/json
96+

‎docs/api/QuotaApi.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# QuotaApi
2+
3+
All URIs are relative to *https://dns.de-fra.ionos.com*
4+
5+
| Method | HTTP request | Description |
6+
| ------------- | ------------- | ------------- |
7+
| [**quota_get**](QuotaApi.md#quota_get) | **GET** /quota | Retrieve resources quota |
8+
9+
10+
# **quota_get**
11+
> Quota quota_get()
12+
13+
Retrieve resources quota
14+
15+
Get quota details for zones, secondary zones, and records.
16+
17+
### Example
18+
19+
### Parameters
20+
This endpoint does not need any parameter.
21+
22+
### Return type
23+
24+
[**Quota**](../models/Quota.md)
25+
26+
### Authorization
27+
28+
tokenAuth
29+
30+
### HTTP request headers
31+
32+
- **Content-Type**: Not defined
33+
- **Accept**: application/json
34+

‎docs/api/RecordsApi.md

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ All URIs are relative to *https://dns.de-fra.ionos.com*
44

55
| Method | HTTP request | Description |
66
| ------------- | ------------- | ------------- |
7-
| [**records_get**](RecordsApi.md#records_get) | **GET** /records | Retrieve all records |
7+
| [**records_get**](RecordsApi.md#records_get) | **GET** /records | Retrieve all records from primary zones |
8+
| [**secondaryzones_records_get**](RecordsApi.md#secondaryzones_records_get) | **GET** /secondaryzones/{secondaryZoneId}/records | Retrieve records for a secondary zone |
89
| [**zones_records_delete**](RecordsApi.md#zones_records_delete) | **DELETE** /zones/{zoneId}/records/{recordId} | Delete a record |
910
| [**zones_records_find_by_id**](RecordsApi.md#zones_records_find_by_id) | **GET** /zones/{zoneId}/records/{recordId} | Retrieve a record |
1011
| [**zones_records_get**](RecordsApi.md#zones_records_get) | **GET** /zones/{zoneId}/records | Retrieve records |
@@ -15,7 +16,7 @@ All URIs are relative to *https://dns.de-fra.ionos.com*
1516
# **records_get**
1617
> RecordReadList records_get(filter_zone_id=filter_zone_id, filter_name=filter_name, filter_state=filter_state, offset=offset, limit=limit)
1718
18-
Retrieve all records
19+
Retrieve all records from primary zones
1920

2021
Returns the list of all records for all customer DNS zones with the possibility to filter them.
2122

@@ -39,13 +40,43 @@ Returns the list of all records for all customer DNS zones with the possibility
3940

4041
tokenAuth
4142

43+
### HTTP request headers
44+
45+
- **Content-Type**: Not defined
46+
- **Accept**: application/json
47+
48+
# **secondaryzones_records_get**
49+
> SecondaryZoneRecordReadList secondaryzones_records_get(secondary_zone_id, offset=offset, limit=limit)
50+
51+
Retrieve records for a secondary zone
52+
53+
Returns the list of records for a secondary zone. Those are the records created for its primary IPs
54+
55+
### Example
56+
57+
### Parameters
58+
59+
| Name | Type | Description | Notes |
60+
| ------------- | ------------- | ------------- | ------------- |
61+
| **secondary_zone_id** | **str**| The ID (UUID) of the DNS secondary zone. | |
62+
| **offset** | **int**| The first element (of the total list of elements) to include in the response. Use together with limit for pagination. | [optional] [default to 0] |
63+
| **limit** | **int**| The maximum number of elements to return. Use together with offset for pagination. | [optional] [default to 100] |
64+
65+
### Return type
66+
67+
[**SecondaryZoneRecordReadList**](../models/SecondaryZoneRecordReadList.md)
68+
69+
### Authorization
70+
71+
tokenAuth
72+
4273
### HTTP request headers
4374

4475
- **Content-Type**: Not defined
4576
- **Accept**: application/json
4677

4778
# **zones_records_delete**
48-
> zones_records_delete(zone_id, record_id)
79+
> object zones_records_delete(zone_id, record_id)
4980
5081
Delete a record
5182

@@ -62,7 +93,7 @@ Deletes a specified record from the DNS zone.
6293

6394
### Return type
6495

65-
void (empty response body)
96+
**object**
6697

6798
### Authorization
6899

0 commit comments

Comments
 (0)