Kraken REST API

Analysis

debugLoadTest

Debugs a Gatling load test.


/analysis/test/debug

Usage and SDK Samples

curl -X POST "http://localhost:80/api/analysis/test/debug?runDescription="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnalysisApi;

import java.io.File;
import java.util.*;

public class AnalysisApiExample {

    public static void main(String[] args) {
        
        AnalysisApi apiInstance = new AnalysisApi();
        Object body = ; // Object | The environment variables Map.
        String applicationId = applicationId_example; // String | ID of the frontend application that debug the test (used to dispatch command execution logs).
        String runDescription = runDescription_example; // String | Description of the [test debug](https://kraken.octoperf.com/gatling/debug-gatling-scripts/).
        try {
            'String' result = apiInstance.debugLoadTest(body, applicationId, runDescription);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalysisApi#debugLoadTest");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AnalysisApi;

public class AnalysisApiExample {

    public static void main(String[] args) {
        AnalysisApi apiInstance = new AnalysisApi();
        Object body = ; // Object | The environment variables Map.
        String applicationId = applicationId_example; // String | ID of the frontend application that debug the test (used to dispatch command execution logs).
        String runDescription = runDescription_example; // String | Description of the [test debug](https://kraken.octoperf.com/gatling/debug-gatling-scripts/).
        try {
            'String' result = apiInstance.debugLoadTest(body, applicationId, runDescription);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalysisApi#debugLoadTest");
            e.printStackTrace();
        }
    }
}
Object *body = ; // The environment variables Map.
String *applicationId = applicationId_example; // ID of the frontend application that debug the test (used to dispatch command execution logs).
String *runDescription = runDescription_example; // Description of the [test debug](https://kraken.octoperf.com/gatling/debug-gatling-scripts/).

AnalysisApi *apiInstance = [[AnalysisApi alloc] init];

// Debugs a Gatling load test.
[apiInstance debugLoadTestWith:body
    applicationId:applicationId
    runDescription:runDescription
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.AnalysisApi()
var body = ; // {{Object}} The environment variables Map.
var applicationId = applicationId_example; // {{String}} ID of the frontend application that debug the test (used to dispatch command execution logs).
var runDescription = runDescription_example; // {{String}} Description of the [test debug](https://kraken.octoperf.com/gatling/debug-gatling-scripts/).

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.debugLoadTest(bodyapplicationIdrunDescription, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class debugLoadTestExample
    {
        public void main()
        {

            var apiInstance = new AnalysisApi();
            var body = new Object(); // Object | The environment variables Map.
            var applicationId = applicationId_example;  // String | ID of the frontend application that debug the test (used to dispatch command execution logs).
            var runDescription = runDescription_example;  // String | Description of the [test debug](https://kraken.octoperf.com/gatling/debug-gatling-scripts/).

            try
            {
                // Debugs a Gatling load test.
                'String' result = apiInstance.debugLoadTest(body, applicationId, runDescription);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnalysisApi.debugLoadTest: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAnalysisApi();
$body = ; // Object | The environment variables Map.
$applicationId = applicationId_example; // String | ID of the frontend application that debug the test (used to dispatch command execution logs).
$runDescription = runDescription_example; // String | Description of the [test debug](https://kraken.octoperf.com/gatling/debug-gatling-scripts/).

try {
    $result = $api_instance->debugLoadTest($body, $applicationId, $runDescription);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalysisApi->debugLoadTest: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnalysisApi;

my $api_instance = WWW::SwaggerClient::AnalysisApi->new();
my $body = WWW::SwaggerClient::Object::Object->new(); # Object | The environment variables Map.
my $applicationId = applicationId_example; # String | ID of the frontend application that debug the test (used to dispatch command execution logs).
my $runDescription = runDescription_example; # String | Description of the [test debug](https://kraken.octoperf.com/gatling/debug-gatling-scripts/).

eval { 
    my $result = $api_instance->debugLoadTest(body => $body, applicationId => $applicationId, runDescription => $runDescription);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnalysisApi->debugLoadTest: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AnalysisApi()
body =  # Object | The environment variables Map.
applicationId = applicationId_example # String | ID of the frontend application that debug the test (used to dispatch command execution logs).
runDescription = runDescription_example # String | Description of the [test debug](https://kraken.octoperf.com/gatling/debug-gatling-scripts/).

try: 
    # Debugs a Gatling load test.
    api_response = api_instance.debug_load_test(body, applicationId, runDescription)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalysisApi->debugLoadTest: %s\n" % e)

Parameters

Header parameters
Name Description
ApplicationId*
String
ID of the frontend application that debug the test (used to dispatch command execution logs).
Required
Body parameters
Name Description
body *
Query parameters
Name Description
runDescription*
String
Description of the [test debug](https://kraken.octoperf.com/gatling/debug-gatling-scripts/).
Required

Responses

Status: 200 - The ID of the command.


deleteLoadTest

Deletes a load test execution/debug/record from Kraken.


/analysis/test/delete

Usage and SDK Samples

curl -X DELETE "http://localhost:80/api/analysis/test/delete?testId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnalysisApi;

import java.io.File;
import java.util.*;

public class AnalysisApiExample {

    public static void main(String[] args) {
        
        AnalysisApi apiInstance = new AnalysisApi();
        String testId = testId_example; // String | ID of the test.
        try {
            'String' result = apiInstance.deleteLoadTest(testId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalysisApi#deleteLoadTest");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AnalysisApi;

public class AnalysisApiExample {

    public static void main(String[] args) {
        AnalysisApi apiInstance = new AnalysisApi();
        String testId = testId_example; // String | ID of the test.
        try {
            'String' result = apiInstance.deleteLoadTest(testId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalysisApi#deleteLoadTest");
            e.printStackTrace();
        }
    }
}
String *testId = testId_example; // ID of the test.

AnalysisApi *apiInstance = [[AnalysisApi alloc] init];

// Deletes a load test execution/debug/record from Kraken.
[apiInstance deleteLoadTestWith:testId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.AnalysisApi()
var testId = testId_example; // {{String}} ID of the test.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteLoadTest(testId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteLoadTestExample
    {
        public void main()
        {

            var apiInstance = new AnalysisApi();
            var testId = testId_example;  // String | ID of the test.

            try
            {
                // Deletes a load test execution/debug/record from Kraken.
                'String' result = apiInstance.deleteLoadTest(testId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnalysisApi.deleteLoadTest: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAnalysisApi();
$testId = testId_example; // String | ID of the test.

try {
    $result = $api_instance->deleteLoadTest($testId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalysisApi->deleteLoadTest: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnalysisApi;

my $api_instance = WWW::SwaggerClient::AnalysisApi->new();
my $testId = testId_example; # String | ID of the test.

eval { 
    my $result = $api_instance->deleteLoadTest(testId => $testId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnalysisApi->deleteLoadTest: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AnalysisApi()
testId = testId_example # String | ID of the test.

try: 
    # Deletes a load test execution/debug/record from Kraken.
    api_response = api_instance.delete_load_test(testId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalysisApi->deleteLoadTest: %s\n" % e)

Parameters

Query parameters
Name Description
testId*
String
ID of the test.
Required

Responses

Status: 200 - ID of the test.


recordLoadTest

Records a Gatling script from an HAR file.


/analysis/test/record

Usage and SDK Samples

curl -X POST "http://localhost:80/api/analysis/test/record"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnalysisApi;

import java.io.File;
import java.util.*;

public class AnalysisApiExample {

    public static void main(String[] args) {
        
        AnalysisApi apiInstance = new AnalysisApi();
        Object body = ; // Object | The environment variables Map.
        String applicationId = applicationId_example; // String | ID of the frontend application that debug the test (used to dispatch command execution logs).
        try {
            'String' result = apiInstance.recordLoadTest(body, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalysisApi#recordLoadTest");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AnalysisApi;

public class AnalysisApiExample {

    public static void main(String[] args) {
        AnalysisApi apiInstance = new AnalysisApi();
        Object body = ; // Object | The environment variables Map.
        String applicationId = applicationId_example; // String | ID of the frontend application that debug the test (used to dispatch command execution logs).
        try {
            'String' result = apiInstance.recordLoadTest(body, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalysisApi#recordLoadTest");
            e.printStackTrace();
        }
    }
}
Object *body = ; // The environment variables Map.
String *applicationId = applicationId_example; // ID of the frontend application that debug the test (used to dispatch command execution logs).

AnalysisApi *apiInstance = [[AnalysisApi alloc] init];

// Records a Gatling script from an HAR file.
[apiInstance recordLoadTestWith:body
    applicationId:applicationId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.AnalysisApi()
var body = ; // {{Object}} The environment variables Map.
var applicationId = applicationId_example; // {{String}} ID of the frontend application that debug the test (used to dispatch command execution logs).

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.recordLoadTest(bodyapplicationId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class recordLoadTestExample
    {
        public void main()
        {

            var apiInstance = new AnalysisApi();
            var body = new Object(); // Object | The environment variables Map.
            var applicationId = applicationId_example;  // String | ID of the frontend application that debug the test (used to dispatch command execution logs).

            try
            {
                // Records a Gatling script from an HAR file.
                'String' result = apiInstance.recordLoadTest(body, applicationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnalysisApi.recordLoadTest: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAnalysisApi();
$body = ; // Object | The environment variables Map.
$applicationId = applicationId_example; // String | ID of the frontend application that debug the test (used to dispatch command execution logs).

try {
    $result = $api_instance->recordLoadTest($body, $applicationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalysisApi->recordLoadTest: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnalysisApi;

my $api_instance = WWW::SwaggerClient::AnalysisApi->new();
my $body = WWW::SwaggerClient::Object::Object->new(); # Object | The environment variables Map.
my $applicationId = applicationId_example; # String | ID of the frontend application that debug the test (used to dispatch command execution logs).

eval { 
    my $result = $api_instance->recordLoadTest(body => $body, applicationId => $applicationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnalysisApi->recordLoadTest: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AnalysisApi()
body =  # Object | The environment variables Map.
applicationId = applicationId_example # String | ID of the frontend application that debug the test (used to dispatch command execution logs).

try: 
    # Records a Gatling script from an HAR file.
    api_response = api_instance.record_load_test(body, applicationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalysisApi->recordLoadTest: %s\n" % e)

Parameters

Header parameters
Name Description
ApplicationId*
String
ID of the frontend application that debug the test (used to dispatch command execution logs).
Required
Body parameters
Name Description
body *

Responses

Status: 200 - The ID of the command.


runLoadTest

Runs a Gatling load test.


/analysis/test/run

Usage and SDK Samples

curl -X POST "http://localhost:80/api/analysis/test/run?runDescription="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnalysisApi;

import java.io.File;
import java.util.*;

public class AnalysisApiExample {

    public static void main(String[] args) {
        
        AnalysisApi apiInstance = new AnalysisApi();
        Object body = ; // Object | The environment variables Map.
        String applicationId = applicationId_example; // String | ID of the frontend application that ran the test (used to dispatch command execution logs).
        String runDescription = runDescription_example; // String | Description of the [test execution](https://kraken.octoperf.com/gatling/execute-gatling-scripts/).
        try {
            'String' result = apiInstance.runLoadTest(body, applicationId, runDescription);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalysisApi#runLoadTest");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AnalysisApi;

public class AnalysisApiExample {

    public static void main(String[] args) {
        AnalysisApi apiInstance = new AnalysisApi();
        Object body = ; // Object | The environment variables Map.
        String applicationId = applicationId_example; // String | ID of the frontend application that ran the test (used to dispatch command execution logs).
        String runDescription = runDescription_example; // String | Description of the [test execution](https://kraken.octoperf.com/gatling/execute-gatling-scripts/).
        try {
            'String' result = apiInstance.runLoadTest(body, applicationId, runDescription);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalysisApi#runLoadTest");
            e.printStackTrace();
        }
    }
}
Object *body = ; // The environment variables Map.
String *applicationId = applicationId_example; // ID of the frontend application that ran the test (used to dispatch command execution logs).
String *runDescription = runDescription_example; // Description of the [test execution](https://kraken.octoperf.com/gatling/execute-gatling-scripts/).

AnalysisApi *apiInstance = [[AnalysisApi alloc] init];

// Runs a Gatling load test.
[apiInstance runLoadTestWith:body
    applicationId:applicationId
    runDescription:runDescription
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.AnalysisApi()
var body = ; // {{Object}} The environment variables Map.
var applicationId = applicationId_example; // {{String}} ID of the frontend application that ran the test (used to dispatch command execution logs).
var runDescription = runDescription_example; // {{String}} Description of the [test execution](https://kraken.octoperf.com/gatling/execute-gatling-scripts/).

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.runLoadTest(bodyapplicationIdrunDescription, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class runLoadTestExample
    {
        public void main()
        {

            var apiInstance = new AnalysisApi();
            var body = new Object(); // Object | The environment variables Map.
            var applicationId = applicationId_example;  // String | ID of the frontend application that ran the test (used to dispatch command execution logs).
            var runDescription = runDescription_example;  // String | Description of the [test execution](https://kraken.octoperf.com/gatling/execute-gatling-scripts/).

            try
            {
                // Runs a Gatling load test.
                'String' result = apiInstance.runLoadTest(body, applicationId, runDescription);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnalysisApi.runLoadTest: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAnalysisApi();
$body = ; // Object | The environment variables Map.
$applicationId = applicationId_example; // String | ID of the frontend application that ran the test (used to dispatch command execution logs).
$runDescription = runDescription_example; // String | Description of the [test execution](https://kraken.octoperf.com/gatling/execute-gatling-scripts/).

try {
    $result = $api_instance->runLoadTest($body, $applicationId, $runDescription);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalysisApi->runLoadTest: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnalysisApi;

my $api_instance = WWW::SwaggerClient::AnalysisApi->new();
my $body = WWW::SwaggerClient::Object::Object->new(); # Object | The environment variables Map.
my $applicationId = applicationId_example; # String | ID of the frontend application that ran the test (used to dispatch command execution logs).
my $runDescription = runDescription_example; # String | Description of the [test execution](https://kraken.octoperf.com/gatling/execute-gatling-scripts/).

eval { 
    my $result = $api_instance->runLoadTest(body => $body, applicationId => $applicationId, runDescription => $runDescription);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnalysisApi->runLoadTest: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AnalysisApi()
body =  # Object | The environment variables Map.
applicationId = applicationId_example # String | ID of the frontend application that ran the test (used to dispatch command execution logs).
runDescription = runDescription_example # String | Description of the [test execution](https://kraken.octoperf.com/gatling/execute-gatling-scripts/).

try: 
    # Runs a Gatling load test.
    api_response = api_instance.run_load_test(body, applicationId, runDescription)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalysisApi->runLoadTest: %s\n" % e)

Parameters

Header parameters
Name Description
ApplicationId*
String
ID of the frontend application that ran the test (used to dispatch command execution logs).
Required
Body parameters
Name Description
body *
Query parameters
Name Description
runDescription*
String
Description of the [test execution](https://kraken.octoperf.com/gatling/execute-gatling-scripts/).
Required

Responses

Status: 200 - The ID of the command.


setLoadTestStatus

Sets a load test execution/debug/record status.


/analysis/test/status/{status}

Usage and SDK Samples

curl -X POST "http://localhost:80/api/analysis/test/status/{status}?testId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnalysisApi;

import java.io.File;
import java.util.*;

public class AnalysisApiExample {

    public static void main(String[] args) {
        
        AnalysisApi apiInstance = new AnalysisApi();
        String testId = testId_example; // String | ID of the test.
        String status = status_example; // String | ID of the test.
        try {
            'String' result = apiInstance.setLoadTestStatus(testId, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalysisApi#setLoadTestStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AnalysisApi;

public class AnalysisApiExample {

    public static void main(String[] args) {
        AnalysisApi apiInstance = new AnalysisApi();
        String testId = testId_example; // String | ID of the test.
        String status = status_example; // String | ID of the test.
        try {
            'String' result = apiInstance.setLoadTestStatus(testId, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalysisApi#setLoadTestStatus");
            e.printStackTrace();
        }
    }
}
String *testId = testId_example; // ID of the test.
String *status = status_example; // ID of the test.

AnalysisApi *apiInstance = [[AnalysisApi alloc] init];

// Sets a load test execution/debug/record status.
[apiInstance setLoadTestStatusWith:testId
    status:status
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.AnalysisApi()
var testId = testId_example; // {{String}} ID of the test.
var status = status_example; // {{String}} ID of the test.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setLoadTestStatus(testId, status, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setLoadTestStatusExample
    {
        public void main()
        {

            var apiInstance = new AnalysisApi();
            var testId = testId_example;  // String | ID of the test.
            var status = status_example;  // String | ID of the test.

            try
            {
                // Sets a load test execution/debug/record status.
                'String' result = apiInstance.setLoadTestStatus(testId, status);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnalysisApi.setLoadTestStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAnalysisApi();
$testId = testId_example; // String | ID of the test.
$status = status_example; // String | ID of the test.

try {
    $result = $api_instance->setLoadTestStatus($testId, $status);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalysisApi->setLoadTestStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnalysisApi;

my $api_instance = WWW::SwaggerClient::AnalysisApi->new();
my $testId = testId_example; # String | ID of the test.
my $status = status_example; # String | ID of the test.

eval { 
    my $result = $api_instance->setLoadTestStatus(testId => $testId, status => $status);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnalysisApi->setLoadTestStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AnalysisApi()
testId = testId_example # String | ID of the test.
status = status_example # String | ID of the test.

try: 
    # Sets a load test execution/debug/record status.
    api_response = api_instance.set_load_test_status(testId, status)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalysisApi->setLoadTestStatus: %s\n" % e)

Parameters

Path parameters
Name Description
status*
String
ID of the test.
Required
Query parameters
Name Description
testId*
String
ID of the test.
Required

Responses

Status: 200 - ID of the test.


Command

cancelCommand

Cancels the given command (by ID).


/command/cancel

Usage and SDK Samples

curl -X DELETE "http://localhost:80/api/command/cancel?commandId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommandApi;

import java.io.File;
import java.util.*;

public class CommandApiExample {

    public static void main(String[] args) {
        
        CommandApi apiInstance = new CommandApi();
        String commandId = commandId_example; // String | The identifier of the command to cancel (returned by the endpoint `/execute` when running a command).
        try {
            'Boolean' result = apiInstance.cancelCommand(commandId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandApi#cancelCommand");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommandApi;

public class CommandApiExample {

    public static void main(String[] args) {
        CommandApi apiInstance = new CommandApi();
        String commandId = commandId_example; // String | The identifier of the command to cancel (returned by the endpoint `/execute` when running a command).
        try {
            'Boolean' result = apiInstance.cancelCommand(commandId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandApi#cancelCommand");
            e.printStackTrace();
        }
    }
}
String *commandId = commandId_example; // The identifier of the command to cancel (returned by the endpoint `/execute` when running a command).

CommandApi *apiInstance = [[CommandApi alloc] init];

// Cancels the given command (by ID).
[apiInstance cancelCommandWith:commandId
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.CommandApi()
var commandId = commandId_example; // {{String}} The identifier of the command to cancel (returned by the endpoint `/execute` when running a command).

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cancelCommand(commandId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cancelCommandExample
    {
        public void main()
        {

            var apiInstance = new CommandApi();
            var commandId = commandId_example;  // String | The identifier of the command to cancel (returned by the endpoint `/execute` when running a command).

            try
            {
                // Cancels the given command (by ID).
                'Boolean' result = apiInstance.cancelCommand(commandId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommandApi.cancelCommand: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCommandApi();
$commandId = commandId_example; // String | The identifier of the command to cancel (returned by the endpoint `/execute` when running a command).

try {
    $result = $api_instance->cancelCommand($commandId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommandApi->cancelCommand: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommandApi;

my $api_instance = WWW::SwaggerClient::CommandApi->new();
my $commandId = commandId_example; # String | The identifier of the command to cancel (returned by the endpoint `/execute` when running a command).

eval { 
    my $result = $api_instance->cancelCommand(commandId => $commandId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommandApi->cancelCommand: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CommandApi()
commandId = commandId_example # String | The identifier of the command to cancel (returned by the endpoint `/execute` when running a command).

try: 
    # Cancels the given command (by ID).
    api_response = api_instance.cancel_command(commandId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommandApi->cancelCommand: %s\n" % e)

Parameters

Query parameters
Name Description
commandId*
String
The identifier of the command to cancel (returned by the endpoint `/execute` when running a command).
Required

Responses

Status: 200 - `true` if the command was cancelled.


executeCommand

Executes the given command.


/command/execute

Usage and SDK Samples

curl -X POST "http://localhost:80/api/command/execute"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommandApi;

import java.io.File;
import java.util.*;

public class CommandApiExample {

    public static void main(String[] args) {
        
        CommandApi apiInstance = new CommandApi();
        Command body = ; // Command | The command to execute.
        try {
            'String' result = apiInstance.executeCommand(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandApi#executeCommand");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommandApi;

public class CommandApiExample {

    public static void main(String[] args) {
        CommandApi apiInstance = new CommandApi();
        Command body = ; // Command | The command to execute.
        try {
            'String' result = apiInstance.executeCommand(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandApi#executeCommand");
            e.printStackTrace();
        }
    }
}
Command *body = ; // The command to execute.

CommandApi *apiInstance = [[CommandApi alloc] init];

// Executes the given command.
[apiInstance executeCommandWith:body
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.CommandApi()
var body = ; // {{Command}} The command to execute.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.executeCommand(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class executeCommandExample
    {
        public void main()
        {

            var apiInstance = new CommandApi();
            var body = new Command(); // Command | The command to execute.

            try
            {
                // Executes the given command.
                'String' result = apiInstance.executeCommand(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommandApi.executeCommand: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCommandApi();
$body = ; // Command | The command to execute.

try {
    $result = $api_instance->executeCommand($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommandApi->executeCommand: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommandApi;

my $api_instance = WWW::SwaggerClient::CommandApi->new();
my $body = WWW::SwaggerClient::Object::Command->new(); # Command | The command to execute.

eval { 
    my $result = $api_instance->executeCommand(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommandApi->executeCommand: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CommandApi()
body =  # Command | The command to execute.

try: 
    # Executes the given command.
    api_response = api_instance.execute_command(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommandApi->executeCommand: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - The generated command id.


listenLogs

Listens for command execution logs using SSE: https://en.wikipedia.org/wiki/Server-sent_events


/command/listen/{applicationId}

Usage and SDK Samples

curl -X GET "http://localhost:80/api/command/listen/{applicationId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommandApi;

import java.io.File;
import java.util.*;

public class CommandApiExample {

    public static void main(String[] args) {
        
        CommandApi apiInstance = new CommandApi();
        String applicationId = applicationId_example; // String | The frontend application (only logs for command with the same application id are returned). A request header cannot be used here as it is not supported by SSE.
        try {
            CommandLogs result = apiInstance.listenLogs(applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandApi#listenLogs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommandApi;

public class CommandApiExample {

    public static void main(String[] args) {
        CommandApi apiInstance = new CommandApi();
        String applicationId = applicationId_example; // String | The frontend application (only logs for command with the same application id are returned). A request header cannot be used here as it is not supported by SSE.
        try {
            CommandLogs result = apiInstance.listenLogs(applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandApi#listenLogs");
            e.printStackTrace();
        }
    }
}
String *applicationId = applicationId_example; // The frontend application (only logs for command with the same application id are returned). A request header cannot be used here as it is not supported by SSE.

CommandApi *apiInstance = [[CommandApi alloc] init];

// Listens for command execution logs using SSE: https://en.wikipedia.org/wiki/Server-sent_events
[apiInstance listenLogsWith:applicationId
              completionHandler: ^(CommandLogs output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.CommandApi()
var applicationId = applicationId_example; // {{String}} The frontend application (only logs for command with the same application id are returned). A request header cannot be used here as it is not supported by SSE.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listenLogs(applicationId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listenLogsExample
    {
        public void main()
        {

            var apiInstance = new CommandApi();
            var applicationId = applicationId_example;  // String | The frontend application (only logs for command with the same application id are returned). A request header cannot be used here as it is not supported by SSE.

            try
            {
                // Listens for command execution logs using SSE: https://en.wikipedia.org/wiki/Server-sent_events
                CommandLogs result = apiInstance.listenLogs(applicationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommandApi.listenLogs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCommandApi();
$applicationId = applicationId_example; // String | The frontend application (only logs for command with the same application id are returned). A request header cannot be used here as it is not supported by SSE.

try {
    $result = $api_instance->listenLogs($applicationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommandApi->listenLogs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommandApi;

my $api_instance = WWW::SwaggerClient::CommandApi->new();
my $applicationId = applicationId_example; # String | The frontend application (only logs for command with the same application id are returned). A request header cannot be used here as it is not supported by SSE.

eval { 
    my $result = $api_instance->listenLogs(applicationId => $applicationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommandApi->listenLogs: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CommandApi()
applicationId = applicationId_example # String | The frontend application (only logs for command with the same application id are returned). A request header cannot be used here as it is not supported by SSE.

try: 
    # Listens for command execution logs using SSE: https://en.wikipedia.org/wiki/Server-sent_events
    api_response = api_instance.listen_logs(applicationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommandApi->listenLogs: %s\n" % e)

Parameters

Path parameters
Name Description
applicationId*
String
The frontend application (only logs for command with the same application id are returned). A request header cannot be used here as it is not supported by SSE.
Required

Responses

Status: 200 - The executing command logs.


Docker

containerDelete

Removes a Docker container `docker rm`.


/docker/container

Usage and SDK Samples

curl -X DELETE "http://localhost:80/api/docker/container?containerId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DockerApi;

import java.io.File;
import java.util.*;

public class DockerApiExample {

    public static void main(String[] args) {
        
        DockerApi apiInstance = new DockerApi();
        String containerId = containerId_example; // String | The ID of the Docker container.
        try {
            'Boolean' result = apiInstance.containerDelete(containerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DockerApi#containerDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DockerApi;

public class DockerApiExample {

    public static void main(String[] args) {
        DockerApi apiInstance = new DockerApi();
        String containerId = containerId_example; // String | The ID of the Docker container.
        try {
            'Boolean' result = apiInstance.containerDelete(containerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DockerApi#containerDelete");
            e.printStackTrace();
        }
    }
}
String *containerId = containerId_example; // The ID of the Docker container.

DockerApi *apiInstance = [[DockerApi alloc] init];

// Removes a Docker container `docker rm`.
[apiInstance containerDeleteWith:containerId
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.DockerApi()
var containerId = containerId_example; // {{String}} The ID of the Docker container.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.containerDelete(containerId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class containerDeleteExample
    {
        public void main()
        {

            var apiInstance = new DockerApi();
            var containerId = containerId_example;  // String | The ID of the Docker container.

            try
            {
                // Removes a Docker container `docker rm`.
                'Boolean' result = apiInstance.containerDelete(containerId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DockerApi.containerDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDockerApi();
$containerId = containerId_example; // String | The ID of the Docker container.

try {
    $result = $api_instance->containerDelete($containerId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DockerApi->containerDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DockerApi;

my $api_instance = WWW::SwaggerClient::DockerApi->new();
my $containerId = containerId_example; # String | The ID of the Docker container.

eval { 
    my $result = $api_instance->containerDelete(containerId => $containerId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DockerApi->containerDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DockerApi()
containerId = containerId_example # String | The ID of the Docker container.

try: 
    # Removes a Docker container `docker rm`.
    api_response = api_instance.container_delete(containerId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DockerApi->containerDelete: %s\n" % e)

Parameters

Query parameters
Name Description
containerId*
String
The ID of the Docker container.
Required

Responses

Status: 200 - `true` if the container was removed.


containerInspect

Returns a Docker container.


/docker/container/inspect

Usage and SDK Samples

curl -X GET "http://localhost:80/api/docker/container/inspect?containerId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DockerApi;

import java.io.File;
import java.util.*;

public class DockerApiExample {

    public static void main(String[] args) {
        
        DockerApi apiInstance = new DockerApi();
        String containerId = containerId_example; // String | The ID of the Docker container.
        try {
            DockerContainer result = apiInstance.containerInspect(containerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DockerApi#containerInspect");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DockerApi;

public class DockerApiExample {

    public static void main(String[] args) {
        DockerApi apiInstance = new DockerApi();
        String containerId = containerId_example; // String | The ID of the Docker container.
        try {
            DockerContainer result = apiInstance.containerInspect(containerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DockerApi#containerInspect");
            e.printStackTrace();
        }
    }
}
String *containerId = containerId_example; // The ID of the Docker container.

DockerApi *apiInstance = [[DockerApi alloc] init];

// Returns a Docker container.
[apiInstance containerInspectWith:containerId
              completionHandler: ^(DockerContainer output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.DockerApi()
var containerId = containerId_example; // {{String}} The ID of the Docker container.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.containerInspect(containerId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class containerInspectExample
    {
        public void main()
        {

            var apiInstance = new DockerApi();
            var containerId = containerId_example;  // String | The ID of the Docker container.

            try
            {
                // Returns a Docker container.
                DockerContainer result = apiInstance.containerInspect(containerId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DockerApi.containerInspect: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDockerApi();
$containerId = containerId_example; // String | The ID of the Docker container.

try {
    $result = $api_instance->containerInspect($containerId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DockerApi->containerInspect: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DockerApi;

my $api_instance = WWW::SwaggerClient::DockerApi->new();
my $containerId = containerId_example; # String | The ID of the Docker container.

eval { 
    my $result = $api_instance->containerInspect(containerId => $containerId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DockerApi->containerInspect: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DockerApi()
containerId = containerId_example # String | The ID of the Docker container.

try: 
    # Returns a Docker container.
    api_response = api_instance.container_inspect(containerId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DockerApi->containerInspect: %s\n" % e)

Parameters

Query parameters
Name Description
containerId*
String
The ID of the Docker container.
Required

Responses

Status: 200 - The Docker container.


containerLogs

Displays the Docker container logs for the given identifier.


/docker/container/logs

Usage and SDK Samples

curl -X GET "http://localhost:80/api/docker/container/logs?containerId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DockerApi;

import java.io.File;
import java.util.*;

public class DockerApiExample {

    public static void main(String[] args) {
        
        DockerApi apiInstance = new DockerApi();
        String containerId = containerId_example; // String | The id of the Docker container.
        String applicationId = applicationId_example; // String | The id of the frontend application (to retrieve the execution logs).
        try {
            'String' result = apiInstance.containerLogs(containerId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DockerApi#containerLogs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DockerApi;

public class DockerApiExample {

    public static void main(String[] args) {
        DockerApi apiInstance = new DockerApi();
        String containerId = containerId_example; // String | The id of the Docker container.
        String applicationId = applicationId_example; // String | The id of the frontend application (to retrieve the execution logs).
        try {
            'String' result = apiInstance.containerLogs(containerId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DockerApi#containerLogs");
            e.printStackTrace();
        }
    }
}
String *containerId = containerId_example; // The id of the Docker container.
String *applicationId = applicationId_example; // The id of the frontend application (to retrieve the execution logs).

DockerApi *apiInstance = [[DockerApi alloc] init];

// Displays the Docker container logs for the given identifier.
[apiInstance containerLogsWith:containerId
    applicationId:applicationId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.DockerApi()
var containerId = containerId_example; // {{String}} The id of the Docker container.
var applicationId = applicationId_example; // {{String}} The id of the frontend application (to retrieve the execution logs).

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.containerLogs(containerId, applicationId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class containerLogsExample
    {
        public void main()
        {

            var apiInstance = new DockerApi();
            var containerId = containerId_example;  // String | The id of the Docker container.
            var applicationId = applicationId_example;  // String | The id of the frontend application (to retrieve the execution logs).

            try
            {
                // Displays the Docker container logs for the given identifier.
                'String' result = apiInstance.containerLogs(containerId, applicationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DockerApi.containerLogs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDockerApi();
$containerId = containerId_example; // String | The id of the Docker container.
$applicationId = applicationId_example; // String | The id of the frontend application (to retrieve the execution logs).

try {
    $result = $api_instance->containerLogs($containerId, $applicationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DockerApi->containerLogs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DockerApi;

my $api_instance = WWW::SwaggerClient::DockerApi->new();
my $containerId = containerId_example; # String | The id of the Docker container.
my $applicationId = applicationId_example; # String | The id of the frontend application (to retrieve the execution logs).

eval { 
    my $result = $api_instance->containerLogs(containerId => $containerId, applicationId => $applicationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DockerApi->containerLogs: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DockerApi()
containerId = containerId_example # String | The id of the Docker container.
applicationId = applicationId_example # String | The id of the frontend application (to retrieve the execution logs).

try: 
    # Displays the Docker container logs for the given identifier.
    api_response = api_instance.container_logs(containerId, applicationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DockerApi->containerLogs: %s\n" % e)

Parameters

Header parameters
Name Description
ApplicationId*
String
The id of the frontend application (to retrieve the execution logs).
Required
Query parameters
Name Description
containerId*
String
The id of the Docker container.
Required

Responses

Status: 200 - The logs command id.


containerRun

Creates a Docker container.


/docker/container/run

Usage and SDK Samples

curl -X POST "http://localhost:80/api/docker/container/run?name=&config="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DockerApi;

import java.io.File;
import java.util.*;

public class DockerApiExample {

    public static void main(String[] args) {
        
        DockerApi apiInstance = new DockerApi();
        String name = name_example; // String | The name of the Docker container.
        String config = config_example; // String | The [Spotify container configuration](https://github.com/spotify/docker-client/blob/master/src/main/java/com/spotify/docker/client/messages/ContainerConfig.java) written in `yml` format.
        try {
            'String' result = apiInstance.containerRun(name, config);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DockerApi#containerRun");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DockerApi;

public class DockerApiExample {

    public static void main(String[] args) {
        DockerApi apiInstance = new DockerApi();
        String name = name_example; // String | The name of the Docker container.
        String config = config_example; // String | The [Spotify container configuration](https://github.com/spotify/docker-client/blob/master/src/main/java/com/spotify/docker/client/messages/ContainerConfig.java) written in `yml` format.
        try {
            'String' result = apiInstance.containerRun(name, config);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DockerApi#containerRun");
            e.printStackTrace();
        }
    }
}
String *name = name_example; // The name of the Docker container.
String *config = config_example; // The [Spotify container configuration](https://github.com/spotify/docker-client/blob/master/src/main/java/com/spotify/docker/client/messages/ContainerConfig.java) written in `yml` format.

DockerApi *apiInstance = [[DockerApi alloc] init];

// Creates a Docker container.
[apiInstance containerRunWith:name
    config:config
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.DockerApi()
var name = name_example; // {{String}} The name of the Docker container.
var config = config_example; // {{String}} The [Spotify container configuration](https://github.com/spotify/docker-client/blob/master/src/main/java/com/spotify/docker/client/messages/ContainerConfig.java) written in `yml` format.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.containerRun(name, config, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class containerRunExample
    {
        public void main()
        {

            var apiInstance = new DockerApi();
            var name = name_example;  // String | The name of the Docker container.
            var config = config_example;  // String | The [Spotify container configuration](https://github.com/spotify/docker-client/blob/master/src/main/java/com/spotify/docker/client/messages/ContainerConfig.java) written in `yml` format.

            try
            {
                // Creates a Docker container.
                'String' result = apiInstance.containerRun(name, config);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DockerApi.containerRun: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDockerApi();
$name = name_example; // String | The name of the Docker container.
$config = config_example; // String | The [Spotify container configuration](https://github.com/spotify/docker-client/blob/master/src/main/java/com/spotify/docker/client/messages/ContainerConfig.java) written in `yml` format.

try {
    $result = $api_instance->containerRun($name, $config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DockerApi->containerRun: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DockerApi;

my $api_instance = WWW::SwaggerClient::DockerApi->new();
my $name = name_example; # String | The name of the Docker container.
my $config = config_example; # String | The [Spotify container configuration](https://github.com/spotify/docker-client/blob/master/src/main/java/com/spotify/docker/client/messages/ContainerConfig.java) written in `yml` format.

eval { 
    my $result = $api_instance->containerRun(name => $name, config => $config);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DockerApi->containerRun: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DockerApi()
name = name_example # String | The name of the Docker container.
config = config_example # String | The [Spotify container configuration](https://github.com/spotify/docker-client/blob/master/src/main/java/com/spotify/docker/client/messages/ContainerConfig.java) written in `yml` format.

try: 
    # Creates a Docker container.
    api_response = api_instance.container_run(name, config)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DockerApi->containerRun: %s\n" % e)

Parameters

Query parameters
Name Description
name*
String
The name of the Docker container.
Required
config*
String
The [Spotify container configuration](https://github.com/spotify/docker-client/blob/master/src/main/java/com/spotify/docker/client/messages/ContainerConfig.java) written in `yml` format.
Required

Responses

Status: 200 - The container id.


containerStart

Starts an existing Docker container.


/docker/container/start

Usage and SDK Samples

curl -X POST "http://localhost:80/api/docker/container/start?containerId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DockerApi;

import java.io.File;
import java.util.*;

public class DockerApiExample {

    public static void main(String[] args) {
        
        DockerApi apiInstance = new DockerApi();
        String containerId = containerId_example; // String | The ID of the Docker container.
        try {
            'Boolean' result = apiInstance.containerStart(containerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DockerApi#containerStart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DockerApi;

public class DockerApiExample {

    public static void main(String[] args) {
        DockerApi apiInstance = new DockerApi();
        String containerId = containerId_example; // String | The ID of the Docker container.
        try {
            'Boolean' result = apiInstance.containerStart(containerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DockerApi#containerStart");
            e.printStackTrace();
        }
    }
}
String *containerId = containerId_example; // The ID of the Docker container.

DockerApi *apiInstance = [[DockerApi alloc] init];

// Starts an existing Docker container.
[apiInstance containerStartWith:containerId
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.DockerApi()
var containerId = containerId_example; // {{String}} The ID of the Docker container.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.containerStart(containerId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class containerStartExample
    {
        public void main()
        {

            var apiInstance = new DockerApi();
            var containerId = containerId_example;  // String | The ID of the Docker container.

            try
            {
                // Starts an existing Docker container.
                'Boolean' result = apiInstance.containerStart(containerId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DockerApi.containerStart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDockerApi();
$containerId = containerId_example; // String | The ID of the Docker container.

try {
    $result = $api_instance->containerStart($containerId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DockerApi->containerStart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DockerApi;

my $api_instance = WWW::SwaggerClient::DockerApi->new();
my $containerId = containerId_example; # String | The ID of the Docker container.

eval { 
    my $result = $api_instance->containerStart(containerId => $containerId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DockerApi->containerStart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DockerApi()
containerId = containerId_example # String | The ID of the Docker container.

try: 
    # Starts an existing Docker container.
    api_response = api_instance.container_start(containerId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DockerApi->containerStart: %s\n" % e)

Parameters

Query parameters
Name Description
containerId*
String
The ID of the Docker container.
Required

Responses

Status: 200 - `true` if the container was started.


containerStop

Stops an existing Docker container.


/docker/container/stop

Usage and SDK Samples

curl -X DELETE "http://localhost:80/api/docker/container/stop?containerId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DockerApi;

import java.io.File;
import java.util.*;

public class DockerApiExample {

    public static void main(String[] args) {
        
        DockerApi apiInstance = new DockerApi();
        String containerId = containerId_example; // String | The ID of the Docker container.
        try {
            'Boolean' result = apiInstance.containerStop(containerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DockerApi#containerStop");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DockerApi;

public class DockerApiExample {

    public static void main(String[] args) {
        DockerApi apiInstance = new DockerApi();
        String containerId = containerId_example; // String | The ID of the Docker container.
        try {
            'Boolean' result = apiInstance.containerStop(containerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DockerApi#containerStop");
            e.printStackTrace();
        }
    }
}
String *containerId = containerId_example; // The ID of the Docker container.

DockerApi *apiInstance = [[DockerApi alloc] init];

// Stops an existing Docker container.
[apiInstance containerStopWith:containerId
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.DockerApi()
var containerId = containerId_example; // {{String}} The ID of the Docker container.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.containerStop(containerId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class containerStopExample
    {
        public void main()
        {

            var apiInstance = new DockerApi();
            var containerId = containerId_example;  // String | The ID of the Docker container.

            try
            {
                // Stops an existing Docker container.
                'Boolean' result = apiInstance.containerStop(containerId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DockerApi.containerStop: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDockerApi();
$containerId = containerId_example; // String | The ID of the Docker container.

try {
    $result = $api_instance->containerStop($containerId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DockerApi->containerStop: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DockerApi;

my $api_instance = WWW::SwaggerClient::DockerApi->new();
my $containerId = containerId_example; # String | The ID of the Docker container.

eval { 
    my $result = $api_instance->containerStop(containerId => $containerId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DockerApi->containerStop: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DockerApi()
containerId = containerId_example # String | The ID of the Docker container.

try: 
    # Stops an existing Docker container.
    api_response = api_instance.container_stop(containerId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DockerApi->containerStop: %s\n" % e)

Parameters

Query parameters
Name Description
containerId*
String
The ID of the Docker container.
Required

Responses

Status: 200 - `true` if the container was stoped.


containerTail

Displays the Docker container tail logs for the given identifier.


/docker/container/tail

Usage and SDK Samples

curl -X GET "http://localhost:80/api/docker/container/tail?containerId=&lines="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DockerApi;

import java.io.File;
import java.util.*;

public class DockerApiExample {

    public static void main(String[] args) {
        
        DockerApi apiInstance = new DockerApi();
        String containerId = containerId_example; // String | The id of the Docker container.
        Integer lines = 56; // Integer | The number of lines to returns.
        try {
            'String' result = apiInstance.containerTail(containerId, lines);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DockerApi#containerTail");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DockerApi;

public class DockerApiExample {

    public static void main(String[] args) {
        DockerApi apiInstance = new DockerApi();
        String containerId = containerId_example; // String | The id of the Docker container.
        Integer lines = 56; // Integer | The number of lines to returns.
        try {
            'String' result = apiInstance.containerTail(containerId, lines);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DockerApi#containerTail");
            e.printStackTrace();
        }
    }
}
String *containerId = containerId_example; // The id of the Docker container.
Integer *lines = 56; // The number of lines to returns.

DockerApi *apiInstance = [[DockerApi alloc] init];

// Displays the Docker container tail logs for the given identifier.
[apiInstance containerTailWith:containerId
    lines:lines
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.DockerApi()
var containerId = containerId_example; // {{String}} The id of the Docker container.
var lines = 56; // {{Integer}} The number of lines to returns.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.containerTail(containerId, lines, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class containerTailExample
    {
        public void main()
        {

            var apiInstance = new DockerApi();
            var containerId = containerId_example;  // String | The id of the Docker container.
            var lines = 56;  // Integer | The number of lines to returns.

            try
            {
                // Displays the Docker container tail logs for the given identifier.
                'String' result = apiInstance.containerTail(containerId, lines);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DockerApi.containerTail: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDockerApi();
$containerId = containerId_example; // String | The id of the Docker container.
$lines = 56; // Integer | The number of lines to returns.

try {
    $result = $api_instance->containerTail($containerId, $lines);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DockerApi->containerTail: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DockerApi;

my $api_instance = WWW::SwaggerClient::DockerApi->new();
my $containerId = containerId_example; # String | The id of the Docker container.
my $lines = 56; # Integer | The number of lines to returns.

eval { 
    my $result = $api_instance->containerTail(containerId => $containerId, lines => $lines);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DockerApi->containerTail: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DockerApi()
containerId = containerId_example # String | The id of the Docker container.
lines = 56 # Integer | The number of lines to returns.

try: 
    # Displays the Docker container tail logs for the given identifier.
    api_response = api_instance.container_tail(containerId, lines)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DockerApi->containerTail: %s\n" % e)

Parameters

Query parameters
Name Description
containerId*
String
The id of the Docker container.
Required
lines*
Integer
The number of lines to returns.
Required

Responses

Status: 200 - The logs tail.


containersList

Returns all Docker containers `docker ps`.


/docker/container/ps

Usage and SDK Samples

curl -X GET "http://localhost:80/api/docker/container/ps"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DockerApi;

import java.io.File;
import java.util.*;

public class DockerApiExample {

    public static void main(String[] args) {
        
        DockerApi apiInstance = new DockerApi();
        try {
            DockerContainers result = apiInstance.containersList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DockerApi#containersList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DockerApi;

public class DockerApiExample {

    public static void main(String[] args) {
        DockerApi apiInstance = new DockerApi();
        try {
            DockerContainers result = apiInstance.containersList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DockerApi#containersList");
            e.printStackTrace();
        }
    }
}

DockerApi *apiInstance = [[DockerApi alloc] init];

// Returns all Docker containers `docker ps`.
[apiInstance containersListWithCompletionHandler: 
              ^(DockerContainers output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.DockerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.containersList(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class containersListExample
    {
        public void main()
        {

            var apiInstance = new DockerApi();

            try
            {
                // Returns all Docker containers `docker ps`.
                DockerContainers result = apiInstance.containersList();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DockerApi.containersList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDockerApi();

try {
    $result = $api_instance->containersList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DockerApi->containersList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DockerApi;

my $api_instance = WWW::SwaggerClient::DockerApi->new();

eval { 
    my $result = $api_instance->containersList();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DockerApi->containersList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DockerApi()

try: 
    # Returns all Docker containers `docker ps`.
    api_response = api_instance.containers_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DockerApi->containersList: %s\n" % e)

Parameters

Responses

Status: 200 - The Docker containers.


imagePull

Pulls the given Docker image.


/docker/image/pull

Usage and SDK Samples

curl -X GET "http://localhost:80/api/docker/image/pull?image="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DockerApi;

import java.io.File;
import java.util.*;

public class DockerApiExample {

    public static void main(String[] args) {
        
        DockerApi apiInstance = new DockerApi();
        String image = image_example; // String | The name of the Docker image to pull.
        String applicationId = applicationId_example; // String | The id of the frontend application (to retrieve the execution logs).
        try {
            'String' result = apiInstance.imagePull(image, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DockerApi#imagePull");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DockerApi;

public class DockerApiExample {

    public static void main(String[] args) {
        DockerApi apiInstance = new DockerApi();
        String image = image_example; // String | The name of the Docker image to pull.
        String applicationId = applicationId_example; // String | The id of the frontend application (to retrieve the execution logs).
        try {
            'String' result = apiInstance.imagePull(image, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DockerApi#imagePull");
            e.printStackTrace();
        }
    }
}
String *image = image_example; // The name of the Docker image to pull.
String *applicationId = applicationId_example; // The id of the frontend application (to retrieve the execution logs).

DockerApi *apiInstance = [[DockerApi alloc] init];

// Pulls the given Docker image.
[apiInstance imagePullWith:image
    applicationId:applicationId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.DockerApi()
var image = image_example; // {{String}} The name of the Docker image to pull.
var applicationId = applicationId_example; // {{String}} The id of the frontend application (to retrieve the execution logs).

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.imagePull(image, applicationId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class imagePullExample
    {
        public void main()
        {

            var apiInstance = new DockerApi();
            var image = image_example;  // String | The name of the Docker image to pull.
            var applicationId = applicationId_example;  // String | The id of the frontend application (to retrieve the execution logs).

            try
            {
                // Pulls the given Docker image.
                'String' result = apiInstance.imagePull(image, applicationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DockerApi.imagePull: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDockerApi();
$image = image_example; // String | The name of the Docker image to pull.
$applicationId = applicationId_example; // String | The id of the frontend application (to retrieve the execution logs).

try {
    $result = $api_instance->imagePull($image, $applicationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DockerApi->imagePull: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DockerApi;

my $api_instance = WWW::SwaggerClient::DockerApi->new();
my $image = image_example; # String | The name of the Docker image to pull.
my $applicationId = applicationId_example; # String | The id of the frontend application (to retrieve the execution logs).

eval { 
    my $result = $api_instance->imagePull(image => $image, applicationId => $applicationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DockerApi->imagePull: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DockerApi()
image = image_example # String | The name of the Docker image to pull.
applicationId = applicationId_example # String | The id of the frontend application (to retrieve the execution logs).

try: 
    # Pulls the given Docker image.
    api_response = api_instance.image_pull(image, applicationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DockerApi->imagePull: %s\n" % e)

Parameters

Header parameters
Name Description
ApplicationId*
String
The id of the frontend application (to retrieve the execution logs).
Required
Query parameters
Name Description
image*
String
The name of the Docker image to pull.
Required

Responses

Status: 200 - The pull command id.


listImages

Returns the list of Docker Images available on the host.


/docker/image

Usage and SDK Samples

curl -X GET "http://localhost:80/api/docker/image"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DockerApi;

import java.io.File;
import java.util.*;

public class DockerApiExample {

    public static void main(String[] args) {
        
        DockerApi apiInstance = new DockerApi();
        try {
            DockerImages result = apiInstance.listImages();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DockerApi#listImages");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DockerApi;

public class DockerApiExample {

    public static void main(String[] args) {
        DockerApi apiInstance = new DockerApi();
        try {
            DockerImages result = apiInstance.listImages();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DockerApi#listImages");
            e.printStackTrace();
        }
    }
}

DockerApi *apiInstance = [[DockerApi alloc] init];

// Returns the list of Docker Images available on the host.
[apiInstance listImagesWithCompletionHandler: 
              ^(DockerImages output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.DockerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listImages(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listImagesExample
    {
        public void main()
        {

            var apiInstance = new DockerApi();

            try
            {
                // Returns the list of Docker Images available on the host.
                DockerImages result = apiInstance.listImages();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DockerApi.listImages: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDockerApi();

try {
    $result = $api_instance->listImages();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DockerApi->listImages: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DockerApi;

my $api_instance = WWW::SwaggerClient::DockerApi->new();

eval { 
    my $result = $api_instance->listImages();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DockerApi->listImages: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DockerApi()

try: 
    # Returns the list of Docker Images available on the host.
    api_response = api_instance.list_images()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DockerApi->listImages: %s\n" % e)

Parameters

Responses

Status: 200 - The list of Docker images.


systemPrune

Prunes the host Docker system.


/docker/system/prune

Usage and SDK Samples

curl -X GET "http://localhost:80/api/docker/system/prune?all=&volumes="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DockerApi;

import java.io.File;
import java.util.*;

public class DockerApiExample {

    public static void main(String[] args) {
        
        DockerApi apiInstance = new DockerApi();
        Boolean all = true; // Boolean | Should all images be removed.
        Boolean volumes = true; // Boolean | Should all volumes be removed.
        String applicationId = applicationId_example; // String | The id of the frontend application (to retrieve the execution logs).
        try {
            'String' result = apiInstance.systemPrune(all, volumes, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DockerApi#systemPrune");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DockerApi;

public class DockerApiExample {

    public static void main(String[] args) {
        DockerApi apiInstance = new DockerApi();
        Boolean all = true; // Boolean | Should all images be removed.
        Boolean volumes = true; // Boolean | Should all volumes be removed.
        String applicationId = applicationId_example; // String | The id of the frontend application (to retrieve the execution logs).
        try {
            'String' result = apiInstance.systemPrune(all, volumes, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DockerApi#systemPrune");
            e.printStackTrace();
        }
    }
}
Boolean *all = true; // Should all images be removed.
Boolean *volumes = true; // Should all volumes be removed.
String *applicationId = applicationId_example; // The id of the frontend application (to retrieve the execution logs).

DockerApi *apiInstance = [[DockerApi alloc] init];

// Prunes the host Docker system.
[apiInstance systemPruneWith:all
    volumes:volumes
    applicationId:applicationId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.DockerApi()
var all = true; // {{Boolean}} Should all images be removed.
var volumes = true; // {{Boolean}} Should all volumes be removed.
var applicationId = applicationId_example; // {{String}} The id of the frontend application (to retrieve the execution logs).

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.systemPrune(all, volumes, applicationId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class systemPruneExample
    {
        public void main()
        {

            var apiInstance = new DockerApi();
            var all = true;  // Boolean | Should all images be removed.
            var volumes = true;  // Boolean | Should all volumes be removed.
            var applicationId = applicationId_example;  // String | The id of the frontend application (to retrieve the execution logs).

            try
            {
                // Prunes the host Docker system.
                'String' result = apiInstance.systemPrune(all, volumes, applicationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DockerApi.systemPrune: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDockerApi();
$all = true; // Boolean | Should all images be removed.
$volumes = true; // Boolean | Should all volumes be removed.
$applicationId = applicationId_example; // String | The id of the frontend application (to retrieve the execution logs).

try {
    $result = $api_instance->systemPrune($all, $volumes, $applicationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DockerApi->systemPrune: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DockerApi;

my $api_instance = WWW::SwaggerClient::DockerApi->new();
my $all = true; # Boolean | Should all images be removed.
my $volumes = true; # Boolean | Should all volumes be removed.
my $applicationId = applicationId_example; # String | The id of the frontend application (to retrieve the execution logs).

eval { 
    my $result = $api_instance->systemPrune(all => $all, volumes => $volumes, applicationId => $applicationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DockerApi->systemPrune: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DockerApi()
all = true # Boolean | Should all images be removed.
volumes = true # Boolean | Should all volumes be removed.
applicationId = applicationId_example # String | The id of the frontend application (to retrieve the execution logs).

try: 
    # Prunes the host Docker system.
    api_response = api_instance.system_prune(all, volumes, applicationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DockerApi->systemPrune: %s\n" % e)

Parameters

Header parameters
Name Description
ApplicationId*
String
The id of the frontend application (to retrieve the execution logs).
Required
Query parameters
Name Description
all*
Boolean
Should all images be removed.
Required
volumes*
Boolean
Should all volumes be removed.
Required

Responses

Status: 200 - The prune command id.


Storage

copyNodes

Copies the files (paths given in request body) into the destination folder.


/storage/files/copy

Usage and SDK Samples

curl -X POST "http://localhost:80/api/storage/files/copy?destination="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StorageApi;

import java.io.File;
import java.util.*;

public class StorageApiExample {

    public static void main(String[] args) {
        
        StorageApi apiInstance = new StorageApi();
        array[String] body = ; // array[String] | A list of file paths
        String destination = destination_example; // String | The destination folder path.
        try {
            StorageNodes result = apiInstance.copyNodes(body, destination);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#copyNodes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StorageApi;

public class StorageApiExample {

    public static void main(String[] args) {
        StorageApi apiInstance = new StorageApi();
        array[String] body = ; // array[String] | A list of file paths
        String destination = destination_example; // String | The destination folder path.
        try {
            StorageNodes result = apiInstance.copyNodes(body, destination);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#copyNodes");
            e.printStackTrace();
        }
    }
}
array[String] *body = ; // A list of file paths
String *destination = destination_example; // The destination folder path.

StorageApi *apiInstance = [[StorageApi alloc] init];

// Copies the files (paths given in request body) into the destination folder.
[apiInstance copyNodesWith:body
    destination:destination
              completionHandler: ^(StorageNodes output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.StorageApi()
var body = ; // {{array[String]}} A list of file paths
var destination = destination_example; // {{String}} The destination folder path.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.copyNodes(bodydestination, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class copyNodesExample
    {
        public void main()
        {

            var apiInstance = new StorageApi();
            var body = new array[String](); // array[String] | A list of file paths
            var destination = destination_example;  // String | The destination folder path.

            try
            {
                // Copies the files (paths given in request body) into the destination folder.
                StorageNodes result = apiInstance.copyNodes(body, destination);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StorageApi.copyNodes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStorageApi();
$body = ; // array[String] | A list of file paths
$destination = destination_example; // String | The destination folder path.

try {
    $result = $api_instance->copyNodes($body, $destination);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorageApi->copyNodes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StorageApi;

my $api_instance = WWW::SwaggerClient::StorageApi->new();
my $body = [WWW::SwaggerClient::Object::array[String]->new()]; # array[String] | A list of file paths
my $destination = destination_example; # String | The destination folder path.

eval { 
    my $result = $api_instance->copyNodes(body => $body, destination => $destination);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StorageApi->copyNodes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StorageApi()
body =  # array[String] | A list of file paths
destination = destination_example # String | The destination folder path.

try: 
    # Copies the files (paths given in request body) into the destination folder.
    api_response = api_instance.copy_nodes(body, destination)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StorageApi->copyNodes: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
destination*
String
The destination folder path.
Required

Responses

Status: 200 - The storage nodes for the copied files.

Status: 400 - You probably forgot the 'destination' parameter.


deleteNodes

Delete the storage nodes for the given path array.


/storage/files/delete

Usage and SDK Samples

curl -X POST "http://localhost:80/api/storage/files/delete"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StorageApi;

import java.io.File;
import java.util.*;

public class StorageApiExample {

    public static void main(String[] args) {
        
        StorageApi apiInstance = new StorageApi();
        array[String] body = ; // array[String] | A list of file paths
        try {
            Booleans result = apiInstance.deleteNodes(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#deleteNodes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StorageApi;

public class StorageApiExample {

    public static void main(String[] args) {
        StorageApi apiInstance = new StorageApi();
        array[String] body = ; // array[String] | A list of file paths
        try {
            Booleans result = apiInstance.deleteNodes(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#deleteNodes");
            e.printStackTrace();
        }
    }
}
array[String] *body = ; // A list of file paths

StorageApi *apiInstance = [[StorageApi alloc] init];

// Delete the storage nodes for the given path array.
[apiInstance deleteNodesWith:body
              completionHandler: ^(Booleans output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.StorageApi()
var body = ; // {{array[String]}} A list of file paths

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteNodes(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteNodesExample
    {
        public void main()
        {

            var apiInstance = new StorageApi();
            var body = new array[String](); // array[String] | A list of file paths

            try
            {
                // Delete the storage nodes for the given path array.
                Booleans result = apiInstance.deleteNodes(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StorageApi.deleteNodes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStorageApi();
$body = ; // array[String] | A list of file paths

try {
    $result = $api_instance->deleteNodes($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorageApi->deleteNodes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StorageApi;

my $api_instance = WWW::SwaggerClient::StorageApi->new();
my $body = [WWW::SwaggerClient::Object::array[String]->new()]; # array[String] | A list of file paths

eval { 
    my $result = $api_instance->deleteNodes(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StorageApi->deleteNodes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StorageApi()
body =  # array[String] | A list of file paths

try: 
    # Delete the storage nodes for the given path array.
    api_response = api_instance.delete_nodes(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StorageApi->deleteNodes: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - The deletion result (true means that the node was deleted).


filterExistingNodes

Filter paths given in request body keeping only the ones associated to existing files.


/storage/files/filter/existing

Usage and SDK Samples

curl -X POST "http://localhost:80/api/storage/files/filter/existing"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StorageApi;

import java.io.File;
import java.util.*;

public class StorageApiExample {

    public static void main(String[] args) {
        
        StorageApi apiInstance = new StorageApi();
        array[String] body = ; // array[String] | A list of file paths
        try {
            StorageNodes result = apiInstance.filterExistingNodes(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#filterExistingNodes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StorageApi;

public class StorageApiExample {

    public static void main(String[] args) {
        StorageApi apiInstance = new StorageApi();
        array[String] body = ; // array[String] | A list of file paths
        try {
            StorageNodes result = apiInstance.filterExistingNodes(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#filterExistingNodes");
            e.printStackTrace();
        }
    }
}
array[String] *body = ; // A list of file paths

StorageApi *apiInstance = [[StorageApi alloc] init];

// Filter paths given in request body keeping only the ones associated to existing files.
[apiInstance filterExistingNodesWith:body
              completionHandler: ^(StorageNodes output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.StorageApi()
var body = ; // {{array[String]}} A list of file paths

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.filterExistingNodes(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class filterExistingNodesExample
    {
        public void main()
        {

            var apiInstance = new StorageApi();
            var body = new array[String](); // array[String] | A list of file paths

            try
            {
                // Filter paths given in request body keeping only the ones associated to existing files.
                StorageNodes result = apiInstance.filterExistingNodes(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StorageApi.filterExistingNodes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStorageApi();
$body = ; // array[String] | A list of file paths

try {
    $result = $api_instance->filterExistingNodes($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorageApi->filterExistingNodes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StorageApi;

my $api_instance = WWW::SwaggerClient::StorageApi->new();
my $body = [WWW::SwaggerClient::Object::array[String]->new()]; # array[String] | A list of file paths

eval { 
    my $result = $api_instance->filterExistingNodes(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StorageApi->filterExistingNodes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StorageApi()
body =  # array[String] | A list of file paths

try: 
    # Filter paths given in request body keeping only the ones associated to existing files.
    api_response = api_instance.filter_existing_nodes(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StorageApi->filterExistingNodes: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - The existing file storage nodes.


findNodes

Finds all storage nodes that match the given criteria.


/storage/files/find

Usage and SDK Samples

curl -X GET "http://localhost:80/api/storage/files/find?rootPath=&maxDepth=&matcher="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StorageApi;

import java.io.File;
import java.util.*;

public class StorageApiExample {

    public static void main(String[] args) {
        
        StorageApi apiInstance = new StorageApi();
        String rootPath = rootPath_example; // String | The root directory path (defaults to the Kraken root).
        Integer maxDepth = 56; // Integer | The maximum depth to look for files.
        String matcher = matcher_example; // String | A [Java Regular Expression](https://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html) that is matched against file names. Defaults to `.*`.
        try {
            StorageNodes result = apiInstance.findNodes(rootPath, maxDepth, matcher);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#findNodes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StorageApi;

public class StorageApiExample {

    public static void main(String[] args) {
        StorageApi apiInstance = new StorageApi();
        String rootPath = rootPath_example; // String | The root directory path (defaults to the Kraken root).
        Integer maxDepth = 56; // Integer | The maximum depth to look for files.
        String matcher = matcher_example; // String | A [Java Regular Expression](https://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html) that is matched against file names. Defaults to `.*`.
        try {
            StorageNodes result = apiInstance.findNodes(rootPath, maxDepth, matcher);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#findNodes");
            e.printStackTrace();
        }
    }
}
String *rootPath = rootPath_example; // The root directory path (defaults to the Kraken root). (optional)
Integer *maxDepth = 56; // The maximum depth to look for files. (optional)
String *matcher = matcher_example; // A [Java Regular Expression](https://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html) that is matched against file names. Defaults to `.*`. (optional)

StorageApi *apiInstance = [[StorageApi alloc] init];

// Finds all storage nodes that match the given criteria.
[apiInstance findNodesWith:rootPath
    maxDepth:maxDepth
    matcher:matcher
              completionHandler: ^(StorageNodes output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.StorageApi()
var opts = { 
  'rootPath': rootPath_example, // {{String}} The root directory path (defaults to the Kraken root).
  'maxDepth': 56, // {{Integer}} The maximum depth to look for files.
  'matcher': matcher_example // {{String}} A [Java Regular Expression](https://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html) that is matched against file names. Defaults to `.*`.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findNodes(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findNodesExample
    {
        public void main()
        {

            var apiInstance = new StorageApi();
            var rootPath = rootPath_example;  // String | The root directory path (defaults to the Kraken root). (optional) 
            var maxDepth = 56;  // Integer | The maximum depth to look for files. (optional) 
            var matcher = matcher_example;  // String | A [Java Regular Expression](https://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html) that is matched against file names. Defaults to `.*`. (optional) 

            try
            {
                // Finds all storage nodes that match the given criteria.
                StorageNodes result = apiInstance.findNodes(rootPath, maxDepth, matcher);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StorageApi.findNodes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStorageApi();
$rootPath = rootPath_example; // String | The root directory path (defaults to the Kraken root).
$maxDepth = 56; // Integer | The maximum depth to look for files.
$matcher = matcher_example; // String | A [Java Regular Expression](https://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html) that is matched against file names. Defaults to `.*`.

try {
    $result = $api_instance->findNodes($rootPath, $maxDepth, $matcher);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorageApi->findNodes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StorageApi;

my $api_instance = WWW::SwaggerClient::StorageApi->new();
my $rootPath = rootPath_example; # String | The root directory path (defaults to the Kraken root).
my $maxDepth = 56; # Integer | The maximum depth to look for files.
my $matcher = matcher_example; # String | A [Java Regular Expression](https://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html) that is matched against file names. Defaults to `.*`.

eval { 
    my $result = $api_instance->findNodes(rootPath => $rootPath, maxDepth => $maxDepth, matcher => $matcher);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StorageApi->findNodes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StorageApi()
rootPath = rootPath_example # String | The root directory path (defaults to the Kraken root). (optional)
maxDepth = 56 # Integer | The maximum depth to look for files. (optional)
matcher = matcher_example # String | A [Java Regular Expression](https://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html) that is matched against file names. Defaults to `.*`. (optional)

try: 
    # Finds all storage nodes that match the given criteria.
    api_response = api_instance.find_nodes(rootPath=rootPath, maxDepth=maxDepth, matcher=matcher)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StorageApi->findNodes: %s\n" % e)

Parameters

Query parameters
Name Description
rootPath
String
The root directory path (defaults to the Kraken root).
maxDepth
Integer
The maximum depth to look for files.
matcher
String
A [Java Regular Expression](https://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html) that is matched against file names. Defaults to `.*`.

Responses

Status: 200 - An array of storage nodes.


getContent

Returns the String content of a file.


/storage/files/get/content

Usage and SDK Samples

curl -X GET "http://localhost:80/api/storage/files/get/content?path="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StorageApi;

import java.io.File;
import java.util.*;

public class StorageApiExample {

    public static void main(String[] args) {
        
        StorageApi apiInstance = new StorageApi();
        String path = path_example; // String | The file path.
        try {
            'String' result = apiInstance.getContent(path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#getContent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StorageApi;

public class StorageApiExample {

    public static void main(String[] args) {
        StorageApi apiInstance = new StorageApi();
        String path = path_example; // String | The file path.
        try {
            'String' result = apiInstance.getContent(path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#getContent");
            e.printStackTrace();
        }
    }
}
String *path = path_example; // The file path.

StorageApi *apiInstance = [[StorageApi alloc] init];

// Returns the String content of a file.
[apiInstance getContentWith:path
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.StorageApi()
var path = path_example; // {{String}} The file path.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getContent(path, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getContentExample
    {
        public void main()
        {

            var apiInstance = new StorageApi();
            var path = path_example;  // String | The file path.

            try
            {
                // Returns the String content of a file.
                'String' result = apiInstance.getContent(path);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StorageApi.getContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStorageApi();
$path = path_example; // String | The file path.

try {
    $result = $api_instance->getContent($path);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorageApi->getContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StorageApi;

my $api_instance = WWW::SwaggerClient::StorageApi->new();
my $path = path_example; # String | The file path.

eval { 
    my $result = $api_instance->getContent(path => $path);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StorageApi->getContent: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StorageApi()
path = path_example # String | The file path.

try: 
    # Returns the String content of a file.
    api_response = api_instance.get_content(path)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StorageApi->getContent: %s\n" % e)

Parameters

Query parameters
Name Description
path*
String
The file path.
Required

Responses

Status: 200 - The content of the file.

Status: 400 - You probably forgot the 'path' parameter.


getFile

Downloads a file or folder.


/storage/files/get/file

Usage and SDK Samples

curl -X GET "http://localhost:80/api/storage/files/get/file?path="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StorageApi;

import java.io.File;
import java.util.*;

public class StorageApiExample {

    public static void main(String[] args) {
        
        StorageApi apiInstance = new StorageApi();
        String path = path_example; // String | The file or directory path (or the root directory if not provided).
        try {
            byte[] result = apiInstance.getFile(path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#getFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StorageApi;

public class StorageApiExample {

    public static void main(String[] args) {
        StorageApi apiInstance = new StorageApi();
        String path = path_example; // String | The file or directory path (or the root directory if not provided).
        try {
            byte[] result = apiInstance.getFile(path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#getFile");
            e.printStackTrace();
        }
    }
}
String *path = path_example; // The file or directory path (or the root directory if not provided). (optional)

StorageApi *apiInstance = [[StorageApi alloc] init];

// Downloads a file or folder.
[apiInstance getFileWith:path
              completionHandler: ^(byte[] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.StorageApi()
var opts = { 
  'path': path_example // {{String}} The file or directory path (or the root directory if not provided).
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFile(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFileExample
    {
        public void main()
        {

            var apiInstance = new StorageApi();
            var path = path_example;  // String | The file or directory path (or the root directory if not provided). (optional) 

            try
            {
                // Downloads a file or folder.
                byte[] result = apiInstance.getFile(path);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StorageApi.getFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStorageApi();
$path = path_example; // String | The file or directory path (or the root directory if not provided).

try {
    $result = $api_instance->getFile($path);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorageApi->getFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StorageApi;

my $api_instance = WWW::SwaggerClient::StorageApi->new();
my $path = path_example; # String | The file or directory path (or the root directory if not provided).

eval { 
    my $result = $api_instance->getFile(path => $path);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StorageApi->getFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StorageApi()
path = path_example # String | The file or directory path (or the root directory if not provided). (optional)

try: 
    # Downloads a file or folder.
    api_response = api_instance.get_file(path=path)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StorageApi->getFile: %s\n" % e)

Parameters

Query parameters
Name Description
path
String
The file or directory path (or the root directory if not provided).

Responses

Status: 200 - The file or a .zip archive of the folder.


getJson

Returns a JSON object (content of the given file).


/storage/files/get/json

Usage and SDK Samples

curl -X GET "http://localhost:80/api/storage/files/get/json?path="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StorageApi;

import java.io.File;
import java.util.*;

public class StorageApiExample {

    public static void main(String[] args) {
        
        StorageApi apiInstance = new StorageApi();
        String path = path_example; // String | The file path.
        try {
            'String' result = apiInstance.getJson(path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#getJson");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StorageApi;

public class StorageApiExample {

    public static void main(String[] args) {
        StorageApi apiInstance = new StorageApi();
        String path = path_example; // String | The file path.
        try {
            'String' result = apiInstance.getJson(path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#getJson");
            e.printStackTrace();
        }
    }
}
String *path = path_example; // The file path.

StorageApi *apiInstance = [[StorageApi alloc] init];

// Returns a JSON object (content of the given file).
[apiInstance getJsonWith:path
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.StorageApi()
var path = path_example; // {{String}} The file path.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getJson(path, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getJsonExample
    {
        public void main()
        {

            var apiInstance = new StorageApi();
            var path = path_example;  // String | The file path.

            try
            {
                // Returns a JSON object (content of the given file).
                'String' result = apiInstance.getJson(path);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StorageApi.getJson: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStorageApi();
$path = path_example; // String | The file path.

try {
    $result = $api_instance->getJson($path);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorageApi->getJson: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StorageApi;

my $api_instance = WWW::SwaggerClient::StorageApi->new();
my $path = path_example; # String | The file path.

eval { 
    my $result = $api_instance->getJson(path => $path);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StorageApi->getJson: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StorageApi()
path = path_example # String | The file path.

try: 
    # Returns a JSON object (content of the given file).
    api_response = api_instance.get_json(path)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StorageApi->getJson: %s\n" % e)

Parameters

Query parameters
Name Description
path*
String
The file path.
Required

Responses

Status: 200 - The JSON content of the file.


getNode

Returns the storage nodes for the given path.


/storage/files/get

Usage and SDK Samples

curl -X GET "http://localhost:80/api/storage/files/get?path="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StorageApi;

import java.io.File;
import java.util.*;

public class StorageApiExample {

    public static void main(String[] args) {
        
        StorageApi apiInstance = new StorageApi();
        String path = path_example; // String | The file path.
        try {
            StorageNode result = apiInstance.getNode(path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#getNode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StorageApi;

public class StorageApiExample {

    public static void main(String[] args) {
        StorageApi apiInstance = new StorageApi();
        String path = path_example; // String | The file path.
        try {
            StorageNode result = apiInstance.getNode(path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#getNode");
            e.printStackTrace();
        }
    }
}
String *path = path_example; // The file path.

StorageApi *apiInstance = [[StorageApi alloc] init];

// Returns the storage nodes for the given path.
[apiInstance getNodeWith:path
              completionHandler: ^(StorageNode output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.StorageApi()
var path = path_example; // {{String}} The file path.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getNode(path, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getNodeExample
    {
        public void main()
        {

            var apiInstance = new StorageApi();
            var path = path_example;  // String | The file path.

            try
            {
                // Returns the storage nodes for the given path.
                StorageNode result = apiInstance.getNode(path);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StorageApi.getNode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStorageApi();
$path = path_example; // String | The file path.

try {
    $result = $api_instance->getNode($path);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorageApi->getNode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StorageApi;

my $api_instance = WWW::SwaggerClient::StorageApi->new();
my $path = path_example; # String | The file path.

eval { 
    my $result = $api_instance->getNode(path => $path);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StorageApi->getNode: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StorageApi()
path = path_example # String | The file path.

try: 
    # Returns the storage nodes for the given path.
    api_response = api_instance.get_node(path)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StorageApi->getNode: %s\n" % e)

Parameters

Query parameters
Name Description
path*
String
The file path.
Required

Responses

Status: 200 - A storage node.

Status: 400 - You probably forgot the 'path' parameter.


listJson

Returns an array of JSON objects, given a list of paths.


/storage/files/list/json

Usage and SDK Samples

curl -X POST "http://localhost:80/api/storage/files/list/json"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StorageApi;

import java.io.File;
import java.util.*;

public class StorageApiExample {

    public static void main(String[] args) {
        
        StorageApi apiInstance = new StorageApi();
        array[String] body = ; // array[String] | A list of file paths
        try {
            'String' result = apiInstance.listJson(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#listJson");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StorageApi;

public class StorageApiExample {

    public static void main(String[] args) {
        StorageApi apiInstance = new StorageApi();
        array[String] body = ; // array[String] | A list of file paths
        try {
            'String' result = apiInstance.listJson(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#listJson");
            e.printStackTrace();
        }
    }
}
array[String] *body = ; // A list of file paths

StorageApi *apiInstance = [[StorageApi alloc] init];

// Returns an array of JSON objects, given a list of paths.
[apiInstance listJsonWith:body
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.StorageApi()
var body = ; // {{array[String]}} A list of file paths

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listJson(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listJsonExample
    {
        public void main()
        {

            var apiInstance = new StorageApi();
            var body = new array[String](); // array[String] | A list of file paths

            try
            {
                // Returns an array of JSON objects, given a list of paths.
                'String' result = apiInstance.listJson(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StorageApi.listJson: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStorageApi();
$body = ; // array[String] | A list of file paths

try {
    $result = $api_instance->listJson($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorageApi->listJson: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StorageApi;

my $api_instance = WWW::SwaggerClient::StorageApi->new();
my $body = [WWW::SwaggerClient::Object::array[String]->new()]; # array[String] | A list of file paths

eval { 
    my $result = $api_instance->listJson(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StorageApi->listJson: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StorageApi()
body =  # array[String] | A list of file paths

try: 
    # Returns an array of JSON objects, given a list of paths.
    api_response = api_instance.list_json(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StorageApi->listJson: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - The JSON content of the files.


listNodes

List all nodes


/storage/files/list

Usage and SDK Samples

curl -X GET "http://localhost:80/api/storage/files/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StorageApi;

import java.io.File;
import java.util.*;

public class StorageApiExample {

    public static void main(String[] args) {
        
        StorageApi apiInstance = new StorageApi();
        try {
            StorageNodes result = apiInstance.listNodes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#listNodes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StorageApi;

public class StorageApiExample {

    public static void main(String[] args) {
        StorageApi apiInstance = new StorageApi();
        try {
            StorageNodes result = apiInstance.listNodes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#listNodes");
            e.printStackTrace();
        }
    }
}

StorageApi *apiInstance = [[StorageApi alloc] init];

// List all nodes
[apiInstance listNodesWithCompletionHandler: 
              ^(StorageNodes output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.StorageApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listNodes(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listNodesExample
    {
        public void main()
        {

            var apiInstance = new StorageApi();

            try
            {
                // List all nodes
                StorageNodes result = apiInstance.listNodes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StorageApi.listNodes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStorageApi();

try {
    $result = $api_instance->listNodes();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorageApi->listNodes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StorageApi;

my $api_instance = WWW::SwaggerClient::StorageApi->new();

eval { 
    my $result = $api_instance->listNodes();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StorageApi->listNodes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StorageApi()

try: 
    # List all nodes
    api_response = api_instance.list_nodes()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StorageApi->listNodes: %s\n" % e)

Parameters

Responses

Status: 200 - An array of storage nodes


moveNodes

Moves the files (paths given in request body) into the destination folder.


/storage/files/move

Usage and SDK Samples

curl -X POST "http://localhost:80/api/storage/files/move?destination="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StorageApi;

import java.io.File;
import java.util.*;

public class StorageApiExample {

    public static void main(String[] args) {
        
        StorageApi apiInstance = new StorageApi();
        array[String] body = ; // array[String] | A list of file paths
        String destination = destination_example; // String | The destination folder path.
        try {
            StorageNodes result = apiInstance.moveNodes(body, destination);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#moveNodes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StorageApi;

public class StorageApiExample {

    public static void main(String[] args) {
        StorageApi apiInstance = new StorageApi();
        array[String] body = ; // array[String] | A list of file paths
        String destination = destination_example; // String | The destination folder path.
        try {
            StorageNodes result = apiInstance.moveNodes(body, destination);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#moveNodes");
            e.printStackTrace();
        }
    }
}
array[String] *body = ; // A list of file paths
String *destination = destination_example; // The destination folder path.

StorageApi *apiInstance = [[StorageApi alloc] init];

// Moves the files (paths given in request body) into the destination folder.
[apiInstance moveNodesWith:body
    destination:destination
              completionHandler: ^(StorageNodes output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.StorageApi()
var body = ; // {{array[String]}} A list of file paths
var destination = destination_example; // {{String}} The destination folder path.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.moveNodes(bodydestination, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class moveNodesExample
    {
        public void main()
        {

            var apiInstance = new StorageApi();
            var body = new array[String](); // array[String] | A list of file paths
            var destination = destination_example;  // String | The destination folder path.

            try
            {
                // Moves the files (paths given in request body) into the destination folder.
                StorageNodes result = apiInstance.moveNodes(body, destination);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StorageApi.moveNodes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStorageApi();
$body = ; // array[String] | A list of file paths
$destination = destination_example; // String | The destination folder path.

try {
    $result = $api_instance->moveNodes($body, $destination);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorageApi->moveNodes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StorageApi;

my $api_instance = WWW::SwaggerClient::StorageApi->new();
my $body = [WWW::SwaggerClient::Object::array[String]->new()]; # array[String] | A list of file paths
my $destination = destination_example; # String | The destination folder path.

eval { 
    my $result = $api_instance->moveNodes(body => $body, destination => $destination);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StorageApi->moveNodes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StorageApi()
body =  # array[String] | A list of file paths
destination = destination_example # String | The destination folder path.

try: 
    # Moves the files (paths given in request body) into the destination folder.
    api_response = api_instance.move_nodes(body, destination)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StorageApi->moveNodes: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
destination*
String
The destination folder path.
Required

Responses

Status: 200 - The storage nodes for the moved files.

Status: 400 - You probably forgot the 'destination' parameter.


renameNode

Renames a file or directory.


/storage/files/rename

Usage and SDK Samples

curl -X POST "http://localhost:80/api/storage/files/rename?directoryPath=&oldName=&newName="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StorageApi;

import java.io.File;
import java.util.*;

public class StorageApiExample {

    public static void main(String[] args) {
        
        StorageApi apiInstance = new StorageApi();
        String oldName = oldName_example; // String | The current name of the file to rename.
        String newName = newName_example; // String | The new name of the file to rename.
        String directoryPath = directoryPath_example; // String | The parent directory path (or the root directory if not provided).
        try {
            StorageNode result = apiInstance.renameNode(oldName, newName, directoryPath);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#renameNode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StorageApi;

public class StorageApiExample {

    public static void main(String[] args) {
        StorageApi apiInstance = new StorageApi();
        String oldName = oldName_example; // String | The current name of the file to rename.
        String newName = newName_example; // String | The new name of the file to rename.
        String directoryPath = directoryPath_example; // String | The parent directory path (or the root directory if not provided).
        try {
            StorageNode result = apiInstance.renameNode(oldName, newName, directoryPath);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#renameNode");
            e.printStackTrace();
        }
    }
}
String *oldName = oldName_example; // The current name of the file to rename.
String *newName = newName_example; // The new name of the file to rename.
String *directoryPath = directoryPath_example; // The parent directory path (or the root directory if not provided). (optional)

StorageApi *apiInstance = [[StorageApi alloc] init];

// Renames a file or directory.
[apiInstance renameNodeWith:oldName
    newName:newName
    directoryPath:directoryPath
              completionHandler: ^(StorageNode output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.StorageApi()
var oldName = oldName_example; // {{String}} The current name of the file to rename.
var newName = newName_example; // {{String}} The new name of the file to rename.
var opts = { 
  'directoryPath': directoryPath_example // {{String}} The parent directory path (or the root directory if not provided).
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.renameNode(oldName, newName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class renameNodeExample
    {
        public void main()
        {

            var apiInstance = new StorageApi();
            var oldName = oldName_example;  // String | The current name of the file to rename.
            var newName = newName_example;  // String | The new name of the file to rename.
            var directoryPath = directoryPath_example;  // String | The parent directory path (or the root directory if not provided). (optional) 

            try
            {
                // Renames a file or directory.
                StorageNode result = apiInstance.renameNode(oldName, newName, directoryPath);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StorageApi.renameNode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStorageApi();
$oldName = oldName_example; // String | The current name of the file to rename.
$newName = newName_example; // String | The new name of the file to rename.
$directoryPath = directoryPath_example; // String | The parent directory path (or the root directory if not provided).

try {
    $result = $api_instance->renameNode($oldName, $newName, $directoryPath);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorageApi->renameNode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StorageApi;

my $api_instance = WWW::SwaggerClient::StorageApi->new();
my $oldName = oldName_example; # String | The current name of the file to rename.
my $newName = newName_example; # String | The new name of the file to rename.
my $directoryPath = directoryPath_example; # String | The parent directory path (or the root directory if not provided).

eval { 
    my $result = $api_instance->renameNode(oldName => $oldName, newName => $newName, directoryPath => $directoryPath);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StorageApi->renameNode: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StorageApi()
oldName = oldName_example # String | The current name of the file to rename.
newName = newName_example # String | The new name of the file to rename.
directoryPath = directoryPath_example # String | The parent directory path (or the root directory if not provided). (optional)

try: 
    # Renames a file or directory.
    api_response = api_instance.rename_node(oldName, newName, directoryPath=directoryPath)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StorageApi->renameNode: %s\n" % e)

Parameters

Query parameters
Name Description
directoryPath
String
The parent directory path (or the root directory if not provided).
oldName*
String
The current name of the file to rename.
Required
newName*
String
The new name of the file to rename.
Required

Responses

Status: 200 - The storage node for the renamed file or directory.


setContent

Sets the String content for a file (the file is created if it does not exist).


/storage/files/set/content

Usage and SDK Samples

curl -X POST "http://localhost:80/api/storage/files/set/content?path="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StorageApi;

import java.io.File;
import java.util.*;

public class StorageApiExample {

    public static void main(String[] args) {
        
        StorageApi apiInstance = new StorageApi();
        String path = path_example; // String | The file path.
        String body = ; // String | Defaults to an empty string.
        try {
            StorageNode result = apiInstance.setContent(path, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#setContent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StorageApi;

public class StorageApiExample {

    public static void main(String[] args) {
        StorageApi apiInstance = new StorageApi();
        String path = path_example; // String | The file path.
        String body = ; // String | Defaults to an empty string.
        try {
            StorageNode result = apiInstance.setContent(path, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#setContent");
            e.printStackTrace();
        }
    }
}
String *path = path_example; // The file path.
String *body = ; // Defaults to an empty string. (optional)

StorageApi *apiInstance = [[StorageApi alloc] init];

// Sets the String content for a file (the file is created if it does not exist).
[apiInstance setContentWith:path
    body:body
              completionHandler: ^(StorageNode output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.StorageApi()
var path = path_example; // {{String}} The file path.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setContent(path, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setContentExample
    {
        public void main()
        {

            var apiInstance = new StorageApi();
            var path = path_example;  // String | The file path.
            var body = new String(); // String | Defaults to an empty string. (optional) 

            try
            {
                // Sets the String content for a file (the file is created if it does not exist).
                StorageNode result = apiInstance.setContent(path, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StorageApi.setContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStorageApi();
$path = path_example; // String | The file path.
$body = ; // String | Defaults to an empty string.

try {
    $result = $api_instance->setContent($path, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorageApi->setContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StorageApi;

my $api_instance = WWW::SwaggerClient::StorageApi->new();
my $path = path_example; # String | The file path.
my $body = WWW::SwaggerClient::Object::String->new(); # String | Defaults to an empty string.

eval { 
    my $result = $api_instance->setContent(path => $path, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StorageApi->setContent: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StorageApi()
path = path_example # String | The file path.
body =  # String | Defaults to an empty string. (optional)

try: 
    # Sets the String content for a file (the file is created if it does not exist).
    api_response = api_instance.set_content(path, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StorageApi->setContent: %s\n" % e)

Parameters

Body parameters
Name Description
body
Query parameters
Name Description
path*
String
The file path.
Required

Responses

Status: 200 - The created/updated file storage node.

Status: 400 - You probably forgot the 'path' parameter.


setDirectory

Create a directory for the given path (parent directories are also created if needed).


/storage/files/set/directory

Usage and SDK Samples

curl -X POST "http://localhost:80/api/storage/files/set/directory?path="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StorageApi;

import java.io.File;
import java.util.*;

public class StorageApiExample {

    public static void main(String[] args) {
        
        StorageApi apiInstance = new StorageApi();
        String path = path_example; // String | The directory path.
        try {
            StorageNode result = apiInstance.setDirectory(path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#setDirectory");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StorageApi;

public class StorageApiExample {

    public static void main(String[] args) {
        StorageApi apiInstance = new StorageApi();
        String path = path_example; // String | The directory path.
        try {
            StorageNode result = apiInstance.setDirectory(path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#setDirectory");
            e.printStackTrace();
        }
    }
}
String *path = path_example; // The directory path. (optional)

StorageApi *apiInstance = [[StorageApi alloc] init];

// Create a directory for the given path (parent directories are also created if needed).
[apiInstance setDirectoryWith:path
              completionHandler: ^(StorageNode output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.StorageApi()
var opts = { 
  'path': path_example // {{String}} The directory path.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setDirectory(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setDirectoryExample
    {
        public void main()
        {

            var apiInstance = new StorageApi();
            var path = path_example;  // String | The directory path. (optional) 

            try
            {
                // Create a directory for the given path (parent directories are also created if needed).
                StorageNode result = apiInstance.setDirectory(path);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StorageApi.setDirectory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStorageApi();
$path = path_example; // String | The directory path.

try {
    $result = $api_instance->setDirectory($path);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorageApi->setDirectory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StorageApi;

my $api_instance = WWW::SwaggerClient::StorageApi->new();
my $path = path_example; # String | The directory path.

eval { 
    my $result = $api_instance->setDirectory(path => $path);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StorageApi->setDirectory: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StorageApi()
path = path_example # String | The directory path. (optional)

try: 
    # Create a directory for the given path (parent directories are also created if needed).
    api_response = api_instance.set_directory(path=path)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StorageApi->setDirectory: %s\n" % e)

Parameters

Query parameters
Name Description
path
String
The directory path.

Responses

Status: 200 - The storage node for the created directory.

Status: 400 - You probably forgot the 'path' parameter.


setFile

Uploads a file in the given path (or in the root folder).


/storage/files/set/file

Usage and SDK Samples

curl -X POST "http://localhost:80/api/storage/files/set/file?path="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StorageApi;

import java.io.File;
import java.util.*;

public class StorageApiExample {

    public static void main(String[] args) {
        
        StorageApi apiInstance = new StorageApi();
        Object body = ; // Object | The file to upload.
        String path = path_example; // String | The parent directory path.
        try {
            StorageNode result = apiInstance.setFile(body, path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#setFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StorageApi;

public class StorageApiExample {

    public static void main(String[] args) {
        StorageApi apiInstance = new StorageApi();
        Object body = ; // Object | The file to upload.
        String path = path_example; // String | The parent directory path.
        try {
            StorageNode result = apiInstance.setFile(body, path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#setFile");
            e.printStackTrace();
        }
    }
}
Object *body = ; // The file to upload. (optional)
String *path = path_example; // The parent directory path. (optional)

StorageApi *apiInstance = [[StorageApi alloc] init];

// Uploads a file in the given path (or in the root folder).
[apiInstance setFileWith:body
    path:path
              completionHandler: ^(StorageNode output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.StorageApi()
var opts = { 
  'body':  // {{Object}} The file to upload.
  'path': path_example // {{String}} The parent directory path.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setFile(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setFileExample
    {
        public void main()
        {

            var apiInstance = new StorageApi();
            var body = new Object(); // Object | The file to upload. (optional) 
            var path = path_example;  // String | The parent directory path. (optional) 

            try
            {
                // Uploads a file in the given path (or in the root folder).
                StorageNode result = apiInstance.setFile(body, path);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StorageApi.setFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStorageApi();
$body = ; // Object | The file to upload.
$path = path_example; // String | The parent directory path.

try {
    $result = $api_instance->setFile($body, $path);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorageApi->setFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StorageApi;

my $api_instance = WWW::SwaggerClient::StorageApi->new();
my $body = WWW::SwaggerClient::Object::Object->new(); # Object | The file to upload.
my $path = path_example; # String | The parent directory path.

eval { 
    my $result = $api_instance->setFile(body => $body, path => $path);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StorageApi->setFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StorageApi()
body =  # Object | The file to upload. (optional)
path = path_example # String | The parent directory path. (optional)

try: 
    # Uploads a file in the given path (or in the root folder).
    api_response = api_instance.set_file(body=body, path=path)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StorageApi->setFile: %s\n" % e)

Parameters

Body parameters
Name Description
body
Query parameters
Name Description
path
String
The parent directory path.

Responses

Status: 200 - The storage node for the uploaded file.


watch

Watches for changes in the whole directory structure using SSE: https://en.wikipedia.org/wiki/Server-sent_events


/storage/files/watch

Usage and SDK Samples

curl -X GET "http://localhost:80/api/storage/files/watch"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StorageApi;

import java.io.File;
import java.util.*;

public class StorageApiExample {

    public static void main(String[] args) {
        
        StorageApi apiInstance = new StorageApi();
        try {
            StorageWatcherEvents result = apiInstance.watch();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#watch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StorageApi;

public class StorageApiExample {

    public static void main(String[] args) {
        StorageApi apiInstance = new StorageApi();
        try {
            StorageWatcherEvents result = apiInstance.watch();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageApi#watch");
            e.printStackTrace();
        }
    }
}

StorageApi *apiInstance = [[StorageApi alloc] init];

// Watches for changes in the whole directory structure using SSE: https://en.wikipedia.org/wiki/Server-sent_events
[apiInstance watchWithCompletionHandler: 
              ^(StorageWatcherEvents output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var KrakenRestApi = require('kraken_rest_api');

var api = new KrakenRestApi.StorageApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.watch(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class watchExample
    {
        public void main()
        {

            var apiInstance = new StorageApi();

            try
            {
                // Watches for changes in the whole directory structure using SSE: https://en.wikipedia.org/wiki/Server-sent_events
                StorageWatcherEvents result = apiInstance.watch();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StorageApi.watch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStorageApi();

try {
    $result = $api_instance->watch();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorageApi->watch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StorageApi;

my $api_instance = WWW::SwaggerClient::StorageApi->new();

eval { 
    my $result = $api_instance->watch();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StorageApi->watch: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StorageApi()

try: 
    # Watches for changes in the whole directory structure using SSE: https://en.wikipedia.org/wiki/Server-sent_events
    api_response = api_instance.watch()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StorageApi->watch: %s\n" % e)

Parameters

Responses

Status: 200 - An array of storage events.