Nodeum API

CloudBuckets

indexCloudBuckets

Lists all cloud buckets.

**API Key Scope**: cloud_buckets / index


/cloud_buckets

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" -H "Authorization: [[apiKey]]" "http://localhost/api/v2/cloud_buckets?limit=&offset=&sort_by=&id=&cloud_connector_id=&pool_id=&name=&location=&price="
import io.nodeum.sdk.*;
import io.nodeum.sdk.auth.*;
import io.nodeum.sdk.model.*;
import io.nodeum.sdk.api.CloudBucketsApi;

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

public class CloudBucketsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: BearerAuth
        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //BearerAuth.setApiKeyPrefix("Token");

        CloudBucketsApi apiInstance = new CloudBucketsApi();
        Integer limit = 56; // Integer | The number of items to display for pagination.
        Integer offset = 56; // Integer | The number of items to skip for pagination.
        array[String] sortBy = ; // array[String] | Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
        String id = id_example; // String | Filter on id
        String cloudConnectorId = cloudConnectorId_example; // String | Filter on cloud connector id
        String poolId = poolId_example; // String | Filter on a pool id
        String name = name_example; // String | Filter on name
        String location = location_example; // String | Filter on location
        String price = price_example; // String | Filter on price
        try {
            cloud_bucket_collection result = apiInstance.indexCloudBuckets(limit, offset, sortBy, id, cloudConnectorId, poolId, name, location, price);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudBucketsApi#indexCloudBuckets");
            e.printStackTrace();
        }
    }
}
import io.nodeum.sdk.api.CloudBucketsApi;

public class CloudBucketsApiExample {

