CoreStack - Professional Edition API and SDK Documentation

Alarms

createAlarm

Creates a new alarm.


/v1/{project_id}/alarms

Usage and SDK Samples

curl -X POST -H "X-Auth-Token: [[apiKey]]" -H "X-Auth-User: [[apiKey]]" "http://52.66.156.11:18080/v1/{project_id}/alarms"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlarmsApi;

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

public class AlarmsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: AuthToken
        ApiKeyAuth AuthToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthToken");
        AuthToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //AuthToken.setApiKeyPrefix("Token");

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

        AlarmsApi apiInstance = new AlarmsApi();
        String projectId = projectId_example; // String | Project ID
        CreateAlarm createAlarm = ; // CreateAlarm | Alarm Creation Request
        try {
            CreateAlarmResponse result = apiInstance.createAlarm(projectId, createAlarm);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlarmsApi#createAlarm");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlarmsApi;

public class AlarmsApiExample {

    public static void main(String[] args) {
        AlarmsApi apiInstance = new AlarmsApi();
        String projectId = projectId_example; // String | Project ID
        CreateAlarm createAlarm = ; // CreateAlarm | Alarm Creation Request
        try {
            CreateAlarmResponse result = apiInstance.createAlarm(projectId, createAlarm);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlarmsApi#createAlarm");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

String *projectId = projectId_example; // Project ID
CreateAlarm *createAlarm = ; // Alarm Creation Request

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

[apiInstance createAlarmWith:projectId
    createAlarm:createAlarm
              completionHandler: ^(CreateAlarmResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CorestackProfessionalEditionEndUserApiGuide = require('corestack_professional_edition_end_user_api_guide');
var defaultClient = CorestackProfessionalEditionEndUserApiGuide.ApiClient.instance;

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

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

var api = new CorestackProfessionalEditionEndUserApiGuide.AlarmsApi()

var projectId = projectId_example; // {String} Project ID

var createAlarm = ; // {CreateAlarm} Alarm Creation Request


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

namespace Example
{
    public class createAlarmExample
    {
        public void main()
        {
            
            // Configure API key authorization: AuthToken
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");
            // Configure API key authorization: Username
            Configuration.Default.ApiKey.Add("X-Auth-User", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-User", "Bearer");

            var apiInstance = new AlarmsApi();
            var projectId = projectId_example;  // String | Project ID
            var createAlarm = new CreateAlarm(); // CreateAlarm | Alarm Creation Request

            try
            {
                CreateAlarmResponse result = apiInstance.createAlarm(projectId, createAlarm);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlarmsApi.createAlarm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: AuthToken
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure API key authorization: Username
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-User', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-User', 'Bearer');

$api_instance = new Swagger\Client\Api\AlarmsApi();
$projectId = projectId_example; // String | Project ID
$createAlarm = ; // CreateAlarm | Alarm Creation Request

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

# Configure API key authorization: AuthToken
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";
# Configure API key authorization: Username
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-User'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-User'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AlarmsApi->new();
my $projectId = projectId_example; # String | Project ID
my $createAlarm = WWW::SwaggerClient::Object::CreateAlarm->new(); # CreateAlarm | Alarm Creation Request

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

# Configure API key authorization: AuthToken
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'
# Configure API key authorization: Username
swagger_client.configuration.api_key['X-Auth-User'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-User'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AlarmsApi()
projectId = projectId_example # String | Project ID
createAlarm =  # CreateAlarm | Alarm Creation Request

try: 
    api_response = api_instance.create_alarm(projectId, createAlarm)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlarmsApi->createAlarm: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Project ID
Required
Body parameters
Name Description
createAlarm *

Responses

Status: 200 - successful operation


deleteAlarm

Delete a specific Alarm from given project/tenant


/v1/{project_id}/alarms/{alarm_id}

Usage and SDK Samples

curl -X DELETE -H "X-Auth-Token: [[apiKey]]" -H "X-Auth-User: [[apiKey]]" "http://52.66.156.11:18080/v1/{project_id}/alarms/{alarm_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlarmsApi;

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

public class AlarmsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: AuthToken
        ApiKeyAuth AuthToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthToken");
        AuthToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //AuthToken.setApiKeyPrefix("Token");

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

        AlarmsApi apiInstance = new AlarmsApi();
        String projectId = projectId_example; // String | Project ID
        String alarmId = alarmId_example; // String | Alarm ID
        try {
            DeleteAlarmResponse result = apiInstance.deleteAlarm(projectId, alarmId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlarmsApi#deleteAlarm");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlarmsApi;

public class AlarmsApiExample {

    public static void main(String[] args) {
        AlarmsApi apiInstance = new AlarmsApi();
        String projectId = projectId_example; // String | Project ID
        String alarmId = alarmId_example; // String | Alarm ID
        try {
            DeleteAlarmResponse result = apiInstance.deleteAlarm(projectId, alarmId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlarmsApi#deleteAlarm");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

String *projectId = projectId_example; // Project ID
String *alarmId = alarmId_example; // Alarm ID

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

[apiInstance deleteAlarmWith:projectId
    alarmId:alarmId
              completionHandler: ^(DeleteAlarmResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CorestackProfessionalEditionEndUserApiGuide = require('corestack_professional_edition_end_user_api_guide');
var defaultClient = CorestackProfessionalEditionEndUserApiGuide.ApiClient.instance;

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

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

var api = new CorestackProfessionalEditionEndUserApiGuide.AlarmsApi()

var projectId = projectId_example; // {String} Project ID

var alarmId = alarmId_example; // {String} Alarm ID


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

namespace Example
{
    public class deleteAlarmExample
    {
        public void main()
        {
            
            // Configure API key authorization: AuthToken
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");
            // Configure API key authorization: Username
            Configuration.Default.ApiKey.Add("X-Auth-User", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-User", "Bearer");

            var apiInstance = new AlarmsApi();
            var projectId = projectId_example;  // String | Project ID
            var alarmId = alarmId_example;  // String | Alarm ID

            try
            {
                DeleteAlarmResponse result = apiInstance.deleteAlarm(projectId, alarmId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlarmsApi.deleteAlarm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: AuthToken
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure API key authorization: Username
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-User', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-User', 'Bearer');

$api_instance = new Swagger\Client\Api\AlarmsApi();
$projectId = projectId_example; // String | Project ID
$alarmId = alarmId_example; // String | Alarm ID

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

# Configure API key authorization: AuthToken
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";
# Configure API key authorization: Username
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-User'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-User'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AlarmsApi->new();
my $projectId = projectId_example; # String | Project ID
my $alarmId = alarmId_example; # String | Alarm ID

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

# Configure API key authorization: AuthToken
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'
# Configure API key authorization: Username
swagger_client.configuration.api_key['X-Auth-User'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-User'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AlarmsApi()
projectId = projectId_example # String | Project ID
alarmId = alarmId_example # String | Alarm ID

try: 
    api_response = api_instance.delete_alarm(projectId, alarmId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlarmsApi->deleteAlarm: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Project ID
Required
alarm_id*
String
Alarm ID
Required

Responses

Status: 200 - successful operation


describeAlarm

Get detailed information about an alarm using alarm id.


/v1/{project_id}/alarms/{alarm_id}

Usage and SDK Samples

curl -X GET -H "X-Auth-Token: [[apiKey]]" -H "X-Auth-User: [[apiKey]]" "http://52.66.156.11:18080/v1/{project_id}/alarms/{alarm_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlarmsApi;

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

public class AlarmsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: AuthToken
        ApiKeyAuth AuthToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthToken");
        AuthToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //AuthToken.setApiKeyPrefix("Token");

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

        AlarmsApi apiInstance = new AlarmsApi();
        String projectId = projectId_example; // String | Project ID
        String alarmId = alarmId_example; // String | Alarm ID
        try {
            AlarmView result = apiInstance.describeAlarm(projectId, alarmId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlarmsApi#describeAlarm");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlarmsApi;

public class AlarmsApiExample {

    public static void main(String[] args) {
        AlarmsApi apiInstance = new AlarmsApi();
        String projectId = projectId_example; // String | Project ID
        String alarmId = alarmId_example; // String | Alarm ID
        try {
            AlarmView result = apiInstance.describeAlarm(projectId, alarmId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlarmsApi#describeAlarm");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

String *projectId = projectId_example; // Project ID
String *alarmId = alarmId_example; // Alarm ID

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

[apiInstance describeAlarmWith:projectId
    alarmId:alarmId
              completionHandler: ^(AlarmView output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CorestackProfessionalEditionEndUserApiGuide = require('corestack_professional_edition_end_user_api_guide');
var defaultClient = CorestackProfessionalEditionEndUserApiGuide.ApiClient.instance;

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

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

var api = new CorestackProfessionalEditionEndUserApiGuide.AlarmsApi()

var projectId = projectId_example; // {String} Project ID

var alarmId = alarmId_example; // {String} Alarm ID


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

namespace Example
{
    public class describeAlarmExample
    {
        public void main()
        {
            
            // Configure API key authorization: AuthToken
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");
            // Configure API key authorization: Username
            Configuration.Default.ApiKey.Add("X-Auth-User", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-User", "Bearer");

            var apiInstance = new AlarmsApi();
            var projectId = projectId_example;  // String | Project ID
            var alarmId = alarmId_example;  // String | Alarm ID

            try
            {
                AlarmView result = apiInstance.describeAlarm(projectId, alarmId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlarmsApi.describeAlarm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: AuthToken
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure API key authorization: Username
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-User', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-User', 'Bearer');

$api_instance = new Swagger\Client\Api\AlarmsApi();
$projectId = projectId_example; // String | Project ID
$alarmId = alarmId_example; // String | Alarm ID

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

# Configure API key authorization: AuthToken
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";
# Configure API key authorization: Username
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-User'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-User'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AlarmsApi->new();
my $projectId = projectId_example; # String | Project ID
my $alarmId = alarmId_example; # String | Alarm ID

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

# Configure API key authorization: AuthToken
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'
# Configure API key authorization: Username
swagger_client.configuration.api_key['X-Auth-User'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-User'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AlarmsApi()
projectId = projectId_example # String | Project ID
alarmId = alarmId_example # String | Alarm ID

try: 
    api_response = api_instance.describe_alarm(projectId, alarmId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlarmsApi->describeAlarm: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Project ID
Required
alarm_id*
String
Alarm ID
Required

Responses

Status: 200 - successful operation

{status=success, message=Alarm View, data={id=56bc6977d1c50641ad553e63, name=test_alarm_template_service, type=alert, status=active, rule={}, alarm_action_type=template, host_metadata={}, project_name=Demo_Tenant, created_by=admin, created_at=2016-02-11 10:59:03.576000, updated_by=admin, updated_at=2016-03-10 13:07:44.684000, resource=[{template_details=[{id=56af39d8d1c5066c4335218f, name=Start_Instance_Openstack}]}], service_details=[{service_type=Cloud, service_name=Openstack, id=56af38e6d1c5066c43352173, service_account_name=openstack_223}], resource_details=[], arguments={Instance_ID=19bb26fc-1fc4-4b8b-83f3-e6c5ec865fb0}}}

listAlarms

Alarm function is offered as a separate service within CoreStack™. You can create their own alarms based on certain conditions. When such alarm condition is met, a specific action can be triggered. The triggered action can be the execution of a Template or Script.

Lists all the alarms defined for the project.


/v1/{project_id}/alarms

Usage and SDK Samples

curl -X GET -H "X-Auth-Token: [[apiKey]]" -H "X-Auth-User: [[apiKey]]" "http://52.66.156.11:18080/v1/{project_id}/alarms"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlarmsApi;

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

public class AlarmsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: AuthToken
        ApiKeyAuth AuthToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthToken");
        AuthToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //AuthToken.setApiKeyPrefix("Token");

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

        AlarmsApi apiInstance = new AlarmsApi();
        String projectId = projectId_example; // String | Project ID
        try {
            AlarmsList result = apiInstance.listAlarms(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlarmsApi#listAlarms");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlarmsApi;

public class AlarmsApiExample {

    public static void main(String[] args) {
        AlarmsApi apiInstance = new AlarmsApi();
        String projectId = projectId_example; // String | Project ID
        try {
            AlarmsList result = apiInstance.listAlarms(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlarmsApi#listAlarms");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

String *projectId = projectId_example; // Project ID

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

// Alarm function is offered as a separate service within CoreStack™. You can create their own alarms based on certain conditions. When such alarm condition is met, a specific action can be triggered. The triggered action can be the execution of a Template or Script.
[apiInstance listAlarmsWith:projectId
              completionHandler: ^(AlarmsList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CorestackProfessionalEditionEndUserApiGuide = require('corestack_professional_edition_end_user_api_guide');
var defaultClient = CorestackProfessionalEditionEndUserApiGuide.ApiClient.instance;

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

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

var api = new CorestackProfessionalEditionEndUserApiGuide.AlarmsApi()

var projectId = projectId_example; // {String} Project ID


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

namespace Example
{
    public class listAlarmsExample
    {
        public void main()
        {
            
            // Configure API key authorization: AuthToken
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");
            // Configure API key authorization: Username
            Configuration.Default.ApiKey.Add("X-Auth-User", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-User", "Bearer");

            var apiInstance = new AlarmsApi();
            var projectId = projectId_example;  // String | Project ID

            try
            {
                // Alarm function is offered as a separate service within CoreStack™. You can create their own alarms based on certain conditions. When such alarm condition is met, a specific action can be triggered. The triggered action can be the execution of a Template or Script.
                AlarmsList result = apiInstance.listAlarms(projectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlarmsApi.listAlarms: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: AuthToken
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure API key authorization: Username
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-User', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-User', 'Bearer');

$api_instance = new Swagger\Client\Api\AlarmsApi();
$projectId = projectId_example; // String | Project ID

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

# Configure API key authorization: AuthToken
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";
# Configure API key authorization: Username
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-User'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-User'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AlarmsApi->new();
my $projectId = projectId_example; # String | Project ID

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

# Configure API key authorization: AuthToken
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'
# Configure API key authorization: Username
swagger_client.configuration.api_key['X-Auth-User'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-User'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AlarmsApi()
projectId = projectId_example # String | Project ID

try: 
    # Alarm function is offered as a separate service within CoreStack™. You can create their own alarms based on certain conditions. When such alarm condition is met, a specific action can be triggered. The triggered action can be the execution of a Template or Script.
    api_response = api_instance.list_alarms(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlarmsApi->listAlarms: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Project ID
Required

Responses

Status: 200 - successful operation

{status=success, message=Alarm list, data={alarms=[{id=56bc6977d1c50641ad553e63, name=test_alarm_template_service, type=alert, status=active, alarm_action={resource=[{resource_details=[{id=56af39d8d1c5066c4335218f, name=Start_Instance_Openstack}]}], action_inputs={service_accounts=[{service_type=Cloud, service_name=Openstack, id=56af38e6d1c5066c43352173, core_tenant_id=null, tenant_id=98073903698740af87fb57ca9e41eed5}], resource_elements=[], args={Instance_ID=19bb26fc-1fc4-4b8b-83f3-e6c5ec865fb0}}, type=template}, project_name=Demo_Tenant, created_by=admin, created_at=2016-02-11 10:59:03.576000, updated_by=admin, updated_at=2016-03-10 13:07:44.684000}, {id=56bc808cd1c5064c704a873a, name=test_alarm_script1, type=alert, status=active, alarm_action={resource=[{host=192.168.1.8, resource_details=[{id=56b2f4efd1c50630cc97ebd4, name=Chef_AACC}]}, {host=192.168.1.8, resource_details=[{id=56b2f4efd1c50630cc97ebd4, name=Chef_AACC}]}], action_inputs={service_accounts=[], job_name=test, job_details=[{username=administrator, parameters={chef={}, shell={}, puppet={}}, script_name=[Chef_AACC], port=22, platform=linux, host=192.168.1.8, keypair_flag=false, password=password, key_file=}, {username=administrator, parameters={chef={}, shell={}, puppet={}}, script_name=[Chef_AACC], port=22, platform=linux, host=192.168.1.8, keypair_flag=false, password=cloud@123, key_file=}]}, type=script}, project_name=Demo_Tenant, created_by=admin, created_at=2016-02-11 12:37:32.105000, updated_by=admin, updated_at=2016-02-11 12:59:41.402000}]}}

updateAlarm

Update the details of the alarm


/v1/{project_id}/alarms/{alarm_id}

Usage and SDK Samples

curl -X PUT -H "X-Auth-Token: [[apiKey]]" -H "X-Auth-User: [[apiKey]]" "http://52.66.156.11:18080/v1/{project_id}/alarms/{alarm_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlarmsApi;

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

public class AlarmsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: AuthToken
        ApiKeyAuth AuthToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthToken");
        AuthToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //AuthToken.setApiKeyPrefix("Token");

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

        AlarmsApi apiInstance = new AlarmsApi();
        String projectId = projectId_example; // String | Project ID
        String alarmId = alarmId_example; // String | Alarm ID
        UpdateAlarm updateAlarm = ; // UpdateAlarm | Alarm Updation Request
        try {
            UpdateAlarmResponse result = apiInstance.updateAlarm(projectId, alarmId, updateAlarm);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlarmsApi#updateAlarm");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlarmsApi;

public class AlarmsApiExample {

    public static void main(String[] args) {
        AlarmsApi apiInstance = new AlarmsApi();
        String projectId = projectId_example; // String | Project ID
        String alarmId = alarmId_example; // String | Alarm ID
        UpdateAlarm updateAlarm = ; // UpdateAlarm | Alarm Updation Request
        try {
            UpdateAlarmResponse result = apiInstance.updateAlarm(projectId, alarmId, updateAlarm);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlarmsApi#updateAlarm");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

String *projectId = projectId_example; // Project ID
String *alarmId = alarmId_example; // Alarm ID
UpdateAlarm *updateAlarm = ; // Alarm Updation Request (optional)

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

[apiInstance updateAlarmWith:projectId
    alarmId:alarmId
    updateAlarm:updateAlarm
              completionHandler: ^(UpdateAlarmResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CorestackProfessionalEditionEndUserApiGuide = require('corestack_professional_edition_end_user_api_guide');
var defaultClient = CorestackProfessionalEditionEndUserApiGuide.ApiClient.instance;

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

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

var api = new CorestackProfessionalEditionEndUserApiGuide.AlarmsApi()

var projectId = projectId_example; // {String} Project ID

var alarmId = alarmId_example; // {String} Alarm ID

var opts = { 
  'updateAlarm':  // {UpdateAlarm} Alarm Updation Request
};

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

namespace Example
{
    public class updateAlarmExample
    {
        public void main()
        {
            
            // Configure API key authorization: AuthToken
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");
            // Configure API key authorization: Username
            Configuration.Default.ApiKey.Add("X-Auth-User", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-User", "Bearer");

            var apiInstance = new AlarmsApi();
            var projectId = projectId_example;  // String | Project ID
            var alarmId = alarmId_example;  // String | Alarm ID
            var updateAlarm = new UpdateAlarm(); // UpdateAlarm | Alarm Updation Request (optional) 

            try
            {
                UpdateAlarmResponse result = apiInstance.updateAlarm(projectId, alarmId, updateAlarm);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlarmsApi.updateAlarm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: AuthToken
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure API key authorization: Username
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-User', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-User', 'Bearer');

$api_instance = new Swagger\Client\Api\AlarmsApi();
$projectId = projectId_example; // String | Project ID
$alarmId = alarmId_example; // String | Alarm ID
$updateAlarm = ; // UpdateAlarm | Alarm Updation Request

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

# Configure API key authorization: AuthToken
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";
# Configure API key authorization: Username
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-User'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-User'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AlarmsApi->new();
my $projectId = projectId_example; # String | Project ID
my $alarmId = alarmId_example; # String | Alarm ID
my $updateAlarm = WWW::SwaggerClient::Object::UpdateAlarm->new(); # UpdateAlarm | Alarm Updation Request

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

# Configure API key authorization: AuthToken
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'
# Configure API key authorization: Username
swagger_client.configuration.api_key['X-Auth-User'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-User'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AlarmsApi()
projectId = projectId_example # String | Project ID
alarmId = alarmId_example # String | Alarm ID
updateAlarm =  # UpdateAlarm | Alarm Updation Request (optional)

try: 
    api_response = api_instance.update_alarm(projectId, alarmId, updateAlarm=updateAlarm)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlarmsApi->updateAlarm: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Project ID
Required
alarm_id*
String
Alarm ID
Required
Body parameters
Name Description
updateAlarm

Responses

Status: 200 - successful operation


Applications

createApplication

Create an Application for a given project/tenant


/v1/{project_id}/applications

Usage and SDK Samples

curl -X POST -H "X-Auth-Token: [[apiKey]]" -H "X-Auth-User: [[apiKey]]" "http://52.66.156.11:18080/v1/{project_id}/applications"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: AuthToken
        ApiKeyAuth AuthToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthToken");
        AuthToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //AuthToken.setApiKeyPrefix("Token");

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

        ApplicationsApi apiInstance = new ApplicationsApi();
        String projectId = projectId_example; // String | Project ID
        CreateApplication createApplication = ; // CreateApplication | Application Creation Request
        try {
            CreateApplicationResponse result = apiInstance.createApplication(projectId, createApplication);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#createApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        String projectId = projectId_example; // String | Project ID
        CreateApplication createApplication = ; // CreateApplication | Application Creation Request
        try {
            CreateApplicationResponse result = apiInstance.createApplication(projectId, createApplication);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#createApplication");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

String *projectId = projectId_example; // Project ID
CreateApplication *createApplication = ; // Application Creation Request

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

[apiInstance createApplicationWith:projectId
    createApplication:createApplication
              completionHandler: ^(CreateApplicationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CorestackProfessionalEditionEndUserApiGuide = require('corestack_professional_edition_end_user_api_guide');
var defaultClient = CorestackProfessionalEditionEndUserApiGuide.ApiClient.instance;

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

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

var api = new CorestackProfessionalEditionEndUserApiGuide.ApplicationsApi()

var projectId = projectId_example; // {String} Project ID

var createApplication = ; // {CreateApplication} Application Creation Request


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

namespace Example
{
    public class createApplicationExample
    {
        public void main()
        {
            
            // Configure API key authorization: AuthToken
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");
            // Configure API key authorization: Username
            Configuration.Default.ApiKey.Add("X-Auth-User", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-User", "Bearer");

            var apiInstance = new ApplicationsApi();
            var projectId = projectId_example;  // String | Project ID
            var createApplication = new CreateApplication(); // CreateApplication | Application Creation Request

            try
            {
                CreateApplicationResponse result = apiInstance.createApplication(projectId, createApplication);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.createApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: AuthToken
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure API key authorization: Username
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-User', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-User', 'Bearer');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$projectId = projectId_example; // String | Project ID
$createApplication = ; // CreateApplication | Application Creation Request

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

# Configure API key authorization: AuthToken
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";
# Configure API key authorization: Username
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-User'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-User'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $projectId = projectId_example; # String | Project ID
my $createApplication = WWW::SwaggerClient::Object::CreateApplication->new(); # CreateApplication | Application Creation Request

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

# Configure API key authorization: AuthToken
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'
# Configure API key authorization: Username
swagger_client.configuration.api_key['X-Auth-User'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-User'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
projectId = projectId_example # String | Project ID
createApplication =  # CreateApplication | Application Creation Request

try: 
    api_response = api_instance.create_application(projectId, createApplication)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApplicationsApi->createApplication: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Project ID
Required
Body parameters
Name Description
createApplication *

Responses

Status: 200 - successful operation


deleteApplication

Delete a specific application from given project/tenant.


/v1/{project_id}/applications/{application_id}

Usage and SDK Samples

curl -X DELETE -H "X-Auth-Token: [[apiKey]]" -H "X-Auth-User: [[apiKey]]" "http://52.66.156.11:18080/v1/{project_id}/applications/{application_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: AuthToken
        ApiKeyAuth AuthToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthToken");
        AuthToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //AuthToken.setApiKeyPrefix("Token");

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

        ApplicationsApi apiInstance = new ApplicationsApi();
        String projectId = projectId_example; // String | Project ID
        String applicationId = applicationId_example; // String | Application ID
        try {
            DeleteApplicationResponse result = apiInstance.deleteApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#deleteApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        String projectId = projectId_example; // String | Project ID
        String applicationId = applicationId_example; // String | Application ID
        try {
            DeleteApplicationResponse result = apiInstance.deleteApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#deleteApplication");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

String *projectId = projectId_example; // Project ID
String *applicationId = applicationId_example; // Application ID

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

[apiInstance deleteApplicationWith:projectId
    applicationId:applicationId
              completionHandler: ^(DeleteApplicationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CorestackProfessionalEditionEndUserApiGuide = require('corestack_professional_edition_end_user_api_guide');
var defaultClient = CorestackProfessionalEditionEndUserApiGuide.ApiClient.instance;

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

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

var api = new CorestackProfessionalEditionEndUserApiGuide.ApplicationsApi()

var projectId = projectId_example; // {String} Project ID

var applicationId = applicationId_example; // {String} Application ID


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

namespace Example
{
    public class deleteApplicationExample
    {
        public void main()
        {
            
            // Configure API key authorization: AuthToken
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");
            // Configure API key authorization: Username
            Configuration.Default.ApiKey.Add("X-Auth-User", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-User", "Bearer");

            var apiInstance = new ApplicationsApi();
            var projectId = projectId_example;  // String | Project ID
            var applicationId = applicationId_example;  // String | Application ID

            try
            {
                DeleteApplicationResponse result = apiInstance.deleteApplication(projectId, applicationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.deleteApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: AuthToken
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure API key authorization: Username
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-User', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-User', 'Bearer');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$projectId = projectId_example; // String | Project ID
$applicationId = applicationId_example; // String | Application ID

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

# Configure API key authorization: AuthToken
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";
# Configure API key authorization: Username
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-User'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-User'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $projectId = projectId_example; # String | Project ID
my $applicationId = applicationId_example; # String | Application ID

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

# Configure API key authorization: AuthToken
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'
# Configure API key authorization: Username
swagger_client.configuration.api_key['X-Auth-User'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-User'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
projectId = projectId_example # String | Project ID
applicationId = applicationId_example # String | Application ID

try: 
    api_response = api_instance.delete_application(projectId, applicationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApplicationsApi->deleteApplication: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Project ID
Required
application_id*
String
Application ID
Required

Responses

Status: 200 - successful operation


describeApplication

Get details of a specific application for a given project/tenant


/v1/{project_id}/applications/{application_id}

Usage and SDK Samples

curl -X GET -H "X-Auth-Token: [[apiKey]]" -H "X-Auth-User: [[apiKey]]" "http://52.66.156.11:18080/v1/{project_id}/applications/{application_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: AuthToken
        ApiKeyAuth AuthToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthToken");
        AuthToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //AuthToken.setApiKeyPrefix("Token");

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

        ApplicationsApi apiInstance = new ApplicationsApi();
        String projectId = projectId_example; // String | Project ID
        String applicationId = applicationId_example; // String | Application ID
        try {
            ApplicationView result = apiInstance.describeApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#describeApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        String projectId = projectId_example; // String | Project ID
        String applicationId = applicationId_example; // String | Application ID
        try {
            ApplicationView result = apiInstance.describeApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#describeApplication");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

String *projectId = projectId_example; // Project ID
String *applicationId = applicationId_example; // Application ID

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

[apiInstance describeApplicationWith:projectId
    applicationId:applicationId
              completionHandler: ^(ApplicationView output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CorestackProfessionalEditionEndUserApiGuide = require('corestack_professional_edition_end_user_api_guide');
var defaultClient = CorestackProfessionalEditionEndUserApiGuide.ApiClient.instance;

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

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

var api = new CorestackProfessionalEditionEndUserApiGuide.ApplicationsApi()

var projectId = projectId_example; // {String} Project ID

var applicationId = applicationId_example; // {String} Application ID


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

namespace Example
{
    public class describeApplicationExample
    {
        public void main()
        {
            
            // Configure API key authorization: AuthToken
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");
            // Configure API key authorization: Username
            Configuration.Default.ApiKey.Add("X-Auth-User", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-User", "Bearer");

            var apiInstance = new ApplicationsApi();
            var projectId = projectId_example;  // String | Project ID
            var applicationId = applicationId_example;  // String | Application ID

            try
            {
                ApplicationView result = apiInstance.describeApplication(projectId, applicationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.describeApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: AuthToken
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure API key authorization: Username
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-User', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-User', 'Bearer');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$projectId = projectId_example; // String | Project ID
$applicationId = applicationId_example; // String | Application ID

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

# Configure API key authorization: AuthToken
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";
# Configure API key authorization: Username
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-User'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-User'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $projectId = projectId_example; # String | Project ID
my $applicationId = applicationId_example; # String | Application ID

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

# Configure API key authorization: AuthToken
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'
# Configure API key authorization: Username
swagger_client.configuration.api_key['X-Auth-User'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-User'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
projectId = projectId_example # String | Project ID
applicationId = applicationId_example # String | Application ID

try: 
    api_response = api_instance.describe_application(projectId, applicationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApplicationsApi->describeApplication: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Project ID
Required
application_id*
String
Application ID
Required

Responses

Status: 200 - successful operation

{status=success, message=Application displayed, data={id=56c19d8407e312097fbc5d41, name=DBServers, user_defined=false, description=Ubuntu14.04, operating_system=, metadata={}, created_by=admin, created_at=2016-02-15 09:42:28.466000, updated_by=admin, updated_at=2016-02-15 09:42:28.466000}}

listApplications

Deletes the inventory from the given project.


/v1/{project_id}/applications

Usage and SDK Samples

curl -X GET -H "X-Auth-Token: [[apiKey]]" -H "X-Auth-User: [[apiKey]]" "http://52.66.156.11:18080/v1/{project_id}/applications"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: AuthToken
        ApiKeyAuth AuthToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthToken");
        AuthToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //AuthToken.setApiKeyPrefix("Token");

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

        ApplicationsApi apiInstance = new ApplicationsApi();
        String projectId = projectId_example; // String | Project ID
        try {
            ApplicationsList result = apiInstance.listApplications(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#listApplications");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        String projectId = projectId_example; // String | Project ID
        try {
            ApplicationsList result = apiInstance.listApplications(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#listApplications");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

String *projectId = projectId_example; // Project ID

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

[apiInstance listApplicationsWith:projectId
              completionHandler: ^(ApplicationsList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CorestackProfessionalEditionEndUserApiGuide = require('corestack_professional_edition_end_user_api_guide');
var defaultClient = CorestackProfessionalEditionEndUserApiGuide.ApiClient.instance;

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

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

var api = new CorestackProfessionalEditionEndUserApiGuide.ApplicationsApi()

var projectId = projectId_example; // {String} Project ID


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

namespace Example
{
    public class listApplicationsExample
    {
        public void main()
        {
            
            // Configure API key authorization: AuthToken
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");
            // Configure API key authorization: Username
            Configuration.Default.ApiKey.Add("X-Auth-User", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-User", "Bearer");

            var apiInstance = new ApplicationsApi();
            var projectId = projectId_example;  // String | Project ID

            try
            {
                ApplicationsList result = apiInstance.listApplications(projectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.listApplications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: AuthToken
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure API key authorization: Username
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-User', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-User', 'Bearer');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$projectId = projectId_example; // String | Project ID

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

# Configure API key authorization: AuthToken
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";
# Configure API key authorization: Username
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-User'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-User'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $projectId = projectId_example; # String | Project ID

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

# Configure API key authorization: AuthToken
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'
# Configure API key authorization: Username
swagger_client.configuration.api_key['X-Auth-User'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-User'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
projectId = projectId_example # String | Project ID

try: 
    api_response = api_instance.list_applications(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApplicationsApi->listApplications: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Project ID
Required

Responses

Status: 200 - successful operation

{status=success, message=Application list, data=[{id=56c19d8407e312097fbc5d41, name=DBServers, user_defined=false, description=Ubuntu14.04, operating_system=, metadata={}, created_by=admin, created_at=2016-02-15 09:42:28.466000, updated_by=admin, updated_at=2016-02-15 09:42:28.466000}, {id=56c19da207e312097fbc5d42, name=AppServers, user_defined=false, description=Ubuntu14.04, operating_system=, metadata={}, created_by=admin, created_at=2016-02-15 09:42:58.966000, updated_by=admin, updated_at=2016-02-15 09:42:58.966000}]}

updateApplication

Update an Application for a given project/tenant.


/v1/{project_id}/applications/{application_id}

Usage and SDK Samples

curl -X PUT -H "X-Auth-Token: [[apiKey]]" -H "X-Auth-User: [[apiKey]]" "http://52.66.156.11:18080/v1/{project_id}/applications/{application_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: AuthToken
        ApiKeyAuth AuthToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthToken");
        AuthToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //AuthToken.setApiKeyPrefix("Token");

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

        ApplicationsApi apiInstance = new ApplicationsApi();
        String projectId = projectId_example; // String | Project ID
        String applicationId = applicationId_example; // String | Application ID
        UpdateApplication updateApplication = ; // UpdateApplication | Application Updation Request
        try {
            UpdateApplicationResponse result = apiInstance.updateApplication(projectId, applicationId, updateApplication);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#updateApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        String projectId = projectId_example; // String | Project ID
        String applicationId = applicationId_example; // String | Application ID
        UpdateApplication updateApplication = ; // UpdateApplication | Application Updation Request
        try {
            UpdateApplicationResponse result = apiInstance.updateApplication(projectId, applicationId, updateApplication);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#updateApplication");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

String *projectId = projectId_example; // Project ID
String *applicationId = applicationId_example; // Application ID
UpdateApplication *updateApplication = ; // Application Updation Request (optional)

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

[apiInstance updateApplicationWith:projectId
    applicationId:applicationId
    updateApplication:updateApplication
              completionHandler: ^(UpdateApplicationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CorestackProfessionalEditionEndUserApiGuide = require('corestack_professional_edition_end_user_api_guide');
var defaultClient = CorestackProfessionalEditionEndUserApiGuide.ApiClient.instance;

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

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

var api = new CorestackProfessionalEditionEndUserApiGuide.ApplicationsApi()

var projectId = projectId_example; // {String} Project ID

var applicationId = applicationId_example; // {String} Application ID

var opts = { 
  'updateApplication':  // {UpdateApplication} Application Updation Request
};

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

namespace Example
{
    public class updateApplicationExample
    {
        public void main()
        {
            
            // Configure API key authorization: AuthToken
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");
            // Configure API key authorization: Username
            Configuration.Default.ApiKey.Add("X-Auth-User", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-User", "Bearer");

            var apiInstance = new ApplicationsApi();
            var projectId = projectId_example;  // String | Project ID
            var applicationId = applicationId_example;  // String | Application ID
            var updateApplication = new UpdateApplication(); // UpdateApplication | Application Updation Request (optional) 

            try
            {
                UpdateApplicationResponse result = apiInstance.updateApplication(projectId, applicationId, updateApplication);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.updateApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: AuthToken
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure API key authorization: Username
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-User', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-User', 'Bearer');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$projectId = projectId_example; // String | Project ID
$applicationId = applicationId_example; // String | Application ID
$updateApplication = ; // UpdateApplication | Application Updation Request

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

# Configure API key authorization: AuthToken
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";
# Configure API key authorization: Username
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-User'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-User'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $projectId = projectId_example; # String | Project ID
my $applicationId = applicationId_example; # String | Application ID
my $updateApplication = WWW::SwaggerClient::Object::UpdateApplication->new(); # UpdateApplication | Application Updation Request

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

# Configure API key authorization: AuthToken
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'
# Configure API key authorization: Username
swagger_client.configuration.api_key['X-Auth-User'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-User'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
projectId = projectId_example # String | Project ID
applicationId = applicationId_example # String | Application ID
updateApplication =  # UpdateApplication | Application Updation Request (optional)

try: 
    api_response = api_instance.update_application(projectId, applicationId, updateApplication=updateApplication)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApplicationsApi->updateApplication: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Project ID
Required
application_id*
String
Application ID
Required
Body parameters
Name Description
updateApplication

Responses

Status: 200 - successful operation


Authentication

authentication

The auth-token provided as part of the response is to be used for all subsequent API calls. Extract this auth-token and also the project id from the response. This will be required for subsequent calls. All requests are expected to have the below headers, though the header values would be different. X-Auth-Token and X-Auth-User are the header info used for authentication and authorization purposes within CORESTACK. Also, save the project master id and project id. These will be required in most API calls to set the context.

This API controls the authentication for users accessing the CoreStack platform. This is the first API to be called when initiating the session.


/v1/auth/tokens

Usage and SDK Samples

curl -X POST "http://52.66.156.11:18080/v1/auth/tokens"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthenticationApi;

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

public class AuthenticationApiExample {

    public static void main(String[] args) {
        
        AuthenticationApi apiInstance = new AuthenticationApi();
        LoginRequest loginRequest = ; // LoginRequest | Login Request
        try {
            LoginResponse result = apiInstance.authentication(loginRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#authentication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthenticationApi;

public class AuthenticationApiExample {

    public static void main(String[] args) {
        AuthenticationApi apiInstance = new AuthenticationApi();
        LoginRequest loginRequest = ; // LoginRequest | Login Request
        try {
            LoginResponse result = apiInstance.authentication(loginRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#authentication");
            e.printStackTrace();
        }
    }
}
LoginRequest *loginRequest = ; // Login Request (optional)

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

// The auth-token provided as part of the response is to be used for all subsequent API calls. Extract this auth-token and also the project id from the response. This will be required for subsequent calls. All requests are expected to have the below headers, though the header values would be different. X-Auth-Token and X-Auth-User are the header info used for authentication and authorization purposes within CORESTACK. Also, save the project master id and project id. These will be required in most API calls to set the context.
[apiInstance authenticationWith:loginRequest
              completionHandler: ^(LoginResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CorestackProfessionalEditionEndUserApiGuide = require('corestack_professional_edition_end_user_api_guide');

var api = new CorestackProfessionalEditionEndUserApiGuide.AuthenticationApi()

var opts = { 
  'loginRequest':  // {LoginRequest} Login Request
};

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

namespace Example
{
    public class authenticationExample
    {
        public void main()
        {
            
            var apiInstance = new AuthenticationApi();
            var loginRequest = new LoginRequest(); // LoginRequest | Login Request (optional) 

            try
            {
                // The auth-token provided as part of the response is to be used for all subsequent API calls. Extract this auth-token and also the project id from the response. This will be required for subsequent calls. All requests are expected to have the below headers, though the header values would be different. X-Auth-Token and X-Auth-User are the header info used for authentication and authorization purposes within CORESTACK. Also, save the project master id and project id. These will be required in most API calls to set the context.
                LoginResponse result = apiInstance.authentication(loginRequest);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthenticationApi.authentication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AuthenticationApi();
$loginRequest = ; // LoginRequest | Login Request

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

my $api_instance = WWW::SwaggerClient::AuthenticationApi->new();
my $loginRequest = WWW::SwaggerClient::Object::LoginRequest->new(); # LoginRequest | Login Request

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

# create an instance of the API class
api_instance = swagger_client.AuthenticationApi()
loginRequest =  # LoginRequest | Login Request (optional)

try: 
    # The auth-token provided as part of the response is to be used for all subsequent API calls. Extract this auth-token and also the project id from the response. This will be required for subsequent calls. All requests are expected to have the below headers, though the header values would be different. X-Auth-Token and X-Auth-User are the header info used for authentication and authorization purposes within CORESTACK. Also, save the project master id and project id. These will be required in most API calls to set the context.
    api_response = api_instance.authentication(loginRequest=loginRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->authentication: %s\n" % e)

Parameters

Body parameters
Name Description
loginRequest

Responses

Status: 200 - successful operation

{status=success, message=Authentication Successful, token=5d2ffcf7-98f6-4133-87dc-853254785f14, project_master_id=590d604f29dc124a81210d52, projects=[{name=project_name, id=590d604f29dc124a81210d53, roles=[{name=project_name-ops_admin, role_type=project_admin, id=590d604f29dc124a81210d54}, {name=project_name-ops_team, role_type=project_member, id=590d605029dc124a81210d56}]}]}

Blueprintjobs

describeBlueprintJob

Get details of a specific Blueprintjob for a given project/tenant


/v1/{project_id}/blueprintjobs/{blueprint_job_id}

Usage and SDK Samples

curl -X GET -H "X-Auth-Token: [[apiKey]]" -H "X-Auth-User: [[apiKey]]" "http://52.66.156.11:18080/v1/{project_id}/blueprintjobs/{blueprint_job_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BlueprintjobsApi;

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

public class BlueprintjobsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: AuthToken
        ApiKeyAuth AuthToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthToken");
        AuthToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //AuthToken.setApiKeyPrefix("Token");

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

        BlueprintjobsApi apiInstance = new BlueprintjobsApi();
        String projectId = projectId_example; // String | Project ID
        String blueprintJobId = blueprintJobId_example; // String | Blueprintjob ID
        try {
            BlueprintjobView result = apiInstance.describeBlueprintJob(projectId, blueprintJobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlueprintjobsApi#describeBlueprintJob");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BlueprintjobsApi;

public class BlueprintjobsApiExample {

    public static void main(String[] args) {
        BlueprintjobsApi apiInstance = new BlueprintjobsApi();
        String projectId = projectId_example; // String | Project ID
        String blueprintJobId = blueprintJobId_example; // String | Blueprintjob ID
        try {
            BlueprintjobView result = apiInstance.describeBlueprintJob(projectId, blueprintJobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlueprintjobsApi#describeBlueprintJob");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

String *projectId = projectId_example; // Project ID
String *blueprintJobId = blueprintJobId_example; // Blueprintjob ID

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

[apiInstance describeBlueprintJobWith:projectId
    blueprintJobId:blueprintJobId
              completionHandler: ^(BlueprintjobView output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CorestackProfessionalEditionEndUserApiGuide = require('corestack_professional_edition_end_user_api_guide');
var defaultClient = CorestackProfessionalEditionEndUserApiGuide.ApiClient.instance;

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

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

var api = new CorestackProfessionalEditionEndUserApiGuide.BlueprintjobsApi()

var projectId = projectId_example; // {String} Project ID

var blueprintJobId = blueprintJobId_example; // {String} Blueprintjob ID


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

namespace Example
{
    public class describeBlueprintJobExample
    {
        public void main()
        {
            
            // Configure API key authorization: AuthToken
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");
            // Configure API key authorization: Username
            Configuration.Default.ApiKey.Add("X-Auth-User", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-User", "Bearer");

            var apiInstance = new BlueprintjobsApi();
            var projectId = projectId_example;  // String | Project ID
            var blueprintJobId = blueprintJobId_example;  // String | Blueprintjob ID

            try
            {
                BlueprintjobView result = apiInstance.describeBlueprintJob(projectId, blueprintJobId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BlueprintjobsApi.describeBlueprintJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: AuthToken
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure API key authorization: Username
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-User', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-User', 'Bearer');

$api_instance = new Swagger\Client\Api\BlueprintjobsApi();
$projectId = projectId_example; // String | Project ID
$blueprintJobId = blueprintJobId_example; // String | Blueprintjob ID

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

# Configure API key authorization: AuthToken
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";
# Configure API key authorization: Username
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-User'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-User'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BlueprintjobsApi->new();
my $projectId = projectId_example; # String | Project ID
my $blueprintJobId = blueprintJobId_example; # String | Blueprintjob ID

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

# Configure API key authorization: AuthToken
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'
# Configure API key authorization: Username
swagger_client.configuration.api_key['X-Auth-User'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-User'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BlueprintjobsApi()
projectId = projectId_example # String | Project ID
blueprintJobId = blueprintJobId_example # String | Blueprintjob ID

try: 
    api_response = api_instance.describe_blueprint_job(projectId, blueprintJobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlueprintjobsApi->describeBlueprintJob: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Project ID
Required
blueprint_job_id*
String
Blueprintjob ID
Required

Responses

Status: 200 - successful operation

{status=success, message=Blueprint Job View, data={id=5badc9b307e3120c19f79f1d, name=blueprint4-ucaju, status=COMPLETED, created_by=accadmin, created_at=2018-09-28 06:26:59.203000, job_actions=[rerun], project_name=accadmin, resource=[{job_id=5badc9b307e3120c22aa1274, template_name=blueprint4_AWS_Resource_Summary, action=abcdd, job_name=blueprint4_AWS_Resource_Summary-myllv, input={Bill_Scheduled_bucket_name=s3, to_email=praveen@corestack.io, Billing_filename=aws-billing-csv-}, output=[], status=IN_PROGRESS, is_archive=false, execution_type=on_demand, created_at=2018-09-28}], completed_at=}}

listBlueprintjobs

List all blueprintjobs for a given project/tenant


/v1/{project_id}/blueprintjobs

Usage and SDK Samples

curl -X GET -H "X-Auth-Token: [[apiKey]]" -H "X-Auth-User: [[apiKey]]" "http://52.66.156.11:18080/v1/{project_id}/blueprintjobs"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BlueprintjobsApi;

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

public class BlueprintjobsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: AuthToken
        ApiKeyAuth AuthToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthToken");
        AuthToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //AuthToken.setApiKeyPrefix("Token");

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

        BlueprintjobsApi apiInstance = new BlueprintjobsApi();
        String projectId = projectId_example; // String | Project ID
        try {
            BlueprintJobsList result = apiInstance.listBlueprintjobs(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlueprintjobsApi#listBlueprintjobs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BlueprintjobsApi;

public class BlueprintjobsApiExample {

    public static void main(String[] args) {
        BlueprintjobsApi apiInstance = new BlueprintjobsApi();
        String projectId = projectId_example; // String | Project ID
        try {
            BlueprintJobsList result = apiInstance.listBlueprintjobs(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlueprintjobsApi#listBlueprintjobs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

String *projectId = projectId_example; // Project ID

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

[apiInstance listBlueprintjobsWith:projectId
              completionHandler: ^(BlueprintJobsList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CorestackProfessionalEditionEndUserApiGuide = require('corestack_professional_edition_end_user_api_guide');
var defaultClient = CorestackProfessionalEditionEndUserApiGuide.ApiClient.instance;

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

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

var api = new CorestackProfessionalEditionEndUserApiGuide.BlueprintjobsApi()

var projectId = projectId_example; // {String} Project ID


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

namespace Example
{
    public class listBlueprintjobsExample
    {
        public void main()
        {
            
            // Configure API key authorization: AuthToken
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");
            // Configure API key authorization: Username
            Configuration.Default.ApiKey.Add("X-Auth-User", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-User", "Bearer");

            var apiInstance = new BlueprintjobsApi();
            var projectId = projectId_example;  // String | Project ID

            try
            {
                BlueprintJobsList result = apiInstance.listBlueprintjobs(projectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BlueprintjobsApi.listBlueprintjobs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: AuthToken
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure API key authorization: Username
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-User', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-User', 'Bearer');

$api_instance = new Swagger\Client\Api\BlueprintjobsApi();
$projectId = projectId_example; // String | Project ID

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

# Configure API key authorization: AuthToken
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";
# Configure API key authorization: Username
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-User'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-User'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BlueprintjobsApi->new();
my $projectId = projectId_example; # String | Project ID

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

# Configure API key authorization: AuthToken
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'
# Configure API key authorization: Username
swagger_client.configuration.api_key['X-Auth-User'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-User'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BlueprintjobsApi()
projectId = projectId_example # String | Project ID

try: 
    api_response = api_instance.list_blueprintjobs(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlueprintjobsApi->listBlueprintjobs: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Project ID
Required

Responses

Status: 200 - successful operation

{status=success, message=Blueprint Job List, data={jobs=[{id=5badc9b307e3120c19f79f1d, name=blueprint4-ucaju, status=COMPLETED, created_by=accadmin, created_at=2018-09-28 06:26:59.203000, project_name=accadmin, resource=[{status=IN_PROGRESS, resource_name=blueprint4_AWS_Resource_Summary, resource_id=5badc8c807e3120c19f79f1a, schedule={}, execution_type=on_demand, action=abcdd, execution={service_accounts=[{region=ap-south-1, id=5bab14d107e312502a214379}], resource_elements=[], inventory_elements=[], args={Bill_Scheduled_bucket_name=s3, to_email=praveen@corestack.io, Billing_filename=aws-billing-csv-}}, type=template, id=5badc9b307e3120c22aa1274, resources={id=5b910a9e07e3123ed94009df, name=AWS_Resource_Summary}}]}, {id=5bab582307e3125ad1eeccd1, name=RequestBlueprint10001_hsi4h-322aw, status=COMPLETED, created_by=accadmin, created_at=2018-09-26 09:57:55.129000, project_name=accadmin, resource=[{status=IN_PROGRESS, resource_name=RequestBlueprint10001_hs_Instance_AWS_Linux, resource_id=5bab57a907e3125ad1eecccd, schedule={}, request_resource_id=446592004312, execution_type=on_demand, action=create_instance, execution={service_accounts=[{region=ap-south-1, id=5bab14d107e312502a214379}], resource_elements=[], inventory_elements=[], args={create_root_password=pas_e5kif, create_root_username=root, create_instance_username=adminuser, image=ami-41e9c52e, keypair_name=KP_user1_nxber, create_instance_password=pas_l5hfh, instance_name=VM_AWS_26_9_2018_15_25_42, securitygroup_name=SG_user1_xts4w, flavor=t2.micro}, args_edited=false}, type=template, id=5bab582307e312503070c950, resources={id=5b910aba07e3123ed9400ac5, name=Instance_AWS_Linux}}]}], total_count=2, page_count=1}}

updateBlueprintjob

Re-run the mentioned blueprintjob.


/v1/{project_id}/blueprintjobs/{blueprint_job_id}

Usage and SDK Samples

curl -X PUT -H "X-Auth-Token: [[apiKey]]" -H "X-Auth-User: [[apiKey]]" "http://52.66.156.11:18080/v1/{project_id}/blueprintjobs/{blueprint_job_id}?action="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BlueprintjobsApi;

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

public class BlueprintjobsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: AuthToken
        ApiKeyAuth AuthToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthToken");
        AuthToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //AuthToken.setApiKeyPrefix("Token");

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

        BlueprintjobsApi apiInstance = new BlueprintjobsApi();
        String projectId = projectId_example; // String | Project ID
        String blueprintJobId = blueprintJobId_example; // String | Blueprintjob ID
        String action = action_example; // String | Re-run Blueprintjob
        UpdateBlueprintjob updateBlueprintjob = ; // UpdateBlueprintjob | 
        try {
            UpdateBlueprintjobResponse result = apiInstance.updateBlueprintjob(projectId, blueprintJobId, action, updateBlueprintjob);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlueprintjobsApi#updateBlueprintjob");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BlueprintjobsApi;

public class BlueprintjobsApiExample {

    public static void main(String[] args) {
        BlueprintjobsApi apiInstance = new BlueprintjobsApi();
        String projectId = projectId_example; // String | Project ID
        String blueprintJobId = blueprintJobId_example; // String | Blueprintjob ID
        String action = action_example; // String | Re-run Blueprintjob
        UpdateBlueprintjob updateBlueprintjob = ; // UpdateBlueprintjob | 
        try {
            UpdateBlueprintjobResponse result = apiInstance.updateBlueprintjob(projectId, blueprintJobId, action, updateBlueprintjob);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlueprintjobsApi#updateBlueprintjob");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

String *projectId = projectId_example; // Project ID
String *blueprintJobId = blueprintJobId_example; // Blueprintjob ID
String *action = action_example; // Re-run Blueprintjob
UpdateBlueprintjob *updateBlueprintjob = ; //  (optional)

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

[apiInstance updateBlueprintjobWith:projectId
    blueprintJobId:blueprintJobId
    action:action
    updateBlueprintjob:updateBlueprintjob
              completionHandler: ^(UpdateBlueprintjobResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CorestackProfessionalEditionEndUserApiGuide = require('corestack_professional_edition_end_user_api_guide');
var defaultClient = CorestackProfessionalEditionEndUserApiGuide.ApiClient.instance;

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

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

var api = new CorestackProfessionalEditionEndUserApiGuide.BlueprintjobsApi()

var projectId = projectId_example; // {String} Project ID

var blueprintJobId = blueprintJobId_example; // {String} Blueprintjob ID

var action = action_example; // {String} Re-run Blueprintjob

var opts = { 
  'updateBlueprintjob':  // {UpdateBlueprintjob} 
};

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

namespace Example
{
    public class updateBlueprintjobExample
    {
        public void main()
        {
            
            // Configure API key authorization: AuthToken
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");
            // Configure API key authorization: Username
            Configuration.Default.ApiKey.Add("X-Auth-User", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-User", "Bearer");

            var apiInstance = new BlueprintjobsApi();
            var projectId = projectId_example;  // String | Project ID
            var blueprintJobId = blueprintJobId_example;  // String | Blueprintjob ID
            var action = action_example;  // String | Re-run Blueprintjob
            var updateBlueprintjob = new UpdateBlueprintjob(); // UpdateBlueprintjob |  (optional) 

            try
            {
                UpdateBlueprintjobResponse result = apiInstance.updateBlueprintjob(projectId, blueprintJobId, action, updateBlueprintjob);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BlueprintjobsApi.updateBlueprintjob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: AuthToken
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure API key authorization: Username
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-User', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-User', 'Bearer');

$api_instance = new Swagger\Client\Api\BlueprintjobsApi();
$projectId = projectId_example; // String | Project ID
$blueprintJobId = blueprintJobId_example; // String | Blueprintjob ID
$action = action_example; // String | Re-run Blueprintjob
$updateBlueprintjob = ; // UpdateBlueprintjob | 

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

# Configure API key authorization: AuthToken
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";
# Configure API key authorization: Username
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-User'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-User'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BlueprintjobsApi->new();
my $projectId = projectId_example; # String | Project ID
my $blueprintJobId = blueprintJobId_example; # String | Blueprintjob ID
my $action = action_example; # String | Re-run Blueprintjob
my $updateBlueprintjob = WWW::SwaggerClient::Object::UpdateBlueprintjob->new(); # UpdateBlueprintjob | 

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

# Configure API key authorization: AuthToken
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'
# Configure API key authorization: Username
swagger_client.configuration.api_key['X-Auth-User'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-User'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BlueprintjobsApi()
projectId = projectId_example # String | Project ID
blueprintJobId = blueprintJobId_example # String | Blueprintjob ID
action = action_example # String | Re-run Blueprintjob
updateBlueprintjob =  # UpdateBlueprintjob |  (optional)

try: 
    api_response = api_instance.update_blueprintjob(projectId, blueprintJobId, action, updateBlueprintjob=updateBlueprintjob)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlueprintjobsApi->updateBlueprintjob: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Project ID
Required
blueprint_job_id*
String
Blueprintjob ID
Required
Body parameters
Name Description
updateBlueprintjob
Query parameters
Name Description
action*
String
Re-run Blueprintjob
Required

Responses

Status: 200 - successful operation


Blueprints

createBlueprint

Creating a Blueprint involves selection of multiple templates or scripts that need to be chained in a specific sequence. Hence it is required to decide upfront the list of templates/scripts that you plan to connect to create this blueprint. You need to have the details of the Templates/Scripts such as:-Name, id, Input & Output Parameters, Sequence, Whether you would like to execute them on-demand / scheduled, Inter-dependencies between the templates/scripts - this can specified by mapping the output parameter of a preceding template to the input parameter of this template.


/v1/{project_id}/blueprints

Usage and SDK Samples

curl -X POST -H "X-Auth-Token: [[apiKey]]" -H "X-Auth-User: [[apiKey]]" "http://52.66.156.11:18080/v1/{project_id}/blueprints"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BlueprintsApi;

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

public class BlueprintsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: AuthToken
        ApiKeyAuth AuthToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthToken");
        AuthToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //AuthToken.setApiKeyPrefix("Token");

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

        BlueprintsApi apiInstance = new BlueprintsApi();
        String projectId = projectId_example; // String | Project ID
        BlueprintCreate blueprintCreate = ; // BlueprintCreate | Blueprint Create Request
        try {
            BlueprintCreateResponse result = apiInstance.createBlueprint(projectId, blueprintCreate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlueprintsApi#createBlueprint");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BlueprintsApi;

public class BlueprintsApiExample {

    public static void main(String[] args) {
        BlueprintsApi apiInstance = new BlueprintsApi();
        String projectId = projectId_example; // String | Project ID
        BlueprintCreate blueprintCreate = ; // BlueprintCreate | Blueprint Create Request
        try {
            BlueprintCreateResponse result = apiInstance.createBlueprint(projectId, blueprintCreate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlueprintsApi#createBlueprint");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

String *projectId = projectId_example; // Project ID
BlueprintCreate *blueprintCreate = ; // Blueprint Create Request (optional)

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

[apiInstance createBlueprintWith:projectId
    blueprintCreate:blueprintCreate
              completionHandler: ^(BlueprintCreateResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CorestackProfessionalEditionEndUserApiGuide = require('corestack_professional_edition_end_user_api_guide');
var defaultClient = CorestackProfessionalEditionEndUserApiGuide.ApiClient.instance;

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

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

var api = new CorestackProfessionalEditionEndUserApiGuide.BlueprintsApi()

var projectId = projectId_example; // {String} Project ID

var opts = { 
  'blueprintCreate':  // {BlueprintCreate} Blueprint Create Request
};

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

namespace Example
{
    public class createBlueprintExample
    {
        public void main()
        {
            
            // Configure API key authorization: AuthToken
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");
            // Configure API key authorization: Username
            Configuration.Default.ApiKey.Add("X-Auth-User", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-User", "Bearer");

            var apiInstance = new BlueprintsApi();
            var projectId = projectId_example;  // String | Project ID
            var blueprintCreate = new BlueprintCreate(); // BlueprintCreate | Blueprint Create Request (optional) 

            try
            {
                BlueprintCreateResponse result = apiInstance.createBlueprint(projectId, blueprintCreate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BlueprintsApi.createBlueprint: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: AuthToken
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure API key authorization: Username
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-User', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-User', 'Bearer');

$api_instance = new Swagger\Client\Api\BlueprintsApi();
$projectId = projectId_example; // String | Project ID
$blueprintCreate = ; // BlueprintCreate | Blueprint Create Request

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

# Configure API key authorization: AuthToken
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";
# Configure API key authorization: Username
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-User'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-User'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BlueprintsApi->new();
my $projectId = projectId_example; # String | Project ID
my $blueprintCreate = WWW::SwaggerClient::Object::BlueprintCreate->new(); # BlueprintCreate | Blueprint Create Request

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

# Configure API key authorization: AuthToken
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'
# Configure API key authorization: Username
swagger_client.configuration.api_key['X-Auth-User'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-User'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BlueprintsApi()
projectId = projectId_example # String | Project ID
blueprintCreate =  # BlueprintCreate | Blueprint Create Request (optional)

try: 
    api_response = api_instance.create_blueprint(projectId, blueprintCreate=blueprintCreate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlueprintsApi->createBlueprint: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Project ID
Required
Body parameters
Name Description
blueprintCreate

Responses

Status: 200 - successful operation


deleteBlueprint

This call can be used to delete a blueprint.


/v1/{project_id}/blueprints/{blueprint_id}

Usage and SDK Samples

curl -X DELETE -H "X-Auth-Token: [[apiKey]]" -H "X-Auth-User: [[apiKey]]" "http://52.66.156.11:18080/v1/{project_id}/blueprints/{blueprint_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BlueprintsApi;

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

public class BlueprintsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: AuthToken
        ApiKeyAuth AuthToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthToken");
        AuthToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //AuthToken.setApiKeyPrefix("Token");

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

        BlueprintsApi apiInstance = new BlueprintsApi();
        String projectId = projectId_example; // String | Project ID
        String blueprintId = blueprintId_example; // String | Blueprint ID
        try {
            DeleteBlueprintResponse result = apiInstance.deleteBlueprint(projectId, blueprintId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlueprintsApi#deleteBlueprint");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BlueprintsApi;

public class BlueprintsApiExample {

    public static void main(String[] args) {
        BlueprintsApi apiInstance = new BlueprintsApi();
        String projectId = projectId_example; // String | Project ID
        String blueprintId = blueprintId_example; // String | Blueprint ID
        try {
            DeleteBlueprintResponse result = apiInstance.deleteBlueprint(projectId, blueprintId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlueprintsApi#deleteBlueprint");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

String *projectId = projectId_example; // Project ID
String *blueprintId = blueprintId_example; // Blueprint ID

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

[apiInstance deleteBlueprintWith:projectId
    blueprintId:blueprintId
              completionHandler: ^(DeleteBlueprintResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CorestackProfessionalEditionEndUserApiGuide = require('corestack_professional_edition_end_user_api_guide');
var defaultClient = CorestackProfessionalEditionEndUserApiGuide.ApiClient.instance;

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

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

var api = new CorestackProfessionalEditionEndUserApiGuide.BlueprintsApi()

var projectId = projectId_example; // {String} Project ID

var blueprintId = blueprintId_example; // {String} Blueprint ID


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

namespace Example
{
    public class deleteBlueprintExample
    {
        public void main()
        {
            
            // Configure API key authorization: AuthToken
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");
            // Configure API key authorization: Username
            Configuration.Default.ApiKey.Add("X-Auth-User", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-User", "Bearer");

            var apiInstance = new BlueprintsApi();
            var projectId = projectId_example;  // String | Project ID
            var blueprintId = blueprintId_example;  // String | Blueprint ID

            try
            {
                DeleteBlueprintResponse result = apiInstance.deleteBlueprint(projectId, blueprintId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BlueprintsApi.deleteBlueprint: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: AuthToken
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure API key authorization: Username
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-User', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-User', 'Bearer');

$api_instance = new Swagger\Client\Api\BlueprintsApi();
$projectId = projectId_example; // String | Project ID
$blueprintId = blueprintId_example; // String | Blueprint ID

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

# Configure API key authorization: AuthToken
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";
# Configure API key authorization: Username
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-User'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-User'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BlueprintsApi->new();
my $projectId = projectId_example; # String | Project ID
my $blueprintId = blueprintId_example; # String | Blueprint ID

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

# Configure API key authorization: AuthToken
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'
# Configure API key authorization: Username
swagger_client.configuration.api_key['X-Auth-User'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-User'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BlueprintsApi()
projectId = projectId_example # String | Project ID
blueprintId = blueprintId_example # String | Blueprint ID

try: 
    api_response = api_instance.delete_blueprint(projectId, blueprintId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlueprintsApi->deleteBlueprint: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Project ID
Required
blueprint_id*
String
Blueprint ID
Required

Responses

Status: 200 - successful operation


describeBlueprint

This call can be used to get the details of a specific blueprint.


/v1/{project_id}/blueprints/{blueprint_id}

Usage and SDK Samples

curl -X GET -H "X-Auth-Token: [[apiKey]]" -H "X-Auth-User: [[apiKey]]" "http://52.66.156.11:18080/v1/{project_id}/blueprints/{blueprint_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BlueprintsApi;

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

public class BlueprintsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: AuthToken
        ApiKeyAuth AuthToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthToken");
        AuthToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //AuthToken.setApiKeyPrefix("Token");

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

        BlueprintsApi apiInstance = new BlueprintsApi();
        String projectId = projectId_example; // String | Project ID
        String blueprintId = blueprintId_example; // String | Blueprint ID
        try {
            BlueprintView result = apiInstance.describeBlueprint(projectId, blueprintId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlueprintsApi#describeBlueprint");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BlueprintsApi;

public class BlueprintsApiExample {

    public static void main(String[] args) {
        BlueprintsApi apiInstance = new BlueprintsApi();
        String projectId = projectId_example; // String | Project ID
        String blueprintId = blueprintId_example; // String | Blueprint ID
        try {
            BlueprintView result = apiInstance.describeBlueprint(projectId, blueprintId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlueprintsApi#describeBlueprint");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

String *projectId = projectId_example; // Project ID
String *blueprintId = blueprintId_example; // Blueprint ID

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

[apiInstance describeBlueprintWith:projectId
    blueprintId:blueprintId
              completionHandler: ^(BlueprintView output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CorestackProfessionalEditionEndUserApiGuide = require('corestack_professional_edition_end_user_api_guide');
var defaultClient = CorestackProfessionalEditionEndUserApiGuide.ApiClient.instance;

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

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

var api = new CorestackProfessionalEditionEndUserApiGuide.BlueprintsApi()

var projectId = projectId_example; // {String} Project ID

var blueprintId = blueprintId_example; // {String} Blueprint ID


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

namespace Example
{
    public class describeBlueprintExample
    {
        public void main()
        {
            
            // Configure API key authorization: AuthToken
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");
            // Configure API key authorization: Username
            Configuration.Default.ApiKey.Add("X-Auth-User", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-User", "Bearer");

            var apiInstance = new BlueprintsApi();
            var projectId = projectId_example;  // String | Project ID
            var blueprintId = blueprintId_example;  // String | Blueprint ID

            try
            {
                BlueprintView result = apiInstance.describeBlueprint(projectId, blueprintId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BlueprintsApi.describeBlueprint: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: AuthToken
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure API key authorization: Username
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-User', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-User', 'Bearer');

$api_instance = new Swagger\Client\Api\BlueprintsApi();
$projectId = projectId_example; // String | Project ID
$blueprintId = blueprintId_example; // String | Blueprint ID

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

# Configure API key authorization: AuthToken
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";
# Configure API key authorization: Username
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-User'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-User'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BlueprintsApi->new();
my $projectId = projectId_example; # String | Project ID
my $blueprintId = blueprintId_example; # String | Blueprint ID

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

# Configure API key authorization: AuthToken
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'
# Configure API key authorization: Username
swagger_client.configuration.api_key['X-Auth-User'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-User'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BlueprintsApi()
projectId = projectId_example # String | Project ID
blueprintId = blueprintId_example # String | Blueprint ID

try: 
    api_response = api_instance.describe_blueprint(projectId, blueprintId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlueprintsApi->describeBlueprint: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Project ID
Required
blueprint_id*
String
Blueprint ID
Required

Responses

Status: 200 - successful operation

{status=success, message=Blueprints View, data={total_count=1, blueprints=[{id=591ec18d29dc12539fd1fd1a, name=blueprint_name, description=blueprint_description, is_deleted=false, is_temp=false, metadata={}, resources=[{param_mapper={}, clone_details={name=first_clone_template_name, id=591ec18d29dc12539fd1fd16}, execution_type=on_demand, action=Provision, type=template, id=591a875b29dc124fd8cda8b7, name=first_template_name}, {param_mapper={param1=first_template_name.output1, param2=first_template_name.output2}, clone_details={name=second_clone_template_name, id=591ec18d29dc12539fd1fd18}, execution_type=on_demand, action=Deploy, type=template, id=591a8a3629dc124fd8cda8e8, name=second_template_name}], scope=global, status=active, created_by=admin, created_at=2017-05-19 09:57:33.892000, updated_by=admin, updated_at=2017-05-19 09:57:33.892000}], page_count=1}}

executeBlueprint

This call can be used to execute a blueprint. When you execute the blueprint all templates/scripts mapped to this blueprint will be executed in the given sequence. You need to provide the required input parameter values. In case of templates/scripts that have execution type as “scheduled”, you should also provide the schedule information.


/v1/{project_id}/blueprints/{blueprint_id}/execute

Usage and SDK Samples

curl -X POST -H "X-Auth-Token: [[apiKey]]" -H "X-Auth-User: [[apiKey]]" "http://52.66.156.11:18080/v1/{project_id}/blueprints/{blueprint_id}/execute"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BlueprintsApi;

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

public class BlueprintsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: AuthToken
        ApiKeyAuth AuthToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthToken");
        AuthToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //AuthToken.setApiKeyPrefix("Token");

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

        BlueprintsApi apiInstance = new BlueprintsApi();
        String projectId = projectId_example; // String | Project ID
        String blueprintId = blueprintId_example; // String | Blueprint ID
        BlueprintExecute blueprintExecute = ; // BlueprintExecute | Blueprint Execute Request Body
        try {
            ExecuteBlueprintResponse result = apiInstance.executeBlueprint(projectId, blueprintId, blueprintExecute);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlueprintsApi#executeBlueprint");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BlueprintsApi;

public class BlueprintsApiExample {

    public static void main(String[] args) {
        BlueprintsApi apiInstance = new BlueprintsApi();
        String projectId = projectId_example; // String | Project ID
        String blueprintId = blueprintId_example; // String | Blueprint ID
        BlueprintExecute blueprintExecute = ; // BlueprintExecute | Blueprint Execute Request Body
        try {
            ExecuteBlueprintResponse result = apiInstance.executeBlueprint(projectId, blueprintId, blueprintExecute);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlueprintsApi#executeBlueprint");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

String *projectId = projectId_example; // Project ID
String *blueprintId = blueprintId_example; // Blueprint ID
BlueprintExecute *blueprintExecute = ; // Blueprint Execute Request Body (optional)

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

[apiInstance executeBlueprintWith:projectId
    blueprintId:blueprintId
    blueprintExecute:blueprintExecute
              completionHandler: ^(ExecuteBlueprintResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CorestackProfessionalEditionEndUserApiGuide = require('corestack_professional_edition_end_user_api_guide');
var defaultClient = CorestackProfessionalEditionEndUserApiGuide.ApiClient.instance;

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

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

var api = new CorestackProfessionalEditionEndUserApiGuide.BlueprintsApi()

var projectId = projectId_example; // {String} Project ID

var blueprintId = blueprintId_example; // {String} Blueprint ID

var opts = { 
  'blueprintExecute':  // {BlueprintExecute} Blueprint Execute Request Body
};

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

namespace Example
{
    public class executeBlueprintExample
    {
        public void main()
        {
            
            // Configure API key authorization: AuthToken
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");
            // Configure API key authorization: Username
            Configuration.Default.ApiKey.Add("X-Auth-User", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-User", "Bearer");

            var apiInstance = new BlueprintsApi();
            var projectId = projectId_example;  // String | Project ID
            var blueprintId = blueprintId_example;  // String | Blueprint ID
            var blueprintExecute = new BlueprintExecute(); // BlueprintExecute | Blueprint Execute Request Body (optional) 

            try
            {
                ExecuteBlueprintResponse result = apiInstance.executeBlueprint(projectId, blueprintId, blueprintExecute);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BlueprintsApi.executeBlueprint: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: AuthToken
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure API key authorization: Username
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-User', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-User', 'Bearer');

$api_instance = new Swagger\Client\Api\BlueprintsApi();
$projectId = projectId_example; // String | Project ID
$blueprintId = blueprintId_example; // String | Blueprint ID
$blueprintExecute = ; // BlueprintExecute | Blueprint Execute Request Body

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

# Configure API key authorization: AuthToken
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";
# Configure API key authorization: Username
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-User'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-User'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BlueprintsApi->new();
my $projectId = projectId_example; # String | Project ID
my $blueprintId = blueprintId_example; # String | Blueprint ID
my $blueprintExecute = WWW::SwaggerClient::Object::BlueprintExecute->new(); # BlueprintExecute | Blueprint Execute Request Body

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

# Configure API key authorization: AuthToken
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'
# Configure API key authorization: Username
swagger_client.configuration.api_key['X-Auth-User'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-User'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BlueprintsApi()
projectId = projectId_example # String | Project ID
blueprintId = blueprintId_example # String | Blueprint ID
blueprintExecute =  # BlueprintExecute | Blueprint Execute Request Body (optional)

try: 
    api_response = api_instance.execute_blueprint(projectId, blueprintId, blueprintExecute=blueprintExecute)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlueprintsApi->executeBlueprint: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Project ID
Required
blueprint_id*
String
Blueprint ID
Required
Body parameters
Name Description
blueprintExecute

Responses

Status: 200 - successful operation


listBlueprints

Blueprints are chaining of multiple templates/scripts in the desired sequence, creating very complex automation workflows. Specific templates within the sequence can be scheduled for recurring executions such as daily back-ups.

Use this call to fetch the list of blueprints within a specific project/tenant. The "scope" query parameter can be used to fetch blueprints with global/tenant/private scope.


/v1/{project_id}/blueprints

Usage and SDK Samples

curl -X GET -H "X-Auth-Token: [[apiKey]]" -H "X-Auth-User: [[apiKey]]" "http://52.66.156.11:18080/v1/{project_id}/blueprints?scope="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BlueprintsApi;

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

public class BlueprintsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: AuthToken
        ApiKeyAuth AuthToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthToken");
        AuthToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //AuthToken.setApiKeyPrefix("Token");

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

        BlueprintsApi apiInstance = new BlueprintsApi();
        String projectId = projectId_example; // String | Project ID
        String scope = scope_example; // String | Scope can be any one of global, tenant and private".
        try {
            BlueprintsList result = apiInstance.listBlueprints(projectId, scope);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlueprintsApi#listBlueprints");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BlueprintsApi;

public class BlueprintsApiExample {

    public static void main(String[] args) {
        BlueprintsApi apiInstance = new BlueprintsApi();
        String projectId = projectId_example; // String | Project ID
        String scope = scope_example; // String | Scope can be any one of global, tenant and private".
        try {
            BlueprintsList result = apiInstance.listBlueprints(projectId, scope);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlueprintsApi#listBlueprints");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

String *projectId = projectId_example; // Project ID
String *scope = scope_example; // Scope can be any one of global, tenant and private". (optional)

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

// Blueprints are chaining of multiple templates/scripts in the desired sequence, creating very complex automation workflows. Specific templates within the sequence can be scheduled for recurring executions such as daily back-ups.
[apiInstance listBlueprintsWith:projectId
    scope:scope
              completionHandler: ^(BlueprintsList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CorestackProfessionalEditionEndUserApiGuide = require('corestack_professional_edition_end_user_api_guide');
var defaultClient = CorestackProfessionalEditionEndUserApiGuide.ApiClient.instance;

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

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

var api = new CorestackProfessionalEditionEndUserApiGuide.BlueprintsApi()

var projectId = projectId_example; // {String} Project ID

var opts = { 
  'scope': scope_example // {String} Scope can be any one of global, tenant and private".
};

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

namespace Example
{
    public class listBlueprintsExample
    {
        public void main()
        {
            
            // Configure API key authorization: AuthToken
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");
            // Configure API key authorization: Username
            Configuration.Default.ApiKey.Add("X-Auth-User", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-User", "Bearer");

            var apiInstance = new BlueprintsApi();
            var projectId = projectId_example;  // String | Project ID
            var scope = scope_example;  // String | Scope can be any one of global, tenant and private". (optional) 

            try
            {
                // Blueprints are chaining of multiple templates/scripts in the desired sequence, creating very complex automation workflows. Specific templates within the sequence can be scheduled for recurring executions such as daily back-ups.
                BlueprintsList result = apiInstance.listBlueprints(projectId, scope);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BlueprintsApi.listBlueprints: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: AuthToken
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure API key authorization: Username
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-User', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-User', 'Bearer');

$api_instance = new Swagger\Client\Api\BlueprintsApi();
$projectId = projectId_example; // String | Project ID
$scope = scope_example; // String | Scope can be any one of global, tenant and private".

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

# Configure API key authorization: AuthToken
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";
# Configure API key authorization: Username
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-User'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-User'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BlueprintsApi->new();
my $projectId = projectId_example; # String | Project ID
my $scope = scope_example; # String | Scope can be any one of global, tenant and private".

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

# Configure API key authorization: AuthToken
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'
# Configure API key authorization: Username
swagger_client.configuration.api_key['X-Auth-User'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-User'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BlueprintsApi()
projectId = projectId_example # String | Project ID
scope = scope_example # String | Scope can be any one of global, tenant and private". (optional)

try: 
    # Blueprints are chaining of multiple templates/scripts in the desired sequence, creating very complex automation workflows. Specific templates within the sequence can be scheduled for recurring executions such as daily back-ups.
    api_response = api_instance.list_blueprints(projectId, scope=scope)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlueprintsApi->listBlueprints: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Project ID
Required
Query parameters
Name Description
scope
String
Scope can be any one of global, tenant and private".

Responses

Status: 200 - successful operation

{name=blueprint_name, description=blueprint_description, is_temp=false, metadata={}, resources=[{param_mapper={}, name=AWS_Create_Assessment_Target_Fixed_Tag, action=Create_Assessment, type=template, id=59c3ba9d4686333b7697d033, execution_type=on_demand}, {param_mapper={Template_name=AWS_Create_Assessment_Target_Fixed_Tag.Assessment_Template_Name}, name=AWS_Inspector_Run_Assessment_Template, action=Run_Assessment, type=template, id=59c3ba7c4686333b7697d031, execution_type=on_demand}], scope=private}

updateBlueprint

You can use this call to modify the details related to a specific blueprint. All the keys can be modified except the id. To get the current value of the keys, you can use the “Describe Blueprint” call first. This is recommended since this call will override all existing values.


/v1/{project_id}/blueprints/{blueprint_id}

Usage and SDK Samples

curl -X PUT -H "X-Auth-Token: [[apiKey]]" -H "X-Auth-User: [[apiKey]]" "http://52.66.156.11:18080/v1/{project_id}/blueprints/{blueprint_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BlueprintsApi;

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

public class BlueprintsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: AuthToken
        ApiKeyAuth AuthToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthToken");
        AuthToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //AuthToken.setApiKeyPrefix("Token");

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

        BlueprintsApi apiInstance = new BlueprintsApi();
        String projectId = projectId_example; // String | Project ID
        String blueprintId = blueprintId_example; // String | Blueprint ID
        BlueprintUpdate blueprintUpdate = ; // BlueprintUpdate | Blueprint Update Request
        try {
            BlueprintUpdateResponse result = apiInstance.updateBlueprint(projectId, blueprintId, blueprintUpdate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlueprintsApi#updateBlueprint");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BlueprintsApi;

public class BlueprintsApiExample {

    public static void main(String[] args) {
        BlueprintsApi apiInstance = new BlueprintsApi();
        String projectId = projectId_example; // String | Project ID
        String blueprintId = blueprintId_example; // String | Blueprint ID
        BlueprintUpdate blueprintUpdate = ; // BlueprintUpdate | Blueprint Update Request
        try {
            BlueprintUpdateResponse result = apiInstance.updateBlueprint(projectId, blueprintId, blueprintUpdate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlueprintsApi#updateBlueprint");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

String *projectId = projectId_example; // Project ID
String *blueprintId = blueprintId_example; // Blueprint ID
BlueprintUpdate *blueprintUpdate = ; // Blueprint Update Request (optional)

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

[apiInstance updateBlueprintWith:projectId
    blueprintId:blueprintId
    blueprintUpdate:blueprintUpdate
              completionHandler: ^(BlueprintUpdateResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CorestackProfessionalEditionEndUserApiGuide = require('corestack_professional_edition_end_user_api_guide');
var defaultClient = CorestackProfessionalEditionEndUserApiGuide.ApiClient.instance;

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

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

var api = new CorestackProfessionalEditionEndUserApiGuide.BlueprintsApi()

var projectId = projectId_example; // {String} Project ID

var blueprintId = blueprintId_example; // {String} Blueprint ID

var opts = { 
  'blueprintUpdate':  // {BlueprintUpdate} Blueprint Update Request
};

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

namespace Example
{
    public class updateBlueprintExample
    {
        public void main()
        {
            
            // Configure API key authorization: AuthToken
            Configuration.Default.ApiKey.Add("X-Auth-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-Token", "Bearer");
            // Configure API key authorization: Username
            Configuration.Default.ApiKey.Add("X-Auth-User", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Auth-User", "Bearer");

            var apiInstance = new BlueprintsApi();
            var projectId = projectId_example;  // String | Project ID
            var blueprintId = blueprintId_example;  // String | Blueprint ID
            var blueprintUpdate = new BlueprintUpdate(); // BlueprintUpdate | Blueprint Update Request (optional) 

            try
            {
                BlueprintUpdateResponse result = apiInstance.updateBlueprint(projectId, blueprintId, blueprintUpdate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BlueprintsApi.updateBlueprint: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: AuthToken
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure API key authorization: Username
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-User', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-User', 'Bearer');

$api_instance = new Swagger\Client\Api\BlueprintsApi();
$projectId = projectId_example; // String | Project ID
$blueprintId = blueprintId_example; // String | Blueprint ID
$blueprintUpdate = ; // BlueprintUpdate | Blueprint Update Request

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

# Configure API key authorization: AuthToken
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-Token'} = "Bearer";
# Configure API key authorization: Username
$WWW::SwaggerClient::Configuration::api_key->{'X-Auth-User'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Auth-User'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BlueprintsApi->new();
my $projectId = projectId_example; # String | Project ID
my $blueprintId = blueprintId_example; # String | Blueprint ID
my $blueprintUpdate = WWW::SwaggerClient::Object::BlueprintUpdate->new(); # BlueprintUpdate | Blueprint Update Request

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

# Configure API key authorization: AuthToken
swagger_client.configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'
# Configure API key authorization: Username
swagger_client.configuration.api_key['X-Auth-User'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Auth-User'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BlueprintsApi()
projectId = projectId_example # String | Project ID
blueprintId = blueprintId_example # String | Blueprint ID
blueprintUpdate =  # BlueprintUpdate | Blueprint Update Request (optional)

try: 
    api_response = api_instance.update_blueprint(projectId, blueprintId, blueprintUpdate=blueprintUpdate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlueprintsApi->updateBlueprint: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Project ID
Required
blueprint_id*
String
Blueprint ID
Required
Body parameters
Name Description
blueprintUpdate

Responses

Status: 200 - successful operation


CloudServiceResourcesActionsDetails

v2ProjectIdCloudServiceNameResourcesActionsListPost

Fetch the cloud service resources actions list based on the resource operations id


/v2/{project_id}/cloud/{service_name}/resources/actions_list

Usage and SDK Samples

curl -X POST "http://52.66.156.11:18080/v2/{project_id}/cloud/{service_name}/resources/actions_list?action_type="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CloudServiceResourcesActionsDetailsApi;

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

public class CloudServiceResourcesActionsDetailsApiExample {

    public static void main(String[] args) {
        
        CloudServiceResourcesActionsDetailsApi apiInstance = new CloudServiceResourcesActionsDetailsApi();
        String xAuthUser = xAuthUser_example; // String | corestack username
        String xAuthToken = xAuthToken_example; // String | corestack authorisation token
        String projectId = projectId_example; // String | project data
        String serviceName = serviceName_example; // String | service data
        String actionType = actionType_example; // String | action type for list data
        ResourceListActionsListRequest requestBody = ; // ResourceListActionsListRequest | service resource actions list request data
        try {
            apiInstance.v2ProjectIdCloudServiceNameResourcesActionsListPost(xAuthUser, xAuthToken, projectId, serviceName, actionType, requestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudServiceResourcesActionsDetailsApi#v2ProjectIdCloudServiceNameResourcesActionsListPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CloudServiceResourcesActionsDetailsApi;

public class CloudServiceResourcesActionsDetailsApiExample {

    public static void main(String[] args) {
        CloudServiceResourcesActionsDetailsApi apiInstance = new CloudServiceResourcesActionsDetailsApi();
        String xAuthUser = xAuthUser_example; // String | corestack username
        String xAuthToken = xAuthToken_example; // String | corestack authorisation token
        String projectId = projectId_example; // String | project data
        String serviceName = serviceName_example; // String | service data
        String actionType = actionType_example; // String | action type for list data
        ResourceListActionsListRequest requestBody = ; // ResourceListActionsListRequest | service resource actions list request data
        try {
            apiInstance.v2ProjectIdCloudServiceNameResourcesActionsListPost(xAuthUser, xAuthToken, projectId, serviceName, actionType, requestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudServiceResourcesActionsDetailsApi#v2ProjectIdCloudServiceNameResourcesActionsListPost");
            e.printStackTrace();
        }
    }
}
String *xAuthUser = xAuthUser_example; // corestack username
String *xAuthToken = xAuthToken_example; // corestack authorisation token
String *projectId = projectId_example; // project data
String *serviceName = serviceName_example; // service data
String *actionType = actionType_example; // action type for list data (optional)
ResourceListActionsListRequest *requestBody = ; // service resource actions list request data (optional)

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

// Fetch the cloud service resources actions list based on the resource operations id
[apiInstance v2ProjectIdCloudServiceNameResourcesActionsListPostWith:xAuthUser
    xAuthToken:xAuthToken
    projectId:projectId
    serviceName:serviceName
    actionType:actionType
    requestBody:requestBody
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CorestackProfessionalEditionEndUserApiGuide = require('corestack_professional_edition_end_user_api_guide');

var api = new CorestackProfessionalEditionEndUserApiGuide.CloudServiceResourcesActionsDetailsApi()

var xAuthUser = xAuthUser_example; // {String} corestack username

var xAuthToken = xAuthToken_example; // {String} corestack authorisation token

var projectId = projectId_example; // {String} project data

var serviceName = serviceName_example; // {String} service data

var opts = { 
  'actionType': actionType_example, // {String} action type for list data
  'requestBody':  // {ResourceListActionsListRequest} service resource actions list request data
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.v2ProjectIdCloudServiceNameResourcesActionsListPost(xAuthUser, xAuthToken, projectId, serviceName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class v2ProjectIdCloudServiceNameResourcesActionsListPostExample
    {
        public void main()
        {
            
            var apiInstance = new CloudServiceResourcesActionsDetailsApi();
            var xAuthUser = xAuthUser_example;  // String | corestack username
            var xAuthToken = xAuthToken_example;  // String | corestack authorisation token
            var projectId = projectId_example;  // String | project data
            var serviceName = serviceName_example;  // String | service data
            var actionType = actionType_example;  // String | action type for list data (optional) 
            var requestBody = new ResourceListActionsListRequest(); // ResourceListActionsListRequest | service resource actions list request data (optional) 

            try
            {
                // Fetch the cloud service resources actions list based on the resource operations id
                apiInstance.v2ProjectIdCloudServiceNameResourcesActionsListPost(xAuthUser, xAuthToken, projectId, serviceName, actionType, requestBody);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CloudServiceResourcesActionsDetailsApi.v2ProjectIdCloudServiceNameResourcesActionsListPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CloudServiceResourcesActionsDetailsApi();
$xAuthUser = xAuthUser_example; // String | corestack username
$xAuthToken = xAuthToken_example; // String | corestack authorisation token
$projectId = projectId_example; // String | project data
$serviceName = serviceName_example; // String | service data
$actionType = actionType_example; // String | action type for list data
$requestBody = ; // ResourceListActionsListRequest | service resource actions list request data

try {
    $api_instance->v2ProjectIdCloudServiceNameResourcesActionsListPost($xAuthUser, $xAuthToken, $projectId, $serviceName, $actionType, $requestBody);
} catch (Exception $e) {
    echo 'Exception when calling CloudServiceResourcesActionsDetailsApi->v2ProjectIdCloudServiceNameResourcesActionsListPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CloudServiceResourcesActionsDetailsApi;

my $api_instance = WWW::SwaggerClient::CloudServiceResourcesActionsDetailsApi->new();
my $xAuthUser = xAuthUser_example; # String | corestack username
my $xAuthToken = xAuthToken_example; # String | corestack authorisation token
my $projectId = projectId_example; # String | project data
my $serviceName = serviceName_example; # String | service data
my $actionType = actionType_example; # String | action type for list data
my $requestBody = WWW::SwaggerClient::Object::ResourceListActionsListRequest->new(); # ResourceListActionsListRequest | service resource actions list request data

eval { 
    $api_instance->v2ProjectIdCloudServiceNameResourcesActionsListPost(xAuthUser => $xAuthUser, xAuthToken => $xAuthToken, projectId => $projectId, serviceName => $serviceName, actionType => $actionType, requestBody => $requestBody);
};
if ($@) {
    warn "Exception when calling CloudServiceResourcesActionsDetailsApi->v2ProjectIdCloudServiceNameResourcesActionsListPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CloudServiceResourcesActionsDetailsApi()
xAuthUser = xAuthUser_example # String | corestack username
xAuthToken = xAuthToken_example # String | corestack authorisation token
projectId = projectId_example # String | project data
serviceName = serviceName_example # String | service data
actionType = actionType_example # String | action type for list data (optional)
requestBody =  # ResourceListActionsListRequest | service resource actions list request data (optional)

try: 
    # Fetch the cloud service resources actions list based on the resource operations id
    api_instance.v2_project_id_cloud_service_name_resources_actions_list_post(xAuthUser, xAuthToken, projectId, serviceName, actionType=actionType, requestBody=requestBody)
except ApiException as e:
    print("Exception when calling CloudServiceResourcesActionsDetailsApi->v2ProjectIdCloudServiceNameResourcesActionsListPost: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
project data
Required
service_name*
String
service data
Required
Header parameters
Name Description
X-Auth-User*
String
corestack username
Required
X-Auth-Token*
String
corestack authorisation token
Required
Body parameters
Name Description
requestBody
Query parameters
Name Description
action_type
String
action type for list data

Responses

Status: 200 - Resource action list successful

Status: 500 - Error in fetching resource actions list!...


v2ProjectIdCloudServiceNameResourcesActionsPost

Trigger the cloud service resources actions based on the service account data


/v2/{project_id}/cloud/{service_name}/resources/actions

Usage and SDK Samples

curl -X POST "http://52.66.156.11:18080/v2/{project_id}/cloud/{service_name}/resources/actions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CloudServiceResourcesActionsDetailsApi;

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

public class CloudServiceResourcesActionsDetailsApiExample {

    public static void main(String[] args) {
        
        CloudServiceResourcesActionsDetailsApi apiInstance = new CloudServiceResourcesActionsDetailsApi();
        String xAuthUser = xAuthUser_example; // String | corestack username
        String xAuthToken = xAuthToken_example; // String | corestack authorisation token
        String projectId = projectId_example; // String | project data
        String serviceName = serviceName_example; // String | service data
        ResourceListActionsRequest requestBody = ; // ResourceListActionsRequest | service resource list request data
        try {
            apiInstance.v2ProjectIdCloudServiceNameResourcesActionsPost(xAuthUser, xAuthToken, projectId, serviceName, requestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudServiceResourcesActionsDetailsApi#v2ProjectIdCloudServiceNameResourcesActionsPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CloudServiceResourcesActionsDetailsApi;

public class CloudServiceResourcesActionsDetailsApiExample {

    public static void main(String[] args) {
        CloudServiceResourcesActionsDetailsApi apiInstance = new CloudServiceResourcesActionsDetailsApi();
        String xAuthUser = xAuthUser_example; // String | corestack username
        String xAuthToken = xAuthToken_example; // String | corestack authorisation token
        String projectId = projectId_example; // String | project data
        String serviceName = serviceName_example; // String | service data
        ResourceListActionsRequest requestBody = ; // ResourceListActionsRequest | service resource list request data
        try {
            apiInstance.v2ProjectIdCloudServiceNameResourcesActionsPost(xAuthUser, xAuthToken, projectId, serviceName, requestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudServiceResourcesActionsDetailsApi#v2ProjectIdCloudServiceNameResourcesActionsPost");
            e.printStackTrace();
        }
    }
}
String *xAuthUser = xAuthUser_example; // corestack username
String *xAuthToken = xAuthToken_example; // corestack authorisation token
String *projectId = projectId_example; // project data
String *serviceName = serviceName_example; // service data
ResourceListActionsRequest *requestBody = ; // service resource list request data (optional)

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

// Trigger the cloud service resources actions based on the service account data
[apiInstance v2ProjectIdCloudServiceNameResourcesActionsPostWith:xAuthUser
    xAuthToken:xAuthToken
    projectId:projectId
    serviceName:serviceName
    requestBody:requestBody
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CorestackProfessionalEditionEndUserApiGuide = require('corestack_professional_edition_end_user_api_guide');

var api = new CorestackProfessionalEditionEndUserApiGuide.CloudServiceResourcesActionsDetailsApi()

var xAuthUser = xAuthUser_example; // {String} corestack username

var xAuthToken = xAuthToken_example; // {String} corestack authorisation token

var projectId = projectId_example; // {String} project data

var serviceName = serviceName_example; // {String} service data

var opts = { 
  'requestBody':  // {ResourceListActionsRequest} service resource list request data
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.v2ProjectIdCloudServiceNameResourcesActionsPost(xAuthUser, xAuthToken, projectId, serviceName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class v2ProjectIdCloudServiceNameResourcesActionsPostExample
    {
        public void main()
        {
            
            var apiInstance = new CloudServiceResourcesActionsDetailsApi();
            var xAuthUser = xAuthUser_example;  // String | corestack username
            var xAuthToken = xAuthToken_example;  // String | corestack authorisation token
            var projectId = projectId_example;  // String | project data
            var serviceName = serviceName_example;  // String | service data
            var requestBody = new ResourceListActionsRequest(); // ResourceListActionsRequest | service resource list request data (optional) 

            try
            {
                // Trigger the cloud service resources actions based on the service account data
                apiInstance.v2ProjectIdCloudServiceNameResourcesActionsPost(xAuthUser, xAuthToken, projectId, serviceName, requestBody);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CloudServiceResourcesActionsDetailsApi.v2ProjectIdCloudServiceNameResourcesActionsPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CloudServiceResourcesActionsDetailsApi();
$xAuthUser = xAuthUser_example; // String | corestack username
$xAuthToken = xAuthToken_example; // String | corestack authorisation token
$projectId = projectId_example; // String | project data
$serviceName = serviceName_example; // String | service data
$requestBody = ; // ResourceListActionsRequest | service resource list request data

try {
    $api_instance->v2ProjectIdCloudServiceNameResourcesActionsPost($xAuthUser, $xAuthToken, $projectId, $serviceName, $requestBody);
} catch (Exception $e) {
    echo 'Exception when calling CloudServiceResourcesActionsDetailsApi->v2ProjectIdCloudServiceNameResourcesActionsPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CloudServiceResourcesActionsDetailsApi;

my $api_instance = WWW::SwaggerClient::CloudServiceResourcesActionsDetailsApi->new();
my $xAuthUser = xAuthUser_example; # String | corestack username
my $xAuthToken = xAuthToken_example; # String | corestack authorisation token
my $projectId = projectId_example; # String | project data
my $serviceName = serviceName_example; # String | service data
my $requestBody = WWW::SwaggerClient::Object::ResourceListActionsRequest->new(); # ResourceListActionsRequest | service resource list request data

eval { 
    $api_instance->v2ProjectIdCloudServiceNameResourcesActionsPost(xAuthUser => $xAuthUser, xAuthToken => $xAuthToken, projectId => $projectId, serviceName => $serviceName, requestBody => $requestBody);
};
if ($@) {
    warn "Exception when calling CloudServiceResourcesActionsDetailsApi->v2ProjectIdCloudServiceNameResourcesActionsPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CloudServiceResourcesActionsDetailsApi()
xAuthUser = xAuthUser_example # String | corestack username
xAuthToken = xAuthToken_example # String | corestack authorisation token
projectId = projectId_example # String | project data
serviceName = serviceName_example # String | service data
requestBody =  # ResourceListActionsRequest | service resource list request data (optional)

try: 
    # Trigger the cloud service resources actions based on the service account data
    api_instance.v2_project_id_cloud_service_name_resources_actions_post(xAuthUser, xAuthToken, projectId, serviceName, requestBody=requestBody)
except ApiException as e:
    print("Exception when calling CloudServiceResourcesActionsDetailsApi->v2ProjectIdCloudServiceNameResourcesActionsPost: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
project data
Required
service_name*
String
service data
Required
Header parameters
Name Description
X-Auth-User*
String
corestack username
Required
X-Auth-Token*
String
corestack authorisation token
Required
Body parameters
Name Description
requestBody

Responses

Status: 200 - Resource data action triggered successful

Status: 500 - Error in triggering resource data actions!...


CloudServiceResourcesListDetails

v2ProjectIdCloudAuthServiceIdPost

Getting the cloud authorisation data based on the service account data


/v2/{project_id}/cloud/auth/{service_id}

Usage and SDK Samples

curl -X POST "http://52.66.156.11:18080/v2/{project_id}/cloud/auth/{service_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CloudServiceResourcesListDetailsApi;

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

public class CloudServiceResourcesListDetailsApiExample {

    public static void main(String[] args) {
        
        CloudServiceResourcesListDetailsApi apiInstance = new CloudServiceResourcesListDetailsApi();
        String xAuthUser = xAuthUser_example; // String | corestack username
        String xAuthToken = xAuthToken_example; // String | corestack authorisation token
        String projectId = projectId_example; // String | project data
        String serviceId = serviceId_example; // String | service data
        CloudAuthRequest requestBody = ; // CloudAuthRequest | service resource list request data
        try {
            apiInstance.v2ProjectIdCloudAuthServiceIdPost(xAuthUser, xAuthToken, projectId, serviceId, requestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudServiceResourcesListDetailsApi#v2ProjectIdCloudAuthServiceIdPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CloudServiceResourcesListDetailsApi;

public class CloudServiceResourcesListDetailsApiExample {

    public static void main(String[] args) {
        CloudServiceResourcesListDetailsApi apiInstance = new CloudServiceResourcesListDetailsApi();
        String xAuthUser = xAuthUser_example; // String | corestack username
        String xAuthToken = xAuthToken_example; // String | corestack authorisation token
        String projectId = projectId_example; // String | project data
        String serviceId = serviceId_example; // String | service data
        CloudAuthRequest requestBody = ; // CloudAuthRequest | service resource list request data
        try {
            apiInstance.v2ProjectIdCloudAuthServiceIdPost(xAuthUser, xAuthToken, projectId, serviceId, requestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudServiceResourcesListDetailsApi#v2ProjectIdCloudAuthServiceIdPost");
            e.printStackTrace();
        }
    }
}
String *xAuthUser = xAuthUser_example; // corestack username
String *xAuthToken = xAuthToken_example; // corestack authorisation token
String *projectId = projectId_example; // project data
String *serviceId = serviceId_example; // service data
CloudAuthRequest *requestBody = ; // service resource list request data (optional)

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

// Getting the cloud authorisation data based on the service account data
[apiInstance v2ProjectIdCloudAuthServiceIdPostWith:xAuthUser
    xAuthToken:xAuthToken
    projectId:projectId
    serviceId:serviceId
    requestBody:requestBody
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CorestackProfessionalEditionEndUserApiGuide = require('corestack_professional_edition_end_user_api_guide');

var api = new CorestackProfessionalEditionEndUserApiGuide.CloudServiceResourcesListDetailsApi()

var xAuthUser = xAuthUser_example; // {String} corestack username

var xAuthToken = xAuthToken_example; // {String} corestack authorisation token

var projectId = projectId_example; // {String} project data

var serviceId = serviceId_example; // {String} service data

var opts = { 
  'requestBody':  // {CloudAuthRequest} service resource list request data
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.v2ProjectIdCloudAuthServiceIdPost(xAuthUser, xAuthToken, projectId, serviceId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class v2ProjectIdCloudAuthServiceIdPostExample
    {
        public void main()
        {
            
            var apiInstance = new CloudServiceResourcesListDetailsApi();
            var xAuthUser = xAuthUser_example;  // String | corestack username
            var xAuthToken = xAuthToken_example;  // String | corestack authorisation token
            var projectId = projectId_example;  // String | project data
            var serviceId = serviceId_example;  // String | service data
            var requestBody = new CloudAuthRequest(); // CloudAuthRequest | service resource list request data (optional) 

            try
            {
                // Getting the cloud authorisation data based on the service account data
                apiInstance.v2ProjectIdCloudAuthServiceIdPost(xAuthUser, xAuthToken, projectId, serviceId, requestBody);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CloudServiceResourcesListDetailsApi.v2ProjectIdCloudAuthServiceIdPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CloudServiceResourcesListDetailsApi();
$xAuthUser = xAuthUser_example; // String | corestack username
$xAuthToken = xAuthToken_example; // String | corestack authorisation token
$projectId = projectId_example; // String | project data
$serviceId = serviceId_example; // String | service data
$requestBody = ; // CloudAuthRequest | service resource list request data

try {
    $api_instance->v2ProjectIdCloudAuthServiceIdPost($xAuthUser, $xAuthToken, $projectId, $serviceId, $requestBody);
} catch (Exception $e) {
    echo 'Exception when calling CloudServiceResourcesListDetailsApi->v2ProjectIdCloudAuthServiceIdPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CloudServiceResourcesListDetailsApi;

my $api_instance = WWW::SwaggerClient::CloudServiceResourcesListDetailsApi->new();
my $xAuthUser = xAuthUser_example; # String | corestack username
my $xAuthToken = xAuthToken_example; # String | corestack authorisation token
my $projectId = projectId_example; # String | project data
my $serviceId = serviceId_example; # String | service data
my $requestBody = WWW::SwaggerClient::Object::CloudAuthRequest->new(); # CloudAuthRequest | service resource list request data

eval { 
    $api_instance->v2ProjectIdCloudAuthServiceIdPost(xAuthUser => $xAuthUser, xAuthToken => $xAuthToken, projectId => $projectId, serviceId => $serviceId, requestBody => $requestBody);
};
if ($@) {
    warn "Exception when calling CloudServiceResourcesListDetailsApi->v2ProjectIdCloudAuthServiceIdPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CloudServiceResourcesListDetailsApi()
xAuthUser = xAuthUser_example # String | corestack username
xAuthToken = xAuthToken_example # String | corestack authorisation token
projectId = projectId_example # String | project data
serviceId = serviceId_example # String | service data
requestBody =  # CloudAuthRequest | service resource list request data (optional)

try: 
    # Getting the cloud authorisation data based on the service account data
    api_instance.v2_project_id_cloud_auth_service_id_post(xAuthUser, xAuthToken, projectId, serviceId, requestBody=requestBody)
except ApiException as e:
    print("Exception when calling CloudServiceResourcesListDetailsApi->v2ProjectIdCloudAuthServiceIdPost: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
project data
Required
service_id*
String
service data
Required
Header parameters
Name Description
X-Auth-User*
String
corestack username
Required
X-Auth-Token*
String
corestack authorisation token
Required
Body parameters
Name Description
requestBody

Responses

Status: 200 - Cloud Auth Found Successfully

Status: 500 - Error could not find cloud auth since no service/service_account matches!...


v2ProjectIdCloudServiceIdResourcesDependentParamsPost

Get cloud service resources dependent params list based on the service account data


/v2/{project_id}/cloud/{service_id}/resources/dependent_params

Usage and SDK Samples

curl -X POST "http://52.66.156.11:18080/v2/{project_id}/cloud/{service_id}/resources/dependent_params"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CloudServiceResourcesListDetailsApi;

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

public class CloudServiceResourcesListDetailsApiExample {

    public static void main(String[] args) {
        
        CloudServiceResourcesListDetailsApi apiInstance = new CloudServiceResourcesListDetailsApi();
        String xAuthUser = xAuthUser_example; // String | corestack username
        String xAuthToken = xAuthToken_example; // String | corestack authorisation token
        String projectId = projectId_example; // String | project data
        String serviceId = serviceId_example; // String | service data
        DependentParamRequest requestBody = ; // DependentParamRequest | service resource dependent params list request data
        try {
            apiInstance.v2ProjectIdCloudServiceIdResourcesDependentParamsPost(xAuthUser, xAuthToken, projectId, serviceId, requestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudServiceResourcesListDetailsApi#v2ProjectIdCloudServiceIdResourcesDependentParamsPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CloudServiceResourcesListDetailsApi;

public class CloudServiceResourcesListDetailsApiExample {

    public static void main(String[] args) {
        CloudServiceResourcesListDetailsApi apiInstance = new CloudServiceResourcesListDetailsApi();
        String xAuthUser = xAuthUser_example; // String | corestack username
        String xAuthToken = xAuthToken_example; // String | corestack authorisation token
        String projectId = projectId_example; // String | project data
        String serviceId = serviceId_example; // String | service data
        DependentParamRequest requestBody = ; // DependentParamRequest | service resource dependent params list request data
        try {
            apiInstance.v2ProjectIdCloudServiceIdResourcesDependentParamsPost(xAuthUser, xAuthToken, projectId, serviceId, requestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudServiceResourcesListDetailsApi#v2ProjectIdCloudServiceIdResourcesDependentParamsPost");
            e.printStackTrace();
        }
    }
}
String *xAuthUser = xAuthUser_example; // corestack username
String *xAuthToken = xAuthToken_example; // corestack authorisation token
String *projectId = projectId_example; // project data
String *serviceId = serviceId_example; // service data
DependentParamRequest *requestBody = ; // service resource dependent params list request data (optional)

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

// Get cloud service resources dependent params list based on the service account data
[apiInstance v2ProjectIdCloudServiceIdResourcesDependentParamsPostWith:xAuthUser
    xAuthToken:xAuthToken
    projectId:projectId
    serviceId:serviceId
    requestBody:requestBody
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CorestackProfessionalEditionEndUserApiGuide = require('corestack_professional_edition_end_user_api_guide');

var api = new CorestackProfessionalEditionEndUserApiGuide.CloudServiceResourcesListDetailsApi()

var xAuthUser = xAuthUser_example; // {String} corestack username

var xAuthToken = xAuthToken_example; // {String} corestack authorisation token

var projectId = projectId_example; // {String} project data

var serviceId = serviceId_example; // {String} service data

var opts = { 
  'requestBody':  // {DependentParamRequest} service resource dependent params list request data
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.v2ProjectIdCloudServiceIdResourcesDependentParamsPost(xAuthUser, xAuthToken, projectId, serviceId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class v2ProjectIdCloudServiceIdResourcesDependentParamsPostExample
    {
        public void main()
        {
            
            var apiInstance = new CloudServiceResourcesListDetailsApi();
            var xAuthUser = xAuthUser_example;  // String | corestack username
            var xAuthToken = xAuthToken_example;  // String | corestack authorisation token
            var projectId = projectId_example;  // String | project data
            var serviceId = serviceId_example;  // String | service data
            var requestBody = new DependentParamRequest(); // DependentParamRequest | service resource dependent params list request data (optional) 

            try
            {
                // Get cloud service resources dependent params list based on the service account data
                apiInstance.v2ProjectIdCloudServiceIdResourcesDependentParamsPost(xAuthUser, xAuthToken, projectId, serviceId, requestBody);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CloudServiceResourcesListDetailsApi.v2ProjectIdCloudServiceIdResourcesDependentParamsPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CloudServiceResourcesListDetailsApi();
$xAuthUser = xAuthUser_example; // String | corestack username
$xAuthToken = xAuthToken_example; // String | corestack authorisation token
$projectId = projectId_example; // String | project data
$serviceId = serviceId_example; // String | service data
$requestBody = ; // DependentParamRequest | service resource dependent params list request data

try {
    $api_instance->v2ProjectIdCloudServiceIdResourcesDependentParamsPost($xAuthUser, $xAuthToken, $projectId, $serviceId, $requestBody);
} catch (Exception $e) {
    echo 'Exception when calling CloudServiceResourcesListDetailsApi->v2ProjectIdCloudServiceIdResourcesDependentParamsPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CloudServiceResourcesListDetailsApi;

my $api_instance = WWW::SwaggerClient::CloudServiceResourcesListDetailsApi->new();
my $xAuthUser = xAuthUser_example; # String | corestack username
my $xAuthToken = xAuthToken_example; # String | corestack authorisation token
my $projectId = projectId_example; # String | project data
my $serviceId = serviceId_example; # String | service data
my $requestBody = WWW::SwaggerClient::Object::DependentParamRequest->new(); # DependentParamRequest | service resource dependent params list request data

eval { 
    $api_instance->v2ProjectIdCloudServiceIdResourcesDependentParamsPost(xAuthUser => $xAuthUser, xAuthToken => $xAuthToken, projectId => $projectId, serviceId => $serviceId, requestBody => $requestBody);
};
if ($@) {
    warn "Exception when calling CloudServiceResourcesListDetailsApi->v2ProjectIdCloudServiceIdResourcesDependentParamsPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CloudServiceResourcesListDetailsApi()
xAuthUser = xAuthUser_example # String | corestack username
xAuthToken = xAuthToken_example # String | corestack authorisation token
projectId = projectId_example # String | project data
serviceId = serviceId_example # String | service data
requestBody =  # DependentParamRequest | service resource dependent params list request data (optional)

try: 
    # Get cloud service resources dependent params list based on the service account data
    api_instance.v2_project_id_cloud_service_id_resources_dependent_params_post(xAuthUser, xAuthToken, projectId, serviceId, requestBody=requestBody)
except ApiException as e:
    print("Exception when calling CloudServiceResourcesListDetailsApi->v2ProjectIdCloudServiceIdResourcesDependentParamsPost: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
project data
Required
service_id*
String
service data
Required
Header parameters
Name Description
X-Auth-User*
String
corestack username
Required
X-Auth-Token*
String
corestack authorisation token
Required
Body parameters
Name Description
requestBody

Responses

Status: 200 - Resource dependent param data successful

Status: 500 - Error fetching resource dependent param data!...


v2ProjectIdCloudServiceIdResourcesOnlinePost

Getting the cloud service resources list online based on the service account data


/v2/{project_id}/cloud/{service_id}/resources/online

Usage and SDK Samples

curl -X POST "http://52.66.156.11:18080/v2/{project_id}/cloud/{service_id}/resources/online"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CloudServiceResourcesListDetailsApi;

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

public class CloudServiceResourcesListDetailsApiExample {

    public static void main(String[] args) {
        
        CloudServiceResourcesListDetailsApi apiInstance = new CloudServiceResourcesListDetailsApi();
        String xAuthUser = xAuthUser_example; // String | corestack username
        String xAuthToken = xAuthToken_example; // String | corestack authorisation token
        String projectId = projectId_example; // String | project data
        String serviceId = serviceId_example; // String | service data
        ResourceListOnlineRequest requestBody = ; // ResourceListOnlineRequest | service resource list request data
        try {
            apiInstance.v2ProjectIdCloudServiceIdResourcesOnlinePost(xAuthUser, xAuthToken, projectId, serviceId, requestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudServiceResourcesListDetailsApi#v2ProjectIdCloudServiceIdResourcesOnlinePost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CloudServiceResourcesListDetailsApi;

public class CloudServiceResourcesListDetailsApiExample {

    public static void main(String[] args) {
        CloudServiceResourcesListDetailsApi apiInstance = new CloudServiceResourcesListDetailsApi();
        String xAuthUser = xAuthUser_example; // String | corestack username
        String xAuthToken = xAuthToken_example; // String | corestack authorisation token
        String projectId = projectId_example; // String | project data
        String serviceId = serviceId_example; // String | service data
        ResourceListOnlineRequest requestBody = ; // ResourceListOnlineRequest | service resource list request data
        try {
            apiInstance.v2ProjectIdCloudServiceIdResourcesOnlinePost(xAuthUser, xAuthToken, projectId, serviceId, requestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudServiceResourcesListDetailsApi#v2ProjectIdCloudServiceIdResourcesOnlinePost");
            e.printStackTrace();
        }
    }
}
String *xAuthUser = xAuthUser_example; // corestack username
String *xAuthToken = xAuthToken_example; // corestack authorisation token
String *projectId = projectId_example; // project data
String *serviceId = serviceId_example; // service data
ResourceListOnlineRequest *requestBody = ; // service resource list request data (optional)

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

// Getting the cloud service resources list online based on the service account data
[apiInstance v2ProjectIdCloudServiceIdResourcesOnlinePostWith:xAuthUser
    xAuthToken:xAuthToken
    projectId:projectId
    serviceId:serviceId
    requestBody:requestBody
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CorestackProfessionalEditionEndUserApiGuide = require('corestack_professional_edition_end_user_api_guide');

var api = new CorestackProfessionalEditionEndUserApiGuide.CloudServiceResourcesListDetailsApi()

var xAuthUser = xAuthUser_example; // {String} corestack username

var xAuthToken = xAuthToken_example; // {String} corestack authorisation token

var projectId = projectId_example; // {String} project data

var serviceId = serviceId_example; // {String} service data

var opts = { 
  'requestBody':  // {ResourceListOnlineRequest} service resource list request data
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.v2ProjectIdCloudServiceIdResourcesOnlinePost(xAuthUser, xAuthToken, projectId, serviceId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class v2ProjectIdCloudServiceIdResourcesOnlinePostExample
    {
        public void main()
        {
            
            var apiInstance = new CloudServiceResourcesListDetailsApi();
            var xAuthUser = xAuthUser_example;  // String | corestack username
            var xAuthToken = xAuthToken_example;  // String | corestack authorisation token
            var projectId = projectId_example;  // String | project data
            var serviceId = serviceId_example;  // String | service data
            var requestBody = new ResourceListOnlineRequest(); // ResourceListOnlineRequest | service resource list request data (optional) 

            try
            {
                // Getting the cloud service resources list online based on the service account data
                apiInstance.v2ProjectIdCloudServiceIdResourcesOnlinePost(xAuthUser, xAuthToken, projectId, serviceId, requestBody);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CloudServiceResourcesListDetailsApi.v2ProjectIdCloudServiceIdResourcesOnlinePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CloudServiceResourcesListDetailsApi();
$xAuthUser = xAuthUser_example; // String | corestack username
$xAuthToken = xAuthToken_example; // String | corestack authorisation token
$projectId = projectId_example; // String | project data
$serviceId = serviceId_example; // String | service data
$requestBody = ; // ResourceListOnlineRequest | service resource list request data

try {
    $api_instance->v2ProjectIdCloudServiceIdResourcesOnlinePost($xAuthUser, $xAuthToken, $projectId, $serviceId, $requestBody);
} catch (Exception $e) {
    echo 'Exception when calling CloudServiceResourcesListDetailsApi->v2ProjectIdCloudServiceIdResourcesOnlinePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CloudServiceResourcesListDetailsApi;

my $api_instance = WWW::SwaggerClient::CloudServiceResourcesListDetailsApi->new();
my $xAuthUser = xAuthUser_example; # String | corestack username
my $xAuthToken = xAuthToken_example; # String | corestack authorisation token
my $projectId = projectId_example; # String | project data
my $serviceId = serviceId_example; # String | service data
my $requestBody = WWW::SwaggerClient::Object::ResourceListOnlineRequest->new(); # ResourceListOnlineRequest | service resource list request data

eval { 
    $api_instance->v2ProjectIdCloudServiceIdResourcesOnlinePost(xAuthUser => $xAuthUser, xAuthToken => $xAuthToken, projectId => $projectId, serviceId => $serviceId, requestBody => $requestBody);
};
if ($@) {
    warn "Exception when calling CloudServiceResourcesListDetailsApi->v2ProjectIdCloudServiceIdResourcesOnlinePost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CloudServiceResourcesListDetailsApi()
xAuthUser = xAuthUser_example # String | corestack username
xAuthToken = xAuthToken_example # String | corestack authorisation token
projectId = projectId_example # String | project data
serviceId = serviceId_example # String | service data
requestBody =  # ResourceListOnlineRequest | service resource list request data (optional)

try: 
    # Getting the cloud service resources list online based on the service account data
    api_instance.v2_project_id_cloud_service_id_resources_online_post(xAuthUser, xAuthToken, projectId, serviceId, requestBody=requestBody)
except ApiException as e:
    print("Exception when calling CloudServiceResourcesListDetailsApi->v2ProjectIdCloudServiceIdResourcesOnlinePost: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
project data
Required
service_id*
String
service data
Required
Header parameters
Name Description
X-Auth-User*
String
corestack username
Required
X-Auth-Token*
String
corestack authorisation token
Required
Body parameters
Name Description
requestBody

Responses

Status: 200 - Resource data online successful

Status: 500 - Error in fetching resource data online!...


v2ProjectIdCloudServiceIdResourcesPost

Getting the cloud service resources list based on the service account data


/v2/{project_id}/cloud/{service_id}/resources

Usage and SDK Samples

curl -X POST "http://52.66.156.11:18080/v2/{project_id}/cloud/{service_id}/resources"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CloudServiceResourcesListDetailsApi;

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

public class CloudServiceResourcesListDetailsApiExample {

    public static void main(String[] args) {
        
        CloudServiceResourcesListDetailsApi apiInstance = new CloudServiceResourcesListDetailsApi();
        String xAuthUser = xAuthUser_example; // String | corestack username
        String xAuthToken = xAuthToken_example; // String | corestack authorisation token
        String projectId = projectId_example; // String | project data
        String serviceId = serviceId_example; // String | service data
        ResourceListRequest requestBody = ; // ResourceListRequest | service resource list request data
        try {
            apiInstance.v2ProjectIdCloudServiceIdResourcesPost(xAuthUser, xAuthToken, projectId, serviceId, requestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudServiceResourcesListDetailsApi#v2ProjectIdCloudServiceIdResourcesPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CloudServiceResourcesListDetailsApi;

public class CloudServiceResourcesListDetailsApiExample {

    public static void main(String[] args) {
        CloudServiceResourcesListDetailsApi apiInstance = new CloudServiceResourcesListDetailsApi();
        String xAuthUser = xAuthUser_example; // String | corestack username
        String xAuthToken = xAuthToken_example; // String | corestack authorisation token
        String projectId = projectId_example; // String | project data
        String serviceId = serviceId_example; // String | service data
        ResourceListRequest requestBody = ; // ResourceListRequest | service resource list request data
        try {
            apiInstance.v2ProjectIdCloudServiceIdResourcesPost(xAuthUser, xAuthToken, projectId, serviceId, requestBody);
        } catch (ApiException e) {
            S