IPBlocksApi

IPBlocksApi

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

Method	HTTP request	Description
ipblocks_delete	DELETE /ipblocks/{ipblockId}	Delete IP blocks
ipblocks_find_by_id	GET /ipblocks/{ipblockId}	Retrieve IP blocks
ipblocks_get	GET /ipblocks	List IP blocks
ipblocks_patch	PATCH /ipblocks/{ipblockId}	Partially modify IP blocks
ipblocks_post	POST /ipblocks	Reserve a IP Block
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

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

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

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

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 <b><i>limit</i></b> 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

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

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	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

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

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	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

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

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	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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

• Content-Type: application/json

• Accept: application/json