ionoscloud-cert-manager 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/Gemfile.lock +70 -0
- data/LICENSE +201 -0
- data/README.md +2 -0
- data/Rakefile +10 -0
- data/docs/api/CertificatesApi.md +392 -0
- data/docs/api/InformationApi.md +226 -0
- data/docs/models/ApiInfoDto.md +21 -0
- data/docs/models/CertificateCollectionDto.md +29 -0
- data/docs/models/CertificateCollectionDtoLinks.md +21 -0
- data/docs/models/CertificateDto.md +25 -0
- data/docs/models/CertificatePatchDto.md +17 -0
- data/docs/models/CertificatePatchPropertiesDto.md +17 -0
- data/docs/models/CertificatePostDto.md +17 -0
- data/docs/models/CertificatePostPropertiesDto.md +23 -0
- data/docs/models/CertificatePropertiesDto.md +21 -0
- data/docs/models/ConfigPropertyDto.md +23 -0
- data/docs/models/ResourceMetadataDto.md +31 -0
- data/docs/summary.md +23 -0
- data/git_push.sh +56 -0
- data/ionoscloud-cert-manager.gemspec +38 -0
- data/lib/ionoscloud-cert-manager/api/certificates_api.rb +345 -0
- data/lib/ionoscloud-cert-manager/api/information_api.rb +193 -0
- data/lib/ionoscloud-cert-manager/api_client.rb +471 -0
- data/lib/ionoscloud-cert-manager/api_error.rb +57 -0
- data/lib/ionoscloud-cert-manager/configuration.rb +276 -0
- data/lib/ionoscloud-cert-manager/models/api_info_dto.rb +263 -0
- data/lib/ionoscloud-cert-manager/models/certificate_collection_dto.rb +334 -0
- data/lib/ionoscloud-cert-manager/models/certificate_collection_dto_links.rb +262 -0
- data/lib/ionoscloud-cert-manager/models/certificate_dto.rb +297 -0
- data/lib/ionoscloud-cert-manager/models/certificate_patch_dto.rb +231 -0
- data/lib/ionoscloud-cert-manager/models/certificate_patch_properties_dto.rb +231 -0
- data/lib/ionoscloud-cert-manager/models/certificate_post_dto.rb +231 -0
- data/lib/ionoscloud-cert-manager/models/certificate_post_properties_dto.rb +300 -0
- data/lib/ionoscloud-cert-manager/models/certificate_properties_dto.rb +262 -0
- data/lib/ionoscloud-cert-manager/models/config_property_dto.rb +295 -0
- data/lib/ionoscloud-cert-manager/models/resource_metadata_dto.rb +353 -0
- data/lib/ionoscloud-cert-manager/version.rb +15 -0
- data/lib/ionoscloud-cert-manager.rb +52 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/spec_helper.rb +111 -0
- metadata +132 -0
@@ -0,0 +1,392 @@
|
|
1
|
+
# CertificatesApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.ionos.com*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**certificates_delete**](CertificatesApi.md#certificates_delete) | **DELETE** /certificatemanager/certificates/{certificateId} | Delete a Certificate by ID |
|
8
|
+
| [**certificates_get**](CertificatesApi.md#certificates_get) | **GET** /certificatemanager/certificates | Get Certificates |
|
9
|
+
| [**certificates_get_by_id**](CertificatesApi.md#certificates_get_by_id) | **GET** /certificatemanager/certificates/{certificateId} | Get a Certificate by ID |
|
10
|
+
| [**certificates_patch**](CertificatesApi.md#certificates_patch) | **PATCH** /certificatemanager/certificates/{certificateId} | Update a Certificate Name by ID |
|
11
|
+
| [**certificates_post**](CertificatesApi.md#certificates_post) | **POST** /certificatemanager/certificates | Add a New Certificate |
|
12
|
+
|
13
|
+
|
14
|
+
## certificates_delete
|
15
|
+
|
16
|
+
> certificates_delete(certificate_id)
|
17
|
+
|
18
|
+
Delete a Certificate by ID
|
19
|
+
|
20
|
+
Deletes a certificate specified by its ID.
|
21
|
+
|
22
|
+
### Examples
|
23
|
+
|
24
|
+
```ruby
|
25
|
+
require 'time'
|
26
|
+
require 'ionoscloud-cert-manager'
|
27
|
+
# setup authorization
|
28
|
+
IonoscloudCertManager.configure do |config|
|
29
|
+
# Configure HTTP basic authorization: basicAuth
|
30
|
+
config.username = 'YOUR USERNAME'
|
31
|
+
config.password = 'YOUR PASSWORD'
|
32
|
+
|
33
|
+
# Configure API key authorization: tokenAuth
|
34
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
35
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
36
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
37
|
+
end
|
38
|
+
|
39
|
+
api_instance = IonoscloudCertManager::CertificatesApi.new
|
40
|
+
certificate_id = 'certificate_id_example' # String |
|
41
|
+
|
42
|
+
begin
|
43
|
+
# Delete a Certificate by ID
|
44
|
+
api_instance.certificates_delete(certificate_id)
|
45
|
+
rescue IonoscloudCertManager::ApiError => e
|
46
|
+
puts "Error when calling CertificatesApi->certificates_delete: #{e}"
|
47
|
+
end
|
48
|
+
```
|
49
|
+
|
50
|
+
#### Using the certificates_delete_with_http_info variant
|
51
|
+
|
52
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
53
|
+
|
54
|
+
> <Array(nil, Integer, Hash)> certificates_delete_with_http_info(certificate_id)
|
55
|
+
|
56
|
+
```ruby
|
57
|
+
begin
|
58
|
+
# Delete a Certificate by ID
|
59
|
+
data, status_code, headers = api_instance.certificates_delete_with_http_info(certificate_id)
|
60
|
+
p status_code # => 2xx
|
61
|
+
p headers # => { ... }
|
62
|
+
p data # => nil
|
63
|
+
rescue IonoscloudCertManager::ApiError => e
|
64
|
+
puts "Error when calling CertificatesApi->certificates_delete_with_http_info: #{e}"
|
65
|
+
end
|
66
|
+
```
|
67
|
+
|
68
|
+
### Parameters
|
69
|
+
|
70
|
+
| Name | Type | Description | Notes |
|
71
|
+
| ---- | ---- | ----------- | ----- |
|
72
|
+
| **certificate_id** | **String** | | |
|
73
|
+
|
74
|
+
### Return type
|
75
|
+
|
76
|
+
nil (empty response body)
|
77
|
+
|
78
|
+
### Authorization
|
79
|
+
|
80
|
+
basicAuth, tokenAuth
|
81
|
+
|
82
|
+
### HTTP request headers
|
83
|
+
|
84
|
+
- **Content-Type**: Not defined
|
85
|
+
- **Accept**: Not defined
|
86
|
+
|
87
|
+
|
88
|
+
## certificates_get
|
89
|
+
|
90
|
+
> <CertificateCollectionDto> certificates_get(opts)
|
91
|
+
|
92
|
+
Get Certificates
|
93
|
+
|
94
|
+
Retrieves all available certificates.
|
95
|
+
|
96
|
+
### Examples
|
97
|
+
|
98
|
+
```ruby
|
99
|
+
require 'time'
|
100
|
+
require 'ionoscloud-cert-manager'
|
101
|
+
# setup authorization
|
102
|
+
IonoscloudCertManager.configure do |config|
|
103
|
+
# Configure HTTP basic authorization: basicAuth
|
104
|
+
config.username = 'YOUR USERNAME'
|
105
|
+
config.password = 'YOUR PASSWORD'
|
106
|
+
|
107
|
+
# Configure API key authorization: tokenAuth
|
108
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
109
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
110
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
111
|
+
end
|
112
|
+
|
113
|
+
api_instance = IonoscloudCertManager::CertificatesApi.new
|
114
|
+
opts = {
|
115
|
+
offset: 'offset_example', # String | 'Limit' and 'Offset' are optional; you can use these filter parameters to retrieve only part of the results obtained by a request. Offset is the first element (from the complete list of elements) to be included in the response.
|
116
|
+
limit: 'limit_example' # String | 'Limit' and 'Offset' are optional; you can use these filter parameters to retrieve only part of the results of a query. If both 'Offset' and 'Limit'are specified, the offset lines are skipped before counting the returned limit lines.
|
117
|
+
}
|
118
|
+
|
119
|
+
begin
|
120
|
+
# Get Certificates
|
121
|
+
result = api_instance.certificates_get(opts)
|
122
|
+
p result
|
123
|
+
rescue IonoscloudCertManager::ApiError => e
|
124
|
+
puts "Error when calling CertificatesApi->certificates_get: #{e}"
|
125
|
+
end
|
126
|
+
```
|
127
|
+
|
128
|
+
#### Using the certificates_get_with_http_info variant
|
129
|
+
|
130
|
+
This returns an Array which contains the response data, status code and headers.
|
131
|
+
|
132
|
+
> <Array(<CertificateCollectionDto>, Integer, Hash)> certificates_get_with_http_info(opts)
|
133
|
+
|
134
|
+
```ruby
|
135
|
+
begin
|
136
|
+
# Get Certificates
|
137
|
+
data, status_code, headers = api_instance.certificates_get_with_http_info(opts)
|
138
|
+
p status_code # => 2xx
|
139
|
+
p headers # => { ... }
|
140
|
+
p data # => <CertificateCollectionDto>
|
141
|
+
rescue IonoscloudCertManager::ApiError => e
|
142
|
+
puts "Error when calling CertificatesApi->certificates_get_with_http_info: #{e}"
|
143
|
+
end
|
144
|
+
```
|
145
|
+
|
146
|
+
### Parameters
|
147
|
+
|
148
|
+
| Name | Type | Description | Notes |
|
149
|
+
| ---- | ---- | ----------- | ----- |
|
150
|
+
| **offset** | **String** | 'Limit' and 'Offset' are optional; you can use these filter parameters to retrieve only part of the results obtained by a request. Offset is the first element (from the complete list of elements) to be included in the response. | [optional] |
|
151
|
+
| **limit** | **String** | 'Limit' and 'Offset' are optional; you can use these filter parameters to retrieve only part of the results of a query. If both 'Offset' and 'Limit'are specified, the offset lines are skipped before counting the returned limit lines. | [optional] |
|
152
|
+
|
153
|
+
### Return type
|
154
|
+
|
155
|
+
[**CertificateCollectionDto**](CertificateCollectionDto.md)
|
156
|
+
|
157
|
+
### Authorization
|
158
|
+
|
159
|
+
basicAuth, tokenAuth
|
160
|
+
|
161
|
+
### HTTP request headers
|
162
|
+
|
163
|
+
- **Content-Type**: Not defined
|
164
|
+
- **Accept**: application/json
|
165
|
+
|
166
|
+
|
167
|
+
## certificates_get_by_id
|
168
|
+
|
169
|
+
> <CertificateDto> certificates_get_by_id(certificate_id)
|
170
|
+
|
171
|
+
Get a Certificate by ID
|
172
|
+
|
173
|
+
Retrieves a certificate specified by its ID.
|
174
|
+
|
175
|
+
### Examples
|
176
|
+
|
177
|
+
```ruby
|
178
|
+
require 'time'
|
179
|
+
require 'ionoscloud-cert-manager'
|
180
|
+
# setup authorization
|
181
|
+
IonoscloudCertManager.configure do |config|
|
182
|
+
# Configure HTTP basic authorization: basicAuth
|
183
|
+
config.username = 'YOUR USERNAME'
|
184
|
+
config.password = 'YOUR PASSWORD'
|
185
|
+
|
186
|
+
# Configure API key authorization: tokenAuth
|
187
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
188
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
189
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
190
|
+
end
|
191
|
+
|
192
|
+
api_instance = IonoscloudCertManager::CertificatesApi.new
|
193
|
+
certificate_id = 'certificate_id_example' # String |
|
194
|
+
|
195
|
+
begin
|
196
|
+
# Get a Certificate by ID
|
197
|
+
result = api_instance.certificates_get_by_id(certificate_id)
|
198
|
+
p result
|
199
|
+
rescue IonoscloudCertManager::ApiError => e
|
200
|
+
puts "Error when calling CertificatesApi->certificates_get_by_id: #{e}"
|
201
|
+
end
|
202
|
+
```
|
203
|
+
|
204
|
+
#### Using the certificates_get_by_id_with_http_info variant
|
205
|
+
|
206
|
+
This returns an Array which contains the response data, status code and headers.
|
207
|
+
|
208
|
+
> <Array(<CertificateDto>, Integer, Hash)> certificates_get_by_id_with_http_info(certificate_id)
|
209
|
+
|
210
|
+
```ruby
|
211
|
+
begin
|
212
|
+
# Get a Certificate by ID
|
213
|
+
data, status_code, headers = api_instance.certificates_get_by_id_with_http_info(certificate_id)
|
214
|
+
p status_code # => 2xx
|
215
|
+
p headers # => { ... }
|
216
|
+
p data # => <CertificateDto>
|
217
|
+
rescue IonoscloudCertManager::ApiError => e
|
218
|
+
puts "Error when calling CertificatesApi->certificates_get_by_id_with_http_info: #{e}"
|
219
|
+
end
|
220
|
+
```
|
221
|
+
|
222
|
+
### Parameters
|
223
|
+
|
224
|
+
| Name | Type | Description | Notes |
|
225
|
+
| ---- | ---- | ----------- | ----- |
|
226
|
+
| **certificate_id** | **String** | | |
|
227
|
+
|
228
|
+
### Return type
|
229
|
+
|
230
|
+
[**CertificateDto**](CertificateDto.md)
|
231
|
+
|
232
|
+
### Authorization
|
233
|
+
|
234
|
+
basicAuth, tokenAuth
|
235
|
+
|
236
|
+
### HTTP request headers
|
237
|
+
|
238
|
+
- **Content-Type**: Not defined
|
239
|
+
- **Accept**: application/json
|
240
|
+
|
241
|
+
|
242
|
+
## certificates_patch
|
243
|
+
|
244
|
+
> <CertificateDto> certificates_patch(certificate_id, certificate_patch_dto)
|
245
|
+
|
246
|
+
Update a Certificate Name by ID
|
247
|
+
|
248
|
+
Updates the name of the specified certificate.
|
249
|
+
|
250
|
+
### Examples
|
251
|
+
|
252
|
+
```ruby
|
253
|
+
require 'time'
|
254
|
+
require 'ionoscloud-cert-manager'
|
255
|
+
# setup authorization
|
256
|
+
IonoscloudCertManager.configure do |config|
|
257
|
+
# Configure HTTP basic authorization: basicAuth
|
258
|
+
config.username = 'YOUR USERNAME'
|
259
|
+
config.password = 'YOUR PASSWORD'
|
260
|
+
|
261
|
+
# Configure API key authorization: tokenAuth
|
262
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
263
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
264
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
265
|
+
end
|
266
|
+
|
267
|
+
api_instance = IonoscloudCertManager::CertificatesApi.new
|
268
|
+
certificate_id = 'certificate_id_example' # String |
|
269
|
+
certificate_patch_dto = IonoscloudCertManager::CertificatePatchDto.new({properties: IonoscloudCertManager::CertificatePatchPropertiesDto.new({name: 'My Certificate'})}) # CertificatePatchDto |
|
270
|
+
|
271
|
+
begin
|
272
|
+
# Update a Certificate Name by ID
|
273
|
+
result = api_instance.certificates_patch(certificate_id, certificate_patch_dto)
|
274
|
+
p result
|
275
|
+
rescue IonoscloudCertManager::ApiError => e
|
276
|
+
puts "Error when calling CertificatesApi->certificates_patch: #{e}"
|
277
|
+
end
|
278
|
+
```
|
279
|
+
|
280
|
+
#### Using the certificates_patch_with_http_info variant
|
281
|
+
|
282
|
+
This returns an Array which contains the response data, status code and headers.
|
283
|
+
|
284
|
+
> <Array(<CertificateDto>, Integer, Hash)> certificates_patch_with_http_info(certificate_id, certificate_patch_dto)
|
285
|
+
|
286
|
+
```ruby
|
287
|
+
begin
|
288
|
+
# Update a Certificate Name by ID
|
289
|
+
data, status_code, headers = api_instance.certificates_patch_with_http_info(certificate_id, certificate_patch_dto)
|
290
|
+
p status_code # => 2xx
|
291
|
+
p headers # => { ... }
|
292
|
+
p data # => <CertificateDto>
|
293
|
+
rescue IonoscloudCertManager::ApiError => e
|
294
|
+
puts "Error when calling CertificatesApi->certificates_patch_with_http_info: #{e}"
|
295
|
+
end
|
296
|
+
```
|
297
|
+
|
298
|
+
### Parameters
|
299
|
+
|
300
|
+
| Name | Type | Description | Notes |
|
301
|
+
| ---- | ---- | ----------- | ----- |
|
302
|
+
| **certificate_id** | **String** | | |
|
303
|
+
| **certificate_patch_dto** | [**CertificatePatchDto**](CertificatePatchDto.md) | | |
|
304
|
+
|
305
|
+
### Return type
|
306
|
+
|
307
|
+
[**CertificateDto**](CertificateDto.md)
|
308
|
+
|
309
|
+
### Authorization
|
310
|
+
|
311
|
+
basicAuth, tokenAuth
|
312
|
+
|
313
|
+
### HTTP request headers
|
314
|
+
|
315
|
+
- **Content-Type**: application/json
|
316
|
+
- **Accept**: application/json
|
317
|
+
|
318
|
+
|
319
|
+
## certificates_post
|
320
|
+
|
321
|
+
> <CertificateDto> certificates_post(certificate_post_dto)
|
322
|
+
|
323
|
+
Add a New Certificate
|
324
|
+
|
325
|
+
Adds a new PEM (Privacy Enhanced Mail) file that is used to store SSL certificates and their associated private keys.
|
326
|
+
|
327
|
+
### Examples
|
328
|
+
|
329
|
+
```ruby
|
330
|
+
require 'time'
|
331
|
+
require 'ionoscloud-cert-manager'
|
332
|
+
# setup authorization
|
333
|
+
IonoscloudCertManager.configure do |config|
|
334
|
+
# Configure HTTP basic authorization: basicAuth
|
335
|
+
config.username = 'YOUR USERNAME'
|
336
|
+
config.password = 'YOUR PASSWORD'
|
337
|
+
|
338
|
+
# Configure API key authorization: tokenAuth
|
339
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
340
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
341
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
342
|
+
end
|
343
|
+
|
344
|
+
api_instance = IonoscloudCertManager::CertificatesApi.new
|
345
|
+
certificate_post_dto = IonoscloudCertManager::CertificatePostDto.new({properties: IonoscloudCertManager::CertificatePostPropertiesDto.new({name: 'My Certificate', certificate: '-----BEGIN CERTIFICATE-----MIIE5TCCAs2gAwIBAgIBATANBgkqhkiG9w0BAQsFADA2MQswCQYDVQQGEwJSTzEK-----END CERTIFICATE-----', certificate_chain: '-----BEGIN CERTIFICATE-----MIIDoTCCAokCFDrAUWffdxWJVz2Axl9lp/4xiUteMA0GCSqGSIb3DQEBCwUAMIGG-----END CERTIFICATE-----', private_key: '-----BEGIN RSA PRIVATE KEY-----MIIJKQIBAAKCAgEAzDehfqWBr+9q0pxwCDDRph7QSPiMbkDGaGKc+Fd2h3doT8Li-----END RSA PRIVATE KEY-----'})}) # CertificatePostDto |
|
346
|
+
|
347
|
+
begin
|
348
|
+
# Add a New Certificate
|
349
|
+
result = api_instance.certificates_post(certificate_post_dto)
|
350
|
+
p result
|
351
|
+
rescue IonoscloudCertManager::ApiError => e
|
352
|
+
puts "Error when calling CertificatesApi->certificates_post: #{e}"
|
353
|
+
end
|
354
|
+
```
|
355
|
+
|
356
|
+
#### Using the certificates_post_with_http_info variant
|
357
|
+
|
358
|
+
This returns an Array which contains the response data, status code and headers.
|
359
|
+
|
360
|
+
> <Array(<CertificateDto>, Integer, Hash)> certificates_post_with_http_info(certificate_post_dto)
|
361
|
+
|
362
|
+
```ruby
|
363
|
+
begin
|
364
|
+
# Add a New Certificate
|
365
|
+
data, status_code, headers = api_instance.certificates_post_with_http_info(certificate_post_dto)
|
366
|
+
p status_code # => 2xx
|
367
|
+
p headers # => { ... }
|
368
|
+
p data # => <CertificateDto>
|
369
|
+
rescue IonoscloudCertManager::ApiError => e
|
370
|
+
puts "Error when calling CertificatesApi->certificates_post_with_http_info: #{e}"
|
371
|
+
end
|
372
|
+
```
|
373
|
+
|
374
|
+
### Parameters
|
375
|
+
|
376
|
+
| Name | Type | Description | Notes |
|
377
|
+
| ---- | ---- | ----------- | ----- |
|
378
|
+
| **certificate_post_dto** | [**CertificatePostDto**](CertificatePostDto.md) | | |
|
379
|
+
|
380
|
+
### Return type
|
381
|
+
|
382
|
+
[**CertificateDto**](CertificateDto.md)
|
383
|
+
|
384
|
+
### Authorization
|
385
|
+
|
386
|
+
basicAuth, tokenAuth
|
387
|
+
|
388
|
+
### HTTP request headers
|
389
|
+
|
390
|
+
- **Content-Type**: application/json
|
391
|
+
- **Accept**: application/json
|
392
|
+
|
@@ -0,0 +1,226 @@
|
|
1
|
+
# InformationApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.ionos.com*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**get_info**](InformationApi.md#get_info) | **GET** /certificatemanager | Get the Service API Information |
|
8
|
+
| [**get_json_open_api_spec**](InformationApi.md#get_json_open_api_spec) | **GET** /certificatemanager/openapi.json | Get the Open API Documentation JSON |
|
9
|
+
| [**get_yaml_open_api_spec**](InformationApi.md#get_yaml_open_api_spec) | **GET** /certificatemanager/openapi.yaml | Get the Open API Documentation YAML |
|
10
|
+
|
11
|
+
|
12
|
+
## get_info
|
13
|
+
|
14
|
+
> <ApiInfoDto> get_info
|
15
|
+
|
16
|
+
Get the Service API Information
|
17
|
+
|
18
|
+
Retrieves the service API information.
|
19
|
+
|
20
|
+
### Examples
|
21
|
+
|
22
|
+
```ruby
|
23
|
+
require 'time'
|
24
|
+
require 'ionoscloud-cert-manager'
|
25
|
+
# setup authorization
|
26
|
+
IonoscloudCertManager.configure do |config|
|
27
|
+
# Configure HTTP basic authorization: basicAuth
|
28
|
+
config.username = 'YOUR USERNAME'
|
29
|
+
config.password = 'YOUR PASSWORD'
|
30
|
+
|
31
|
+
# Configure API key authorization: tokenAuth
|
32
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
33
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
34
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
35
|
+
end
|
36
|
+
|
37
|
+
api_instance = IonoscloudCertManager::InformationApi.new
|
38
|
+
|
39
|
+
begin
|
40
|
+
# Get the Service API Information
|
41
|
+
result = api_instance.get_info
|
42
|
+
p result
|
43
|
+
rescue IonoscloudCertManager::ApiError => e
|
44
|
+
puts "Error when calling InformationApi->get_info: #{e}"
|
45
|
+
end
|
46
|
+
```
|
47
|
+
|
48
|
+
#### Using the get_info_with_http_info variant
|
49
|
+
|
50
|
+
This returns an Array which contains the response data, status code and headers.
|
51
|
+
|
52
|
+
> <Array(<ApiInfoDto>, Integer, Hash)> get_info_with_http_info
|
53
|
+
|
54
|
+
```ruby
|
55
|
+
begin
|
56
|
+
# Get the Service API Information
|
57
|
+
data, status_code, headers = api_instance.get_info_with_http_info
|
58
|
+
p status_code # => 2xx
|
59
|
+
p headers # => { ... }
|
60
|
+
p data # => <ApiInfoDto>
|
61
|
+
rescue IonoscloudCertManager::ApiError => e
|
62
|
+
puts "Error when calling InformationApi->get_info_with_http_info: #{e}"
|
63
|
+
end
|
64
|
+
```
|
65
|
+
|
66
|
+
### Parameters
|
67
|
+
|
68
|
+
This endpoint does not need any parameter.
|
69
|
+
|
70
|
+
### Return type
|
71
|
+
|
72
|
+
[**ApiInfoDto**](ApiInfoDto.md)
|
73
|
+
|
74
|
+
### Authorization
|
75
|
+
|
76
|
+
basicAuth, tokenAuth
|
77
|
+
|
78
|
+
### HTTP request headers
|
79
|
+
|
80
|
+
- **Content-Type**: Not defined
|
81
|
+
- **Accept**: application/json
|
82
|
+
|
83
|
+
|
84
|
+
## get_json_open_api_spec
|
85
|
+
|
86
|
+
> File get_json_open_api_spec
|
87
|
+
|
88
|
+
Get the Open API Documentation JSON
|
89
|
+
|
90
|
+
Displays the Open API documentation in the JSON format.
|
91
|
+
|
92
|
+
### Examples
|
93
|
+
|
94
|
+
```ruby
|
95
|
+
require 'time'
|
96
|
+
require 'ionoscloud-cert-manager'
|
97
|
+
# setup authorization
|
98
|
+
IonoscloudCertManager.configure do |config|
|
99
|
+
# Configure HTTP basic authorization: basicAuth
|
100
|
+
config.username = 'YOUR USERNAME'
|
101
|
+
config.password = 'YOUR PASSWORD'
|
102
|
+
|
103
|
+
# Configure API key authorization: tokenAuth
|
104
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
105
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
106
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
107
|
+
end
|
108
|
+
|
109
|
+
api_instance = IonoscloudCertManager::InformationApi.new
|
110
|
+
|
111
|
+
begin
|
112
|
+
# Get the Open API Documentation JSON
|
113
|
+
result = api_instance.get_json_open_api_spec
|
114
|
+
p result
|
115
|
+
rescue IonoscloudCertManager::ApiError => e
|
116
|
+
puts "Error when calling InformationApi->get_json_open_api_spec: #{e}"
|
117
|
+
end
|
118
|
+
```
|
119
|
+
|
120
|
+
#### Using the get_json_open_api_spec_with_http_info variant
|
121
|
+
|
122
|
+
This returns an Array which contains the response data, status code and headers.
|
123
|
+
|
124
|
+
> <Array(File, Integer, Hash)> get_json_open_api_spec_with_http_info
|
125
|
+
|
126
|
+
```ruby
|
127
|
+
begin
|
128
|
+
# Get the Open API Documentation JSON
|
129
|
+
data, status_code, headers = api_instance.get_json_open_api_spec_with_http_info
|
130
|
+
p status_code # => 2xx
|
131
|
+
p headers # => { ... }
|
132
|
+
p data # => File
|
133
|
+
rescue IonoscloudCertManager::ApiError => e
|
134
|
+
puts "Error when calling InformationApi->get_json_open_api_spec_with_http_info: #{e}"
|
135
|
+
end
|
136
|
+
```
|
137
|
+
|
138
|
+
### Parameters
|
139
|
+
|
140
|
+
This endpoint does not need any parameter.
|
141
|
+
|
142
|
+
### Return type
|
143
|
+
|
144
|
+
**File**
|
145
|
+
|
146
|
+
### Authorization
|
147
|
+
|
148
|
+
basicAuth, tokenAuth
|
149
|
+
|
150
|
+
### HTTP request headers
|
151
|
+
|
152
|
+
- **Content-Type**: Not defined
|
153
|
+
- **Accept**: application/json
|
154
|
+
|
155
|
+
|
156
|
+
## get_yaml_open_api_spec
|
157
|
+
|
158
|
+
> File get_yaml_open_api_spec
|
159
|
+
|
160
|
+
Get the Open API Documentation YAML
|
161
|
+
|
162
|
+
Displays the Open API documentation in the YAML format.
|
163
|
+
|
164
|
+
### Examples
|
165
|
+
|
166
|
+
```ruby
|
167
|
+
require 'time'
|
168
|
+
require 'ionoscloud-cert-manager'
|
169
|
+
# setup authorization
|
170
|
+
IonoscloudCertManager.configure do |config|
|
171
|
+
# Configure HTTP basic authorization: basicAuth
|
172
|
+
config.username = 'YOUR USERNAME'
|
173
|
+
config.password = 'YOUR PASSWORD'
|
174
|
+
|
175
|
+
# Configure API key authorization: tokenAuth
|
176
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
177
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
178
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
179
|
+
end
|
180
|
+
|
181
|
+
api_instance = IonoscloudCertManager::InformationApi.new
|
182
|
+
|
183
|
+
begin
|
184
|
+
# Get the Open API Documentation YAML
|
185
|
+
result = api_instance.get_yaml_open_api_spec
|
186
|
+
p result
|
187
|
+
rescue IonoscloudCertManager::ApiError => e
|
188
|
+
puts "Error when calling InformationApi->get_yaml_open_api_spec: #{e}"
|
189
|
+
end
|
190
|
+
```
|
191
|
+
|
192
|
+
#### Using the get_yaml_open_api_spec_with_http_info variant
|
193
|
+
|
194
|
+
This returns an Array which contains the response data, status code and headers.
|
195
|
+
|
196
|
+
> <Array(File, Integer, Hash)> get_yaml_open_api_spec_with_http_info
|
197
|
+
|
198
|
+
```ruby
|
199
|
+
begin
|
200
|
+
# Get the Open API Documentation YAML
|
201
|
+
data, status_code, headers = api_instance.get_yaml_open_api_spec_with_http_info
|
202
|
+
p status_code # => 2xx
|
203
|
+
p headers # => { ... }
|
204
|
+
p data # => File
|
205
|
+
rescue IonoscloudCertManager::ApiError => e
|
206
|
+
puts "Error when calling InformationApi->get_yaml_open_api_spec_with_http_info: #{e}"
|
207
|
+
end
|
208
|
+
```
|
209
|
+
|
210
|
+
### Parameters
|
211
|
+
|
212
|
+
This endpoint does not need any parameter.
|
213
|
+
|
214
|
+
### Return type
|
215
|
+
|
216
|
+
**File**
|
217
|
+
|
218
|
+
### Authorization
|
219
|
+
|
220
|
+
basicAuth, tokenAuth
|
221
|
+
|
222
|
+
### HTTP request headers
|
223
|
+
|
224
|
+
- **Content-Type**: Not defined
|
225
|
+
- **Accept**: application/yaml
|
226
|
+
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# ApiInfoDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **href** | **String** | The API entry point. | [optional][readonly] |
|
8
|
+
| **name** | **String** | The API name. | [optional][readonly] |
|
9
|
+
| **version** | **String** | The API version. | [optional][readonly] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'ionoscloud-cert-manager'
|
15
|
+
|
16
|
+
instance = IonoscloudCertManager::ApiInfoDto.new(
|
17
|
+
href: null,
|
18
|
+
name: Certificate Manager API.,
|
19
|
+
version: 1.0
|
20
|
+
)
|
21
|
+
```
|
@@ -0,0 +1,29 @@
|
|
1
|
+
# CertificateCollectionDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | The resource ID. | [optional][readonly] |
|
8
|
+
| **type** | **String** | The resource type. | [optional][readonly] |
|
9
|
+
| **href** | **String** | The URL to the object representation (absolute path). | [optional][readonly] |
|
10
|
+
| **items** | [**Array<CertificateDto>**](CertificateDto.md) | The list of certificates. | [optional][readonly] |
|
11
|
+
| **offset** | **Integer** | The pagination offset. | [optional][readonly] |
|
12
|
+
| **limit** | **Integer** | The pagination limit. | [optional][readonly] |
|
13
|
+
| **_links** | [**CertificateCollectionDtoLinks**](CertificateCollectionDtoLinks.md) | | [optional] |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'ionoscloud-cert-manager'
|
19
|
+
|
20
|
+
instance = IonoscloudCertManager::CertificateCollectionDto.new(
|
21
|
+
id: Certificates,
|
22
|
+
type: collection,
|
23
|
+
href: https://api.ionos.com/certificatemanager/certificates,
|
24
|
+
items: null,
|
25
|
+
offset: 10,
|
26
|
+
limit: 100,
|
27
|
+
_links: null
|
28
|
+
)
|
29
|
+
```
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# CertificateCollectionDtoLinks
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **prev** | **String** | The previous page. | [optional] |
|
8
|
+
| **_self** | **String** | The current page. | [optional] |
|
9
|
+
| **_next** | **String** | The next page. | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'ionoscloud-cert-manager'
|
15
|
+
|
16
|
+
instance = IonoscloudCertManager::CertificateCollectionDtoLinks.new(
|
17
|
+
prev: https://api.ionos.com/certificatemanager/certificates?offset=50&limit=10,
|
18
|
+
_self: https://api.ionos.com/certificatemanager/certificates?offset=60&limit=10,
|
19
|
+
_next: https://api.ionos.com/certificatemanager/certificates?offset=70&limit=10
|
20
|
+
)
|
21
|
+
```
|