Efimeral API

Default

boxCheckStatus

Obtains the status of the given box ID, if it exists.

TODO


/boxes/{id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://api.efimearl.ar/prod/boxes/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String id = id_example; // String | Box ID to fetch status from.
        try {
            BoxStatusResponse result = apiInstance.boxCheckStatus(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#boxCheckStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String id = id_example; // String | Box ID to fetch status from.
        try {
            BoxStatusResponse result = apiInstance.boxCheckStatus(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#boxCheckStatus");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Box ID to fetch status from.

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

// Obtains the status of the given box ID, if it exists.
[apiInstance boxCheckStatusWith:id
              completionHandler: ^(BoxStatusResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EfimeralApi = require('efimeral_api');

var api = new EfimeralApi.DefaultApi()
var id = id_example; // {{String}} Box ID to fetch status from.

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

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

            var apiInstance = new DefaultApi();
            var id = id_example;  // String | Box ID to fetch status from.

            try
            {
                // Obtains the status of the given box ID, if it exists.
                BoxStatusResponse result = apiInstance.boxCheckStatus(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.boxCheckStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDefaultApi();
$id = id_example; // String | Box ID to fetch status from.

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

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $id = id_example; # String | Box ID to fetch status from.

eval { 
    my $result = $api_instance->boxCheckStatus(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->boxCheckStatus: $@\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.DefaultApi()
id = id_example # String | Box ID to fetch status from.

try: 
    # Obtains the status of the given box ID, if it exists.
    api_response = api_instance.box_check_status(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->boxCheckStatus: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String (sha1)
Box ID to fetch status from.
Required

Responses

Status: 200 - Box status description.

Status: 404 - Box not found or not ready.

Status: 500 - Box check status failed.


boxCreateInstance

Creates a new Linux box to expose in the web.

Builds a new Linux box and returns the id. The maximum amount allowed currently is 10. Body is optional; possible values for `type` is: "ubuntu", "alpine".


/boxes

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://api.efimearl.ar/prod/boxes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        BoxType body = ; // BoxType | Optional. Box type to create.
        try {
            BoxCreationResponse result = apiInstance.boxCreateInstance(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#boxCreateInstance");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        BoxType body = ; // BoxType | Optional. Box type to create.
        try {
            BoxCreationResponse result = apiInstance.boxCreateInstance(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#boxCreateInstance");
            e.printStackTrace();
        }
    }
}
BoxType *body = ; // Optional. Box type to create. (optional)

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

// Creates a new Linux box to expose in the web.
[apiInstance boxCreateInstanceWith:body
              completionHandler: ^(BoxCreationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EfimeralApi = require('efimeral_api');

var api = new EfimeralApi.DefaultApi()
var opts = { 
  'body':  // {{BoxType}} Optional. Box type to create.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.boxCreateInstance(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DefaultApi();
            var body = new BoxType(); // BoxType | Optional. Box type to create. (optional) 

            try
            {
                // Creates a new Linux box to expose in the web.
                BoxCreationResponse result = apiInstance.boxCreateInstance(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.boxCreateInstance: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDefaultApi();
$body = ; // BoxType | Optional. Box type to create.

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

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $body = WWW::SwaggerClient::Object::BoxType->new(); # BoxType | Optional. Box type to create.

eval { 
    my $result = $api_instance->boxCreateInstance(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->boxCreateInstance: $@\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.DefaultApi()
body =  # BoxType | Optional. Box type to create. (optional)

try: 
    # Creates a new Linux box to expose in the web.
    api_response = api_instance.box_create_instance(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->boxCreateInstance: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 201 - Box created.

Status: 400 - Invalid body or type.

Status: 429 - Too many requests.

Status: 500 - Box creation failed.