    public static void main(String[] args) {
        CloudBucketsApi apiInstance = new CloudBucketsApi();
        Integer limit = 56; // Integer | The number of items to display for pagination.
        Integer offset = 56; // Integer | The number of items to skip for pagination.
        array[String] sortBy = ; // array[String] | Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
        String id = id_example; // String | Filter on id
        String cloudConnectorId = cloudConnectorId_example; // String | Filter on cloud connector id
        String poolId = poolId_example; // String | Filter on a pool id
        String name = name_example; // String | Filter on name
        String location = location_example; // String | Filter on location
        String price = price_example; // String | Filter on price
        try {
            cloud_bucket_collection result = apiInstance.indexCloudBuckets(limit, offset, sortBy, id, cloudConnectorId, poolId, name, location, price);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudBucketsApi#indexCloudBuckets");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: BearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

Integer *limit = 56; // The number of items to display for pagination. (optional) (default to null)
Integer *offset = 56; // The number of items to skip for pagination. (optional) (default to null)
array[String] *sortBy = ; // Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`. (optional) (default to null)
String *id = id_example; // Filter on id (optional) (default to null)
String *cloudConnectorId = cloudConnectorId_example; // Filter on cloud connector id (optional) (default to null)
String *poolId = poolId_example; // Filter on a pool id (optional) (default to null)
String *name = name_example; // Filter on name (optional) (default to null)
String *location = location_example; // Filter on location (optional) (default to null)
String *price = price_example; // Filter on price (optional) (default to null)

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

// Lists all cloud buckets.
[apiInstance indexCloudBucketsWith:limit
    offset:offset
    sortBy:sortBy
    id:id
    cloudConnectorId:cloudConnectorId
    poolId:poolId
    name:name
    location:location
    price:price
              completionHandler: ^(cloud_bucket_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NodeumApi = require('nodeum_api');
var defaultClient = NodeumApi.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

// Configure API key authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new NodeumApi.CloudBucketsApi()
var opts = {
  'limit': 56, // {Integer} The number of items to display for pagination.
  'offset': 56, // {Integer} The number of items to skip for pagination.
  'sortBy': , // {array[String]} Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
  'id': id_example, // {String} Filter on id
  'cloudConnectorId': cloudConnectorId_example, // {String} Filter on cloud connector id
  'poolId': poolId_example, // {String} Filter on a pool id
  'name': name_example, // {String} Filter on name
  'location': location_example, // {String} Filter on location
  'price': price_example // {String} Filter on price
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.indexCloudBuckets(opts, callback);
using System;
using System.Diagnostics;
using Io.Nodeum.Sdk.Api;
using Io.Nodeum.Sdk.Client;
using Io.Nodeum.Sdk.Model;

namespace Example
{
    public class indexCloudBucketsExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: BearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CloudBucketsApi();
            var limit = 56;  // Integer | The number of items to display for pagination. (optional)  (default to null)
            var offset = 56;  // Integer | The number of items to skip for pagination. (optional)  (default to null)
            var sortBy = new array[String](); // array[String] | Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`. (optional)  (default to null)
            var id = id_example;  // String | Filter on id (optional)  (default to null)
            var cloudConnectorId = cloudConnectorId_example;  // String | Filter on cloud connector id (optional)  (default to null)
            var poolId = poolId_example;  // String | Filter on a pool id (optional)  (default to null)
            var name = name_example;  // String | Filter on name (optional)  (default to null)
            var location = location_example;  // String | Filter on location (optional)  (default to null)
            var price = price_example;  // String | Filter on price (optional)  (default to null)

            try
            {
                // Lists all cloud buckets.
                cloud_bucket_collection result = apiInstance.indexCloudBuckets(limit, offset, sortBy, id, cloudConnectorId, poolId, name, location, price);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CloudBucketsApi.indexCloudBuckets: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: BearerAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\CloudBucketsApi();
$limit = 56; // Integer | The number of items to display for pagination.
$offset = 56; // Integer | The number of items to skip for pagination.
$sortBy = ; // array[String] | Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
$id = id_example; // String | Filter on id
$cloudConnectorId = cloudConnectorId_example; // String | Filter on cloud connector id
$poolId = poolId_example; // String | Filter on a pool id
$name = name_example; // String | Filter on name
$location = location_example; // String | Filter on location
$price = price_example; // String | Filter on price

try {
    $result = $api_instance->indexCloudBuckets($limit, $offset, $sortBy, $id, $cloudConnectorId, $poolId, $name, $location, $price);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudBucketsApi->indexCloudBuckets: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Nodeum::SDK::Configuration;
use Nodeum::SDK::CloudBucketsApi;

# Configure HTTP basic authorization: BasicAuth
$Nodeum::SDK::Configuration::username = 'YOUR_USERNAME';
$Nodeum::SDK::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: BearerAuth
$Nodeum::SDK::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Nodeum::SDK::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = Nodeum::SDK::CloudBucketsApi->new();
my $limit = 56; # Integer | The number of items to display for pagination.
my $offset = 56; # Integer | The number of items to skip for pagination.
my $sortBy = []; # array[String] | Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
my $id = id_example; # String | Filter on id
my $cloudConnectorId = cloudConnectorId_example; # String | Filter on cloud connector id
my $poolId = poolId_example; # String | Filter on a pool id
my $name = name_example; # String | Filter on name
my $location = location_example; # String | Filter on location
my $price = price_example; # String | Filter on price

eval { 
    my $result = $api_instance->indexCloudBuckets(limit => $limit, offset => $offset, sortBy => $sortBy, id => $id, cloudConnectorId => $cloudConnectorId, poolId => $poolId, name => $name, location => $location, price => $price);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CloudBucketsApi->indexCloudBuckets: $@\n";
}
from __future__ import print_statement
import time
import nodeum-sdk
from nodeum-sdk.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
nodeum-sdk.configuration.username = 'YOUR_USERNAME'
nodeum-sdk.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: BearerAuth
nodeum-sdk.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# nodeum-sdk.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = nodeum-sdk.CloudBucketsApi()
limit = 56 # Integer | The number of items to display for pagination. (optional) (default to null)
offset = 56 # Integer | The number of items to skip for pagination. (optional) (default to null)
sortBy =  # array[String] | Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`. (optional) (default to null)
id = id_example # String | Filter on id (optional) (default to null)
cloudConnectorId = cloudConnectorId_example # String | Filter on cloud connector id (optional) (default to null)
poolId = poolId_example # String | Filter on a pool id (optional) (default to null)
name = name_example # String | Filter on name (optional) (default to null)
location = location_example # String | Filter on location (optional) (default to null)
price = price_example # String | Filter on price (optional) (default to null)

try: 
    # Lists all cloud buckets.
    api_response = api_instance.index_cloud_buckets(limit=limit, offset=offset, sortBy=sortBy, id=id, cloudConnectorId=cloudConnectorId, poolId=poolId, name=name, location=location, price=price)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CloudBucketsApi->indexCloudBuckets: %s\n" % e)
extern crate CloudBucketsApi;

pub fn main() {
    let limit = 56; // Integer
    let offset = 56; // Integer
    let sortBy = ; // array[String]
    let id = id_example; // String
    let cloudConnectorId = cloudConnectorId_example; // String
    let poolId = poolId_example; // String
    let name = name_example; // String
    let location = location_example; // String
    let price = price_example; // String

    let mut context = CloudBucketsApi::Context::default();
    let result = client.indexCloudBuckets(limit, offset, sortBy, id, cloudConnectorId, poolId, name, location, price, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Query parameters
Name Description
limit
Integer
The number of items to display for pagination.
offset
Integer
The number of items to skip for pagination.
sort_by
array[String]
Sort results by attribute. Can sort on multiple attributes, separated by `|`. Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
id
String
Filter on id
cloud_connector_id
String
Filter on cloud connector id
pool_id
String
Filter on a pool id
name
String
Filter on name
location
String
Filter on location
price
String
Filter on price

Responses


indexCloudBucketsByCloudConnector

Lists all cloud buckets.

**API Key Scope**: cloud_buckets / index


/cloud_connectors/{cloud_connector_id}/cloud_buckets

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" -H "Authorization: [[apiKey]]" "http://localhost/api/v2/cloud_connectors/{cloud_connector_id}/cloud_buckets?limit=&offset=&sort_by=&id=&pool_id=&name=&location=&price="
import io.nodeum.sdk.*;
import io.nodeum.sdk.auth.*;
import io.nodeum.sdk.model.*;
import io.nodeum.sdk.api.CloudBucketsApi;

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

public class CloudBucketsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: BearerAuth
        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //BearerAuth.setApiKeyPrefix("Token");

        CloudBucketsApi apiInstance = new CloudBucketsApi();
        String cloudConnectorId = cloudConnectorId_example; // String | Numeric ID or name of cloud connector.
        Integer limit = 56; // Integer | The number of items to display for pagination.
        Integer offset = 56; // Integer | The number of items to skip for pagination.
        array[String] sortBy = ; // array[String] | Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
        String id = id_example; // String | Filter on id
        String poolId = poolId_example; // String | Filter on a pool id
        String name = name_example; // String | Filter on name
        String location = location_example; // String | Filter on location
        String price = price_example; // String | Filter on price
        try {
            cloud_bucket_collection result = apiInstance.indexCloudBucketsByCloudConnector(cloudConnectorId, limit, offset, sortBy, id, poolId, name, location, price);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudBucketsApi#indexCloudBucketsByCloudConnector");
            e.printStackTrace();
        }
    }
}
import io.nodeum.sdk.api.CloudBucketsApi;

public class CloudBucketsApiExample {

    public static void main(String[] args) {
        CloudBucketsApi apiInstance = new CloudBucketsApi();
        String cloudConnectorId = cloudConnectorId_example; // String | Numeric ID or name of cloud connector.
        Integer limit = 56; // Integer | The number of items to display for pagination.
        Integer offset = 56; // Integer | The number of items to skip for pagination.
        array[String] sortBy = ; // array[String] | Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
        String id = id_example; // String | Filter on id
        String poolId = poolId_example; // String | Filter on a pool id
        String name = name_example; // String | Filter on name
        String location = location_example; // String | Filter on location
        String price = price_example; // String | Filter on price
        try {
            cloud_bucket_collection result = apiInstance.indexCloudBucketsByCloudConnector(cloudConnectorId, limit, offset, sortBy, id, poolId, name, location, price);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudBucketsApi#indexCloudBucketsByCloudConnector");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: BearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *cloudConnectorId = cloudConnectorId_example; // Numeric ID or name of cloud connector. (default to null)
Integer *limit = 56; // The number of items to display for pagination. (optional) (default to null)
Integer *offset = 56; // The number of items to skip for pagination. (optional) (default to null)
array[String] *sortBy = ; // Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`. (optional) (default to null)
String *id = id_example; // Filter on id (optional) (default to null)
String *poolId = poolId_example; // Filter on a pool id (optional) (default to null)
String *name = name_example; // Filter on name (optional) (default to null)
String *location = location_example; // Filter on location (optional) (default to null)
String *price = price_example; // Filter on price (optional) (default to null)

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

// Lists all cloud buckets.
[apiInstance indexCloudBucketsByCloudConnectorWith:cloudConnectorId
    limit:limit
    offset:offset
    sortBy:sortBy
    id:id
    poolId:poolId
    name:name
    location:location
    price:price
              completionHandler: ^(cloud_bucket_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NodeumApi = require('nodeum_api');
var defaultClient = NodeumApi.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

// Configure API key authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new NodeumApi.CloudBucketsApi()
var cloudConnectorId = cloudConnectorId_example; // {String} Numeric ID or name of cloud connector.
var opts = {
  'limit': 56, // {Integer} The number of items to display for pagination.
  'offset': 56, // {Integer} The number of items to skip for pagination.
  'sortBy': , // {array[String]} Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
  'id': id_example, // {String} Filter on id
  'poolId': poolId_example, // {String} Filter on a pool id
  'name': name_example, // {String} Filter on name
  'location': location_example, // {String} Filter on location
  'price': price_example // {String} Filter on price
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.indexCloudBucketsByCloudConnector(cloudConnectorId, opts, callback);
using System;
using System.Diagnostics;
using Io.Nodeum.Sdk.Api;
using Io.Nodeum.Sdk.Client;
using Io.Nodeum.Sdk.Model;

namespace Example
{
    public class indexCloudBucketsByCloudConnectorExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: BearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CloudBucketsApi();
            var cloudConnectorId = cloudConnectorId_example;  // String | Numeric ID or name of cloud connector. (default to null)
            var limit = 56;  // Integer | The number of items to display for pagination. (optional)  (default to null)
            var offset = 56;  // Integer | The number of items to skip for pagination. (optional)  (default to null)
            var sortBy = new array[String](); // array[String] | Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`. (optional)  (default to null)
            var id = id_example;  // String | Filter on id (optional)  (default to null)
            var poolId = poolId_example;  // String | Filter on a pool id (optional)  (default to null)
            var name = name_example;  // String | Filter on name (optional)  (default to null)
            var location = location_example;  // String | Filter on location (optional)  (default to null)
            var price = price_example;  // String | Filter on price (optional)  (default to null)

            try
            {
                // Lists all cloud buckets.
                cloud_bucket_collection result = apiInstance.indexCloudBucketsByCloudConnector(cloudConnectorId, limit, offset, sortBy, id, poolId, name, location, price);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CloudBucketsApi.indexCloudBucketsByCloudConnector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: BearerAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\CloudBucketsApi();
$cloudConnectorId = cloudConnectorId_example; // String | Numeric ID or name of cloud connector.
$limit = 56; // Integer | The number of items to display for pagination.
$offset = 56; // Integer | The number of items to skip for pagination.
$sortBy = ; // array[String] | Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
$id = id_example; // String | Filter on id
$poolId = poolId_example; // String | Filter on a pool id
$name = name_example; // String | Filter on name
$location = location_example; // String | Filter on location
$price = price_example; // String | Filter on price

try {
    $result = $api_instance->indexCloudBucketsByCloudConnector($cloudConnectorId, $limit, $offset, $sortBy, $id, $poolId, $name, $location, $price);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudBucketsApi->indexCloudBucketsByCloudConnector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Nodeum::SDK::Configuration;
use Nodeum::SDK::CloudBucketsApi;

# Configure HTTP basic authorization: BasicAuth
$Nodeum::SDK::Configuration::username = 'YOUR_USERNAME';
$Nodeum::SDK::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: BearerAuth
$Nodeum::SDK::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Nodeum::SDK::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = Nodeum::SDK::CloudBucketsApi->new();
my $cloudConnectorId = cloudConnectorId_example; # String | Numeric ID or name of cloud connector.
my $limit = 56; # Integer | The number of items to display for pagination.
my $offset = 56; # Integer | The number of items to skip for pagination.
my $sortBy = []; # array[String] | Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
my $id = id_example; # String | Filter on id
my $poolId = poolId_example; # String | Filter on a pool id
my $name = name_example; # String | Filter on name
my $location = location_example; # String | Filter on location
my $price = price_example; # String | Filter on price

eval { 
    my $result = $api_instance->indexCloudBucketsByCloudConnector(cloudConnectorId => $cloudConnectorId, limit => $limit, offset => $offset, sortBy => $sortBy, id => $id, poolId => $poolId, name => $name, location => $location, price => $price);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CloudBucketsApi->indexCloudBucketsByCloudConnector: $@\n";
}
from __future__ import print_statement
import time
import nodeum-sdk
from nodeum-sdk.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
nodeum-sdk.configuration.username = 'YOUR_USERNAME'
nodeum-sdk.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: BearerAuth
nodeum-sdk.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# nodeum-sdk.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = nodeum-sdk.CloudBucketsApi()
cloudConnectorId = cloudConnectorId_example # String | Numeric ID or name of cloud connector. (default to null)
limit = 56 # Integer | The number of items to display for pagination. (optional) (default to null)
offset = 56 # Integer | The number of items to skip for pagination. (optional) (default to null)
sortBy =  # array[String] | Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`. (optional) (default to null)
id = id_example # String | Filter on id (optional) (default to null)
poolId = poolId_example # String | Filter on a pool id (optional) (default to null)
name = name_example # String | Filter on name (optional) (default to null)
location = location_example # String | Filter on location (optional) (default to null)
price = price_example # String | Filter on price (optional) (default to null)

try: 
    # Lists all cloud buckets.
    api_response = api_instance.index_cloud_buckets_by_cloud_connector(cloudConnectorId, limit=limit, offset=offset, sortBy=sortBy, id=id, poolId=poolId, name=name, location=location, price=price)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CloudBucketsApi->indexCloudBucketsByCloudConnector: %s\n" % e)
extern crate CloudBucketsApi;

pub fn main() {
    let cloudConnectorId = cloudConnectorId_example; // String
    let limit = 56; // Integer
    let offset = 56; // Integer
    let sortBy = ; // array[String]
    let id = id_example; // String
    let poolId = poolId_example; // String
    let name = name_example; // String
    let location = location_example; // String
    let price = price_example; // String

    let mut context = CloudBucketsApi::Context::default();
    let result = client.indexCloudBucketsByCloudConnector(cloudConnectorId, limit, offset, sortBy, id, poolId, name, location, price, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
cloud_connector_id*
String
Numeric ID or name of cloud connector.
Required
Query parameters
Name Description
limit
Integer
The number of items to display for pagination.
offset
Integer
The number of items to skip for pagination.
sort_by
array[String]
Sort results by attribute. Can sort on multiple attributes, separated by `|`. Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
id
String
Filter on id
pool_id
String
Filter on a pool id
name
String
Filter on name
location
String
Filter on location
price
String
Filter on price

Responses


indexCloudBucketsByPool

Lists all cloud buckets from pool.

**API Key Scope**: cloud_buckets / index


/pools/{pool_id}/cloud_buckets

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" -H "Authorization: [[apiKey]]" "http://localhost/api/v2/pools/{pool_id}/cloud_buckets?limit=&offset=&sort_by=&id=&cloud_connector_id=&name=&location=&price="
import io.nodeum.sdk.*;
import io.nodeum.sdk.auth.*;
import io.nodeum.sdk.model.*;
import io.nodeum.sdk.api.CloudBucketsApi;

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

public class CloudBucketsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: BearerAuth
        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //BearerAuth.setApiKeyPrefix("Token");

        CloudBucketsApi apiInstance = new CloudBucketsApi();
        String poolId = poolId_example; // String | Numeric ID, or name of pool.
        Integer limit = 56; // Integer | The number of items to display for pagination.
        Integer offset = 56; // Integer | The number of items to skip for pagination.
        array[String] sortBy = ; // array[String] | Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
        String id = id_example; // String | Filter on id
        String cloudConnectorId = cloudConnectorId_example; // String | Filter on cloud connector id
        String name = name_example; // String | Filter on name
        String location = location_example; // String | Filter on location
        String price = price_example; // String | Filter on price
        try {
            cloud_bucket_collection result = apiInstance.indexCloudBucketsByPool(poolId, limit, offset, sortBy, id, cloudConnectorId, name, location, price);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudBucketsApi#indexCloudBucketsByPool");
            e.printStackTrace();
        }
    }
}
import io.nodeum.sdk.api.CloudBucketsApi;

public class CloudBucketsApiExample {

    public static void main(String[] args) {
        CloudBucketsApi apiInstance = new CloudBucketsApi();
        String poolId = poolId_example; // String | Numeric ID, or name of pool.
        Integer limit = 56; // Integer | The number of items to display for pagination.
        Integer offset = 56; // Integer | The number of items to skip for pagination.
        array[String] sortBy = ; // array[String] | Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
        String id = id_example; // String | Filter on id
        String cloudConnectorId = cloudConnectorId_example; // String | Filter on cloud connector id
        String name = name_example; // String | Filter on name
        String location = location_example; // String | Filter on location
        String price = price_example; // String | Filter on price
        try {
            cloud_bucket_collection result = apiInstance.indexCloudBucketsByPool(poolId, limit, offset, sortBy, id, cloudConnectorId, name, location, price);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudBucketsApi#indexCloudBucketsByPool");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: BearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *poolId = poolId_example; // Numeric ID, or name of pool. (default to null)
Integer *limit = 56; // The number of items to display for pagination. (optional) (default to null)
Integer *offset = 56; // The number of items to skip for pagination. (optional) (default to null)
array[String] *sortBy = ; // Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`. (optional) (default to null)
String *id = id_example; // Filter on id (optional) (default to null)
String *cloudConnectorId = cloudConnectorId_example; // Filter on cloud connector id (optional) (default to null)
String *name = name_example; // Filter on name (optional) (default to null)
String *location = location_example; // Filter on location (optional) (default to null)
String *price = price_example; // Filter on price (optional) (default to null)

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

// Lists all cloud buckets from pool.
[apiInstance indexCloudBucketsByPoolWith:poolId
    limit:limit
    offset:offset
    sortBy:sortBy
    id:id
    cloudConnectorId:cloudConnectorId
    name:name
    location:location
    price:price
              completionHandler: ^(cloud_bucket_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NodeumApi = require('nodeum_api');
var defaultClient = NodeumApi.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

// Configure API key authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new NodeumApi.CloudBucketsApi()
var poolId = poolId_example; // {String} Numeric ID, or name of pool.
var opts = {
  'limit': 56, // {Integer} The number of items to display for pagination.
  'offset': 56, // {Integer} The number of items to skip for pagination.
  'sortBy': , // {array[String]} Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
  'id': id_example, // {String} Filter on id
  'cloudConnectorId': cloudConnectorId_example, // {String} Filter on cloud connector id
  'name': name_example, // {String} Filter on name
  'location': location_example, // {String} Filter on location
  'price': price_example // {String} Filter on price
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.indexCloudBucketsByPool(poolId, opts, callback);
using System;
using System.Diagnostics;
using Io.Nodeum.Sdk.Api;
using Io.Nodeum.Sdk.Client;
using Io.Nodeum.Sdk.Model;

namespace Example
{
    public class indexCloudBucketsByPoolExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: BearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CloudBucketsApi();
            var poolId = poolId_example;  // String | Numeric ID, or name of pool. (default to null)
            var limit = 56;  // Integer | The number of items to display for pagination. (optional)  (default to null)
            var offset = 56;  // Integer | The number of items to skip for pagination. (optional)  (default to null)
            var sortBy = new array[String](); // array[String] | Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`. (optional)  (default to null)
            var id = id_example;  // String | Filter on id (optional)  (default to null)
            var cloudConnectorId = cloudConnectorId_example;  // String | Filter on cloud connector id (optional)  (default to null)
            var name = name_example;  // String | Filter on name (optional)  (default to null)
            var location = location_example;  // String | Filter on location (optional)  (default to null)
            var price = price_example;  // String | Filter on price (optional)  (default to null)

            try
            {
                // Lists all cloud buckets from pool.
                cloud_bucket_collection result = apiInstance.indexCloudBucketsByPool(poolId, limit, offset, sortBy, id, cloudConnectorId, name, location, price);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CloudBucketsApi.indexCloudBucketsByPool: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: BearerAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\CloudBucketsApi();
$poolId = poolId_example; // String | Numeric ID, or name of pool.
$limit = 56; // Integer | The number of items to display for pagination.
$offset = 56; // Integer | The number of items to skip for pagination.
$sortBy = ; // array[String] | Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
$id = id_example; // String | Filter on id
$cloudConnectorId = cloudConnectorId_example; // String | Filter on cloud connector id
$name = name_example; // String | Filter on name
$location = location_example; // String | Filter on location
$price = price_example; // String | Filter on price

try {
    $result = $api_instance->indexCloudBucketsByPool($poolId, $limit, $offset, $sortBy, $id, $cloudConnectorId, $name, $location, $price);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudBucketsApi->indexCloudBucketsByPool: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Nodeum::SDK::Configuration;
use Nodeum::SDK::CloudBucketsApi;

# Configure HTTP basic authorization: BasicAuth
$Nodeum::SDK::Configuration::username = 'YOUR_USERNAME';
$Nodeum::SDK::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: BearerAuth
$Nodeum::SDK::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Nodeum::SDK::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = Nodeum::SDK::CloudBucketsApi->new();
my $poolId = poolId_example; # String | Numeric ID, or name of pool.
my $limit = 56; # Integer | The number of items to display for pagination.
my $offset = 56; # Integer | The number of items to skip for pagination.
my $sortBy = []; # array[String] | Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
my $id = id_example; # String | Filter on id
my $cloudConnectorId = cloudConnectorId_example; # String | Filter on cloud connector id
my $name = name_example; # String | Filter on name
my $location = location_example; # String | Filter on location
my $price = price_example; # String | Filter on price

eval { 
    my $result = $api_instance->indexCloudBucketsByPool(poolId => $poolId, limit => $limit, offset => $offset, sortBy => $sortBy, id => $id, cloudConnectorId => $cloudConnectorId, name => $name, location => $location, price => $price);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CloudBucketsApi->indexCloudBucketsByPool: $@\n";
}
from __future__ import print_statement
import time
import nodeum-sdk
from nodeum-sdk.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
nodeum-sdk.configuration.username = 'YOUR_USERNAME'
nodeum-sdk.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: BearerAuth
nodeum-sdk.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# nodeum-sdk.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = nodeum-sdk.CloudBucketsApi()
poolId = poolId_example # String | Numeric ID, or name of pool. (default to null)
limit = 56 # Integer | The number of items to display for pagination. (optional) (default to null)
offset = 56 # Integer | The number of items to skip for pagination. (optional) (default to null)
sortBy =  # array[String] | Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`. (optional) (default to null)
id = id_example # String | Filter on id (optional) (default to null)
cloudConnectorId = cloudConnectorId_example # String | Filter on cloud connector id (optional) (default to null)
name = name_example # String | Filter on name (optional) (default to null)
location = location_example # String | Filter on location (optional) (default to null)
price = price_example # String | Filter on price (optional) (default to null)

try: 
    # Lists all cloud buckets from pool.
    api_response = api_instance.index_cloud_buckets_by_pool(poolId, limit=limit, offset=offset, sortBy=sortBy, id=id, cloudConnectorId=cloudConnectorId, name=name, location=location, price=price)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CloudBucketsApi->indexCloudBucketsByPool: %s\n" % e)
extern crate CloudBucketsApi;

pub fn main() {
    let poolId = poolId_example; // String
    let limit = 56; // Integer
    let offset = 56; // Integer
    let sortBy = ; // array[String]
    let id = id_example; // String
    let cloudConnectorId = cloudConnectorId_example; // String
    let name = name_example; // String
    let location = location_example; // String
    let price = price_example; // String

    let mut context = CloudBucketsApi::Context::default();
    let result = client.indexCloudBucketsByPool(poolId, limit, offset, sortBy, id, cloudConnectorId, name, location, price, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
pool_id*
String
Numeric ID, or name of pool.
Required
Query parameters
Name Description
limit
Integer
The number of items to display for pagination.
offset
Integer
The number of items to skip for pagination.
sort_by
array[String]
Sort results by attribute. Can sort on multiple attributes, separated by `|`. Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
id
String
Filter on id
cloud_connector_id
String
Filter on cloud connector id
name
String
Filter on name
location
String
Filter on location
price
String
Filter on price

Responses


mountStatusCloudBucket

Get mount status of Cloud bucket.

**API Key Scope**: cloud_buckets / mount_status


/cloud_buckets/{cloud_bucket_id}/mount

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" -H "Authorization: [[apiKey]]" "http://localhost/api/v2/cloud_buckets/{cloud_bucket_id}/mount"
import io.nodeum.sdk.*;
import io.nodeum.sdk.auth.*;
import io.nodeum.sdk.model.*;
import io.nodeum.sdk.api.CloudBucketsApi;

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

public class CloudBucketsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: BearerAuth
        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //BearerAuth.setApiKeyPrefix("Token");

        CloudBucketsApi apiInstance = new CloudBucketsApi();
        String cloudBucketId = cloudBucketId_example; // String | Numeric ID or name of cloud bucket.
        try {
            mount_status result = apiInstance.mountStatusCloudBucket(cloudBucketId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudBucketsApi#mountStatusCloudBucket");
            e.printStackTrace();
        }
    }
}
import io.nodeum.sdk.api.CloudBucketsApi;

public class CloudBucketsApiExample {

    public static void main(String[] args) {
        CloudBucketsApi apiInstance = new CloudBucketsApi();
        String cloudBucketId = cloudBucketId_example; // String | Numeric ID or name of cloud bucket.
        try {
            mount_status result = apiInstance.mountStatusCloudBucket(cloudBucketId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudBucketsApi#mountStatusCloudBucket");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: BearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *cloudBucketId = cloudBucketId_example; // Numeric ID or name of cloud bucket. (default to null)

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

// Get mount status of Cloud bucket.
[apiInstance mountStatusCloudBucketWith:cloudBucketId
              completionHandler: ^(mount_status output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NodeumApi = require('nodeum_api');
var defaultClient = NodeumApi.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

// Configure API key authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new NodeumApi.CloudBucketsApi()
var cloudBucketId = cloudBucketId_example; // {String} Numeric ID or name of cloud bucket.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.mountStatusCloudBucket(cloudBucketId, callback);
using System;
using System.Diagnostics;
using Io.Nodeum.Sdk.Api;
using Io.Nodeum.Sdk.Client;
using Io.Nodeum.Sdk.Model;

namespace Example
{
    public class mountStatusCloudBucketExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: BearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CloudBucketsApi();
            var cloudBucketId = cloudBucketId_example;  // String | Numeric ID or name of cloud bucket. (default to null)

            try
            {
                // Get mount status of Cloud bucket.
                mount_status result = apiInstance.mountStatusCloudBucket(cloudBucketId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CloudBucketsApi.mountStatusCloudBucket: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: BearerAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\CloudBucketsApi();
$cloudBucketId = cloudBucketId_example; // String | Numeric ID or name of cloud bucket.

try {
    $result = $api_instance->mountStatusCloudBucket($cloudBucketId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudBucketsApi->mountStatusCloudBucket: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Nodeum::SDK::Configuration;
use Nodeum::SDK::CloudBucketsApi;

# Configure HTTP basic authorization: BasicAuth
$Nodeum::SDK::Configuration::username = 'YOUR_USERNAME';
$Nodeum::SDK::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: BearerAuth
$Nodeum::SDK::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Nodeum::SDK::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = Nodeum::SDK::CloudBucketsApi->new();
my $cloudBucketId = cloudBucketId_example; # String | Numeric ID or name of cloud bucket.

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

# Configure HTTP basic authorization: BasicAuth
nodeum-sdk.configuration.username = 'YOUR_USERNAME'
nodeum-sdk.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: BearerAuth
nodeum-sdk.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# nodeum-sdk.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = nodeum-sdk.CloudBucketsApi()
cloudBucketId = cloudBucketId_example # String | Numeric ID or name of cloud bucket. (default to null)

try: 
    # Get mount status of Cloud bucket.
    api_response = api_instance.mount_status_cloud_bucket(cloudBucketId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CloudBucketsApi->mountStatusCloudBucket: %s\n" % e)
extern crate CloudBucketsApi;

pub fn main() {
    let cloudBucketId = cloudBucketId_example; // String

    let mut context = CloudBucketsApi::Context::default();
    let result = client.mountStatusCloudBucket(cloudBucketId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
cloud_bucket_id*
String
Numeric ID or name of cloud bucket.
Required

Responses


mountStatusCloudBucketByCloudConnector

Get mount status of Cloud bucket.

**API Key Scope**: cloud_buckets / mount_status


/cloud_connectors/{cloud_connector_id}/cloud_buckets/{cloud_bucket_id}/mount

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" -H "Authorization: [[apiKey]]" "http://localhost/api/v2/cloud_connectors/{cloud_connector_id}/cloud_buckets/{cloud_bucket_id}/mount"
import io.nodeum.sdk.*;
import io.nodeum.sdk.auth.*;
import io.nodeum.sdk.model.*;
import io.nodeum.sdk.api.CloudBucketsApi;

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

public class CloudBucketsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: BearerAuth
        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //BearerAuth.setApiKeyPrefix("Token");

        CloudBucketsApi apiInstance = new CloudBucketsApi();
        String cloudConnectorId = cloudConnectorId_example; // String | Numeric ID or name of cloud connector.
        String cloudBucketId = cloudBucketId_example; // String | Numeric ID or name of cloud bucket.
        try {
            mount_status result = apiInstance.mountStatusCloudBucketByCloudConnector(cloudConnectorId, cloudBucketId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudBucketsApi#mountStatusCloudBucketByCloudConnector");
            e.printStackTrace();
        }
    }
}
import io.nodeum.sdk.api.CloudBucketsApi;

public class CloudBucketsApiExample {

    public static void main(String[] args) {
        CloudBucketsApi apiInstance = new CloudBucketsApi();
        String cloudConnectorId = cloudConnectorId_example; // String | Numeric ID or name of cloud connector.
        String cloudBucketId = cloudBucketId_example; // String | Numeric ID or name of cloud bucket.
        try {
            mount_status result = apiInstance.mountStatusCloudBucketByCloudConnector(cloudConnectorId, cloudBucketId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudBucketsApi#mountStatusCloudBucketByCloudConnector");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: BearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *cloudConnectorId = cloudConnectorId_example; // Numeric ID or name of cloud connector. (default to null)
String *cloudBucketId = cloudBucketId_example; // Numeric ID or name of cloud bucket. (default to null)

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

// Get mount status of Cloud bucket.
[apiInstance mountStatusCloudBucketByCloudConnectorWith:cloudConnectorId
    cloudBucketId:cloudBucketId
              completionHandler: ^(mount_status output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NodeumApi = require('nodeum_api');
var defaultClient = NodeumApi.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

// Configure API key authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new NodeumApi.CloudBucketsApi()
var cloudConnectorId = cloudConnectorId_example; // {String} Numeric ID or name of cloud connector.
var cloudBucketId = cloudBucketId_example; // {String} Numeric ID or name of cloud bucket.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.mountStatusCloudBucketByCloudConnector(cloudConnectorId, cloudBucketId, callback);
using System;
using System.Diagnostics;
using Io.Nodeum.Sdk.Api;
using Io.Nodeum.Sdk.Client;
using Io.Nodeum.Sdk.Model;

namespace Example
{
    public class mountStatusCloudBucketByCloudConnectorExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: BearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CloudBucketsApi();
            var cloudConnectorId = cloudConnectorId_example;  // String | Numeric ID or name of cloud connector. (default to null)
            var cloudBucketId = cloudBucketId_example;  // String | Numeric ID or name of cloud bucket. (default to null)

            try
            {
                // Get mount status of Cloud bucket.
                mount_status result = apiInstance.mountStatusCloudBucketByCloudConnector(cloudConnectorId, cloudBucketId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CloudBucketsApi.mountStatusCloudBucketByCloudConnector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: BearerAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\CloudBucketsApi();
$cloudConnectorId = cloudConnectorId_example; // String | Numeric ID or name of cloud connector.
$cloudBucketId = cloudBucketId_example; // String | Numeric ID or name of cloud bucket.

try {
    $result = $api_instance->mountStatusCloudBucketByCloudConnector($cloudConnectorId, $cloudBucketId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudBucketsApi->mountStatusCloudBucketByCloudConnector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Nodeum::SDK::Configuration;
use Nodeum::SDK::CloudBucketsApi;

# Configure HTTP basic authorization: BasicAuth
$Nodeum::SDK::Configuration::username = 'YOUR_USERNAME';
$Nodeum::SDK::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: BearerAuth
$Nodeum::SDK::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Nodeum::SDK::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = Nodeum::SDK::CloudBucketsApi->new();
my $cloudConnectorId = cloudConnectorId_example; # String | Numeric ID or name of cloud connector.
my $cloudBucketId = cloudBucketId_example; # String | Numeric ID or name of cloud bucket.

eval { 
    my $result = $api_instance->mountStatusCloudBucketByCloudConnector(cloudConnectorId => $cloudConnectorId, cloudBucketId => $cloudBucketId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CloudBucketsApi->mountStatusCloudBucketByCloudConnector: $@\n";
}
from __future__ import print_statement
import time
import nodeum-sdk
from nodeum-sdk.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
nodeum-sdk.configuration.username = 'YOUR_USERNAME'
nodeum-sdk.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: BearerAuth
nodeum-sdk.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# nodeum-sdk.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = nodeum-sdk.CloudBucketsApi()
cloudConnectorId = cloudConnectorId_example # String | Numeric ID or name of cloud connector. (default to null)
cloudBucketId = cloudBucketId_example # String | Numeric ID or name of cloud bucket. (default to null)

try: 
    # Get mount status of Cloud bucket.
    api_response = api_instance.mount_status_cloud_bucket_by_cloud_connector(cloudConnectorId, cloudBucketId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CloudBucketsApi->mountStatusCloudBucketByCloudConnector: %s\n" % e)
extern crate CloudBucketsApi;

pub fn main() {
    let cloudConnectorId = cloudConnectorId_example; // String
    let cloudBucketId = cloudBucketId_example; // String

    let mut context = CloudBucketsApi::Context::default();
    let result = client.mountStatusCloudBucketByCloudConnector(cloudConnectorId, cloudBucketId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
cloud_connector_id*
String
Numeric ID or name of cloud connector.
Required
cloud_bucket_id*
String
Numeric ID or name of cloud bucket.
Required

Responses


mountStatusCloudBucketByPool

Get mount status of Cloud bucket.

**API Key Scope**: cloud_buckets / mount_status


/pools/{pool_id}/cloud_buckets/{cloud_bucket_id}/mount

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" -H "Authorization: [[apiKey]]" "http://localhost/api/v2/pools/{pool_id}/cloud_buckets/{cloud_bucket_id}/mount"
import io.nodeum.sdk.*;
import io.nodeum.sdk.auth.*;
import io.nodeum.sdk.model.*;
import io.nodeum.sdk.api.CloudBucketsApi;

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

public class CloudBucketsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: BearerAuth
        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //BearerAuth.setApiKeyPrefix("Token");

        CloudBucketsApi apiInstance = new CloudBucketsApi();
        String poolId = poolId_example; // String | Numeric ID, or name of pool.
        String cloudBucketId = cloudBucketId_example; // String | Numeric ID or name of cloud bucket.
        try {
            mount_status result = apiInstance.mountStatusCloudBucketByPool(poolId, cloudBucketId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudBucketsApi#mountStatusCloudBucketByPool");
            e.printStackTrace();
        }
    }
}
import io.nodeum.sdk.api.CloudBucketsApi;

public class CloudBucketsApiExample {

    public static void main(String[] args) {
        CloudBucketsApi apiInstance = new CloudBucketsApi();
        String poolId = poolId_example; // String | Numeric ID, or name of pool.
        String cloudBucketId = cloudBucketId_example; // String | Numeric ID or name of cloud bucket.
        try {
            mount_status result = apiInstance.mountStatusCloudBucketByPool(poolId, cloudBucketId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudBucketsApi#mountStatusCloudBucketByPool");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: BearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *poolId = poolId_example; // Numeric ID, or name of pool. (default to null)
String *cloudBucketId = cloudBucketId_example; // Numeric ID or name of cloud bucket. (default to null)

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

// Get mount status of Cloud bucket.
[apiInstance mountStatusCloudBucketByPoolWith:poolId
    cloudBucketId:cloudBucketId
              completionHandler: ^(mount_status output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NodeumApi = require('nodeum_api');
var defaultClient = NodeumApi.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

// Configure API key authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new NodeumApi.CloudBucketsApi()
var poolId = poolId_example; // {String} Numeric ID, or name of pool.
var cloudBucketId = cloudBucketId_example; // {String} Numeric ID or name of cloud bucket.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.mountStatusCloudBucketByPool(poolId, cloudBucketId, callback);
using System;
using System.Diagnostics;
using Io.Nodeum.Sdk.Api;
using Io.Nodeum.Sdk.Client;
using Io.Nodeum.Sdk.Model;

namespace Example
{
    public class mountStatusCloudBucketByPoolExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: BearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CloudBucketsApi();
            var poolId = poolId_example;  // String | Numeric ID, or name of pool. (default to null)
            var cloudBucketId = cloudBucketId_example;  // String | Numeric ID or name of cloud bucket. (default to null)

            try
            {
                // Get mount status of Cloud bucket.
                mount_status result = apiInstance.mountStatusCloudBucketByPool(poolId, cloudBucketId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CloudBucketsApi.mountStatusCloudBucketByPool: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: BearerAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\CloudBucketsApi();
$poolId = poolId_example; // String | Numeric ID, or name of pool.
$cloudBucketId = cloudBucketId_example; // String | Numeric ID or name of cloud bucket.

try {
    $result = $api_instance->mountStatusCloudBucketByPool($poolId, $cloudBucketId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudBucketsApi->mountStatusCloudBucketByPool: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Nodeum::SDK::Configuration;
use Nodeum::SDK::CloudBucketsApi;

# Configure HTTP basic authorization: BasicAuth
$Nodeum::SDK::Configuration::username = 'YOUR_USERNAME';
$Nodeum::SDK::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: BearerAuth
$Nodeum::SDK::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Nodeum::SDK::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = Nodeum::SDK::CloudBucketsApi->new();
my $poolId = poolId_example; # String | Numeric ID, or name of pool.
my $cloudBucketId = cloudBucketId_example; # String | Numeric ID or name of cloud bucket.

eval { 
    my $result = $api_instance->mountStatusCloudBucketByPool(poolId => $poolId, cloudBucketId => $cloudBucketId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CloudBucketsApi->mountStatusCloudBucketByPool: $@\n";
}
from __future__ import print_statement
import time
import nodeum-sdk
from nodeum-sdk.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
nodeum-sdk.configuration.username = 'YOUR_USERNAME'
nodeum-sdk.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: BearerAuth
nodeum-sdk.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# nodeum-sdk.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = nodeum-sdk.CloudBucketsApi()
poolId = poolId_example # String | Numeric ID, or name of pool. (default to null)
cloudBucketId = cloudBucketId_example # String | Numeric ID or name of cloud bucket. (default to null)

try: 
    # Get mount status of Cloud bucket.
    api_response = api_instance.mount_status_cloud_bucket_by_pool(poolId, cloudBucketId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CloudBucketsApi->mountStatusCloudBucketByPool: %s\n" % e)
extern crate CloudBucketsApi;

pub fn main() {
    let poolId = poolId_example; // String
    let cloudBucketId = cloudBucketId_example; // String

    let mut context = CloudBucketsApi::Context::default();
    let result = client.mountStatusCloudBucketByPool(poolId, cloudBucketId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
pool_id*
String
Numeric ID, or name of pool.
Required
cloud_bucket_id*
String
Numeric ID or name of cloud bucket.
Required

Responses


showCloudBucket

Displays a specific cloud bucket.

**API Key Scope**: cloud_buckets / show


/cloud_buckets/{cloud_bucket_id}

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" -H "Authorization: [[apiKey]]" "http://localhost/api/v2/cloud_buckets/{cloud_bucket_id}"
import io.nodeum.sdk.*;
import io.nodeum.sdk.auth.*;
import io.nodeum.sdk.model.*;
import io.nodeum.sdk.api.CloudBucketsApi;

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

public class CloudBucketsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: BearerAuth
        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //BearerAuth.setApiKeyPrefix("Token");

        CloudBucketsApi apiInstance = new CloudBucketsApi();
        String cloudBucketId = cloudBucketId_example; // String | Numeric ID or name of cloud bucket.
        try {
            cloud_bucket result = apiInstance.showCloudBucket(cloudBucketId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudBucketsApi#showCloudBucket");
            e.printStackTrace();
        }
    }
}
import io.nodeum.sdk.api.CloudBucketsApi;

public class CloudBucketsApiExample {

    public static void main(String[] args) {
        CloudBucketsApi apiInstance = new CloudBucketsApi();
        String cloudBucketId = cloudBucketId_example; // String | Numeric ID or name of cloud bucket.
        try {
            cloud_bucket result = apiInstance.showCloudBucket(cloudBucketId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudBucketsApi#showCloudBucket");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: BearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *cloudBucketId = cloudBucketId_example; // Numeric ID or name of cloud bucket. (default to null)

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

// Displays a specific cloud bucket.
[apiInstance showCloudBucketWith:cloudBucketId
              completionHandler: ^(cloud_bucket output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NodeumApi = require('nodeum_api');
var defaultClient = NodeumApi.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

// Configure API key authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new NodeumApi.CloudBucketsApi()
var cloudBucketId = cloudBucketId_example; // {String} Numeric ID or name of cloud bucket.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.showCloudBucket(cloudBucketId, callback);
using System;
using System.Diagnostics;
using Io.Nodeum.Sdk.Api;
using Io.Nodeum.Sdk.Client;
using Io.Nodeum.Sdk.Model;

namespace Example
{
    public class showCloudBucketExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: BearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CloudBucketsApi();
            var cloudBucketId = cloudBucketId_example;  // String | Numeric ID or name of cloud bucket. (default to null)

            try
            {
                // Displays a specific cloud bucket.
                cloud_bucket result = apiInstance.showCloudBucket(cloudBucketId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CloudBucketsApi.showCloudBucket: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: BearerAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\CloudBucketsApi();
$cloudBucketId = cloudBucketId_example; // String | Numeric ID or name of cloud bucket.

try {
    $result = $api_instance->showCloudBucket($cloudBucketId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudBucketsApi->showCloudBucket: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Nodeum::SDK::Configuration;
use Nodeum::SDK::CloudBucketsApi;

# Configure HTTP basic authorization: BasicAuth
$Nodeum::SDK::Configuration::username = 'YOUR_USERNAME';
$Nodeum::SDK::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: BearerAuth
$Nodeum::SDK::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Nodeum::SDK::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = Nodeum::SDK::CloudBucketsApi->new();
my $cloudBucketId = cloudBucketId_example; # String | Numeric ID or name of cloud bucket.

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

# Configure HTTP basic authorization: BasicAuth
nodeum-sdk.configuration.username = 'YOUR_USERNAME'
nodeum-sdk.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: BearerAuth
nodeum-sdk.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# nodeum-sdk.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = nodeum-sdk.CloudBucketsApi()
cloudBucketId = cloudBucketId_example # String | Numeric ID or name of cloud bucket. (default to null)

try: 
    # Displays a specific cloud bucket.
    api_response = api_instance.show_cloud_bucket(cloudBucketId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CloudBucketsApi->showCloudBucket: %s\n" % e)
extern crate CloudBucketsApi;

pub fn main() {
    let cloudBucketId = cloudBucketId_example; // String

    let mut context = CloudBucketsApi::Context::default();
    let result = client.showCloudBucket(cloudBucketId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
cloud_bucket_id*
String
Numeric ID or name of cloud bucket.
Required

Responses


showCloudBucketByCloudConnector

Displays a specific cloud bucket.

**API Key Scope**: cloud_buckets / show


/cloud_connectors/{cloud_connector_id}/cloud_buckets/{cloud_bucket_id}

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" -H "Authorization: [[apiKey]]" "http://localhost/api/v2/cloud_connectors/{cloud_connector_id}/cloud_buckets/{cloud_bucket_id}"
import io.nodeum.sdk.*;
import io.nodeum.sdk.auth.*;
import io.nodeum.sdk.model.*;
import io.nodeum.sdk.api.CloudBucketsApi;

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

public class CloudBucketsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: BearerAuth
        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //BearerAuth.setApiKeyPrefix("Token");

        CloudBucketsApi apiInstance = new CloudBucketsApi();
        String cloudConnectorId = cloudConnectorId_example; // String | Numeric ID or name of cloud connector.
        String cloudBucketId = cloudBucketId_example; // String | Numeric ID or name of cloud bucket.
        try {
            cloud_bucket result = apiInstance.showCloudBucketByCloudConnector(cloudConnectorId, cloudBucketId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudBucketsApi#showCloudBucketByCloudConnector");
            e.printStackTrace();
        }
    }
}
import io.nodeum.sdk.api.CloudBucketsApi;

public class CloudBucketsApiExample {

    public static void main(String[] args) {
        CloudBucketsApi apiInstance = new CloudBucketsApi();
        String cloudConnectorId = cloudConnectorId_example; // String | Numeric ID or name of cloud connector.
        String cloudBucketId = cloudBucketId_example; // String | Numeric ID or name of cloud bucket.
        try {
            cloud_bucket result = apiInstance.showCloudBucketByCloudConnector(cloudConnectorId, cloudBucketId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudBucketsApi#showCloudBucketByCloudConnector");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: BearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *cloudConnectorId = cloudConnectorId_example; // Numeric ID or name of cloud connector. (default to null)
String *cloudBucketId = cloudBucketId_example; // Numeric ID or name of cloud bucket. (default to null)

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

// Displays a specific cloud bucket.
[apiInstance showCloudBucketByCloudConnectorWith:cloudConnectorId
    cloudBucketId:cloudBucketId
              completionHandler: ^(cloud_bucket output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NodeumApi = require('nodeum_api');
var defaultClient = NodeumApi.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

// Configure API key authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new NodeumApi.CloudBucketsApi()
var cloudConnectorId = cloudConnectorId_example; // {String} Numeric ID or name of cloud connector.
var cloudBucketId = cloudBucketId_example; // {String} Numeric ID or name of cloud bucket.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.showCloudBucketByCloudConnector(cloudConnectorId, cloudBucketId, callback);
using System;
using System.Diagnostics;
using Io.Nodeum.Sdk.Api;
using Io.Nodeum.Sdk.Client;
using Io.Nodeum.Sdk.Model;

namespace Example
{
    public class showCloudBucketByCloudConnectorExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: BearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CloudBucketsApi();
            var cloudConnectorId = cloudConnectorId_example;  // String | Numeric ID or name of cloud connector. (default to null)
            var cloudBucketId = cloudBucketId_example;  // String | Numeric ID or name of cloud bucket. (default to null)

            try
            {
                // Displays a specific cloud bucket.
                cloud_bucket result = apiInstance.showCloudBucketByCloudConnector(cloudConnectorId, cloudBucketId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CloudBucketsApi.showCloudBucketByCloudConnector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: BearerAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\CloudBucketsApi();
$cloudConnectorId = cloudConnectorId_example; // String | Numeric ID or name of cloud connector.
$cloudBucketId = cloudBucketId_example; // String | Numeric ID or name of cloud bucket.

try {
    $result = $api_instance->showCloudBucketByCloudConnector($cloudConnectorId, $cloudBucketId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudBucketsApi->showCloudBucketByCloudConnector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Nodeum::SDK::Configuration;
use Nodeum::SDK::CloudBucketsApi;

# Configure HTTP basic authorization: BasicAuth
$Nodeum::SDK::Configuration::username = 'YOUR_USERNAME';
$Nodeum::SDK::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: BearerAuth
$Nodeum::SDK::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Nodeum::SDK::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = Nodeum::SDK::CloudBucketsApi->new();
my $cloudConnectorId = cloudConnectorId_example; # String | Numeric ID or name of cloud connector.
my $cloudBucketId = cloudBucketId_example; # String | Numeric ID or name of cloud bucket.

eval { 
    my $result = $api_instance->showCloudBucketByCloudConnector(cloudConnectorId => $cloudConnectorId, cloudBucketId => $cloudBucketId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CloudBucketsApi->showCloudBucketByCloudConnector: $@\n";
}
from __future__ import print_statement
import time
import nodeum-sdk
from nodeum-sdk.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
nodeum-sdk.configuration.username = 'YOUR_USERNAME'
nodeum-sdk.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: BearerAuth
nodeum-sdk.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# nodeum-sdk.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = nodeum-sdk.CloudBucketsApi()
cloudConnectorId = cloudConnectorId_example # String | Numeric ID or name of cloud connector. (default to null)
cloudBucketId = cloudBucketId_example # String | Numeric ID or name of cloud bucket. (default to null)

try: 
    # Displays a specific cloud bucket.
    api_response = api_instance.show_cloud_bucket_by_cloud_connector(cloudConnectorId, cloudBucketId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CloudBucketsApi->showCloudBucketByCloudConnector: %s\n" % e)
extern crate CloudBucketsApi;

pub fn main() {
    let cloudConnectorId = cloudConnectorId_example; // String
    let cloudBucketId = cloudBucketId_example; // String

    let mut context = CloudBucketsApi::Context::default();
    let result = client.showCloudBucketByCloudConnector(cloudConnectorId, cloudBucketId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
cloud_connector_id*
String
Numeric ID or name of cloud connector.
Required
cloud_bucket_id*
String
Numeric ID or name of cloud bucket.
Required

Responses


showCloudBucketByPool

Displays a specific cloud bucket.

**API Key Scope**: cloud_buckets / show


/pools/{pool_id}/cloud_buckets/{cloud_bucket_id}

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" -H "Authorization: [[apiKey]]" "http://localhost/api/v2/pools/{pool_id}/cloud_buckets/{cloud_bucket_id}"
import io.nodeum.sdk.*;
import io.nodeum.sdk.auth.*;
import io.nodeum.sdk.model.*;
import io.nodeum.sdk.api.CloudBucketsApi;

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

public class CloudBucketsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: BearerAuth
        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //BearerAuth.setApiKeyPrefix("Token");

        CloudBucketsApi apiInstance = new CloudBucketsApi();
        String poolId = poolId_example; // String | Numeric ID, or name of pool.
        String cloudBucketId = cloudBucketId_example; // String | Numeric ID or name of cloud bucket.
        try {
            cloud_bucket result = apiInstance.showCloudBucketByPool(poolId, cloudBucketId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudBucketsApi#showCloudBucketByPool");
            e.printStackTrace();
        }
    }
}
import io.nodeum.sdk.api.CloudBucketsApi;

public class CloudBucketsApiExample {

    public static void main(String[] args) {
        CloudBucketsApi apiInstance = new CloudBucketsApi();
        String poolId = poolId_example; // String | Numeric ID, or name of pool.
        String cloudBucketId = cloudBucketId_example; // String | Numeric ID or name of cloud bucket.
        try {
            cloud_bucket result = apiInstance.showCloudBucketByPool(poolId, cloudBucketId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudBucketsApi#showCloudBucketByPool");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: BearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *poolId = poolId_example; // Numeric ID, or name of pool. (default to null)
String *cloudBucketId = cloudBucketId_example; // Numeric ID or name of cloud bucket. (default to null)

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

// Displays a specific cloud bucket.
[apiInstance showCloudBucketByPoolWith:poolId
    cloudBucketId:cloudBucketId
              completionHandler: ^(cloud_bucket output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NodeumApi = require('nodeum_api');
var defaultClient = NodeumApi.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

// Configure API key authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new NodeumApi.CloudBucketsApi()
var poolId = poolId_example; // {String} Numeric ID, or name of pool.
var cloudBucketId = cloudBucketId_example; // {String} Numeric ID or name of cloud bucket.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.showCloudBucketByPool(poolId, cloudBucketId, callback);
using System;
using System.Diagnostics;
using Io.Nodeum.Sdk.Api;
using Io.Nodeum.Sdk.Client;
using Io.Nodeum.Sdk.Model;

namespace Example
{
    public class showCloudBucketByPoolExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: BearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CloudBucketsApi();
            var poolId = poolId_example;  // String | Numeric ID, or name of pool. (default to null)
            var cloudBucketId = cloudBucketId_example;  // String | Numeric ID or name of cloud bucket. (default to null)

            try
            {
                // Displays a specific cloud bucket.
                cloud_bucket result = apiInstance.showCloudBucketByPool(poolId, cloudBucketId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CloudBucketsApi.showCloudBucketByPool: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: BearerAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\CloudBucketsApi();
$poolId = poolId_example; // String | Numeric ID, or name of pool.
$cloudBucketId = cloudBucketId_example; // String | Numeric ID or name of cloud bucket.

try {
    $result = $api_instance->showCloudBucketByPool($poolId, $cloudBucketId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudBucketsApi->showCloudBucketByPool: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Nodeum::SDK::Configuration;
use Nodeum::SDK::CloudBucketsApi;

# Configure HTTP basic authorization: BasicAuth
$Nodeum::SDK::Configuration::username = 'YOUR_USERNAME';
$Nodeum::SDK::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: BearerAuth
$Nodeum::SDK::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Nodeum::SDK::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = Nodeum::SDK::CloudBucketsApi->new();
my $poolId = poolId_example; # String | Numeric ID, or name of pool.
my $cloudBucketId = cloudBucketId_example; # String | Numeric ID or name of cloud bucket.

eval { 
    my $result = $api_instance->showCloudBucketByPool(poolId => $poolId, cloudBucketId => $cloudBucketId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CloudBucketsApi->showCloudBucketByPool: $@\n";
}
from __future__ import print_statement
import time
import nodeum-sdk
from nodeum-sdk.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
nodeum-sdk.configuration.username = 'YOUR_USERNAME'
nodeum-sdk.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: BearerAuth
nodeum-sdk.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# nodeum-sdk.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = nodeum-sdk.CloudBucketsApi()
poolId = poolId_example # String | Numeric ID, or name of pool. (default to null)
cloudBucketId = cloudBucketId_example # String | Numeric ID or name of cloud bucket. (default to null)

try: 
    # Displays a specific cloud bucket.
    api_response = api_instance.show_cloud_bucket_by_pool(poolId, cloudBucketId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CloudBucketsApi->showCloudBucketByPool: %s\n" % e)
extern crate CloudBucketsApi;

pub fn main() {
    let poolId = poolId_example; // String
    let cloudBucketId = cloudBucketId_example; // String

    let mut context = CloudBucketsApi::Context::default();
    let result = client.showCloudBucketByPool(poolId, cloudBucketId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
pool_id*
String
Numeric ID, or name of pool.
Required
cloud_bucket_id*
String
Numeric ID or name of cloud bucket.
Required

Responses


syncCloudBuckets

Synchronize internal cloud buckets with their remote equivalent.

**API Key Scope**: cloud_buckets / sync


/cloud_connectors/{cloud_connector_id}/cloud_buckets/-/sync

Usage and SDK Samples

curl -X PUT -H "Accept: application/json,queued,working,failed" -H "Authorization: Basic [[basicHash]]" -H "Authorization: [[apiKey]]" "http://localhost/api/v2/cloud_connectors/{cloud_connector_id}/cloud_buckets/-/sync"
import io.nodeum.sdk.*;
import io.nodeum.sdk.auth.*;
import io.nodeum.sdk.model.*;
import io.nodeum.sdk.api.CloudBucketsApi;

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

public class CloudBucketsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: BearerAuth
        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //BearerAuth.setApiKeyPrefix("Token");

        CloudBucketsApi apiInstance = new CloudBucketsApi();
        String cloudConnectorId = cloudConnectorId_example; // String | Numeric ID or name of cloud connector.
        try {
            active_job_status result = apiInstance.syncCloudBuckets(cloudConnectorId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudBucketsApi#syncCloudBuckets");
            e.printStackTrace();
        }
    }
}
import io.nodeum.sdk.api.CloudBucketsApi;

public class CloudBucketsApiExample {

    public static void main(String[] args) {
        CloudBucketsApi apiInstance = new CloudBucketsApi();
        String cloudConnectorId = cloudConnectorId_example; // String | Numeric ID or name of cloud connector.
        try {
            active_job_status result = apiInstance.syncCloudBuckets(cloudConnectorId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudBucketsApi#syncCloudBuckets");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: BearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *cloudConnectorId = cloudConnectorId_example; // Numeric ID or name of cloud connector. (default to null)

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

// Synchronize internal cloud buckets with their remote equivalent.
[apiInstance syncCloudBucketsWith:cloudConnectorId
              completionHandler: ^(active_job_status output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NodeumApi = require('nodeum_api');
var defaultClient = NodeumApi.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

// Configure API key authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new NodeumApi.CloudBucketsApi()
var cloudConnectorId = cloudConnectorId_example; // {String} Numeric ID or name of cloud connector.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.syncCloudBuckets(cloudConnectorId, callback);
using System;
using System.Diagnostics;
using Io.Nodeum.Sdk.Api;
using Io.Nodeum.Sdk.Client;
using Io.Nodeum.Sdk.Model;

namespace Example
{
    public class syncCloudBucketsExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: BearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CloudBucketsApi();
            var cloudConnectorId = cloudConnectorId_example;  // String | Numeric ID or name of cloud connector. (default to null)

            try
            {
                // Synchronize internal cloud buckets with their remote equivalent.
                active_job_status result = apiInstance.syncCloudBuckets(cloudConnectorId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CloudBucketsApi.syncCloudBuckets: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: BearerAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\CloudBucketsApi();
$cloudConnectorId = cloudConnectorId_example; // String | Numeric ID or name of cloud connector.

try {
    $result = $api_instance->syncCloudBuckets($cloudConnectorId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudBucketsApi->syncCloudBuckets: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Nodeum::SDK::Configuration;
use Nodeum::SDK::CloudBucketsApi;

# Configure HTTP basic authorization: BasicAuth
$Nodeum::SDK::Configuration::username = 'YOUR_USERNAME';
$Nodeum::SDK::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: BearerAuth
$Nodeum::SDK::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Nodeum::SDK::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = Nodeum::SDK::CloudBucketsApi->new();
my $cloudConnectorId = cloudConnectorId_example; # String | Numeric ID or name of cloud connector.

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

# Configure HTTP basic authorization: BasicAuth
nodeum-sdk.configuration.username = 'YOUR_USERNAME'
nodeum-sdk.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: BearerAuth
nodeum-sdk.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# nodeum-sdk.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = nodeum-sdk.CloudBucketsApi()
cloudConnectorId = cloudConnectorId_example # String | Numeric ID or name of cloud connector. (default to null)

try: 
    # Synchronize internal cloud buckets with their remote equivalent.
    api_response = api_instance.sync_cloud_buckets(cloudConnectorId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CloudBucketsApi->syncCloudBuckets: %s\n" % e)
extern crate CloudBucketsApi;

pub fn main() {
    let cloudConnectorId = cloudConnectorId_example; // String

    let mut context = CloudBucketsApi::Context::default();
    let result = client.syncCloudBuckets(cloudConnectorId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
cloud_connector_id*
String
Numeric ID or name of cloud connector.
Required

Responses


syncResultCloudBuckets

Check result of cloud connector sync job.

**API Key Scope**: cloud_buckets / sync


/cloud_connectors/{cloud_connector_id}/cloud_buckets/-/sync

Usage and SDK Samples

curl -X GET -H "Accept: application/json,queued,working,failed," -H "Authorization: Basic [[basicHash]]" -H "Authorization: [[apiKey]]" "http://localhost/api/v2/cloud_connectors/{cloud_connector_id}/cloud_buckets/-/sync?job_id="
import io.nodeum.sdk.*;
import io.nodeum.sdk.auth.*;
import io.nodeum.sdk.model.*;
import io.nodeum.sdk.api.CloudBucketsApi;

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

public class CloudBucketsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: BearerAuth
        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //BearerAuth.setApiKeyPrefix("Token");

        CloudBucketsApi apiInstance = new CloudBucketsApi();
        String cloudConnectorId = cloudConnectorId_example; // String | Numeric ID or name of cloud connector.
        String jobId = jobId_example; // String | ID of active job
        try {
            cloud_bucket_simple_collection result = apiInstance.syncResultCloudBuckets(cloudConnectorId, jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudBucketsApi#syncResultCloudBuckets");
            e.printStackTrace();
        }
    }
}
import io.nodeum.sdk.api.CloudBucketsApi;

public class CloudBucketsApiExample {

    public static void main(String[] args) {
        CloudBucketsApi apiInstance = new CloudBucketsApi();
        String cloudConnectorId = cloudConnectorId_example; // String | Numeric ID or name of cloud connector.
        String jobId = jobId_example; // String | ID of active job
        try {
            cloud_bucket_simple_collection result = apiInstance.syncResultCloudBuckets(cloudConnectorId, jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudBucketsApi#syncResultCloudBuckets");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: BearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *cloudConnectorId = cloudConnectorId_example; // Numeric ID or name of cloud connector. (default to null)
String *jobId = jobId_example; // ID of active job (default to null)

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

// Check result of cloud connector sync job.
[apiInstance syncResultCloudBucketsWith:cloudConnectorId
    jobId:jobId
              completionHandler: ^(cloud_bucket_simple_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NodeumApi = require('nodeum_api');
var defaultClient = NodeumApi.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

// Configure API key authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new NodeumApi.CloudBucketsApi()
var cloudConnectorId = cloudConnectorId_example; // {String} Numeric ID or name of cloud connector.
var jobId = jobId_example; // {String} ID of active job

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.syncResultCloudBuckets(cloudConnectorId, jobId, callback);
using System;
using System.Diagnostics;
using Io.Nodeum.Sdk.Api;
using Io.Nodeum.Sdk.Client;
using Io.Nodeum.Sdk.Model;

namespace Example
{
    public class syncResultCloudBucketsExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: BearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CloudBucketsApi();
            var cloudConnectorId = cloudConnectorId_example;  // String | Numeric ID or name of cloud connector. (default to null)
            var jobId = jobId_example;  // String | ID of active job (default to null)

            try
            {
                // Check result of cloud connector sync job.
                cloud_bucket_simple_collection result = apiInstance.syncResultCloudBuckets(cloudConnectorId, jobId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CloudBucketsApi.syncResultCloudBuckets: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: BearerAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\CloudBucketsApi();
$cloudConnectorId = cloudConnectorId_example; // String | Numeric ID or name of cloud connector.
$jobId = jobId_example; // String | ID of active job

try {
    $result = $api_instance->syncResultCloudBuckets($cloudConnectorId, $jobId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudBucketsApi->syncResultCloudBuckets: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Nodeum::SDK::Configuration;
use Nodeum::SDK::CloudBucketsApi;

# Configure HTTP basic authorization: BasicAuth
$Nodeum::SDK::Configuration::username = 'YOUR_USERNAME';
$Nodeum::SDK::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: BearerAuth
$Nodeum::SDK::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Nodeum::SDK::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = Nodeum::SDK::CloudBucketsApi->new();
my $cloudConnectorId = cloudConnectorId_example; # String | Numeric ID or name of cloud connector.
my $jobId = jobId_example; # String | ID of active job

eval { 
    my $result = $api_instance->syncResultCloudBuckets(cloudConnectorId => $cloudConnectorId, jobId => $jobId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CloudBucketsApi->syncResultCloudBuckets: $@\n";
}
from __future__ import print_statement
import time
import nodeum-sdk
from nodeum-sdk.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
nodeum-sdk.configuration.username = 'YOUR_USERNAME'
nodeum-sdk.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: BearerAuth
nodeum-sdk.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# nodeum-sdk.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = nodeum-sdk.CloudBucketsApi()
cloudConnectorId = cloudConnectorId_example # String | Numeric ID or name of cloud connector. (default to null)
jobId = jobId_example # String | ID of active job (default to null)

try: 
    # Check result of cloud connector sync job.
    api_response = api_instance.sync_result_cloud_buckets(cloudConnectorId, jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CloudBucketsApi->syncResultCloudBuckets: %s\n" % e)
extern crate CloudBucketsApi;

pub fn main() {
    let cloudConnectorId = cloudConnectorId_example; // String
    let jobId = jobId_example; // String

    let mut context = CloudBucketsApi::Context::default();
    let result = client.syncResultCloudBuckets(cloudConnectorId, jobId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
cloud_connector_id*
String
Numeric ID or name of cloud connector.
Required
Query parameters
Name Description
job_id*
String
ID of active job
Required

Responses


updateCloudBucket

Updates a specific cloud bucket.

**API Key Scope**: cloud_buckets / update


/cloud_buckets/{cloud_bucket_id}

Usage and SDK Samples

curl -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" -H "Authorization: [[apiKey]]" "http://localhost/api/v2/cloud_buckets/{cloud_bucket_id}"
import io.nodeum.sdk.*;
import io.nodeum.sdk.auth.*;
import io.nodeum.sdk.model.*;
import io.nodeum.sdk.api.CloudBucketsApi;

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

public class CloudBucketsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: BearerAuth
        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //BearerAuth.setApiKeyPrefix("Token");

        CloudBucketsApi apiInstance = new CloudBucketsApi();
        String cloudBucketId = cloudBucketId_example; // String | Numeric ID or name of cloud bucket.
        CloudBucket cloudBucketBody = ; // CloudBucket | 
        try {
            cloud_bucket result = apiInstance.updateCloudBucket(cloudBucketId, cloudBucketBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudBucketsApi#updateCloudBucket");
            e.printStackTrace();
        }
    }
}
import io.nodeum.sdk.api.CloudBucketsApi;

public class CloudBucketsApiExample {

    public static void main(String[] args) {
        CloudBucketsApi apiInstance = new CloudBucketsApi();
        String cloudBucketId = cloudBucketId_example; // String | Numeric ID or name of cloud bucket.
        CloudBucket cloudBucketBody = ; // CloudBucket | 
        try {
            cloud_bucket result = apiInstance.updateCloudBucket(cloudBucketId, cloudBucketBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudBucketsApi#updateCloudBucket");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: BearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *cloudBucketId = cloudBucketId_example; // Numeric ID or name of cloud bucket. (default to null)
CloudBucket *cloudBucketBody = ; // 

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

// Updates a specific cloud bucket.
[apiInstance updateCloudBucketWith:cloudBucketId
    cloudBucketBody:cloudBucketBody
              completionHandler: ^(cloud_bucket output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NodeumApi = require('nodeum_api');
var defaultClient = NodeumApi.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

// Configure API key authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new NodeumApi.CloudBucketsApi()
var cloudBucketId = cloudBucketId_example; // {String} Numeric ID or name of cloud bucket.
var cloudBucketBody = ; // {CloudBucket} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCloudBucket(cloudBucketId, cloudBucketBody, callback);
using System;
using System.Diagnostics;
using Io.Nodeum.Sdk.Api;
using Io.Nodeum.Sdk.Client;
using Io.Nodeum.Sdk.Model;

namespace Example
{
    public class updateCloudBucketExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: BearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CloudBucketsApi();
            var cloudBucketId = cloudBucketId_example;  // String | Numeric ID or name of cloud bucket. (default to null)
            var cloudBucketBody = new CloudBucket(); // CloudBucket | 

            try
            {
                // Updates a specific cloud bucket.
                cloud_bucket result = apiInstance.updateCloudBucket(cloudBucketId, cloudBucketBody);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CloudBucketsApi.updateCloudBucket: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: BearerAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\CloudBucketsApi();
$cloudBucketId = cloudBucketId_example; // String | Numeric ID or name of cloud bucket.
$cloudBucketBody = ; // CloudBucket | 

try {
    $result = $api_instance->updateCloudBucket($cloudBucketId, $cloudBucketBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudBucketsApi->updateCloudBucket: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Nodeum::SDK::Configuration;
use Nodeum::SDK::CloudBucketsApi;

# Configure HTTP basic authorization: BasicAuth
$Nodeum::SDK::Configuration::username = 'YOUR_USERNAME';
$Nodeum::SDK::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: BearerAuth
$Nodeum::SDK::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Nodeum::SDK::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = Nodeum::SDK::CloudBucketsApi->new();
my $cloudBucketId = cloudBucketId_example; # String | Numeric ID or name of cloud bucket.
my $cloudBucketBody = Nodeum::SDK::Object::CloudBucket->new(); # CloudBucket | 

eval { 
    my $result = $api_instance->updateCloudBucket(cloudBucketId => $cloudBucketId, cloudBucketBody => $cloudBucketBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CloudBucketsApi->updateCloudBucket: $@\n";
}
from __future__ import print_statement
import time
import nodeum-sdk
from nodeum-sdk.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
nodeum-sdk.configuration.username = 'YOUR_USERNAME'
nodeum-sdk.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: BearerAuth
nodeum-sdk.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# nodeum-sdk.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = nodeum-sdk.CloudBucketsApi()
cloudBucketId = cloudBucketId_example # String | Numeric ID or name of cloud bucket. (default to null)
cloudBucketBody =  # CloudBucket | 

try: 
    # Updates a specific cloud bucket.
    api_response = api_instance.update_cloud_bucket(cloudBucketId, cloudBucketBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CloudBucketsApi->updateCloudBucket: %s\n" % e)
extern crate CloudBucketsApi;

pub fn main() {
    let cloudBucketId = cloudBucketId_example; // String
    let cloudBucketBody = ; // CloudBucket

    let mut context = CloudBucketsApi::Context::default();
    let result = client.updateCloudBucket(cloudBucketId, cloudBucketBody, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
cloud_bucket_id*
String
Numeric ID or name of cloud bucket.
Required
Body parameters
Name Description
cloudBucketBody *

Responses


updateCloudBucketByCloudConnector

Updates a specific cloud bucket.

**API Key Scope**: cloud_buckets / update


/cloud_connectors/{cloud_connector_id}/cloud_buckets/{cloud_bucket_id}

Usage and SDK Samples

curl -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" -H "Authorization: [[apiKey]]" "http://localhost/api/v2/cloud_connectors/{cloud_connector_id}/cloud_buckets/{cloud_bucket_id}"
import io.nodeum.sdk.*;
import io.nodeum.sdk.auth.*;
import io.nodeum.sdk.model.*;
import io.nodeum.sdk.api.CloudBucketsApi;

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

public class CloudBucketsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: BearerAuth
        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //BearerAuth.setApiKeyPrefix("Token");

        CloudBucketsApi apiInstance = new CloudBucketsApi();
        String cloudConnectorId = cloudConnectorId_example; // String | Numeric ID or name of cloud connector.
        String cloudBucketId = cloudBucketId_example; // String | Numeric ID or name of cloud bucket.
        CloudBucket cloudBucketBody = ; // CloudBucket | 
        try {
            cloud_bucket result = apiInstance.updateCloudBucketByCloudConnector(cloudConnectorId, cloudBucketId, cloudBucketBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudBucketsApi#updateCloudBucketByCloudConnector");
            e.printStackTrace();
        }
    }
}
import io.nodeum.sdk.api.CloudBucketsApi;

public class CloudBucketsApiExample {

    public static void main(String[] args) {
        CloudBucketsApi apiInstance = new CloudBucketsApi();
        String cloudConnectorId = cloudConnectorId_example; // String | Numeric ID or name of cloud connector.
        String cloudBucketId = cloudBucketId_example; // String | Numeric ID or name of cloud bucket.
        CloudBucket cloudBucketBody = ; // CloudBucket | 
        try {
            cloud_bucket result = apiInstance.updateCloudBucketByCloudConnector(cloudConnectorId, cloudBucketId, cloudBucketBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudBucketsApi#updateCloudBucketByCloudConnector");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: BearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *cloudConnectorId = cloudConnectorId_example; // Numeric ID or name of cloud connector. (default to null)
String *cloudBucketId = cloudBucketId_example; // Numeric ID or name of cloud bucket. (default to null)
CloudBucket *cloudBucketBody = ; // 

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

// Updates a specific cloud bucket.
[apiInstance updateCloudBucketByCloudConnectorWith:cloudConnectorId
    cloudBucketId:cloudBucketId
    cloudBucketBody:cloudBucketBody
              completionHandler: ^(cloud_bucket output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NodeumApi = require('nodeum_api');
var defaultClient = NodeumApi.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

// Configure API key authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new NodeumApi.CloudBucketsApi()
var cloudConnectorId = cloudConnectorId_example; // {String} Numeric ID or name of cloud connector.
var cloudBucketId = cloudBucketId_example; // {String} Numeric ID or name of cloud bucket.
var cloudBucketBody = ; // {CloudBucket} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCloudBucketByCloudConnector(cloudConnectorId, cloudBucketId, cloudBucketBody, callback);
using System;
using System.Diagnostics;
using Io.Nodeum.Sdk.Api;
using Io.Nodeum.Sdk.Client;
using Io.Nodeum.Sdk.Model;

namespace Example
{
    public class updateCloudBucketByCloudConnectorExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: BearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CloudBucketsApi();
            var cloudConnectorId = cloudConnectorId_example;  // String | Numeric ID or name of cloud connector. (default to null)
            var cloudBucketId = cloudBucketId_example;  // String | Numeric ID or name of cloud bucket. (default to null)
            var cloudBucketBody = new CloudBucket(); // CloudBucket | 

            try
            {
                // Updates a specific cloud bucket.
                cloud_bucket result = apiInstance.updateCloudBucketByCloudConnector(cloudConnectorId, cloudBucketId, cloudBucketBody);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CloudBucketsApi.updateCloudBucketByCloudConnector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: BearerAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\CloudBucketsApi();
$cloudConnectorId = cloudConnectorId_example; // String | Numeric ID or name of cloud connector.
$cloudBucketId = cloudBucketId_example; // String | Numeric ID or name of cloud bucket.
$cloudBucketBody = ; // CloudBucket | 

try {
    $result = $api_instance->updateCloudBucketByCloudConnector($cloudConnectorId, $cloudBucketId, $cloudBucketBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudBucketsApi->updateCloudBucketByCloudConnector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Nodeum::SDK::Configuration;
use Nodeum::SDK::CloudBucketsApi;

# Configure HTTP basic authorization: BasicAuth
$Nodeum::SDK::Configuration::username = 'YOUR_USERNAME';
$Nodeum::SDK::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: BearerAuth
$Nodeum::SDK::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Nodeum::SDK::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = Nodeum::SDK::CloudBucketsApi->new();
my $cloudConnectorId = cloudConnectorId_example; # String | Numeric ID or name of cloud connector.
my $cloudBucketId = cloudBucketId_example; # String | Numeric ID or name of cloud bucket.
my $cloudBucketBody = Nodeum::SDK::Object::CloudBucket->new(); # CloudBucket | 

eval { 
    my $result = $api_instance->updateCloudBucketByCloudConnector(cloudConnectorId => $cloudConnectorId, cloudBucketId => $cloudBucketId, cloudBucketBody => $cloudBucketBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CloudBucketsApi->updateCloudBucketByCloudConnector: $@\n";
}
from __future__ import print_statement
import time
import nodeum-sdk
from nodeum-sdk.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
nodeum-sdk.configuration.username = 'YOUR_USERNAME'
nodeum-sdk.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: BearerAuth
nodeum-sdk.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# nodeum-sdk.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = nodeum-sdk.CloudBucketsApi()
cloudConnectorId = cloudConnectorId_example # String | Numeric ID or name of cloud connector. (default to null)
cloudBucketId = cloudBucketId_example # String | Numeric ID or name of cloud bucket. (default to null)
cloudBucketBody =  # CloudBucket | 

try: 
    # Updates a specific cloud bucket.
    api_response = api_instance.update_cloud_bucket_by_cloud_connector(cloudConnectorId, cloudBucketId, cloudBucketBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CloudBucketsApi->updateCloudBucketByCloudConnector: %s\n" % e)
extern crate CloudBucketsApi;

pub fn main() {
    let cloudConnectorId = cloudConnectorId_example; // String
    let cloudBucketId = cloudBucketId_example; // String
    let cloudBucketBody = ; // CloudBucket

    let mut context = CloudBucketsApi::Context::default();
    let result = client.updateCloudBucketByCloudConnector(cloudConnectorId, cloudBucketId, cloudBucketBody, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
cloud_connector_id*
String
Numeric ID or name of cloud connector.
Required
cloud_bucket_id*
String
Numeric ID or name of cloud bucket.
Required
Body parameters
Name Description
cloudBucketBody *

Responses


updateCloudBucketByPool

Updates a specific cloud bucket.

**API Key Scope**: cloud_buckets / update


/pools/{pool_id}/cloud_buckets/{cloud_bucket_id}

Usage and SDK Samples

curl -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" -H "Authorization: [[apiKey]]" "http://localhost/api/v2/pools/{pool_id}/cloud_buckets/{cloud_bucket_id}"
import io.nodeum.sdk.*;
import io.nodeum.sdk.auth.*;
import io.nodeum.sdk.model.*;
import io.nodeum.sdk.api.CloudBucketsApi;

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

public class CloudBucketsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: BearerAuth
        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //BearerAuth.setApiKeyPrefix("Token");

        CloudBucketsApi apiInstance = new CloudBucketsApi();
        String poolId = poolId_example; // String | Numeric ID, or name of pool.
        String cloudBucketId = cloudBucketId_example; // String | Numeric ID or name of cloud bucket.
        CloudBucket cloudBucketBody = ; // CloudBucket | 
        try {
            cloud_bucket result = apiInstance.updateCloudBucketByPool(poolId, cloudBucketId, cloudBucketBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudBucketsApi#updateCloudBucketByPool");
            e.printStackTrace();
        }
    }
}
import io.nodeum.sdk.api.CloudBucketsApi;

public class CloudBucketsApiExample {

    public static void main(String[] args) {
        CloudBucketsApi apiInstance = new CloudBucketsApi();
        String poolId = poolId_example; // String | Numeric ID, or name of pool.
        String cloudBucketId = cloudBucketId_example; // String | Numeric ID or name of cloud bucket.
        CloudBucket cloudBucketBody = ; // CloudBucket | 
        try {
            cloud_bucket result = apiInstance.updateCloudBucketByPool(poolId, cloudBucketId, cloudBucketBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudBucketsApi#updateCloudBucketByPool");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: BearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *poolId = poolId_example; // Numeric ID, or name of pool. (default to null)
String *cloudBucketId = cloudBucketId_example; // Numeric ID or name of cloud bucket. (default to null)
CloudBucket *cloudBucketBody = ; // 

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

// Updates a specific cloud bucket.
[apiInstance updateCloudBucketByPoolWith:poolId
    cloudBucketId:cloudBucketId
    cloudBucketBody:cloudBucketBody
              completionHandler: ^(cloud_bucket output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NodeumApi = require('nodeum_api');
var defaultClient = NodeumApi.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

// Configure API key authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new NodeumApi.CloudBucketsApi()
var poolId = poolId_example; // {String} Numeric ID, or name of pool.
var cloudBucketId = cloudBucketId_example; // {String} Numeric ID or name of cloud bucket.
var cloudBucketBody = ; // {CloudBucket} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCloudBucketByPool(poolId, cloudBucketId, cloudBucketBody, callback);
using System;
using System.Diagnostics;
using Io.Nodeum.Sdk.Api;
using Io.Nodeum.Sdk.Client;
using Io.Nodeum.Sdk.Model;

namespace Example
{
    public class updateCloudBucketByPoolExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: BearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CloudBucketsApi();
            var poolId = poolId_example;  // String | Numeric ID, or name of pool. (default to null)
            var cloudBucketId = cloudBucketId_example;  // String | Numeric ID or name of cloud bucket. (default to null)
            var cloudBucketBody = new CloudBucket(); // CloudBucket | 

            try
            {
                // Updates a specific cloud bucket.
                cloud_bucket result = apiInstance.updateCloudBucketByPool(poolId, cloudBucketId, cloudBucketBody);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CloudBucketsApi.updateCloudBucketByPool: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: BearerAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\CloudBucketsApi();
$poolId = poolId_example; // String | Numeric ID, or name of pool.
$cloudBucketId = cloudBucketId_example; // String | Numeric ID or name of cloud bucket.
$cloudBucketBody = ; // CloudBucket | 

try {
    $result = $api_instance->updateCloudBucketByPool($poolId, $cloudBucketId, $cloudBucketBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudBucketsApi->updateCloudBucketByPool: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Nodeum::SDK::Configuration;
use Nodeum::SDK::CloudBucketsApi;

# Configure HTTP basic authorization: BasicAuth
$Nodeum::SDK::Configuration::username = 'YOUR_USERNAME';
$Nodeum::SDK::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: BearerAuth
$Nodeum::SDK::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Nodeum::SDK::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = Nodeum::SDK::CloudBucketsApi->new();
my $poolId = poolId_example; # String | Numeric ID, or name of pool.
my $cloudBucketId = cloudBucketId_example; # String | Numeric ID or name of cloud bucket.
my $cloudBucketBody = Nodeum::SDK::Object::CloudBucket->new(); # CloudBucket | 

eval { 
    my $result = $api_instance->updateCloudBucketByPool(poolId => $poolId, cloudBucketId => $cloudBucketId, cloudBucketBody => $cloudBucketBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CloudBucketsApi->updateCloudBucketByPool: $@\n";
}
from __future__ import print_statement
import time
import nodeum-sdk
from nodeum-sdk.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
nodeum-sdk.configuration.username = 'YOUR_USERNAME'
nodeum-sdk.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: BearerAuth
nodeum-sdk.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# nodeum-sdk.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = nodeum-sdk.CloudBucketsApi()
poolId = poolId_example # String | Numeric ID, or name of pool. (default to null)
cloudBucketId = cloudBucketId_example # String | Numeric ID or name of cloud bucket. (default to null)
cloudBucketBody =  # CloudBucket | 

try: 
    # Updates a specific cloud bucket.
    api_response = api_instance.update_cloud_bucket_by_pool(poolId, cloudBucketId, cloudBucketBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CloudBucketsApi->updateCloudBucketByPool: %s\n" % e)
extern crate CloudBucketsApi;

pub fn main() {
    let poolId = poolId_example; // String
    let cloudBucketId = cloudBucketId_example; // String
    let cloudBucketBody = ; // CloudBucket

    let mut context = CloudBucketsApi::Context::default();
    let result = client.updateCloudBucketByPool(poolId, cloudBucketId, cloudBucketBody, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
pool_id*
String
Numeric ID, or name of pool.
Required
cloud_bucket_id*
String
Numeric ID or name of cloud bucket.
Required
Body parameters
Name Description
cloudBucketBody *

Responses


updateConfigFileCloudBucket

Updates a specific cloud bucket.

**API Key Scope**: cloud_buckets / update_config_file


/cloud_buckets/{cloud_bucket_id}/config_file

Usage and SDK Samples

curl -X PUT -H "Accept: application/json" -H "Content-Type: multipart/form-data" -H "Authorization: Basic [[basicHash]]" -H "Authorization: [[apiKey]]" "http://localhost/api/v2/cloud_buckets/{cloud_bucket_id}/config_file"
import io.nodeum.sdk.*;
import io.nodeum.sdk.auth.*;
import io.nodeum.sdk.model.*;
import io.nodeum.sdk.api.CloudBucketsApi;

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

public class CloudBucketsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: BearerAuth
        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //BearerAuth.setApiKeyPrefix("Token");

        CloudBucketsApi apiInstance = new CloudBucketsApi();
        String cloudBucketId = cloudBucketId_example; // String | Numeric ID or name of cloud bucket.
        File configFile = BINARY_DATA_HERE; // File | Config file to upload.
        try {
            'String' result = apiInstance.updateConfigFileCloudBucket(cloudBucketId, configFile);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudBucketsApi#updateConfigFileCloudBucket");
            e.printStackTrace();
        }
    }
}
import io.nodeum.sdk.api.CloudBucketsApi;

public class CloudBucketsApiExample {

    public static void main(String[] args) {
        CloudBucketsApi apiInstance = new CloudBucketsApi();
        String cloudBucketId = cloudBucketId_example; // String | Numeric ID or name of cloud bucket.
        File configFile = BINARY_DATA_HERE; // File | Config file to upload.
        try {
            'String' result = apiInstance.updateConfigFileCloudBucket(cloudBucketId, configFile);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudBucketsApi#updateConfigFileCloudBucket");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: BearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *cloudBucketId = cloudBucketId_example; // Numeric ID or name of cloud bucket. (default to null)
File *configFile = BINARY_DATA_HERE; // Config file to upload. (default to null)

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

// Updates a specific cloud bucket.
[apiInstance updateConfigFileCloudBucketWith:cloudBucketId
    configFile:configFile
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NodeumApi = require('nodeum_api');
var defaultClient = NodeumApi.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

// Configure API key authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new NodeumApi.CloudBucketsApi()
var cloudBucketId = cloudBucketId_example; // {String} Numeric ID or name of cloud bucket.
var configFile = BINARY_DATA_HERE; // {File} Config file to upload.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateConfigFileCloudBucket(cloudBucketId, configFile, callback);
using System;
using System.Diagnostics;
using Io.Nodeum.Sdk.Api;
using Io.Nodeum.Sdk.Client;
using Io.Nodeum.Sdk.Model;

namespace Example
{
    public class updateConfigFileCloudBucketExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: BearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CloudBucketsApi();
            var cloudBucketId = cloudBucketId_example;  // String | Numeric ID or name of cloud bucket. (default to null)
            var configFile = BINARY_DATA_HERE;  // File | Config file to upload. (default to null)

            try
            {
                // Updates a specific cloud bucket.
                'String' result = apiInstance.updateConfigFileCloudBucket(cloudBucketId, configFile);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CloudBucketsApi.updateConfigFileCloudBucket: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: BearerAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\CloudBucketsApi();
$cloudBucketId = cloudBucketId_example; // String | Numeric ID or name of cloud bucket.
$configFile = BINARY_DATA_HERE; // File | Config file to upload.

try {
    $result = $api_instance->updateConfigFileCloudBucket($cloudBucketId, $configFile);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudBucketsApi->updateConfigFileCloudBucket: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Nodeum::SDK::Configuration;
use Nodeum::SDK::CloudBucketsApi;

# Configure HTTP basic authorization: BasicAuth
$Nodeum::SDK::Configuration::username = 'YOUR_USERNAME';
$Nodeum::SDK::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: BearerAuth
$Nodeum::SDK::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Nodeum::SDK::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = Nodeum::SDK::CloudBucketsApi->new();
my $cloudBucketId = cloudBucketId_example; # String | Numeric ID or name of cloud bucket.
my $configFile = BINARY_DATA_HERE; # File | Config file to upload.

eval { 
    my $result = $api_instance->updateConfigFileCloudBucket(cloudBucketId => $cloudBucketId, configFile => $configFile);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CloudBucketsApi->updateConfigFileCloudBucket: $@\n";
}
from __future__ import print_statement
import time
import nodeum-sdk
from nodeum-sdk.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
nodeum-sdk.configuration.username = 'YOUR_USERNAME'
nodeum-sdk.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: BearerAuth
nodeum-sdk.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# nodeum-sdk.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = nodeum-sdk.CloudBucketsApi()
cloudBucketId = cloudBucketId_example # String | Numeric ID or name of cloud bucket. (default to null)
configFile = BINARY_DATA_HERE # File | Config file to upload. (default to null)

try: 
    # Updates a specific cloud bucket.
    api_response = api_instance.update_config_file_cloud_bucket(cloudBucketId, configFile)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CloudBucketsApi->updateConfigFileCloudBucket: %s\n" % e)
extern crate CloudBucketsApi;

pub fn main() {
    let cloudBucketId = cloudBucketId_example; // String
    let configFile = BINARY_DATA_HERE; // File

    let mut context = CloudBucketsApi::Context::default();
    let result = client.updateConfigFileCloudBucket(cloudBucketId, configFile, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
cloud_bucket_id*
String
Numeric ID or name of cloud bucket.
Required
Form parameters
Name Description
config_file*
File (binary)
Config file to upload.
Required

Responses


CloudConnectors

createCloudConnector

Creates a new cloud connector.

**API Key Scope**: cloud_connectors / create


/cloud_connectors

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" -H "Authorization: [[apiKey]]" "http://localhost/api/v2/cloud_connectors"
import io.nodeum.sdk.*;
import io.nodeum.sdk.auth.*;
import io.nodeum.sdk.model.*;
import io.nodeum.sdk.api.CloudConnectorsApi;

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

public class CloudConnectorsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: BearerAuth
        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //BearerAuth.setApiKeyPrefix("Token");

        CloudConnectorsApi apiInstance = new CloudConnectorsApi();
        CloudConnector cloudConnectorBody = ; // CloudConnector | 
        try {
            cloud_connector result = apiInstance.createCloudConnector(cloudConnectorBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudConnectorsApi#createCloudConnector");
            e.printStackTrace();
        }
    }
}
import io.nodeum.sdk.api.CloudConnectorsApi;

public class CloudConnectorsApiExample {

    public static void main(String[] args) {
        CloudConnectorsApi apiInstance = new CloudConnectorsApi();
        CloudConnector cloudConnectorBody = ; // CloudConnector | 
        try {
            cloud_connector result = apiInstance.createCloudConnector(cloudConnectorBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudConnectorsApi#createCloudConnector");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: BearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

CloudConnector *cloudConnectorBody = ; // 

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

// Creates a new cloud connector.
[apiInstance createCloudConnectorWith:cloudConnectorBody
              completionHandler: ^(cloud_connector output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NodeumApi = require('nodeum_api');
var defaultClient = NodeumApi.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

// Configure API key authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new NodeumApi.CloudConnectorsApi()
var cloudConnectorBody = ; // {CloudConnector} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createCloudConnector(cloudConnectorBody, callback);
using System;
using System.Diagnostics;
using Io.Nodeum.Sdk.Api;
using Io.Nodeum.Sdk.Client;
using Io.Nodeum.Sdk.Model;

namespace Example
{
    public class createCloudConnectorExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: BearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CloudConnectorsApi();
            var cloudConnectorBody = new CloudConnector(); // CloudConnector | 

            try
            {
                // Creates a new cloud connector.
                cloud_connector result = apiInstance.createCloudConnector(cloudConnectorBody);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CloudConnectorsApi.createCloudConnector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: BearerAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\CloudConnectorsApi();
$cloudConnectorBody = ; // CloudConnector | 

try {
    $result = $api_instance->createCloudConnector($cloudConnectorBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudConnectorsApi->createCloudConnector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Nodeum::SDK::Configuration;
use Nodeum::SDK::CloudConnectorsApi;

# Configure HTTP basic authorization: BasicAuth
$Nodeum::SDK::Configuration::username = 'YOUR_USERNAME';
$Nodeum::SDK::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: BearerAuth
$Nodeum::SDK::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Nodeum::SDK::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = Nodeum::SDK::CloudConnectorsApi->new();
my $cloudConnectorBody = Nodeum::SDK::Object::CloudConnector->new(); # CloudConnector | 

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

# Configure HTTP basic authorization: BasicAuth
nodeum-sdk.configuration.username = 'YOUR_USERNAME'
nodeum-sdk.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: BearerAuth
nodeum-sdk.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# nodeum-sdk.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = nodeum-sdk.CloudConnectorsApi()
cloudConnectorBody =  # CloudConnector | 

try: 
    # Creates a new cloud connector.
    api_response = api_instance.create_cloud_connector(cloudConnectorBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CloudConnectorsApi->createCloudConnector: %s\n" % e)
extern crate CloudConnectorsApi;

pub fn main() {
    let cloudConnectorBody = ; // CloudConnector

    let mut context = CloudConnectorsApi::Context::default();
    let result = client.createCloudConnector(cloudConnectorBody, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Body parameters
Name Description
cloudConnectorBody *

Responses


destroyCloudConnector

Destroys a specific cloud connector.

**API Key Scope**: cloud_connectors / destroy


/cloud_connectors/{cloud_connector_id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: Basic [[basicHash]]" -H "Authorization: [[apiKey]]" "http://localhost/api/v2/cloud_connectors/{cloud_connector_id}"
import io.nodeum.sdk.*;
import io.nodeum.sdk.auth.*;
import io.nodeum.sdk.model.*;
import io.nodeum.sdk.api.CloudConnectorsApi;

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

public class CloudConnectorsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: BearerAuth
        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //BearerAuth.setApiKeyPrefix("Token");

        CloudConnectorsApi apiInstance = new CloudConnectorsApi();
        String cloudConnectorId = cloudConnectorId_example; // String | Numeric ID or name of cloud connector.
        try {
            apiInstance.destroyCloudConnector(cloudConnectorId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudConnectorsApi#destroyCloudConnector");
            e.printStackTrace();
        }
    }
}
import io.nodeum.sdk.api.CloudConnectorsApi;

public class CloudConnectorsApiExample {

    public static void main(String[] args) {
        CloudConnectorsApi apiInstance = new CloudConnectorsApi();
        String cloudConnectorId = cloudConnectorId_example; // String | Numeric ID or name of cloud connector.
        try {
            apiInstance.destroyCloudConnector(cloudConnectorId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudConnectorsApi#destroyCloudConnector");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: BearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *cloudConnectorId = cloudConnectorId_example; // Numeric ID or name of cloud connector. (default to null)

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

// Destroys a specific cloud connector.
[apiInstance destroyCloudConnectorWith:cloudConnectorId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NodeumApi = require('nodeum_api');
var defaultClient = NodeumApi.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

// Configure API key authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new NodeumApi.CloudConnectorsApi()
var cloudConnectorId = cloudConnectorId_example; // {String} Numeric ID or name of cloud connector.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.destroyCloudConnector(cloudConnectorId, callback);
using System;
using System.Diagnostics;
using Io.Nodeum.Sdk.Api;
using Io.Nodeum.Sdk.Client;
using Io.Nodeum.Sdk.Model;

namespace Example
{
    public class destroyCloudConnectorExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: BearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CloudConnectorsApi();
            var cloudConnectorId = cloudConnectorId_example;  // String | Numeric ID or name of cloud connector. (default to null)

            try
            {
                // Destroys a specific cloud connector.
                apiInstance.destroyCloudConnector(cloudConnectorId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CloudConnectorsApi.destroyCloudConnector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: BearerAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\CloudConnectorsApi();
$cloudConnectorId = cloudConnectorId_example; // String | Numeric ID or name of cloud connector.

try {
    $api_instance->destroyCloudConnector($cloudConnectorId);
} catch (Exception $e) {
    echo 'Exception when calling CloudConnectorsApi->destroyCloudConnector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Nodeum::SDK::Configuration;
use Nodeum::SDK::CloudConnectorsApi;

# Configure HTTP basic authorization: BasicAuth
$Nodeum::SDK::Configuration::username = 'YOUR_USERNAME';
$Nodeum::SDK::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: BearerAuth
$Nodeum::SDK::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Nodeum::SDK::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = Nodeum::SDK::CloudConnectorsApi->new();
my $cloudConnectorId = cloudConnectorId_example; # String | Numeric ID or name of cloud connector.

eval { 
    $api_instance->destroyCloudConnector(cloudConnectorId => $cloudConnectorId);
};
if ($@) {
    warn "Exception when calling CloudConnectorsApi->destroyCloudConnector: $@\n";
}
from __future__ import print_statement
import time
import nodeum-sdk
from nodeum-sdk.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
nodeum-sdk.configuration.username = 'YOUR_USERNAME'
nodeum-sdk.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: BearerAuth
nodeum-sdk.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# nodeum-sdk.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = nodeum-sdk.CloudConnectorsApi()
cloudConnectorId = cloudConnectorId_example # String | Numeric ID or name of cloud connector. (default to null)

try: 
    # Destroys a specific cloud connector.
    api_instance.destroy_cloud_connector(cloudConnectorId)
except ApiException as e:
    print("Exception when calling CloudConnectorsApi->destroyCloudConnector: %s\n" % e)
extern crate CloudConnectorsApi;

pub fn main() {
    let cloudConnectorId = cloudConnectorId_example; // String

    let mut context = CloudConnectorsApi::Context::default();
    let result = client.destroyCloudConnector(cloudConnectorId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
cloud_connector_id*
String
Numeric ID or name of cloud connector.
Required

Responses


indexCloudConnectors

Lists all cloud connectors.

**API Key Scope**: cloud_connectors / index Optional API Key Explicit Scope: cloud_connectors / get_secret_key


/cloud_connectors

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" -H "Authorization: [[apiKey]]" "http://localhost/api/v2/cloud_connectors?limit=&offset=&sort_by=&id=&name=&url=&url_proxy=&provider=®ion=&access_key="
import io.nodeum.sdk.*;
import io.nodeum.sdk.auth.*;
import io.nodeum.sdk.model.*;
import io.nodeum.sdk.api.CloudConnectorsApi;

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

public class CloudConnectorsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: BearerAuth
        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //BearerAuth.setApiKeyPrefix("Token");

        CloudConnectorsApi apiInstance = new CloudConnectorsApi();
        Integer limit = 56; // Integer | The number of items to display for pagination.
        Integer offset = 56; // Integer | The number of items to skip for pagination.
        array[String] sortBy = ; // array[String] | Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
        String id = id_example; // String | Filter on id
        String name = name_example; // String | Filter on name
        String url = url_example; // String | Filter on url
        String urlProxy = urlProxy_example; // String | Filter on url proxy
        String provider = provider_example; // String | Filter on provider
        String region = region_example; // String | Filter on region
        String accessKey = accessKey_example; // String | Filter on access key
        try {
            cloud_connector_collection result = apiInstance.indexCloudConnectors(limit, offset, sortBy, id, name, url, urlProxy, provider, region, accessKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudConnectorsApi#indexCloudConnectors");
            e.printStackTrace();
        }
    }
}
import io.nodeum.sdk.api.CloudConnectorsApi;

public class CloudConnectorsApiExample {

    public static void main(String[] args) {
        CloudConnectorsApi apiInstance = new CloudConnectorsApi();
        Integer limit = 56; // Integer | The number of items to display for pagination.
        Integer offset = 56; // Integer | The number of items to skip for pagination.
        array[String] sortBy = ; // array[String] | Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
        String id = id_example; // String | Filter on id
        String name = name_example; // String | Filter on name
        String url = url_example; // String | Filter on url
        String urlProxy = urlProxy_example; // String | Filter on url proxy
        String provider = provider_example; // String | Filter on provider
        String region = region_example; // String | Filter on region
        String accessKey = accessKey_example; // String | Filter on access key
        try {
            cloud_connector_collection result = apiInstance.indexCloudConnectors(limit, offset, sortBy, id, name, url, urlProxy, provider, region, accessKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudConnectorsApi#indexCloudConnectors");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: BearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

Integer *limit = 56; // The number of items to display for pagination. (optional) (default to null)
Integer *offset = 56; // The number of items to skip for pagination. (optional) (default to null)
array[String] *sortBy = ; // Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`. (optional) (default to null)
String *id = id_example; // Filter on id (optional) (default to null)
String *name = name_example; // Filter on name (optional) (default to null)
String *url = url_example; // Filter on url (optional) (default to null)
String *urlProxy = urlProxy_example; // Filter on url proxy (optional) (default to null)
String *provider = provider_example; // Filter on provider (optional) (default to null)
String *region = region_example; // Filter on region (optional) (default to null)
String *accessKey = accessKey_example; // Filter on access key (optional) (default to null)

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

// Lists all cloud connectors.
[apiInstance indexCloudConnectorsWith:limit
    offset:offset
    sortBy:sortBy
    id:id
    name:name
    url:url
    urlProxy:urlProxy
    provider:provider
    region:region
    accessKey:accessKey
              completionHandler: ^(cloud_connector_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NodeumApi = require('nodeum_api');
var defaultClient = NodeumApi.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

// Configure API key authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new NodeumApi.CloudConnectorsApi()
var opts = {
  'limit': 56, // {Integer} The number of items to display for pagination.
  'offset': 56, // {Integer} The number of items to skip for pagination.
  'sortBy': , // {array[String]} Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
  'id': id_example, // {String} Filter on id
  'name': name_example, // {String} Filter on name
  'url': url_example, // {String} Filter on url
  'urlProxy': urlProxy_example, // {String} Filter on url proxy
  'provider': provider_example, // {String} Filter on provider
  'region': region_example, // {String} Filter on region
  'accessKey': accessKey_example // {String} Filter on access key
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.indexCloudConnectors(opts, callback);
using System;
using System.Diagnostics;
using Io.Nodeum.Sdk.Api;
using Io.Nodeum.Sdk.Client;
using Io.Nodeum.Sdk.Model;

namespace Example
{
    public class indexCloudConnectorsExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: BearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CloudConnectorsApi();
            var limit = 56;  // Integer | The number of items to display for pagination. (optional)  (default to null)
            var offset = 56;  // Integer | The number of items to skip for pagination. (optional)  (default to null)
            var sortBy = new array[String](); // array[String] | Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`. (optional)  (default to null)
            var id = id_example;  // String | Filter on id (optional)  (default to null)
            var name = name_example;  // String | Filter on name (optional)  (default to null)
            var url = url_example;  // String | Filter on url (optional)  (default to null)
            var urlProxy = urlProxy_example;  // String | Filter on url proxy (optional)  (default to null)
            var provider = provider_example;  // String | Filter on provider (optional)  (default to null)
            var region = region_example;  // String | Filter on region (optional)  (default to null)
            var accessKey = accessKey_example;  // String | Filter on access key (optional)  (default to null)

            try
            {
                // Lists all cloud connectors.
                cloud_connector_collection result = apiInstance.indexCloudConnectors(limit, offset, sortBy, id, name, url, urlProxy, provider, region, accessKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CloudConnectorsApi.indexCloudConnectors: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: BearerAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\CloudConnectorsApi();
$limit = 56; // Integer | The number of items to display for pagination.
$offset = 56; // Integer | The number of items to skip for pagination.
$sortBy = ; // array[String] | Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
$id = id_example; // String | Filter on id
$name = name_example; // String | Filter on name
$url = url_example; // String | Filter on url
$urlProxy = urlProxy_example; // String | Filter on url proxy
$provider = provider_example; // String | Filter on provider
$region = region_example; // String | Filter on region
$accessKey = accessKey_example; // String | Filter on access key

try {
    $result = $api_instance->indexCloudConnectors($limit, $offset, $sortBy, $id, $name, $url, $urlProxy, $provider, $region, $accessKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudConnectorsApi->indexCloudConnectors: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Nodeum::SDK::Configuration;
use Nodeum::SDK::CloudConnectorsApi;

# Configure HTTP basic authorization: BasicAuth
$Nodeum::SDK::Configuration::username = 'YOUR_USERNAME';
$Nodeum::SDK::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: BearerAuth
$Nodeum::SDK::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Nodeum::SDK::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = Nodeum::SDK::CloudConnectorsApi->new();
my $limit = 56; # Integer | The number of items to display for pagination.
my $offset = 56; # Integer | The number of items to skip for pagination.
my $sortBy = []; # array[String] | Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
my $id = id_example; # String | Filter on id
my $name = name_example; # String | Filter on name
my $url = url_example; # String | Filter on url
my $urlProxy = urlProxy_example; # String | Filter on url proxy
my $provider = provider_example; # String | Filter on provider
my $region = region_example; # String | Filter on region
my $accessKey = accessKey_example; # String | Filter on access key

eval { 
    my $result = $api_instance->indexCloudConnectors(limit => $limit, offset => $offset, sortBy => $sortBy, id => $id, name => $name, url => $url, urlProxy => $urlProxy, provider => $provider, region => $region, accessKey => $accessKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CloudConnectorsApi->indexCloudConnectors: $@\n";
}
from __future__ import print_statement
import time
import nodeum-sdk
from nodeum-sdk.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
nodeum-sdk.configuration.username = 'YOUR_USERNAME'
nodeum-sdk.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: BearerAuth
nodeum-sdk.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# nodeum-sdk.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = nodeum-sdk.CloudConnectorsApi()
limit = 56 # Integer | The number of items to display for pagination. (optional) (default to null)
offset = 56 # Integer | The number of items to skip for pagination. (optional) (default to null)
sortBy =  # array[String] | Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`. (optional) (default to null)
id = id_example # String | Filter on id (optional) (default to null)
name = name_example # String | Filter on name (optional) (default to null)
url = url_example # String | Filter on url (optional) (default to null)
urlProxy = urlProxy_example # String | Filter on url proxy (optional) (default to null)
provider = provider_example # String | Filter on provider (optional) (default to null)
region = region_example # String | Filter on region (optional) (default to null)
accessKey = accessKey_example # String | Filter on access key (optional) (default to null)

try: 
    # Lists all cloud connectors.
    api_response = api_instance.index_cloud_connectors(limit=limit, offset=offset, sortBy=sortBy, id=id, name=name, url=url, urlProxy=urlProxy, provider=provider, region=region, accessKey=accessKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CloudConnectorsApi->indexCloudConnectors: %s\n" % e)
extern crate CloudConnectorsApi;

pub fn main() {
    let limit = 56; // Integer
    let offset = 56; // Integer
    let sortBy = ; // array[String]
    let id = id_example; // String
    let name = name_example; // String
    let url = url_example; // String
    let urlProxy = urlProxy_example; // String
    let provider = provider_example; // String
    let region = region_example; // String
    let accessKey = accessKey_example; // String

    let mut context = CloudConnectorsApi::Context::default();
    let result = client.indexCloudConnectors(limit, offset, sortBy, id, name, url, urlProxy, provider, region, accessKey, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Query parameters
Name Description
limit
Integer
The number of items to display for pagination.
offset
Integer
The number of items to skip for pagination.
sort_by
array[String]
Sort results by attribute. Can sort on multiple attributes, separated by `|`. Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
id
String
Filter on id
name
String
Filter on name
url
String
Filter on url
url_proxy
String
Filter on url proxy
provider
String
Filter on provider
region
String
Filter on region
access_key
String
Filter on access key

Responses


showCloudConnector

Displays a specific cloud connector.

**API Key Scope**: cloud_connectors / show Optional API Key Explicit Scope: cloud_connectors / get_secret_key


/cloud_connectors/{cloud_connector_id}

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" -H "Authorization: [[apiKey]]" "http://localhost/api/v2/cloud_connectors/{cloud_connector_id}"
import io.nodeum.sdk.*;
import io.nodeum.sdk.auth.*;
import io.nodeum.sdk.model.*;
import io.nodeum.sdk.api.CloudConnectorsApi;

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

public class CloudConnectorsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: BearerAuth
        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //BearerAuth.setApiKeyPrefix("Token");

        CloudConnectorsApi apiInstance = new CloudConnectorsApi();
        String cloudConnectorId = cloudConnectorId_example; // String | Numeric ID or name of cloud connector.
        try {
            cloud_connector result = apiInstance.showCloudConnector(cloudConnectorId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudConnectorsApi#showCloudConnector");
            e.printStackTrace();
        }
    }
}
import io.nodeum.sdk.api.CloudConnectorsApi;

public class CloudConnectorsApiExample {

    public static void main(String[] args) {
        CloudConnectorsApi apiInstance = new CloudConnectorsApi();
        String cloudConnectorId = cloudConnectorId_example; // String | Numeric ID or name of cloud connector.
        try {
            cloud_connector result = apiInstance.showCloudConnector(cloudConnectorId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudConnectorsApi#showCloudConnector");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: BearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *cloudConnectorId = cloudConnectorId_example; // Numeric ID or name of cloud connector. (default to null)

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

// Displays a specific cloud connector.
[apiInstance showCloudConnectorWith:cloudConnectorId
              completionHandler: ^(cloud_connector output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NodeumApi = require('nodeum_api');
var defaultClient = NodeumApi.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

// Configure API key authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new NodeumApi.CloudConnectorsApi()
var cloudConnectorId = cloudConnectorId_example; // {String} Numeric ID or name of cloud connector.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.showCloudConnector(cloudConnectorId, callback);
using System;
using System.Diagnostics;
using Io.Nodeum.Sdk.Api;
using Io.Nodeum.Sdk.Client;
using Io.Nodeum.Sdk.Model;

namespace Example
{
    public class showCloudConnectorExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: BearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CloudConnectorsApi();
            var cloudConnectorId = cloudConnectorId_example;  // String | Numeric ID or name of cloud connector. (default to null)

            try
            {
                // Displays a specific cloud connector.
                cloud_connector result = apiInstance.showCloudConnector(cloudConnectorId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CloudConnectorsApi.showCloudConnector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: BearerAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\CloudConnectorsApi();
$cloudConnectorId = cloudConnectorId_example; // String | Numeric ID or name of cloud connector.

try {
    $result = $api_instance->showCloudConnector($cloudConnectorId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudConnectorsApi->showCloudConnector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Nodeum::SDK::Configuration;
use Nodeum::SDK::CloudConnectorsApi;

# Configure HTTP basic authorization: BasicAuth
$Nodeum::SDK::Configuration::username = 'YOUR_USERNAME';
$Nodeum::SDK::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: BearerAuth
$Nodeum::SDK::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Nodeum::SDK::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = Nodeum::SDK::CloudConnectorsApi->new();
my $cloudConnectorId = cloudConnectorId_example; # String | Numeric ID or name of cloud connector.

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

# Configure HTTP basic authorization: BasicAuth
nodeum-sdk.configuration.username = 'YOUR_USERNAME'
nodeum-sdk.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: BearerAuth
nodeum-sdk.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# nodeum-sdk.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = nodeum-sdk.CloudConnectorsApi()
cloudConnectorId = cloudConnectorId_example # String | Numeric ID or name of cloud connector. (default to null)

try: 
    # Displays a specific cloud connector.
    api_response = api_instance.show_cloud_connector(cloudConnectorId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CloudConnectorsApi->showCloudConnector: %s\n" % e)
extern crate CloudConnectorsApi;

pub fn main() {
    let cloudConnectorId = cloudConnectorId_example; // String

    let mut context = CloudConnectorsApi::Context::default();
    let result = client.showCloudConnector(cloudConnectorId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
cloud_connector_id*
String
Numeric ID or name of cloud connector.
Required

Responses


testCloudConnector

Test an unsaved cloud connector.

**API Key Scope**: cloud_connectors / test


/cloud_connectors/-/test

Usage and SDK Samples

curl -X PUT -H "Accept: application/json,queued,working,failed" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" -H "Authorization: [[apiKey]]" "http://localhost/api/v2/cloud_connectors/-/test"
import io.nodeum.sdk.*;
import io.nodeum.sdk.auth.*;
import io.nodeum.sdk.model.*;
import io.nodeum.sdk.api.CloudConnectorsApi;

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

public class CloudConnectorsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: BearerAuth
        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //BearerAuth.setApiKeyPrefix("Token");

        CloudConnectorsApi apiInstance = new CloudConnectorsApi();
        CloudConnector cloudConnectorBody = ; // CloudConnector | 
        try {
            active_job_status result = apiInstance.testCloudConnector(cloudConnectorBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudConnectorsApi#testCloudConnector");
            e.printStackTrace();
        }
    }
}
import io.nodeum.sdk.api.CloudConnectorsApi;

public class CloudConnectorsApiExample {

    public static void main(String[] args) {
        CloudConnectorsApi apiInstance = new CloudConnectorsApi();
        CloudConnector cloudConnectorBody = ; // CloudConnector | 
        try {
            active_job_status result = apiInstance.testCloudConnector(cloudConnectorBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudConnectorsApi#testCloudConnector");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: BearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

CloudConnector *cloudConnectorBody = ; // 

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

// Test an unsaved cloud connector.
[apiInstance testCloudConnectorWith:cloudConnectorBody
              completionHandler: ^(active_job_status output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NodeumApi = require('nodeum_api');
var defaultClient = NodeumApi.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

// Configure API key authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new NodeumApi.CloudConnectorsApi()
var cloudConnectorBody = ; // {CloudConnector} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.testCloudConnector(cloudConnectorBody, callback);
using System;
using System.Diagnostics;
using Io.Nodeum.Sdk.Api;
using Io.Nodeum.Sdk.Client;
using Io.Nodeum.Sdk.Model;

namespace Example
{
    public class testCloudConnectorExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: BearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CloudConnectorsApi();
            var cloudConnectorBody = new CloudConnector(); // CloudConnector | 

            try
            {
                // Test an unsaved cloud connector.
                active_job_status result = apiInstance.testCloudConnector(cloudConnectorBody);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CloudConnectorsApi.testCloudConnector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: BearerAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\CloudConnectorsApi();
$cloudConnectorBody = ; // CloudConnector | 

try {
    $result = $api_instance->testCloudConnector($cloudConnectorBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudConnectorsApi->testCloudConnector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Nodeum::SDK::Configuration;
use Nodeum::SDK::CloudConnectorsApi;

# Configure HTTP basic authorization: BasicAuth
$Nodeum::SDK::Configuration::username = 'YOUR_USERNAME';
$Nodeum::SDK::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: BearerAuth
$Nodeum::SDK::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Nodeum::SDK::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = Nodeum::SDK::CloudConnectorsApi->new();
my $cloudConnectorBody = Nodeum::SDK::Object::CloudConnector->new(); # CloudConnector | 

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

# Configure HTTP basic authorization: BasicAuth
nodeum-sdk.configuration.username = 'YOUR_USERNAME'
nodeum-sdk.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: BearerAuth
nodeum-sdk.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# nodeum-sdk.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = nodeum-sdk.CloudConnectorsApi()
cloudConnectorBody =  # CloudConnector | 

try: 
    # Test an unsaved cloud connector.
    api_response = api_instance.test_cloud_connector(cloudConnectorBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CloudConnectorsApi->testCloudConnector: %s\n" % e)
extern crate CloudConnectorsApi;

pub fn main() {
    let cloudConnectorBody = ; // CloudConnector

    let mut context = CloudConnectorsApi::Context::default();
    let result = client.testCloudConnector(cloudConnectorBody, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Body parameters
Name Description
cloudConnectorBody *

Responses


testResultCloudConnector

Check result of cloud connector test job.

**API Key Scope**: cloud_connectors / test


/cloud_connectors/-/test

Usage and SDK Samples

curl -X GET -H "Accept: application/json,queued,working,failed," -H "Authorization: Basic [[basicHash]]" -H "Authorization: [[apiKey]]" "http://localhost/api/v2/cloud_connectors/-/test?job_id="
import io.nodeum.sdk.*;
import io.nodeum.sdk.auth.*;
import io.nodeum.sdk.model.*;
import io.nodeum.sdk.api.CloudConnectorsApi;

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

public class CloudConnectorsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: BearerAuth
        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //BearerAuth.setApiKeyPrefix("Token");

        CloudConnectorsApi apiInstance = new CloudConnectorsApi();
        String jobId = jobId_example; // String | ID of active job
        try {
            cloud_bucket_simple_collection result = apiInstance.testResultCloudConnector(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudConnectorsApi#testResultCloudConnector");
            e.printStackTrace();
        }
    }
}
import io.nodeum.sdk.api.CloudConnectorsApi;

public class CloudConnectorsApiExample {

    public static void main(String[] args) {
        CloudConnectorsApi apiInstance = new CloudConnectorsApi();
        String jobId = jobId_example; // String | ID of active job
        try {
            cloud_bucket_simple_collection result = apiInstance.testResultCloudConnector(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudConnectorsApi#testResultCloudConnector");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: BearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *jobId = jobId_example; // ID of active job (default to null)

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

// Check result of cloud connector test job.
[apiInstance testResultCloudConnectorWith:jobId
              completionHandler: ^(cloud_bucket_simple_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NodeumApi = require('nodeum_api');
var defaultClient = NodeumApi.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

// Configure API key authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new NodeumApi.CloudConnectorsApi()
var jobId = jobId_example; // {String} ID of active job

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.testResultCloudConnector(jobId, callback);
using System;
using System.Diagnostics;
using Io.Nodeum.Sdk.Api;
using Io.Nodeum.Sdk.Client;
using Io.Nodeum.Sdk.Model;

namespace Example
{
    public class testResultCloudConnectorExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: BearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CloudConnectorsApi();
            var jobId = jobId_example;  // String | ID of active job (default to null)

            try
            {
                // Check result of cloud connector test job.
                cloud_bucket_simple_collection result = apiInstance.testResultCloudConnector(jobId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CloudConnectorsApi.testResultCloudConnector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: BearerAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\CloudConnectorsApi();
$jobId = jobId_example; // String | ID of active job

try {
    $result = $api_instance->testResultCloudConnector($jobId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudConnectorsApi->testResultCloudConnector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Nodeum::SDK::Configuration;
use Nodeum::SDK::CloudConnectorsApi;

# Configure HTTP basic authorization: BasicAuth
$Nodeum::SDK::Configuration::username = 'YOUR_USERNAME';
$Nodeum::SDK::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: BearerAuth
$Nodeum::SDK::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Nodeum::SDK::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = Nodeum::SDK::CloudConnectorsApi->new();
my $jobId = jobId_example; # String | ID of active job

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

# Configure HTTP basic authorization: BasicAuth
nodeum-sdk.configuration.username = 'YOUR_USERNAME'
nodeum-sdk.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: BearerAuth
nodeum-sdk.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# nodeum-sdk.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = nodeum-sdk.CloudConnectorsApi()
jobId = jobId_example # String | ID of active job (default to null)

try: 
    # Check result of cloud connector test job.
    api_response = api_instance.test_result_cloud_connector(jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CloudConnectorsApi->testResultCloudConnector: %s\n" % e)
extern crate CloudConnectorsApi;

pub fn main() {
    let jobId = jobId_example; // String

    let mut context = CloudConnectorsApi::Context::default();
    let result = client.testResultCloudConnector(jobId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Query parameters
Name Description
job_id*
String
ID of active job
Required

Responses


updateCloudConnector

Updates a specific cloud connector.

**API Key Scope**: cloud_connectors / update


/cloud_connectors/{cloud_connector_id}

Usage and SDK Samples

curl -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" -H "Authorization: [[apiKey]]" "http://localhost/api/v2/cloud_connectors/{cloud_connector_id}"
import io.nodeum.sdk.*;
import io.nodeum.sdk.auth.*;
import io.nodeum.sdk.model.*;
import io.nodeum.sdk.api.CloudConnectorsApi;

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

public class CloudConnectorsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: BearerAuth
        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //BearerAuth.setApiKeyPrefix("Token");

        CloudConnectorsApi apiInstance = new CloudConnectorsApi();
        String cloudConnectorId = cloudConnectorId_example; // String | Numeric ID or name of cloud connector.
        CloudConnector cloudConnectorBody = ; // CloudConnector | 
        try {
            cloud_connector result = apiInstance.updateCloudConnector(cloudConnectorId, cloudConnectorBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudConnectorsApi#updateCloudConnector");
            e.printStackTrace();
        }
    }
}
import io.nodeum.sdk.api.CloudConnectorsApi;

public class CloudConnectorsApiExample {

    public static void main(String[] args) {
        CloudConnectorsApi apiInstance = new CloudConnectorsApi();
        String cloudConnectorId = cloudConnectorId_example; // String | Numeric ID or name of cloud connector.
        CloudConnector cloudConnectorBody = ; // CloudConnector | 
        try {
            cloud_connector result = apiInstance.updateCloudConnector(cloudConnectorId, cloudConnectorBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudConnectorsApi#updateCloudConnector");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: BearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *cloudConnectorId = cloudConnectorId_example; // Numeric ID or name of cloud connector. (default to null)
CloudConnector *cloudConnectorBody = ; // 

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

// Updates a specific cloud connector.
[apiInstance updateCloudConnectorWith:cloudConnectorId
    cloudConnectorBody:cloudConnectorBody
              completionHandler: ^(cloud_connector output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NodeumApi = require('nodeum_api');
var defaultClient = NodeumApi.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

// Configure API key authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new NodeumApi.CloudConnectorsApi()
var cloudConnectorId = cloudConnectorId_example; // {String} Numeric ID or name of cloud connector.
var cloudConnectorBody = ; // {CloudConnector} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCloudConnector(cloudConnectorId, cloudConnectorBody, callback);
using System;
using System.Diagnostics;
using Io.Nodeum.Sdk.Api;
using Io.Nodeum.Sdk.Client;
using Io.Nodeum.Sdk.Model;

namespace Example
{
    public class updateCloudConnectorExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: BearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CloudConnectorsApi();
            var cloudConnectorId = cloudConnectorId_example;  // String | Numeric ID or name of cloud connector. (default to null)
            var cloudConnectorBody = new CloudConnector(); // CloudConnector | 

            try
            {
                // Updates a specific cloud connector.
                cloud_connector result = apiInstance.updateCloudConnector(cloudConnectorId, cloudConnectorBody);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CloudConnectorsApi.updateCloudConnector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: BearerAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\CloudConnectorsApi();
$cloudConnectorId = cloudConnectorId_example; // String | Numeric ID or name of cloud connector.
$cloudConnectorBody = ; // CloudConnector | 

try {
    $result = $api_instance->updateCloudConnector($cloudConnectorId, $cloudConnectorBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudConnectorsApi->updateCloudConnector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Nodeum::SDK::Configuration;
use Nodeum::SDK::CloudConnectorsApi;

# Configure HTTP basic authorization: BasicAuth
$Nodeum::SDK::Configuration::username = 'YOUR_USERNAME';
$Nodeum::SDK::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: BearerAuth
$Nodeum::SDK::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Nodeum::SDK::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = Nodeum::SDK::CloudConnectorsApi->new();
my $cloudConnectorId = cloudConnectorId_example; # String | Numeric ID or name of cloud connector.
my $cloudConnectorBody = Nodeum::SDK::Object::CloudConnector->new(); # CloudConnector | 

eval { 
    my $result = $api_instance->updateCloudConnector(cloudConnectorId => $cloudConnectorId, cloudConnectorBody => $cloudConnectorBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CloudConnectorsApi->updateCloudConnector: $@\n";
}
from __future__ import print_statement
import time
import nodeum-sdk
from nodeum-sdk.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
nodeum-sdk.configuration.username = 'YOUR_USERNAME'
nodeum-sdk.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: BearerAuth
nodeum-sdk.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# nodeum-sdk.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = nodeum-sdk.CloudConnectorsApi()
cloudConnectorId = cloudConnectorId_example # String | Numeric ID or name of cloud connector. (default to null)
cloudConnectorBody =  # CloudConnector | 

try: 
    # Updates a specific cloud connector.
    api_response = api_instance.update_cloud_connector(cloudConnectorId, cloudConnectorBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CloudConnectorsApi->updateCloudConnector: %s\n" % e)
extern crate CloudConnectorsApi;

pub fn main() {
    let cloudConnectorId = cloudConnectorId_example; // String
    let cloudConnectorBody = ; // CloudConnector

    let mut context = CloudConnectorsApi::Context::default();
    let result = client.updateCloudConnector(cloudConnectorId, cloudConnectorBody, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
cloud_connector_id*
String
Numeric ID or name of cloud connector.
Required
Body parameters
Name Description
cloudConnectorBody *

Responses


Containers

createContainer

Creates a new container.

It **does not** yet create the file structure and configure the samba connection. Use API v1 instead. **API Key Scope**: containers / create


/containers

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" -H "Authorization: [[apiKey]]" "http://localhost/api/v2/containers"
import io.nodeum.sdk.*;
import io.nodeum.sdk.auth.*;
import io.nodeum.sdk.model.*;
import io.nodeum.sdk.api.ContainersApi;

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

public class ContainersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: BearerAuth
        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //BearerAuth.setApiKeyPrefix("Token");

        ContainersApi apiInstance = new ContainersApi();
        Container containerBody = ; // Container | 
        try {
            container result = apiInstance.createContainer(containerBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContainersApi#createContainer");
            e.printStackTrace();
        }
    }
}
import io.nodeum.sdk.api.ContainersApi;

public class ContainersApiExample {

    public static void main(String[] args) {
        ContainersApi apiInstance = new ContainersApi();
        Container containerBody = ; // Container | 
        try {
            container result = apiInstance.createContainer(containerBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContainersApi#createContainer");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: BearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

Container *containerBody = ; // 

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

// Creates a new container.
[apiInstance createContainerWith:containerBody
              completionHandler: ^(container output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NodeumApi = require('nodeum_api');
var defaultClient = NodeumApi.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

// Configure API key authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new NodeumApi.ContainersApi()
var containerBody = ; // {Container} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createContainer(containerBody, callback);
using System;
using System.Diagnostics;
using Io.Nodeum.Sdk.Api;
using Io.Nodeum.Sdk.Client;
using Io.Nodeum.Sdk.Model;

namespace Example
{
    public class createContainerExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: BearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ContainersApi();
            var containerBody = new Container(); // Container | 

            try
            {
                // Creates a new container.
                container result = apiInstance.createContainer(containerBody);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContainersApi.createContainer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: BearerAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\ContainersApi();
$containerBody = ; // Container | 

try {
    $result = $api_instance->createContainer($containerBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContainersApi->createContainer: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Nodeum::SDK::Configuration;
use Nodeum::SDK::ContainersApi;

# Configure HTTP basic authorization: BasicAuth
$Nodeum::SDK::Configuration::username = 'YOUR_USERNAME';
$Nodeum::SDK::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: BearerAuth
$Nodeum::SDK::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Nodeum::SDK::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = Nodeum::SDK::ContainersApi->new();
my $containerBody = Nodeum::SDK::Object::Container->new(); # Container | 

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

# Configure HTTP basic authorization: BasicAuth
nodeum-sdk.configuration.username = 'YOUR_USERNAME'
nodeum-sdk.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: BearerAuth
nodeum-sdk.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# nodeum-sdk.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = nodeum-sdk.ContainersApi()
containerBody =  # Container | 

try: 
    # Creates a new container.
    api_response = api_instance.create_container(containerBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContainersApi->createContainer: %s\n" % e)
extern crate ContainersApi;

pub fn main() {
    let containerBody = ; // Container

    let mut context = ContainersApi::Context::default();
    let result = client.createContainer(containerBody, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Body parameters
Name Description
containerBody *

Responses


createContainerPrivilege

Creates a new privilege on the container.

**API Key Scope**: container_privileges / create


/containers/{container_id}/container_privileges

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" -H "Authorization: [[apiKey]]" "http://localhost/api/v2/containers/{container_id}/container_privileges"
import io.nodeum.sdk.*;
import io.nodeum.sdk.auth.*;
import io.nodeum.sdk.model.*;
import io.nodeum.sdk.api.ContainersApi;

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

public class ContainersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: BearerAuth
        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //BearerAuth.setApiKeyPrefix("Token");

        ContainersApi apiInstance = new ContainersApi();
        String containerId = containerId_example; // String | Numeric ID or name of container.
        ContainerPrivilege containerPrivilegeBody = ; // ContainerPrivilege | 
        try {
            container_privilege result = apiInstance.createContainerPrivilege(containerId, containerPrivilegeBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContainersApi#createContainerPrivilege");
            e.printStackTrace();
        }
    }
}
import io.nodeum.sdk.api.ContainersApi;

public class ContainersApiExample {

    public static void main(String[] args) {
        ContainersApi apiInstance = new ContainersApi();
        String containerId = containerId_example; // String | Numeric ID or name of container.
        ContainerPrivilege containerPrivilegeBody = ; // ContainerPrivilege | 
        try {
            container_privilege result = apiInstance.createContainerPrivilege(containerId, containerPrivilegeBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContainersApi#createContainerPrivilege");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: BearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *containerId = containerId_example; // Numeric ID or name of container. (default to null)
ContainerPrivilege *containerPrivilegeBody = ; // 

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

// Creates a new privilege on the container.
[apiInstance createContainerPrivilegeWith:containerId
    containerPrivilegeBody:containerPrivilegeBody
              completionHandler: ^(container_privilege output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NodeumApi = require('nodeum_api');
var defaultClient = NodeumApi.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

// Configure API key authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new NodeumApi.ContainersApi()
var containerId = containerId_example; // {String} Numeric ID or name of container.
var containerPrivilegeBody = ; // {ContainerPrivilege} 

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

namespace Example
{
    public class createContainerPrivilegeExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: BearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ContainersApi();
            var containerId = containerId_example;  // String | Numeric ID or name of container. (default to null)
            var containerPrivilegeBody = new ContainerPrivilege(); // ContainerPrivilege | 

            try
            {
                // Creates a new privilege on the container.
                container_privilege result = apiInstance.createContainerPrivilege(containerId, containerPrivilegeBody);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContainersApi.createContainerPrivilege: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: BearerAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\ContainersApi();
$containerId = containerId_example; // String | Numeric ID or name of container.
$containerPrivilegeBody = ; // ContainerPrivilege | 

try {
    $result = $api_instance->createContainerPrivilege($containerId, $containerPrivilegeBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContainersApi->createContainerPrivilege: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Nodeum::SDK::Configuration;
use Nodeum::SDK::ContainersApi;

# Configure HTTP basic authorization: BasicAuth
$Nodeum::SDK::Configuration::username = 'YOUR_USERNAME';
$Nodeum::SDK::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: BearerAuth
$Nodeum::SDK::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Nodeum::SDK::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = Nodeum::SDK::ContainersApi->new();
my $containerId = containerId_example; # String | Numeric ID or name of container.
my $containerPrivilegeBody = Nodeum::SDK::Object::ContainerPrivilege->new(); # ContainerPrivilege | 

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

# Configure HTTP basic authorization: BasicAuth
nodeum-sdk.configuration.username = 'YOUR_USERNAME'
nodeum-sdk.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: BearerAuth
nodeum-sdk.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# nodeum-sdk.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = nodeum-sdk.ContainersApi()
containerId = containerId_example # String | Numeric ID or name of container. (default to null)
containerPrivilegeBody =  # ContainerPrivilege | 

try: 
    # Creates a new privilege on the container.
    api_response = api_instance.create_container_privilege(containerId, containerPrivilegeBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContainersApi->createContainerPrivilege: %s\n" % e)
extern crate ContainersApi;

pub fn main() {
    let containerId = containerId_example; // String
    let containerPrivilegeBody = ; // ContainerPrivilege

    let mut context = ContainersApi::Context::default();
    let result = client.createContainerPrivilege(containerId, containerPrivilegeBody, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
container_id*
String
Numeric ID or name of container.
Required
Body parameters
Name Description
containerPrivilegeBody *

Responses


destroyContainer

Destroys a specific container.

**API Key Scope**: containers / destroy


/containers/{container_id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: Basic [[basicHash]]" -H "Authorization: [[apiKey]]" "http://localhost/api/v2/containers/{container_id}"
import io.nodeum.sdk.*;
import io.nodeum.sdk.auth.*;
import io.nodeum.sdk.model.*;
import io.nodeum.sdk.api.ContainersApi;

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

public class ContainersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: BearerAuth
        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //BearerAuth.setApiKeyPrefix("Token");

        ContainersApi apiInstance = new ContainersApi();
        String containerId = containerId_example; // String | Numeric ID or name of container.
        try {
            apiInstance.destroyContainer(containerId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContainersApi#destroyContainer");
            e.printStackTrace();
        }
    }
}
import io.nodeum.sdk.api.ContainersApi;

public class ContainersApiExample {

    public static void main(String[] args) {
        ContainersApi apiInstance = new ContainersApi();
        String containerId = containerId_example; // String | Numeric ID or name of container.
        try {
            apiInstance.destroyContainer(containerId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContainersApi#destroyContainer");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: BearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *containerId = containerId_example; // Numeric ID or name of container. (default to null)

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

// Destroys a specific container.
[apiInstance destroyContainerWith:containerId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NodeumApi = require('nodeum_api');
var defaultClient = NodeumApi.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

// Configure API key authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new NodeumApi.ContainersApi()
var containerId = containerId_example; // {String} Numeric ID or name of container.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.destroyContainer(containerId, callback);
using System;
using System.Diagnostics;
using Io.Nodeum.Sdk.Api;
using Io.Nodeum.Sdk.Client;
using Io.Nodeum.Sdk.Model;

namespace Example
{
    public class destroyContainerExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: BearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ContainersApi();
            var containerId = containerId_example;  // String | Numeric ID or name of container. (default to null)

            try
            {
                // Destroys a specific container.
                apiInstance.destroyContainer(containerId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContainersApi.destroyContainer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: BearerAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\ContainersApi();
$containerId = containerId_example; // String | Numeric ID or name of container.

try {
    $api_instance->destroyContainer($containerId);
} catch (Exception $e) {
    echo 'Exception when calling ContainersApi->destroyContainer: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Nodeum::SDK::Configuration;
use Nodeum::SDK::ContainersApi;

# Configure HTTP basic authorization: BasicAuth
$Nodeum::SDK::Configuration::username = 'YOUR_USERNAME';
$Nodeum::SDK::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: BearerAuth
$Nodeum::SDK::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Nodeum::SDK::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = Nodeum::SDK::ContainersApi->new();
my $containerId = containerId_example; # String | Numeric ID or name of container.

eval { 
    $api_instance->destroyContainer(containerId => $containerId);
};
if ($@) {
    warn "Exception when calling ContainersApi->destroyContainer: $@\n";
}
from __future__ import print_statement
import time
import nodeum-sdk
from nodeum-sdk.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
nodeum-sdk.configuration.username = 'YOUR_USERNAME'
nodeum-sdk.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: BearerAuth
nodeum-sdk.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# nodeum-sdk.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = nodeum-sdk.ContainersApi()
containerId = containerId_example # String | Numeric ID or name of container. (default to null)

try: 
    # Destroys a specific container.
    api_instance.destroy_container(containerId)
except ApiException as e:
    print("Exception when calling ContainersApi->destroyContainer: %s\n" % e)
extern crate ContainersApi;

pub fn main() {
    let containerId = containerId_example; // String

    let mut context = ContainersApi::Context::default();
    let result = client.destroyContainer(containerId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
container_id*
String
Numeric ID or name of container.
Required

Responses


destroyContainerPrivilege

Destroys a specific privilege.

**API Key Scope**: container_privileges / destroy


/containers/{container_id}/container_privileges/{container_privilege_id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: Basic [[basicHash]]" -H "Authorization: [[apiKey]]" "http://localhost/api/v2/containers/{container_id}/container_privileges/{container_privilege_id}"
import io.nodeum.sdk.*;
import io.nodeum.sdk.auth.*;
import io.nodeum.sdk.model.*;
import io.nodeum.sdk.api.ContainersApi;

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

public class ContainersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: BearerAuth
        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //BearerAuth.setApiKeyPrefix("Token");

        ContainersApi apiInstance = new ContainersApi();
        String containerId = containerId_example; // String | Numeric ID or name of container.
        Integer containerPrivilegeId = 56; // Integer | Numeric ID of container privilege.
        try {
            apiInstance.destroyContainerPrivilege(containerId, containerPrivilegeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContainersApi#destroyContainerPrivilege");
            e.printStackTrace();
        }
    }
}
import io.nodeum.sdk.api.ContainersApi;

public class ContainersApiExample {

    public static void main(String[] args) {
        ContainersApi apiInstance = new ContainersApi();
        String containerId = containerId_example; // String | Numeric ID or name of container.
        Integer containerPrivilegeId = 56; // Integer | Numeric ID of container privilege.
        try {
            apiInstance.destroyContainerPrivilege(containerId, containerPrivilegeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContainersApi#destroyContainerPrivilege");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: BearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *containerId = containerId_example; // Numeric ID or name of container. (default to null)
Integer *containerPrivilegeId = 56; // Numeric ID of container privilege. (default to null)

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

// Destroys a specific privilege.
[apiInstance destroyContainerPrivilegeWith:containerId
    containerPrivilegeId:containerPrivilegeId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NodeumApi = require('nodeum_api');
var defaultClient = NodeumApi.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

// Configure API key authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new NodeumApi.ContainersApi()
var containerId = containerId_example; // {String} Numeric ID or name of container.
var containerPrivilegeId = 56; // {Integer} Numeric ID of container privilege.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.destroyContainerPrivilege(containerId, containerPrivilegeId, callback);
using System;
using System.Diagnostics;
using Io.Nodeum.Sdk.Api;
using Io.Nodeum.Sdk.Client;
using Io.Nodeum.Sdk.Model;

namespace Example
{
    public class destroyContainerPrivilegeExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: BearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ContainersApi();
            var containerId = containerId_example;  // String | Numeric ID or name of container. (default to null)
            var containerPrivilegeId = 56;  // Integer | Numeric ID of container privilege. (default to null)

            try
            {
                // Destroys a specific privilege.
                apiInstance.destroyContainerPrivilege(containerId, containerPrivilegeId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContainersApi.destroyContainerPrivilege: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: BearerAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\ContainersApi();
$containerId = containerId_example; // String | Numeric ID or name of container.
$containerPrivilegeId = 56; // Integer | Numeric ID of container privilege.

try {
    $api_instance->destroyContainerPrivilege($containerId, $containerPrivilegeId);
} catch (Exception $e) {
    echo 'Exception when calling ContainersApi->destroyContainerPrivilege: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Nodeum::SDK::Configuration;
use Nodeum::SDK::ContainersApi;

# Configure HTTP basic authorization: BasicAuth
$Nodeum::SDK::Configuration::username = 'YOUR_USERNAME';
$Nodeum::SDK::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: BearerAuth
$Nodeum::SDK::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Nodeum::SDK::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = Nodeum::SDK::ContainersApi->new();
my $containerId = containerId_example; # String | Numeric ID or name of container.
my $containerPrivilegeId = 56; # Integer | Numeric ID of container privilege.

eval { 
    $api_instance->destroyContainerPrivilege(containerId => $containerId, containerPrivilegeId => $containerPrivilegeId);
};
if ($@) {
    warn "Exception when calling ContainersApi->destroyContainerPrivilege: $@\n";
}
from __future__ import print_statement
import time
import nodeum-sdk
from nodeum-sdk.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
nodeum-sdk.configuration.username = 'YOUR_USERNAME'
nodeum-sdk.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: BearerAuth
nodeum-sdk.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# nodeum-sdk.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = nodeum-sdk.ContainersApi()
containerId = containerId_example # String | Numeric ID or name of container. (default to null)
containerPrivilegeId = 56 # Integer | Numeric ID of container privilege. (default to null)

try: 
    # Destroys a specific privilege.
    api_instance.destroy_container_privilege(containerId, containerPrivilegeId)
except ApiException as e:
    print("Exception when calling ContainersApi->destroyContainerPrivilege: %s\n" % e)
extern crate ContainersApi;

pub fn main() {
    let containerId = containerId_example; // String
    let containerPrivilegeId = 56; // Integer

    let mut context = ContainersApi::Context::default();
    let result = client.destroyContainerPrivilege(containerId, containerPrivilegeId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
container_id*
String
Numeric ID or name of container.
Required
container_privilege_id*
Integer
Numeric ID of container privilege.
Required

Responses


indexContainerPrivileges

Lists all privilege on the container.

**API Key Scope**: container_privileges / index


/containers/{container_id}/container_privileges

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" -H "Authorization: [[apiKey]]" "http://localhost/api/v2/containers/{container_id}/container_privileges?limit=&offset=&sort_by=&id=&name=&privilege=&type="
import io.nodeum.sdk.*;
import io.nodeum.sdk.auth.*;
import io.nodeum.sdk.model.*;
import io.nodeum.sdk.api.ContainersApi;

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

public class ContainersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: BearerAuth
        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //BearerAuth.setApiKeyPrefix("Token");

        ContainersApi apiInstance = new ContainersApi();
        String containerId = containerId_example; // String | Numeric ID or name of container.
        Integer limit = 56; // Integer | The number of items to display for pagination.
        Integer offset = 56; // Integer | The number of items to skip for pagination.
        array[String] sortBy = ; // array[String] | Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
        String id = id_example; // String | Filter on id
        String name = name_example; // String | Filter on name
        String privilege = privilege_example; // String | Filter on privilege
        String type = type_example; // String | Filter on type
        try {
            container_privilege_collection result = apiInstance.indexContainerPrivileges(containerId, limit, offset, sortBy, id, name, privilege, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContainersApi#indexContainerPrivileges");
            e.printStackTrace();
        }
    }
}
import io.nodeum.sdk.api.ContainersApi;

public class ContainersApiExample {

    public static void main(String[] args) {
        ContainersApi apiInstance = new ContainersApi();
        String containerId = containerId_example; // String | Numeric ID or name of container.
        Integer limit = 56; // Integer | The number of items to display for pagination.
        Integer offset = 56; // Integer | The number of items to skip for pagination.
        array[String] sortBy = ; // array[String] | Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
        String id = id_example; // String | Filter on id
        String name = name_example; // String | Filter on name
        String privilege = privilege_example; // String | Filter on privilege
        String type = type_example; // String | Filter on type
        try {
            container_privilege_collection result = apiInstance.indexContainerPrivileges(containerId, limit, offset, sortBy, id, name, privilege, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContainersApi#indexContainerPrivileges");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: BearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *containerId = containerId_example; // Numeric ID or name of container. (default to null)
Integer *limit = 56; // The number of items to display for pagination. (optional) (default to null)
Integer *offset = 56; // The number of items to skip for pagination. (optional) (default to null)
array[String] *sortBy = ; // Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`. (optional) (default to null)
String *id = id_example; // Filter on id (optional) (default to null)
String *name = name_example; // Filter on name (optional) (default to null)
String *privilege = privilege_example; // Filter on privilege (optional) (default to null)
String *type = type_example; // Filter on type (optional) (default to null)

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

// Lists all privilege on the container.
[apiInstance indexContainerPrivilegesWith:containerId
    limit:limit
    offset:offset
    sortBy:sortBy
    id:id
    name:name
    privilege:privilege
    type:type
              completionHandler: ^(container_privilege_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NodeumApi = require('nodeum_api');
var defaultClient = NodeumApi.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

// Configure API key authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new NodeumApi.ContainersApi()
var containerId = containerId_example; // {String} Numeric ID or name of container.
var opts = {
  'limit': 56, // {Integer} The number of items to display for pagination.
  'offset': 56, // {Integer} The number of items to skip for pagination.
  'sortBy': , // {array[String]} Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
  'id': id_example, // {String} Filter on id
  'name': name_example, // {String} Filter on name
  'privilege': privilege_example, // {String} Filter on privilege
  'type': type_example // {String} Filter on type
};

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

namespace Example
{
    public class indexContainerPrivilegesExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: BearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ContainersApi();
            var containerId = containerId_example;  // String | Numeric ID or name of container. (default to null)
            var limit = 56;  // Integer | The number of items to display for pagination. (optional)  (default to null)
            var offset = 56;  // Integer | The number of items to skip for pagination. (optional)  (default to null)
            var sortBy = new array[String](); // array[String] | Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`. (optional)  (default to null)
            var id = id_example;  // String | Filter on id (optional)  (default to null)
            var name = name_example;  // String | Filter on name (optional)  (default to null)
            var privilege = privilege_example;  // String | Filter on privilege (optional)  (default to null)
            var type = type_example;  // String | Filter on type (optional)  (default to null)

            try
            {
                // Lists all privilege on the container.
                container_privilege_collection result = apiInstance.indexContainerPrivileges(containerId, limit, offset, sortBy, id, name, privilege, type);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContainersApi.indexContainerPrivileges: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: BearerAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\ContainersApi();
$containerId = containerId_example; // String | Numeric ID or name of container.
$limit = 56; // Integer | The number of items to display for pagination.
$offset = 56; // Integer | The number of items to skip for pagination.
$sortBy = ; // array[String] | Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
$id = id_example; // String | Filter on id
$name = name_example; // String | Filter on name
$privilege = privilege_example; // String | Filter on privilege
$type = type_example; // String | Filter on type

try {
    $result = $api_instance->indexContainerPrivileges($containerId, $limit, $offset, $sortBy, $id, $name, $privilege, $type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContainersApi->indexContainerPrivileges: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Nodeum::SDK::Configuration;
use Nodeum::SDK::ContainersApi;

# Configure HTTP basic authorization: BasicAuth
$Nodeum::SDK::Configuration::username = 'YOUR_USERNAME';
$Nodeum::SDK::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: BearerAuth
$Nodeum::SDK::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Nodeum::SDK::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = Nodeum::SDK::ContainersApi->new();
my $containerId = containerId_example; # String | Numeric ID or name of container.
my $limit = 56; # Integer | The number of items to display for pagination.
my $offset = 56; # Integer | The number of items to skip for pagination.
my $sortBy = []; # array[String] | Sort results by attribute.

Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
my $id = id_example; # String | Filter on id
my $name = name_example; # String | Filter on name
my $privilege = privilege_example; # String | Filter on privilege
my $type = type_example; # String | Filter on type

eval { 
    my $result = $api_instance->indexContainerPrivileges(containerId => $containerId, limit => $limit, offset => $offset, sortBy => $sortBy, id => $id, name => $name, privilege => $privilege, type => $type);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContainersApi->indexContainerPrivileges: $@\n";
}
from __future__ import print_statement
import time
import nodeum-sdk
from nodeum-sdk.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
nodeum-sdk.configuration.username = 'YOUR_USERNAME'
nodeum-sdk.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: BearerAuth
nodeum-sdk.configur