CertService Documentation

Actuator

healthCheck

Actuator web endpoint 'health'


/actuator/health

Usage and SDK Samples

curl -X GET "http://localhost:8080/actuator/health"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActuatorApi;

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

public class ActuatorApiExample {

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

public class ActuatorApiExample {

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

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

// Actuator web endpoint 'health'
[apiInstance healthCheckWithCompletionHandler: 
              ^(StatusResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CertServiceDocumentation = require('cert_service_documentation');

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

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

            var apiInstance = new ActuatorApi();

            try
            {
                // Actuator web endpoint 'health'
                StatusResponseModel result = apiInstance.healthCheck();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActuatorApi.healthCheck: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

eval { 
    my $result = $api_instance->healthCheck();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ActuatorApi->healthCheck: $@\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.ActuatorApi()

try: 
    # Actuator web endpoint 'health'
    api_response = api_instance.health_check()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActuatorApi->healthCheck: %s\n" % e)

Parameters

Responses

Status: 200 - Service is healthy


CertificationService

checkReady

Check if CertService application is ready

Web endpoint for checking if service is ready to be used.


/ready

Usage and SDK Samples

curl -X GET "http://localhost:8080/ready"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CertificationServiceApi;

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

public class CertificationServiceApiExample {

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

public class CertificationServiceApiExample {

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

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

// Check if CertService application is ready
[apiInstance checkReadyWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CertServiceDocumentation = require('cert_service_documentation');

var api = new CertServiceDocumentation.CertificationServiceApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.checkReady(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new CertificationServiceApi();

            try
            {
                // Check if CertService application is ready
                apiInstance.checkReady();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CertificationServiceApi.checkReady: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

eval { 
    $api_instance->checkReady();
};
if ($@) {
    warn "Exception when calling CertificationServiceApi->checkReady: $@\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.CertificationServiceApi()

try: 
    # Check if CertService application is ready
    api_instance.check_ready()
except ApiException as e:
    print("Exception when calling CertificationServiceApi->checkReady: %s\n" % e)

Parameters

Responses

Status: 200 - Configuration is loaded and service is ready to use

Status: 503 - Configuration loading failed and service is unavailable


reloadConfiguration

Reload CMPv2 servers configuration from configuration file

Web endpoint for performing configuration reload. Used to reload configuration from file.


/reload

Usage and SDK Samples

curl -X GET "http://localhost:8080/reload"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CertificationServiceApi;

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

public class CertificationServiceApiExample {

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

public class CertificationServiceApiExample {

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

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

// Reload CMPv2 servers configuration from configuration file
[apiInstance reloadConfigurationWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CertServiceDocumentation = require('cert_service_documentation');

var api = new CertServiceDocumentation.CertificationServiceApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.reloadConfiguration(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new CertificationServiceApi();

            try
            {
                // Reload CMPv2 servers configuration from configuration file
                apiInstance.reloadConfiguration();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CertificationServiceApi.reloadConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

eval { 
    $api_instance->reloadConfiguration();
};
if ($@) {
    warn "Exception when calling CertificationServiceApi->reloadConfiguration: $@\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.CertificationServiceApi()

try: 
    # Reload CMPv2 servers configuration from configuration file
    api_instance.reload_configuration()
except ApiException as e:
    print("Exception when calling CertificationServiceApi->reloadConfiguration: %s\n" % e)

Parameters

Responses

Status: 200 - Configuration has been successfully reloaded

Status: 500 - Something went wrong during configuration loading


signCertificate

Sign certificate

Web endpoint for requesting certificate signing. Used by system components to gain certificate signed by CA.


/v1/certificate/{caName}

Usage and SDK Samples

curl -X GET "http://localhost:8080/v1/certificate/{caName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CertificationServiceApi;

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

public class CertificationServiceApiExample {

    public static void main(String[] args) {
        
        CertificationServiceApi apiInstance = new CertificationServiceApi();
        String caName = caName_example; // String | Name of certification authority that will sign CSR.
        String cSR = cSR_example; // String | Certificate signing request in form of PEM object encoded in Base64 (with header and footer).
        String pK = pK_example; // String | Private key in form of PEM object encoded in Base64 (with header and footer).
        try {
            CertificationModel result = apiInstance.signCertificate(caName, cSR, pK);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CertificationServiceApi#signCertificate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CertificationServiceApi;

public class CertificationServiceApiExample {

    public static void main(String[] args) {
        CertificationServiceApi apiInstance = new CertificationServiceApi();
        String caName = caName_example; // String | Name of certification authority that will sign CSR.
        String cSR = cSR_example; // String | Certificate signing request in form of PEM object encoded in Base64 (with header and footer).
        String pK = pK_example; // String | Private key in form of PEM object encoded in Base64 (with header and footer).
        try {
            CertificationModel result = apiInstance.signCertificate(caName, cSR, pK);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CertificationServiceApi#signCertificate");
            e.printStackTrace();
        }
    }
}
String *caName = caName_example; // Name of certification authority that will sign CSR.
String *cSR = cSR_example; // Certificate signing request in form of PEM object encoded in Base64 (with header and footer).
String *pK = pK_example; // Private key in form of PEM object encoded in Base64 (with header and footer).

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

// Sign certificate
[apiInstance signCertificateWith:caName
    cSR:cSR
    pK:pK
              completionHandler: ^(CertificationModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CertServiceDocumentation = require('cert_service_documentation');

var api = new CertServiceDocumentation.CertificationServiceApi()
var caName = caName_example; // {{String}} Name of certification authority that will sign CSR.
var cSR = cSR_example; // {{String}} Certificate signing request in form of PEM object encoded in Base64 (with header and footer).
var pK = pK_example; // {{String}} Private key in form of PEM object encoded in Base64 (with header and footer).

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

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

            var apiInstance = new CertificationServiceApi();
            var caName = caName_example;  // String | Name of certification authority that will sign CSR.
            var cSR = cSR_example;  // String | Certificate signing request in form of PEM object encoded in Base64 (with header and footer).
            var pK = pK_example;  // String | Private key in form of PEM object encoded in Base64 (with header and footer).

            try
            {
                // Sign certificate
                CertificationModel result = apiInstance.signCertificate(caName, cSR, pK);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CertificationServiceApi.signCertificate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCertificationServiceApi();
$caName = caName_example; // String | Name of certification authority that will sign CSR.
$cSR = cSR_example; // String | Certificate signing request in form of PEM object encoded in Base64 (with header and footer).
$pK = pK_example; // String | Private key in form of PEM object encoded in Base64 (with header and footer).

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

my $api_instance = WWW::SwaggerClient::CertificationServiceApi->new();
my $caName = caName_example; # String | Name of certification authority that will sign CSR.
my $cSR = cSR_example; # String | Certificate signing request in form of PEM object encoded in Base64 (with header and footer).
my $pK = pK_example; # String | Private key in form of PEM object encoded in Base64 (with header and footer).

eval { 
    my $result = $api_instance->signCertificate(caName => $caName, cSR => $cSR, pK => $pK);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CertificationServiceApi->signCertificate: $@\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.CertificationServiceApi()
caName = caName_example # String | Name of certification authority that will sign CSR.
cSR = cSR_example # String | Certificate signing request in form of PEM object encoded in Base64 (with header and footer).
pK = pK_example # String | Private key in form of PEM object encoded in Base64 (with header and footer).

try: 
    # Sign certificate
    api_response = api_instance.sign_certificate(caName, cSR, pK)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CertificationServiceApi->signCertificate: %s\n" % e)

Parameters

Path parameters
Name Description
caName*
String
Name of certification authority that will sign CSR.
Required
Header parameters
Name Description
CSR*
String
Certificate signing request in form of PEM object encoded in Base64 (with header and footer).
Required
PK*
String
Private key in form of PEM object encoded in Base64 (with header and footer).
Required

Responses

Status: 200 - Certificate successfully signed

Status: 400 - Given CSR or/and PK is incorrect

Status: 404 - CA not found for given name

Status: 500 - Something went wrong during connectiion to CMPv2 server