OpenAPI\Client\BroadbandIPApi

All URIs are relative to http://localhost, except if the operation defines another base path.

Method	HTTP request	Description
broadbandIpRdnsUsernameGet()	GET /broadband/ip/rdns/{username}	Retrieves the broadband Reverse DNS information of a static, routed and Ipv6 addresses of a broadband user
broadbandIpRdnsUsernamePost()	POST /broadband/ip/rdns/{username}	Assigns a Reverse DNS records to a static or routed IP address
broadbandIpRoutedUsernameDelete()	DELETE /broadband/ip/routed/{username}	Removes a routed subnet from a broadband user
broadbandIpRoutedUsernamePost()	POST /broadband/ip/routed/{username}	Assigns a routed IPv4 address of the supplied size to a broadband user and updates the RIPE database with the supplied RIPE NIC handle. If the current allocation is dynamic a static IP will also be created
broadbandIpStaticUsernameDelete()	DELETE /broadband/ip/static/{username}	Removes a static IP address and all routed subnets from a broadband user
broadbandIpStaticUsernamePost()	POST /broadband/ip/static/{username}	Assigns a static IPv4 address to a broadband user
broadbandIpUsernameGet()	GET /broadband/ip/{username}	Retrieves the static, routed and Ipv6 information of a broadband user
broadbandIpv6UsernameDelete()	DELETE /broadband/ipv6/{username}	Removes a IPv6 address from a broadband user
broadbandIpv6UsernamePost()	POST /broadband/ipv6/{username}	Assigns a IPv6 address to a broadband user

`broadbandIpRdnsUsernameGet()`

broadbandIpRdnsUsernameGet($username, $api_platform): \OpenAPI\Client\Model\BroadbandIPRDNS[]

Retrieves the broadband Reverse DNS information of a static, routed and Ipv6 addresses of a broadband user

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth2
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\BroadbandIPApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$username = 'username_example'; // string | The name of the user
$api_platform = 'api_platform_example'; // string | The API provides access to two separate platforms: test and live. The test platform allows you to experiment with the API without incurring charges or affecting customer orders. The live platform allows you to make real world changes.

