# IPBlocksApi ## IPBlocksApi All URIs are relative to ** | Method | HTTP request | Description | | -------------------------------------------------- | -------------------------------- | -------------------------- | | [**ipblocks\_delete**](#ipblocks_delete) | **DELETE** /ipblocks/{ipblockId} | Delete IP blocks | | [**ipblocks\_find\_by\_id**](#ipblocks_find_by_id) | **GET** /ipblocks/{ipblockId} | Retrieve IP blocks | | [**ipblocks\_get**](#ipblocks_get) | **GET** /ipblocks | List IP blocks | | [**ipblocks\_patch**](#ipblocks_patch) | **PATCH** /ipblocks/{ipblockId} | Partially modify IP blocks | | [**ipblocks\_post**](#ipblocks_post) | **POST** /ipblocks | Reserve a IP Block | | [**ipblocks\_put**](#ipblocks_put) | **PUT** /ipblocks/{ipblockId} | Modify a IP Block by ID | ## **ipblocks\_delete** > ipblocks\_delete(ipblock\_id, pretty=pretty, depth=depth, x\_contract\_number=x\_contract\_number) Delete IP blocks Remove the specified IP block. #### 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', ) # Example of configuring HTTP Basic Authorization configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' with ionoscloud.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = ionoscloud.IPBlocksApi(api_client) ipblock_id = 'ipblock_id_example' # str | The unique ID of the IP block. try: # Delete IP blocks api_instance.ipblocks_delete(ipblock_id) except ApiException as e: print('Exception when calling IPBlocksApi.ipblocks_delete: %s\n' % e) ``` #### Parameters | Name | Type | Description | Notes | | ----------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **ipblock\_id** | **str** | The unique ID of the IP block. | | | **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 void (empty response body) #### Authorization Basic Authentication, Token Authentication #### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## **ipblocks\_find\_by\_id** > IpBlock ipblocks\_find\_by\_id(ipblock\_id, pretty=pretty, depth=depth, x\_contract\_number=x\_contract\_number) Retrieve IP blocks Retrieve the properties of the specified IP block. #### 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', ) # Example of configuring HTTP Basic Authorization configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' with ionoscloud.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = ionoscloud.IPBlocksApi(api_client) ipblock_id = 'ipblock_id_example' # str | The unique ID of the IP block. try: # Retrieve IP blocks api_response = api_instance.ipblocks_find_by_id(ipblock_id) print(api_response) except ApiException as e: print('Exception when calling IPBlocksApi.ipblocks_find_by_id: %s\n' % e) ``` #### Parameters | Name | Type | Description | Notes | | ----------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **ipblock\_id** | **str** | The unique ID of the IP block. | | | **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 [**IpBlock**](https://docs.ionos.com/sections-test/python-sdk/cloud-api-python-sdk/models/ipblock) #### Authorization Basic Authentication, Token Authentication #### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## **ipblocks\_get** > IpBlocks ipblocks\_get(pretty=pretty, depth=depth, x\_contract\_number=x\_contract\_number, offset=offset, limit=limit) List IP blocks List all reserved IP blocks. #### 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', ) # Example of configuring HTTP Basic Authorization configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' with ionoscloud.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = ionoscloud.IPBlocksApi(api_client) try: # List IP blocks api_response = api_instance.ipblocks_get() print(api_response) except ApiException as e: print('Exception when calling IPBlocksApi.ipblocks_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] | | **offset** | **int** | The first element (from the complete list of the elements) to include in the response (used together with \\limit\\ for pagination). | \[optional] \[default to 0] | | **limit** | **int** | The maximum number of elements to return (use together with offset for pagination). | \[optional] \[default to 100] | #### Return type [**IpBlocks**](https://docs.ionos.com/sections-test/python-sdk/cloud-api-python-sdk/models/ipblocks) #### Authorization Basic Authentication, Token Authentication #### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## **ipblocks\_patch** > IpBlock ipblocks\_patch(ipblock\_id, ipblock, pretty=pretty, depth=depth, x\_contract\_number=x\_contract\_number) Partially modify IP blocks Update the properties of the specified IP block. #### 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', ) # Example of configuring HTTP Basic Authorization configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' with ionoscloud.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = ionoscloud.IPBlocksApi(api_client) ipblock_id = 'ipblock_id_example' # str | The unique ID of the IP block. ipblock = ionoscloud.IpBlockProperties() # IpBlockProperties | The properties of the IP block to be updated. try: # Partially modify IP blocks api_response = api_instance.ipblocks_patch(ipblock_id, ipblock) print(api_response) except ApiException as e: print('Exception when calling IPBlocksApi.ipblocks_patch: %s\n' % e) ``` #### Parameters | Name | Type | Description | Notes | | ----------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **ipblock\_id** | **str** | The unique ID of the IP block. | | | **ipblock** | [**IpBlockProperties**](https://docs.ionos.com/sections-test/python-sdk/cloud-api-python-sdk/models/ipblockproperties) | The properties of the IP block to be updated. | | | **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 [**IpBlock**](https://docs.ionos.com/sections-test/python-sdk/cloud-api-python-sdk/models/ipblock) #### Authorization Basic Authentication, Token Authentication #### HTTP request headers * **Content-Type**: application/json * **Accept**: application/json ## **ipblocks\_post** > IpBlock ipblocks\_post(ipblock, pretty=pretty, depth=depth, x\_contract\_number=x\_contract\_number) Reserve a IP Block Reserves a new IP block. #### 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', ) # Example of configuring HTTP Basic Authorization configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' with ionoscloud.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = ionoscloud.IPBlocksApi(api_client) ipblock = ionoscloud.IpBlock() # IpBlock | The IP block to be reserved. try: # Reserve a IP Block api_response = api_instance.ipblocks_post(ipblock) print(api_response) except ApiException as e: print('Exception when calling IPBlocksApi.ipblocks_post: %s\n' % e) ``` #### Parameters | Name | Type | Description | Notes | | ----------------------- | -------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **ipblock** | [**IpBlock**](https://docs.ionos.com/sections-test/python-sdk/cloud-api-python-sdk/models/ipblock) | The IP block to be reserved. | | | **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 [**IpBlock**](https://docs.ionos.com/sections-test/python-sdk/cloud-api-python-sdk/models/ipblock) #### Authorization Basic Authentication, Token Authentication #### HTTP request headers * **Content-Type**: application/json * **Accept**: application/json ## **ipblocks\_put** > IpBlock ipblocks\_put(ipblock\_id, ipblock, pretty=pretty, depth=depth, x\_contract\_number=x\_contract\_number) Modify a IP Block by ID Modifies the properties of the specified IP block. #### 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', ) # Example of configuring HTTP Basic Authorization configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' with ionoscloud.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = ionoscloud.IPBlocksApi(api_client) ipblock_id = 'ipblock_id_example' # str | The unique ID of the IP block. ipblock = ionoscloud.IpBlock() # IpBlock | The modified IP block. try: # Modify a IP Block by ID api_response = api_instance.ipblocks_put(ipblock_id, ipblock) print(api_response) except ApiException as e: print('Exception when calling IPBlocksApi.ipblocks_put: %s\n' % e) ``` #### Parameters | Name | Type | Description | Notes | | ----------------------- | -------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **ipblock\_id** | **str** | The unique ID of the IP block. | | | **ipblock** | [**IpBlock**](https://docs.ionos.com/sections-test/python-sdk/cloud-api-python-sdk/models/ipblock) | The modified IP block. | | | **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 [**IpBlock**](https://docs.ionos.com/sections-test/python-sdk/cloud-api-python-sdk/models/ipblock) #### Authorization Basic Authentication, Token Authentication #### HTTP request headers * **Content-Type**: application/json * **Accept**: application/json