OpenAPI\Client\NodeServiceApi

All URIs are relative to http://api.madana.io/rest.

Method	HTTP request	Description
createNode()	POST /nodes/v2
getBootstrap()	GET /nodes/bootstrap
getNodeLicenses()	GET /nodes/licenses
getNodeV2()	GET /nodes/v2/{ident}
getNodes2()	GET /nodes
getNodesV2()	GET /nodes/v2	Returns UUIDs of existing analyses.
killNode()	POST /nodes/v2/{ident}/kill
postNodeInfo()	POST /nodes
postNodeInfo_0()	POST /nodes/create

`createNode()`

createNode($body): \SplFileObject

Example

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



$apiInstance = new OpenAPI\Client\Api\NodeServiceApi(
    // 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()
);
$body = new \OpenAPI\Client\Model\JsonNodeRunRequest(); // \OpenAPI\Client\Model\JsonNodeRunRequest

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

Parameters

Name	Type	Description	Notes
body	\OpenAPI\Client\Model\JsonNodeRunRequest		[optional]

Return type

\SplFileObject

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, application/xml

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

`getBootstrap()`

getBootstrap(): \SplFileObject

Example

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



$apiInstance = new OpenAPI\Client\Api\NodeServiceApi(
    // 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()
);

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

Parameters

This endpoint does not need any parameter.

Return type

\SplFileObject

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getNodeLicenses()`

getNodeLicenses($active): \SplFileObject

Example

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



$apiInstance = new OpenAPI\Client\Api\NodeServiceApi(
    // 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()
);
$active = 'true'; // string

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

Parameters

Name	Type	Description	Notes
active	string		[optional] [default to 'true']

Return type

\SplFileObject

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getNodeV2()`

getNodeV2($ident): \SplFileObject

Example

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



$apiInstance = new OpenAPI\Client\Api\NodeServiceApi(
    // 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()
);
$ident = 'ident_example'; // string

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

Parameters

Name	Type	Description	Notes
ident	string

Return type

\SplFileObject

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getNodes2()`

getNodes2($owner): \SplFileObject

Example

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



$apiInstance = new OpenAPI\Client\Api\NodeServiceApi(
    // 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()
);
$owner = 'owner_example'; // string

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

Parameters

Name	Type	Description	Notes
owner	string		[optional]

Return type

\SplFileObject

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getNodesV2()`

getNodesV2($authorization, $created, $limit, $offset, $status): \SplFileObject

Returns UUIDs of existing analyses.

Example

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



$apiInstance = new OpenAPI\Client\Api\NodeServiceApi(
    // 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()
);
$authorization = 'authorization_example'; // string | Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
$created = 'true'; // string | - if Queryparam \"created=true\" only the UUIDs of own Requests are shown
$limit = '30'; // string | Used for offset pagination. Limit/Offset Paging would look like GET /request?limit=20&offset=100. This query would return the 20 rows starting with the 100th row
$offset = '0'; // string | Used for offset pagination. Limit/Offset Paging would look like GET /request?limit=20&offset=100. This query would return the 20 rows starting with the 100th row
$status = 'status_example'; // string

try {
    $result = $apiInstance->getNodesV2($authorization, $created, $limit, $offset, $status);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NodeServiceApi->getNodesV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
authorization	string	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c	[optional]
created	string	- if Queryparam "created=true" only the UUIDs of own Requests are shown	[optional] [default to 'true']
limit	string	Used for offset pagination. Limit/Offset Paging would look like GET /request?limit=20&offset=100. This query would return the 20 rows starting with the 100th row	[optional] [default to '30']
offset	string	Used for offset pagination. Limit/Offset Paging would look like GET /request?limit=20&offset=100. This query would return the 20 rows starting with the 100th row	[optional] [default to '0']
status	string		[optional]

Return type

\SplFileObject

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`killNode()`

killNode($ident): \SplFileObject

Example

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



$apiInstance = new OpenAPI\Client\Api\NodeServiceApi(
    // 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()
);
$ident = 'ident_example'; // string

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

Parameters

Name	Type	Description	Notes
ident	string

Return type

\SplFileObject

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`postNodeInfo()`

postNodeInfo($body): \SplFileObject

Example

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



$apiInstance = new OpenAPI\Client\Api\NodeServiceApi(
    // 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()
);
$body = new \OpenAPI\Client\Model\JsonNodeInfo(); // \OpenAPI\Client\Model\JsonNodeInfo

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

Parameters

Name	Type	Description	Notes
body	\OpenAPI\Client\Model\JsonNodeInfo		[optional]

Return type

\SplFileObject

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, application/xml

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

`postNodeInfo_0()`

postNodeInfo_0($body): \SplFileObject

Example

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



$apiInstance = new OpenAPI\Client\Api\NodeServiceApi(
    // 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()
);
$body = new \OpenAPI\Client\Model\JsonNodeRunRequest(); // \OpenAPI\Client\Model\JsonNodeRunRequest

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

Parameters

Name	Type	Description	Notes
body	\OpenAPI\Client\Model\JsonNodeRunRequest		[optional]

Return type

\SplFileObject

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, application/xml

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

Files

NodeServiceApi.md

Latest commit

History

NodeServiceApi.md

File metadata and controls

OpenAPI\Client\NodeServiceApi

createNode()

Example

Parameters

Return type

Authorization

HTTP request headers

getBootstrap()

Example

Parameters

Return type

Authorization

HTTP request headers

getNodeLicenses()

Example

Parameters

Return type

Authorization

HTTP request headers

getNodeV2()

Example

Parameters

Return type

Authorization

HTTP request headers

getNodes2()

Example

Parameters

Return type

Authorization

HTTP request headers

getNodesV2()

Example

Parameters

Return type

Authorization

HTTP request headers

killNode()

Example

Parameters

Return type

Authorization

HTTP request headers

postNodeInfo()

Example

Parameters

Return type

Authorization

HTTP request headers

postNodeInfo_0()

Example

Parameters

Return type

Authorization

HTTP request headers

`createNode()`

`getBootstrap()`

`getNodeLicenses()`

`getNodeV2()`

`getNodes2()`

`getNodesV2()`

`killNode()`

`postNodeInfo()`

`postNodeInfo_0()`