1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
|
# Api
All URIs are relative to *https://api.ionos.com/cloudapi/v6*
| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**api_info_get**](Api.md#api_info_get) | **GET** / | Get API information |
# **api_info_get**
> Info api_info_get(pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Get API information
Retrieves the API information such as API version.
### Example
```python
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
with ionoscloud.ApiClient() as api_client:
# Create an instance of the API class
api_instance = ionoscloud.Api(api_client)
try:
# Get API information
api_response = api_instance.api_info_get()
print(api_response)
except ApiException as e:
print('Exception when calling Api.api_info_get: %s\n' % e)
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **pretty** | **bool**| Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
| **depth** | **int**| Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional] [default to 0] |
| **x_contract_number** | **int**| Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
### Return type
[**Info**](../models/Info.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
|