Skip to content

ObjectSubnetApi.md

Latest commit

 

History

History
263 lines (175 loc) · 8.01 KB

ObjectSubnetApi.md

File metadata and controls

263 lines (175 loc) · 8.01 KB

eZmaxAPI\ObjectSubnetApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest, except if the operation defines another base path.

Method HTTP request Description
subnetCreateObjectV1() POST /1/object/subnet Create a new Subnet
subnetDeleteObjectV1() DELETE /1/object/subnet/{pkiSubnetID} Delete an existing Subnet
subnetEditObjectV1() PUT /1/object/subnet/{pkiSubnetID} Edit an existing Subnet
subnetGetObjectV2() GET /2/object/subnet/{pkiSubnetID} Retrieve an existing Subnet

subnetCreateObjectV1()

subnetCreateObjectV1($subnetCreateObjectV1Request): \eZmaxAPI\Model\SubnetCreateObjectV1Response

Create a new Subnet

The endpoint allows to create one or many elements at once.

Example

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


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectSubnetApi(
    // 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
);
$subnetCreateObjectV1Request = new \eZmaxAPI\Model\SubnetCreateObjectV1Request(); // \eZmaxAPI\Model\SubnetCreateObjectV1Request

try {
    $result = $apiInstance->subnetCreateObjectV1($subnetCreateObjectV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectSubnetApi->subnetCreateObjectV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
subnetCreateObjectV1Request \eZmaxAPI\Model\SubnetCreateObjectV1Request

Return type

\eZmaxAPI\Model\SubnetCreateObjectV1Response

Authorization

Authorization

HTTP request headers

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

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

subnetDeleteObjectV1()

subnetDeleteObjectV1($pkiSubnetID): \eZmaxAPI\Model\SubnetDeleteObjectV1Response

Delete an existing Subnet

Example

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


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectSubnetApi(
    // 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
);
$pkiSubnetID = 56; // int | The unique ID of the Subnet

try {
    $result = $apiInstance->subnetDeleteObjectV1($pkiSubnetID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectSubnetApi->subnetDeleteObjectV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiSubnetID int The unique ID of the Subnet

Return type

\eZmaxAPI\Model\SubnetDeleteObjectV1Response

Authorization

Authorization

HTTP request headers

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

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

subnetEditObjectV1()

subnetEditObjectV1($pkiSubnetID, $subnetEditObjectV1Request): \eZmaxAPI\Model\SubnetEditObjectV1Response

Edit an existing Subnet

Example

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


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectSubnetApi(
    // 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
);
$pkiSubnetID = 56; // int | The unique ID of the Subnet
$subnetEditObjectV1Request = new \eZmaxAPI\Model\SubnetEditObjectV1Request(); // \eZmaxAPI\Model\SubnetEditObjectV1Request

try {
    $result = $apiInstance->subnetEditObjectV1($pkiSubnetID, $subnetEditObjectV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectSubnetApi->subnetEditObjectV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiSubnetID int The unique ID of the Subnet
subnetEditObjectV1Request \eZmaxAPI\Model\SubnetEditObjectV1Request

Return type

\eZmaxAPI\Model\SubnetEditObjectV1Response

Authorization

Authorization

HTTP request headers

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

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

subnetGetObjectV2()

subnetGetObjectV2($pkiSubnetID): \eZmaxAPI\Model\SubnetGetObjectV2Response

Retrieve an existing Subnet

Example

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


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectSubnetApi(
    // 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
);
$pkiSubnetID = 56; // int | The unique ID of the Subnet

try {
    $result = $apiInstance->subnetGetObjectV2($pkiSubnetID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectSubnetApi->subnetGetObjectV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiSubnetID int The unique ID of the Subnet

Return type

\eZmaxAPI\Model\SubnetGetObjectV2Response

Authorization

Authorization

HTTP request headers

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

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