Skip to content

Api.md

Latest commit

 

History

History
61 lines (42 loc) · 2.15 KB

Api.md

File metadata and controls

61 lines (42 loc) · 2.15 KB
Raw

Api

All URIs are relative to https://api.ionos.com/cloudapi/v6

Method HTTP request Description
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

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

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json