Returns a zip archive of YAML files.
curl -X GET "https://localhost/ejbca/ejbca-rest-api/v1/configdump/configdump.zip?ignoreerrors=&defaults=&externalcas=&include=&exclude="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.V1configdumpApi;
import java.io.File;
import java.util.*;
public class V1configdumpApiExample {
public static void main(String[] args) {
V1configdumpApi apiInstance = new V1configdumpApi();
Boolean ignoreerrors = true; // Boolean | Print a warning instead of aborting and throwing an exception on errors.
Boolean defaults = true; // Boolean | Also include fields having the default value.
Boolean externalcas = true; // Boolean | Enables export of external CAs (i.e. CAs where there's only a certificate and nothing else)
array[String] include = ; // array[String] | Names of items/types to include in the export. The syntax is identical to that of exclude. For items of types that aren't listed, everything is included.
array[String] exclude = ; // array[String] | Names of items/types to exclude in the export, separated by semicolon. Type and name is separated by a colon, and wildcards "\*" are allowed. Both are case-insensitive. E.g. exclude="\*:Example CA;cryptotoken:Example\*;systemconfiguration:\*".
Supported types are: ACMECONFIG/acme-config, AUTOENROLLMENTCONFIG/autoenrollment-config, CA/certification-authorities, CRYPTOTOKEN/crypto-tokens, PUBLISHER/publishers, APPROVALPROFILE/approval-profiles, CERTPROFILE/certificate-profiles, EEPROFILE/end-entity-profiles, SERVICE/services, ROLE/admin-roles, KEYBINDING/internal-key-bindings, ADMINPREFS/admin-preferences, OCSPCONFIG/ocsp-configuration, PEERCONNECTOR/peer-connectors, SCEPCONFIG/scep-config, CMPCONFIG/cmp-config, ESTCONFIG/est-config, VALIDATOR/validators, CTLOG/ct-logs, EXTENDEDKEYUSAGE/extended-key-usage, CERTEXTENSION/custom-certificate-extensions, OAUTHKEY/trusted-oauth-providers, AVAILABLEPROTOCOLS/available-protocols
try {
array[byte[]] result = apiInstance.getZipExport(ignoreerrors, defaults, externalcas, include, exclude);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling V1configdumpApi#getZipExport");
e.printStackTrace();
}
}
}
import io.swagger.client.api.V1configdumpApi;
public class V1configdumpApiExample {
public static void main(String[] args) {
V1configdumpApi apiInstance = new V1configdumpApi();
Boolean ignoreerrors = true; // Boolean | Print a warning instead of aborting and throwing an exception on errors.
Boolean defaults = true; // Boolean | Also include fields having the default value.
Boolean externalcas = true; // Boolean | Enables export of external CAs (i.e. CAs where there's only a certificate and nothing else)
array[String] include = ; // array[String] | Names of items/types to include in the export. The syntax is identical to that of exclude. For items of types that aren't listed, everything is included.
array[String] exclude = ; // array[String] | Names of items/types to exclude in the export, separated by semicolon. Type and name is separated by a colon, and wildcards "\*" are allowed. Both are case-insensitive. E.g. exclude="\*:Example CA;cryptotoken:Example\*;systemconfiguration:\*".
Supported types are: ACMECONFIG/acme-config, AUTOENROLLMENTCONFIG/autoenrollment-config, CA/certification-authorities, CRYPTOTOKEN/crypto-tokens, PUBLISHER/publishers, APPROVALPROFILE/approval-profiles, CERTPROFILE/certificate-profiles, EEPROFILE/end-entity-profiles, SERVICE/services, ROLE/admin-roles, KEYBINDING/internal-key-bindings, ADMINPREFS/admin-preferences, OCSPCONFIG/ocsp-configuration, PEERCONNECTOR/peer-connectors, SCEPCONFIG/scep-config, CMPCONFIG/cmp-config, ESTCONFIG/est-config, VALIDATOR/validators, CTLOG/ct-logs, EXTENDEDKEYUSAGE/extended-key-usage, CERTEXTENSION/custom-certificate-extensions, OAUTHKEY/trusted-oauth-providers, AVAILABLEPROTOCOLS/available-protocols
try {
array[byte[]] result = apiInstance.getZipExport(ignoreerrors, defaults, externalcas, include, exclude);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling V1configdumpApi#getZipExport");
e.printStackTrace();
}
}
}
Boolean *ignoreerrors = true; // Print a warning instead of aborting and throwing an exception on errors. (optional) (default to false)
Boolean *defaults = true; // Also include fields having the default value. (optional) (default to false)
Boolean *externalcas = true; // Enables export of external CAs (i.e. CAs where there's only a certificate and nothing else) (optional) (default to false)
array[String] *include = ; // Names of items/types to include in the export. The syntax is identical to that of exclude. For items of types that aren't listed, everything is included. (optional)
array[String] *exclude = ; // Names of items/types to exclude in the export, separated by semicolon. Type and name is separated by a colon, and wildcards "\*" are allowed. Both are case-insensitive. E.g. exclude="\*:Example CA;cryptotoken:Example\*;systemconfiguration:\*".
Supported types are: ACMECONFIG/acme-config, AUTOENROLLMENTCONFIG/autoenrollment-config, CA/certification-authorities, CRYPTOTOKEN/crypto-tokens, PUBLISHER/publishers, APPROVALPROFILE/approval-profiles, CERTPROFILE/certificate-profiles, EEPROFILE/end-entity-profiles, SERVICE/services, ROLE/admin-roles, KEYBINDING/internal-key-bindings, ADMINPREFS/admin-preferences, OCSPCONFIG/ocsp-configuration, PEERCONNECTOR/peer-connectors, SCEPCONFIG/scep-config, CMPCONFIG/cmp-config, ESTCONFIG/est-config, VALIDATOR/validators, CTLOG/ct-logs, EXTENDEDKEYUSAGE/extended-key-usage, CERTEXTENSION/custom-certificate-extensions, OAUTHKEY/trusted-oauth-providers, AVAILABLEPROTOCOLS/available-protocols (optional)
V1configdumpApi *apiInstance = [[V1configdumpApi alloc] init];
// Get the configuration as a ZIP file.
[apiInstance getZipExportWith:ignoreerrors
defaults:defaults
externalcas:externalcas
include:include
exclude:exclude
completionHandler: ^(array[byte[]] output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var EjbcaRestInterface = require('ejbca_rest_interface');
var api = new EjbcaRestInterface.V1configdumpApi()
var opts = {
'ignoreerrors': true, // {Boolean} Print a warning instead of aborting and throwing an exception on errors.
'defaults': true, // {Boolean} Also include fields having the default value.
'externalcas': true, // {Boolean} Enables export of external CAs (i.e. CAs where there's only a certificate and nothing else)
'include': , // {array[String]} Names of items/types to include in the export. The syntax is identical to that of exclude. For items of types that aren't listed, everything is included.
'exclude': // {array[String]} Names of items/types to exclude in the export, separated by semicolon. Type and name is separated by a colon, and wildcards "\*" are allowed. Both are case-insensitive. E.g. exclude="\*:Example CA;cryptotoken:Example\*;systemconfiguration:\*".
Supported types are: ACMECONFIG/acme-config, AUTOENROLLMENTCONFIG/autoenrollment-config, CA/certification-authorities, CRYPTOTOKEN/crypto-tokens, PUBLISHER/publishers, APPROVALPROFILE/approval-profiles, CERTPROFILE/certificate-profiles, EEPROFILE/end-entity-profiles, SERVICE/services, ROLE/admin-roles, KEYBINDING/internal-key-bindings, ADMINPREFS/admin-preferences, OCSPCONFIG/ocsp-configuration, PEERCONNECTOR/peer-connectors, SCEPCONFIG/scep-config, CMPCONFIG/cmp-config, ESTCONFIG/est-config, VALIDATOR/validators, CTLOG/ct-logs, EXTENDEDKEYUSAGE/extended-key-usage, CERTEXTENSION/custom-certificate-extensions, OAUTHKEY/trusted-oauth-providers, AVAILABLEPROTOCOLS/available-protocols
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getZipExport(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class getZipExportExample
{
public void main()
{
var apiInstance = new V1configdumpApi();
var ignoreerrors = true; // Boolean | Print a warning instead of aborting and throwing an exception on errors. (optional) (default to false)
var defaults = true; // Boolean | Also include fields having the default value. (optional) (default to false)
var externalcas = true; // Boolean | Enables export of external CAs (i.e. CAs where there's only a certificate and nothing else) (optional) (default to false)
var include = new array[String](); // array[String] | Names of items/types to include in the export. The syntax is identical to that of exclude. For items of types that aren't listed, everything is included. (optional)
var exclude = new array[String](); // array[String] | Names of items/types to exclude in the export, separated by semicolon. Type and name is separated by a colon, and wildcards "\*" are allowed. Both are case-insensitive. E.g. exclude="\*:Example CA;cryptotoken:Example\*;systemconfiguration:\*".
Supported types are: ACMECONFIG/acme-config, AUTOENROLLMENTCONFIG/autoenrollment-config, CA/certification-authorities, CRYPTOTOKEN/crypto-tokens, PUBLISHER/publishers, APPROVALPROFILE/approval-profiles, CERTPROFILE/certificate-profiles, EEPROFILE/end-entity-profiles, SERVICE/services, ROLE/admin-roles, KEYBINDING/internal-key-bindings, ADMINPREFS/admin-preferences, OCSPCONFIG/ocsp-configuration, PEERCONNECTOR/peer-connectors, SCEPCONFIG/scep-config, CMPCONFIG/cmp-config, ESTCONFIG/est-config, VALIDATOR/validators, CTLOG/ct-logs, EXTENDEDKEYUSAGE/extended-key-usage, CERTEXTENSION/custom-certificate-extensions, OAUTHKEY/trusted-oauth-providers, AVAILABLEPROTOCOLS/available-protocols (optional)
try
{
// Get the configuration as a ZIP file.
array[byte[]] result = apiInstance.getZipExport(ignoreerrors, defaults, externalcas, include, exclude);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling V1configdumpApi.getZipExport: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\V1configdumpApi();
$ignoreerrors = true; // Boolean | Print a warning instead of aborting and throwing an exception on errors.
$defaults = true; // Boolean | Also include fields having the default value.
$externalcas = true; // Boolean | Enables export of external CAs (i.e. CAs where there's only a certificate and nothing else)
$include = ; // array[String] | Names of items/types to include in the export. The syntax is identical to that of exclude. For items of types that aren't listed, everything is included.
$exclude = ; // array[String] | Names of items/types to exclude in the export, separated by semicolon. Type and name is separated by a colon, and wildcards "\*" are allowed. Both are case-insensitive. E.g. exclude="\*:Example CA;cryptotoken:Example\*;systemconfiguration:\*".
Supported types are: ACMECONFIG/acme-config, AUTOENROLLMENTCONFIG/autoenrollment-config, CA/certification-authorities, CRYPTOTOKEN/crypto-tokens, PUBLISHER/publishers, APPROVALPROFILE/approval-profiles, CERTPROFILE/certificate-profiles, EEPROFILE/end-entity-profiles, SERVICE/services, ROLE/admin-roles, KEYBINDING/internal-key-bindings, ADMINPREFS/admin-preferences, OCSPCONFIG/ocsp-configuration, PEERCONNECTOR/peer-connectors, SCEPCONFIG/scep-config, CMPCONFIG/cmp-config, ESTCONFIG/est-config, VALIDATOR/validators, CTLOG/ct-logs, EXTENDEDKEYUSAGE/extended-key-usage, CERTEXTENSION/custom-certificate-extensions, OAUTHKEY/trusted-oauth-providers, AVAILABLEPROTOCOLS/available-protocols
try {
$result = $api_instance->getZipExport($ignoreerrors, $defaults, $externalcas, $include, $exclude);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling V1configdumpApi->getZipExport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::V1configdumpApi;
my $api_instance = WWW::SwaggerClient::V1configdumpApi->new();
my $ignoreerrors = true; # Boolean | Print a warning instead of aborting and throwing an exception on errors.
my $defaults = true; # Boolean | Also include fields having the default value.
my $externalcas = true; # Boolean | Enables export of external CAs (i.e. CAs where there's only a certificate and nothing else)
my $include = []; # array[String] | Names of items/types to include in the export. The syntax is identical to that of exclude. For items of types that aren't listed, everything is included.
my $exclude = []; # array[String] | Names of items/types to exclude in the export, separated by semicolon. Type and name is separated by a colon, and wildcards "\*" are allowed. Both are case-insensitive. E.g. exclude="\*:Example CA;cryptotoken:Example\*;systemconfiguration:\*".
Supported types are: ACMECONFIG/acme-config, AUTOENROLLMENTCONFIG/autoenrollment-config, CA/certification-authorities, CRYPTOTOKEN/crypto-tokens, PUBLISHER/publishers, APPROVALPROFILE/approval-profiles, CERTPROFILE/certificate-profiles, EEPROFILE/end-entity-profiles, SERVICE/services, ROLE/admin-roles, KEYBINDING/internal-key-bindings, ADMINPREFS/admin-preferences, OCSPCONFIG/ocsp-configuration, PEERCONNECTOR/peer-connectors, SCEPCONFIG/scep-config, CMPCONFIG/cmp-config, ESTCONFIG/est-config, VALIDATOR/validators, CTLOG/ct-logs, EXTENDEDKEYUSAGE/extended-key-usage, CERTEXTENSION/custom-certificate-extensions, OAUTHKEY/trusted-oauth-providers, AVAILABLEPROTOCOLS/available-protocols
eval {
my $result = $api_instance->getZipExport(ignoreerrors => $ignoreerrors, defaults => $defaults, externalcas => $externalcas, include => $include, exclude => $exclude);
print Dumper($result);
};
if ($@) {
warn "Exception when calling V1configdumpApi->getZipExport: $@\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.V1configdumpApi()
ignoreerrors = true # Boolean | Print a warning instead of aborting and throwing an exception on errors. (optional) (default to false)
defaults = true # Boolean | Also include fields having the default value. (optional) (default to false)
externalcas = true # Boolean | Enables export of external CAs (i.e. CAs where there's only a certificate and nothing else) (optional) (default to false)
include = # array[String] | Names of items/types to include in the export. The syntax is identical to that of exclude. For items of types that aren't listed, everything is included. (optional)
exclude = # array[String] | Names of items/types to exclude in the export, separated by semicolon. Type and name is separated by a colon, and wildcards "\*" are allowed. Both are case-insensitive. E.g. exclude="\*:Example CA;cryptotoken:Example\*;systemconfiguration:\*".
Supported types are: ACMECONFIG/acme-config, AUTOENROLLMENTCONFIG/autoenrollment-config, CA/certification-authorities, CRYPTOTOKEN/crypto-tokens, PUBLISHER/publishers, APPROVALPROFILE/approval-profiles, CERTPROFILE/certificate-profiles, EEPROFILE/end-entity-profiles, SERVICE/services, ROLE/admin-roles, KEYBINDING/internal-key-bindings, ADMINPREFS/admin-preferences, OCSPCONFIG/ocsp-configuration, PEERCONNECTOR/peer-connectors, SCEPCONFIG/scep-config, CMPCONFIG/cmp-config, ESTCONFIG/est-config, VALIDATOR/validators, CTLOG/ct-logs, EXTENDEDKEYUSAGE/extended-key-usage, CERTEXTENSION/custom-certificate-extensions, OAUTHKEY/trusted-oauth-providers, AVAILABLEPROTOCOLS/available-protocols (optional)
try:
# Get the configuration as a ZIP file.
api_response = api_instance.get_zip_export(ignoreerrors=ignoreerrors, defaults=defaults, externalcas=externalcas, include=include, exclude=exclude)
pprint(api_response)
except ApiException as e:
print("Exception when calling V1configdumpApi->getZipExport: %s\n" % e)