try {
    $result = $apiInstance->broadbandIpRdnsUsernameGet($username, $api_platform);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BroadbandIPApi->broadbandIpRdnsUsernameGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
username	string	The name of the user
api_platform	string	The API provides access to two separate platforms: test and live. The test platform allows you to experiment with the API without incurring charges or affecting customer orders. The live platform allows you to make real world changes.

Return type

\OpenAPI\Client\Model\BroadbandIPRDNS[]

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`broadbandIpRdnsUsernamePost()`

broadbandIpRdnsUsernamePost($username, $api_platform, $broadband_iprdns)

Assigns a Reverse DNS records to a static or routed IP address

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth2
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\BroadbandIPApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$username = 'username_example'; // string | The name of the user
$api_platform = 'api_platform_example'; // string | The API provides access to two separate platforms: test and live. The test platform allows you to experiment with the API without incurring charges or affecting customer orders. The live platform allows you to make real world changes.
$broadband_iprdns = new \OpenAPI\Client\Model\BroadbandIPRDNS(); // \OpenAPI\Client\Model\BroadbandIPRDNS | 

try {
    $apiInstance->broadbandIpRdnsUsernamePost($username, $api_platform, $broadband_iprdns);
} catch (Exception $e) {
    echo 'Exception when calling BroadbandIPApi->broadbandIpRdnsUsernamePost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
username	string	The name of the user
api_platform	string	The API provides access to two separate platforms: test and live. The test platform allows you to experiment with the API without incurring charges or affecting customer orders. The live platform allows you to make real world changes.
broadband_iprdns	\OpenAPI\Client\Model\BroadbandIPRDNS		[optional]

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`broadbandIpRoutedUsernameDelete()`

broadbandIpRoutedUsernameDelete($username, $api_platform, $broadband_ip_deallocation)

Removes a routed subnet from a broadband user

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth2
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\BroadbandIPApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$username = 'username_example'; // string | The name of the user
$api_platform = 'api_platform_example'; // string | The API provides access to two separate platforms: test and live. The test platform allows you to experiment with the API without incurring charges or affecting customer orders. The live platform allows you to make real world changes.
$broadband_ip_deallocation = new \OpenAPI\Client\Model\BroadbandIPDeallocation(); // \OpenAPI\Client\Model\BroadbandIPDeallocation | 

try {
    $apiInstance->broadbandIpRoutedUsernameDelete($username, $api_platform, $broadband_ip_deallocation);
} catch (Exception $e) {
    echo 'Exception when calling BroadbandIPApi->broadbandIpRoutedUsernameDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
username	string	The name of the user
api_platform	string	The API provides access to two separate platforms: test and live. The test platform allows you to experiment with the API without incurring charges or affecting customer orders. The live platform allows you to make real world changes.
broadband_ip_deallocation	\OpenAPI\Client\Model\BroadbandIPDeallocation		[optional]

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`broadbandIpRoutedUsernamePost()`

broadbandIpRoutedUsernamePost($username, $api_platform, $broadband_ip_allocation)

Assigns a routed IPv4 address of the supplied size to a broadband user and updates the RIPE database with the supplied RIPE NIC handle. If the current allocation is dynamic a static IP will also be created

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth2
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\BroadbandIPApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$username = 'username_example'; // string | The name of the user
$api_platform = 'api_platform_example'; // string | The API provides access to two separate platforms: test and live. The test platform allows you to experiment with the API without incurring charges or affecting customer orders. The live platform allows you to make real world changes.
$broadband_ip_allocation = new \OpenAPI\Client\Model\BroadbandIPAllocation(); // \OpenAPI\Client\Model\BroadbandIPAllocation | Allocation details

try {
    $apiInstance->broadbandIpRoutedUsernamePost($username, $api_platform, $broadband_ip_allocation);
} catch (Exception $e) {
    echo 'Exception when calling BroadbandIPApi->broadbandIpRoutedUsernamePost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
username	string	The name of the user
api_platform	string	The API provides access to two separate platforms: test and live. The test platform allows you to experiment with the API without incurring charges or affecting customer orders. The live platform allows you to make real world changes.
broadband_ip_allocation	\OpenAPI\Client\Model\BroadbandIPAllocation	Allocation details	[optional]

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`broadbandIpStaticUsernameDelete()`

broadbandIpStaticUsernameDelete($username, $api_platform)

Removes a static IP address and all routed subnets from a broadband user

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth2
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\BroadbandIPApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$username = 'username_example'; // string | The name of the user
$api_platform = 'api_platform_example'; // string | The API provides access to two separate platforms: test and live. The test platform allows you to experiment with the API without incurring charges or affecting customer orders. The live platform allows you to make real world changes.

try {
    $apiInstance->broadbandIpStaticUsernameDelete($username, $api_platform);
} catch (Exception $e) {
    echo 'Exception when calling BroadbandIPApi->broadbandIpStaticUsernameDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
username	string	The name of the user
api_platform	string	The API provides access to two separate platforms: test and live. The test platform allows you to experiment with the API without incurring charges or affecting customer orders. The live platform allows you to make real world changes.

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`broadbandIpStaticUsernamePost()`

broadbandIpStaticUsernamePost($username, $api_platform)

Assigns a static IPv4 address to a broadband user

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth2
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\BroadbandIPApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$username = 'username_example'; // string | The name of the user
$api_platform = 'api_platform_example'; // string | The API provides access to two separate platforms: test and live. The test platform allows you to experiment with the API without incurring charges or affecting customer orders. The live platform allows you to make real world changes.

try {
    $apiInstance->broadbandIpStaticUsernamePost($username, $api_platform);
} catch (Exception $e) {
    echo 'Exception when calling BroadbandIPApi->broadbandIpStaticUsernamePost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
username	string	The name of the user
api_platform	string	The API provides access to two separate platforms: test and live. The test platform allows you to experiment with the API without incurring charges or affecting customer orders. The live platform allows you to make real world changes.

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`broadbandIpUsernameGet()`

broadbandIpUsernameGet($username, $api_platform): \OpenAPI\Client\Model\BroadbandIPResults

Retrieves the static, routed and Ipv6 information of a broadband user

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth2
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\BroadbandIPApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$username = 'username_example'; // string | Name of the user
$api_platform = 'api_platform_example'; // string | The API provides access to two separate platforms: test and live. The test platform allows you to experiment with the API without incurring charges or affecting customer orders. The live platform allows you to make real world changes.

try {
    $result = $apiInstance->broadbandIpUsernameGet($username, $api_platform);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BroadbandIPApi->broadbandIpUsernameGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
username	string	Name of the user
api_platform	string	The API provides access to two separate platforms: test and live. The test platform allows you to experiment with the API without incurring charges or affecting customer orders. The live platform allows you to make real world changes.

Return type

\OpenAPI\Client\Model\BroadbandIPResults

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`broadbandIpv6UsernameDelete()`

broadbandIpv6UsernameDelete($username, $api_platform)

Removes a IPv6 address from a broadband user

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth2
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\BroadbandIPApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$username = 'username_example'; // string | The name of the user
$api_platform = 'api_platform_example'; // string | The API provides access to two separate platforms: test and live. The test platform allows you to experiment with the API without incurring charges or affecting customer orders. The live platform allows you to make real world changes.

try {
    $apiInstance->broadbandIpv6UsernameDelete($username, $api_platform);
} catch (Exception $e) {
    echo 'Exception when calling BroadbandIPApi->broadbandIpv6UsernameDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
username	string	The name of the user
api_platform	string	The API provides access to two separate platforms: test and live. The test platform allows you to experiment with the API without incurring charges or affecting customer orders. The live platform allows you to make real world changes.

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`broadbandIpv6UsernamePost()`

broadbandIpv6UsernamePost($username, $api_platform)

Assigns a IPv6 address to a broadband user

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth2
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\BroadbandIPApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$username = 'username_example'; // string | 
$api_platform = 'api_platform_example'; // string | The API provides access to two separate platforms: test and live. The test platform allows you to experiment with the API without incurring charges or affecting customer orders. The live platform allows you to make real world changes.

try {
    $apiInstance->broadbandIpv6UsernamePost($username, $api_platform);
} catch (Exception $e) {
    echo 'Exception when calling BroadbandIPApi->broadbandIpv6UsernamePost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
username	string
api_platform	string	The API provides access to two separate platforms: test and live. The test platform allows you to experiment with the API without incurring charges or affecting customer orders. The live platform allows you to make real world changes.

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

BroadbandIPApi.md

Latest commit

History

BroadbandIPApi.md

File metadata and controls

OpenAPI\Client\BroadbandIPApi

broadbandIpRdnsUsernameGet()

Example

Parameters

Return type

Authorization

HTTP request headers

broadbandIpRdnsUsernamePost()

Example

Parameters

Return type

Authorization

HTTP request headers

broadbandIpRoutedUsernameDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

broadbandIpRoutedUsernamePost()

Example

Parameters

Return type

Authorization

HTTP request headers

broadbandIpStaticUsernameDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

broadbandIpStaticUsernamePost()

Example

Parameters

Return type

Authorization

HTTP request headers

broadbandIpUsernameGet()

Example

Parameters

Return type

Authorization

HTTP request headers

broadbandIpv6UsernameDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

broadbandIpv6UsernamePost()

Example

Parameters

Return type

Authorization

HTTP request headers

`broadbandIpRdnsUsernameGet()`

`broadbandIpRdnsUsernamePost()`

`broadbandIpRoutedUsernameDelete()`

`broadbandIpRoutedUsernamePost()`

`broadbandIpStaticUsernameDelete()`

`broadbandIpStaticUsernamePost()`

`broadbandIpUsernameGet()`

`broadbandIpv6UsernameDelete()`

`broadbandIpv6UsernamePost()`