Container Management API
{ http://soa.com/uri/products/containerservice/wsdl/1.0 } ContainerManagerService
This API is used to manage PM service containers. Containers can be registered based on metadata documents. Containers may also be modifed or removed from the system. The API also provides read/write access to container metadata and container listener configuration. Information on services hosted by a specific container can be retrieved. To add or modify services other APIs can be used.
POSTAdd Container (Form-based)
Add a container to the system using a set of form parameters.
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
ContainerName
form
The new container's name.
string
OrganizationKey
form
The organization that should contain the new container.
string
ClusterKey
form
An optional cluster key if the container should be added to a cluster.
string
ContainerDescription
form
The new container's description. Optional.
string
ContainerLocation
form
The new container's location. Optional.
string
MetadataLocation
form
The location of the container's metadata document. Either this or the metadata parameter must be provided.
string
MetadataUsername
form
Username to use to access the container's metadata document if authentication required. Used with the metadataLocation parameter.
string
MetadataPassword
form
Password to use to access the container's metadata document if authentication required. Used with the metadataLocation parameter.
string
Metadata
form
The new container's metdata as an XML form-encoded document if a location is not provided.
string
AddressOverrideBehavior
form
The new container's AddressOverrideBehavior. Optional.
string
RandomPrefixBehavior
form
The new container's RandomPrefixBehavior. Optional
string
CreateCluster
form
Indicates that the cluster should be created. Optional, default value is false.
boolean
ClusterName
form
Name of clsuter to create. Used with the CreateCluster parameter.
string
ClusterDescription
form
Description of clsuter to create. Used with the CreateCluster parameter.
string
Reponse
Produces application/xmlapplication/json
Status Code
Reason
Model
201
Created
anyType
GETGet Containers
Fetch all defined containers.
Parameters
Name
Type
Description
Model
orgKey
query
Organization holding the containers. Optional.
string
type
query
Type of containers. Optional.
string
Reponse
Produces application/xmlapplication/json
Status Code
Reason
Model
200
Success
containers
containers {
Container( Collection of anyType )
}
POSTAdd Container (Multipart-form-data)
Add a container to the system using a set of form parameters and metadata file upload as multipart/form-data.
Parameters
Accepts multipart/form-data
Name
Type
Description
Model
body
entity
base64Binary
Reponse
Produces application/xmlapplication/json
Status Code
Reason
Model
201
Created
anyType
POSTAdd a Container
Add a container.
Parameters
Accepts application/xml application/json
Name
Type
Description
Model
body
entity
The new container information.
AddContainerWithCluster
AddContainerWithCluster {
NewCluster {
Metadata {
MetadataCredentials {
ContainerDescription( string )
NewCluster( NewCluster )
MetadataLocation( anyURI )
AddressOverrideBehavior( string )
ClusterKey( string )
ContainerType( string )
Metadata( Metadata )
ContainerLocation( string )
OrganizationKey( string )
RandomPrefixBehavior( string )
ContainerName( string )
MetadataCredentials( MetadataCredentials, required )
ContainerTypeName( string )
MetadataContainerKey( string )
}
NewCluster {
ContainerDescription( string )
ContainerName( string )
}
Metadata {
any( anyType )
}
MetadataCredentials {
Username( string )
Password( string )
}
Reponse
Produces application/xmlapplication/json
Status Code
Reason
Model
201
Created
anyType
400
Invalid container data provided.
PUT/{key}Modify Container (Form-based)
Modify an existing container using a set of form parameters.
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
key
path
The container key.
string
ContainerName
form
The container's new name.
string
OrganizationKey
form
The container's new organization.
string
ContainerDescription
form
The container's new description.
string
ContainerLocation
form
The container's new location.
string
AddressOverrideBehavior
form
The new container's AddressOverrideBehavior.
string
RandomPrefixBehavior
form
The new container's RandomPrefixBehavior.
string
Reponse
Produces application/xmlapplication/json
Status Code
Reason
Model
200
Success
anyType
404
Specified container not found (Invalid container key)
POST/{key}Modify Container (Multipart-form-data)
Modifies a container to the system using a set of form parameters and metadata file upload as multipart/form-data.
Parameters
Accepts multipart/form-data
Name
Type
Description
Model
key
path
The container key.
string
body
entity
base64Binary
Reponse
Produces application/xmlapplication/json
Status Code
Reason
Model
200
Success
anyType
GET/{key}Fetch a Container
Retreive detailed information on a specific container.
Parameters
Name
Type
Description
Model
key
path
The container key.
string
Reponse
Produces application/xmlapplication/json
Status Code
Reason
Model
200
Success
anyType
404
Specified container not found (Invalid container key)
PUT/{key}Modify a Container
Modify a container.
Parameters
Accepts application/xml application/json
Name
Type
Description
Model
key
path
The container key.
string
body
entity
The updated container information.
anyType
Reponse
Produces application/xmlapplication/json
Status Code
Reason
Model
200
Success
anyType
404
Specified container not found (Invalid container key)
DELETE/{key}Delete a Container
Remove a container from the system.
Parameters
Name
Type
Description
Model
key
path
The container key.
string
Reponse
Status Code
Reason
Model
200
Success
404
Specified container not found (Invalid container key)
POST/{key}/listenersAdd Container Listener
Add a listener to a container.
Parameters
Accepts application/xml application/json
Name
Type
Description
Model
key
path
The container key.
string
body
entity
The new listener configuration.
endpoint
endpoint {
atomLink {
nameValuePair {
name( string )
description( string )
Links( Collection of atomLink )
Properties( Collection of nameValuePair )
URI( string )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI, required )
title( string )
type( string )
lang( string )
base( anyURI )
}
nameValuePair {
name( string, required )
value( string )
}
Reponse
Produces application/xmlapplication/json
Status Code
Reason
Model
200
Success
endpoint
endpoint {
atomLink {
nameValuePair {
name( string )
description( string )
Links( Collection of atomLink )
Properties( Collection of nameValuePair )
URI( string )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
nameValuePair {
name( string )
value( string )
}
404
Specified container not found (Invalid container key)
GET/{key}/listenersGet Container Listeners
Get all listeners configured for a container.
Parameters
Name
Type
Description
Model
key
path
The container key.
string
Reponse
Produces application/xmlapplication/json
Status Code
Reason
Model
200
Success
endpoints
endpoints {
endpoint {
atomLink {
nameValuePair {
Endpoint( Collection of endpoint )
}
endpoint {
name( string )
description( string )
Links( Collection of atomLink )
Properties( Collection of nameValuePair )
URI( string )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
nameValuePair {
name( string )
value( string )
}
404
Specified container not found (Invalid container key)
GET/{key}/metadataGet Container Metadata
Get a container's metadata.
Parameters
Name
Type
Description
Model
key
path
The container key.
string
Reponse
Produces application/xmlapplication/json
Status Code
Reason
Model
200
Success
ContainerMetadataType
ContainerMetadataType {
CapabilitiesType {
CapabilityType {
CapabilityOptionsType {
BootstrapConfigurationType {
CapabilityConfigParametersType {
CapabilityConfigParameterType {
X509CertificateChain {
ContainerName( string )
Capabilities( CapabilitiesType )
ContainerType( anyURI )
X509Identity( X509CertificateChain )
ContainerTypeName( string )
ContainerKey( string )
any( anyType )
}
CapabilitiesType {
Capability( Collection of CapabilityType )
}
CapabilityType {
Description( string )
CapabilityOptions( CapabilityOptionsType )
BootstrapConfiguration( BootstrapConfigurationType )
CapabilityConfigParameters( CapabilityConfigParametersType )
Id( anyURI )
any( anyType )
Name( string )
}
CapabilityOptionsType {
any( anyType )
}
BootstrapConfigurationType {
any( anyType )
}
CapabilityConfigParametersType {
ConfigParameter( Collection of CapabilityConfigParameterType )
}
CapabilityConfigParameterType {
Description( string )
minOccurs( int )
Element( QName )
maxOccurs( string )
Id( NCName )
any( anyType )
Name( string )
}
X509CertificateChain {
X509Certificate( Collection of base64Binary )
}
404
Specified container not found (Invalid container key)
POST/{cluster}/nodesAdd a Container to a Cluster (Form-Based)
Add a container to a cluster.
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
cluster
path
The cluster key.
string
ClusterNodeKey
form
The container key.
string
Reponse
Produces application/xmlapplication/json
Status Code
Reason
Model
200
Success
ClusterNodeList
ClusterNodeList {
ClusterNode {
atomLink {
ClusterNode( Collection of ClusterNode )
}
ClusterNode {
ContainerDescription( string )
ContainerName( string )
ClusterKey( string )
ContainerType( string )
ContainerLocation( string )
LastUpdated( dateTime )
ContainerKey( string )
Link( Collection of atomLink )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
404
Specified container or cluster not found (Invalid key)
POST/{cluster}/nodesAdd a Container to a Cluster
Add a container to a cluster.
Parameters
Accepts application/xml application/json
Name
Type
Description
Model
cluster
path
The cluster key.
string
container
query
The container key. Deprecated. Please use the POST body instead.
string
body
entity
List of containers to add along with the instruction to replace all nodes or just add to. Optional. Can also use the container query parameter for backwards compatibility.
AddOrReplaceClusterNodes
AddOrReplaceClusterNodes {
doReplace( boolean )
ClusterNodeKey( Collection of string )
}
Reponse
Produces application/xmlapplication/json
Status Code
Reason
Model
200
Success
ClusterNodeList
ClusterNodeList {
ClusterNode {
atomLink {
ClusterNode( Collection of ClusterNode )
}
ClusterNode {
ContainerDescription( string )
ContainerName( string )
ClusterKey( string )
ContainerType( string )
ContainerLocation( string )
LastUpdated( dateTime )
ContainerKey( string )
Link( Collection of atomLink )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
404
Specified container or cluster not found (Invalid key)
GET/{cluster}/nodesGet Cluster Nodes
Get a list of containers in a cluster.
Parameters
Name
Type
Description
Model
cluster
path
The cluster key.
string
Reponse
Produces application/xmlapplication/json
Status Code
Reason
Model
200
Success
ClusterNodeList
ClusterNodeList {
ClusterNode {
atomLink {
ClusterNode( Collection of ClusterNode )
}
ClusterNode {
ContainerDescription( string )
ContainerName( string )
ClusterKey( string )
ContainerType( string )
ContainerLocation( string )
LastUpdated( dateTime )
ContainerKey( string )
Link( Collection of atomLink )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
404
Specified container or cluster not found (Invalid key)
POST/{key}/metadataModify Container Metadata (Form-Based)
Modify a container's metadata using a set of form parameters.
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
key
path
The container key.
string
MetadataLocation
form
The container metadata location. Either this or the metadata string must be provided.
string
MetadataUsername
form
Username to use to access the container's metadata document if authentication required. Used with the metadataLocation parameter.
string
MetadataPassword
form
Password to use to access the container's metadata document if authentication required. Used with the metadataLocation parameter.
string
Metadata
form
The container metadata as an encoded XML string.
string
Reponse
Produces application/xmlapplication/json
Status Code
Reason
Model
200
Success
anyType
404
Specified container not found (Invalid container key)
POST/{key}/metadataModify Container Metadata (Multipart-form-data)
Modify a container's metadata using multipart-form-data.
Parameters
Accepts multipart/form-data
Name
Type
Description
Model
key
path
The container key.
string
body
entity
base64Binary
Reponse
Produces application/xmlapplication/json
Status Code
Reason
Model
200
Success
anyType
404
Specified container not found (Invalid container key)
PUT/{key}/metadataModify Container Metadata (Form-Based)
Modify a container's metadata.
Parameters
Accepts application/xml application/json
Name
Type
Description
Model
key
path
The container key.
string
body
entity
The container metadata.
ContainerMetadataType
ContainerMetadataType {
CapabilitiesType {
CapabilityType {
CapabilityOptionsType {
BootstrapConfigurationType {
CapabilityConfigParametersType {
CapabilityConfigParameterType {
X509CertificateChain {
ContainerName( string )
Capabilities( CapabilitiesType )
ContainerType( anyURI, required )
X509Identity( X509CertificateChain )
ContainerTypeName( string )
ContainerKey( string, required )
any( anyType )
}
CapabilitiesType {
Capability( Collection of CapabilityType )
}
CapabilityType {
Description( string )
CapabilityOptions( CapabilityOptionsType )
BootstrapConfiguration( BootstrapConfigurationType )
CapabilityConfigParameters( CapabilityConfigParametersType )
Id( anyURI, required )
any( anyType )
Name( string )
}
CapabilityOptionsType {
any( anyType )
}
BootstrapConfigurationType {
any( anyType )
}
CapabilityConfigParametersType {
ConfigParameter( Collection of CapabilityConfigParameterType )
}
CapabilityConfigParameterType {
Description( string )
minOccurs( int )
Element( QName, required )
maxOccurs( string )
Id( NCName, required )
any( anyType )
Name( string, required )
}
X509CertificateChain {
X509Certificate( Collection of base64Binary, required )
}
Reponse
Produces application/xmlapplication/json
Status Code
Reason
Model
200
Success
ContainerMetadataType
ContainerMetadataType {
CapabilitiesType {
CapabilityType {
CapabilityOptionsType {
BootstrapConfigurationType {
CapabilityConfigParametersType {
CapabilityConfigParameterType {
X509CertificateChain {
ContainerName( string )
Capabilities( CapabilitiesType )
ContainerType( anyURI )
X509Identity( X509CertificateChain )
ContainerTypeName( string )
ContainerKey( string )
any( anyType )
}
CapabilitiesType {
Capability( Collection of CapabilityType )
}
CapabilityType {
Description( string )
CapabilityOptions( CapabilityOptionsType )
BootstrapConfiguration( BootstrapConfigurationType )
CapabilityConfigParameters( CapabilityConfigParametersType )
Id( anyURI )
any( anyType )
Name( string )
}
CapabilityOptionsType {
any( anyType )
}
BootstrapConfigurationType {
any( anyType )
}
CapabilityConfigParametersType {
ConfigParameter( Collection of CapabilityConfigParameterType )
}
CapabilityConfigParameterType {
Description( string )
minOccurs( int )
Element( QName )
maxOccurs( string )
Id( NCName )
any( anyType )
Name( string )
}
X509CertificateChain {
X509Certificate( Collection of base64Binary )
}
404
Specified container not found (Invalid container key)
GET/{key}/servicesGet Container Services
Fetch all services hosted in a specified container.
Parameters
Name
Type
Description
Model
key
path
The container key.
string
Reponse
Produces application/xmlapplication/json
Status Code
Reason
Model
200
Success
hostedServices
hostedServices {
hostedService {
atomLink {
nameValuePair {
Service( Collection of hostedService )
}
hostedService {
qname( string )
organization( string )
name( string )
description( string )
Links( Collection of atomLink )
Properties( Collection of nameValuePair )
key( string )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
nameValuePair {
name( string )
value( string )
}
404
Specified container not found (Invalid container key)
DELETE/{key}/listeners/{listener}Remove a Listener
Remove a container listener.
Parameters
Name
Type
Description
Model
key
path
The container key.
string
listener
path
The listener name.
string
Reponse
Status Code
Reason
Model
200
Success
404
Specified container not found (Invalid container key) or invalid listener name
GET/{key}/pki/identityGet Container Certificate
Returns the PKI configuration (including the encoded certificate chain) used to identify a container. May return no content if no certificate is assigned. See example response for certificate chain encoding.
Request:
GET /rest/containers/uddi:978841b1-7088-11e4-8574-cb4613969888/pki/identity HTTP/1.1
Accept: application/json
Response:
HTTP/1.1 200 OK
{
"SubjectDN" : "CN=sa1, OU=Akana, O=Akana, ST=CA, C=US",
"IssuerDN" : "CN=ca, OU=Akana, O=Akana, ST=CA, C=US",
"SerialNo" : "4942932839929778611",
"EffectiveDate" : "2017-01-11-08:00",
"ExpirationDate" : "2018-01-11-08:00",
"EncodedCertChain" : "-----BEGIN CERTIFICATE-----\n... Primary Certificate bytes ...\n-----END CERTIFICATE-----\n \
-----BEGIN CERTIFICATE-----\n... Root Certificate bytes ...\n-----END CERTIFICATE-----\n"
}
Parameters
Name
Type
Description
Model
key
path
The container key.
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
POST/{key}/pki/identityModify Container Certificate (Multipart-form-data)
Modify a container's certificate using multipart-form-data.
Parameters
Accepts multipart/form-data
Name
Type
Description
Model
key
path
The container key.
string
body
entity
The certificate in .CER or .DER file format.
base64Binary
Reponse
Status Code
Reason
Model
200
Success
any
404
Specified container not found (Invalid container key)
DELETE/{cluster}/nodes/{node}Remove a Container from a Cluster
Remove a container from a cluster.
Parameters
Name
Type
Description
Model
cluster
path
The cluster key.
string
node
path
The container key.
string
Reponse
Produces application/xmlapplication/json
Status Code
Reason
Model
200
Success
ClusterNodeList
ClusterNodeList {
ClusterNode {
atomLink {
ClusterNode( Collection of ClusterNode )
}
ClusterNode {
ContainerDescription( string )
ContainerName( string )
ClusterKey( string )
ContainerType( string )
ContainerLocation( string )
LastUpdated( dateTime )
ContainerKey( string )
Link( Collection of atomLink )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
404
Specified container or cluster not found (Invalid key)
GET/{key}/listeners/{listener}Get Listener
Fetch details for a specific container listener.
Parameters
Name
Type
Description
Model
key
path
The container key.
string
listener
path
The listener name.
string
Reponse
Produces application/xmlapplication/json
Status Code
Reason
Model
200
Success
endpoint
endpoint {
atomLink {
nameValuePair {
name( string )
description( string )
Links( Collection of atomLink )
Properties( Collection of nameValuePair )
URI( string )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
nameValuePair {
name( string )
value( string )
}
404
Specified container not found (Invalid container key) or invalid listener name
PUT/{key}/listeners/{listener}Modify a Listener
Modify the configuration of a container listener.
Parameters
Accepts application/xml application/json
Name
Type
Description
Model
key
path
The container key.
string
listener
path
The listener name.
string
body
entity
The updated listener configuration.
endpoint
endpoint {
atomLink {
nameValuePair {
name( string )
description( string )
Links( Collection of atomLink )
Properties( Collection of nameValuePair )
URI( string )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI, required )
title( string )
type( string )
lang( string )
base( anyURI )
}
nameValuePair {
name( string, required )
value( string )
}
Reponse
Produces application/xmlapplication/json
Status Code
Reason
Model
200
Success
endpoint
endpoint {
atomLink {
nameValuePair {
name( string )
description( string )
Links( Collection of atomLink )
Properties( Collection of nameValuePair )
URI( string )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
nameValuePair {
name( string )
value( string )
}
404
Specified container not found (Invalid container key) or invalid listener name
POST/{key}/pki/outboundUploads outbound PKI keys and certificate for a container.
Uploads a keystore that holds outbound PKI key/cert data for a container. The following is an example request and response.
Request:
POST /rest/uddi:978841b1-7088-11e4-8574-cb4613969888/pki?alias=https1&keystorePass=changeit&aliasPass=changeit HTTP/1.1
Content-Type: multipart/form-data; boundary=Jlo6Rm_FfX2_s3WQ5QhfUoY6qqLxTbdyHMSkf0W
--Jlo6Rm_FfX2_s3WQ5QhfUoY6qqLxTbdyHMSkf0W
Content-Disposition: form-data; name="fileUpload"; filename="test.jks"
Content-Type: application/octet-stream
Content-Transfer-Encoding: binary
<File content omitted>
Response:
HTTP/1.1 201 Created if creation successful
Parameters
Accepts multipart/form-data
Name
Type
Description
Model
key
path
The container key.
string
keystorePass
query
Keystore password.
string
alias
query
Alias in the keystore to use.
string
aliasPass
query
Alias password. Can be omitted if not needed or the same as the keystore password.
string
forceTrust
query
Add to trust store if not trusted already. If false and not trusted an error will be returned. Can be omitted. Default is false.
boolean
body
entity
The uploaded file.
base64Binary
Reponse
Produces application/jsonapplication/xml
Status Code
Reason
Model
200
Success
pkiAndCertificateInfo
pkiAndCertificateInfo {
atomLink {
availablePKIManagementOptions {
certificateInfo {
privateKeyExists( boolean )
Links( Collection of atomLink )
publicKey( string )
managementOptions( availablePKIManagementOptions )
certificateInfo( certificateInfo )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
availablePKIManagementOptions {
import( boolean )
export( boolean )
delete( boolean )
assign( boolean )
}
certificateInfo {
issuerDN( string )
effectiveDate( long )
subjectDN( string )
serialNo( string )
expirationDate( long )
}
GET/{key}/pki/outboundGet Container Outbound Certificate
Returns the outbound PKI configuration including the encoded certificate chain for a container (if it exists). May return no content if no certificate is assigned. See example response for certificate chain encoding.
Request:
GET /rest/containers/uddi:978841b1-7088-11e4-8574-cb4613969888/pki/outbound HTTP/1.1
Accept: application/json
Response:
HTTP/1.1 200 OK
{
"SubjectDN" : "CN=sa1, OU=Akana, O=Akana, ST=CA, C=US",
"IssuerDN" : "CN=ca, OU=Akana, O=Akana, ST=CA, C=US",
"SerialNo" : "4942932839929778611",
"EffectiveDate" : "2017-01-11-08:00",
"ExpirationDate" : "2018-01-11-08:00",
"EncodedCertChain" : "-----BEGIN CERTIFICATE-----\n... Primary Certificate bytes ...\n-----END CERTIFICATE-----\n \
-----BEGIN CERTIFICATE-----\n... Root Certificate bytes ...\n-----END CERTIFICATE-----\n"
}
Parameters
Name
Type
Description
Model
key
path
The container key.
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/{key}/pki/identity/infoReturns the identity PKI configuration.
Parameters
Name
Type
Description
Model
key
path
The container key.
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
pkiAndCertificateInfo
pkiAndCertificateInfo {
atomLink {
availablePKIManagementOptions {
certificateInfo {
privateKeyExists( boolean )
Links( Collection of atomLink )
publicKey( string )
managementOptions( availablePKIManagementOptions )
certificateInfo( certificateInfo )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
availablePKIManagementOptions {
import( boolean )
export( boolean )
delete( boolean )
assign( boolean )
}
certificateInfo {
issuerDN( string )
effectiveDate( long )
subjectDN( string )
serialNo( string )
expirationDate( long )
}
GET/{key}/listeners/{listener}/pkiReturns the listener certificate (if any).
Returns the PKI configuration (including the encoded certificate chain) for a listener. May return no content if no certificate is assigned or applicable based on type of listener. See example response for certificate chain encoding.
Request:
GET /rest/containers/uddi:978841b1-7088-11e4-8574-cb4613969888/listeners/https1/pki HTTP/1.1
Accept: application/json
Response:
HTTP/1.1 200 OK
{
"SubjectDN" : "CN=listener1, OU=Akana, O=Akana, ST=CA, C=US",
"IssuerDN" : "CN=ca, OU=Akana, O=Akana, ST=CA, C=US",
"SerialNo" : "4942932839929778611",
"EffectiveDate" : "2017-01-11-08:00",
"ExpirationDate" : "2018-01-11-08:00",
"EncodedCertChain" : "-----BEGIN CERTIFICATE-----\n... Primary Certificate bytes ...\n-----END CERTIFICATE-----\n \
-----BEGIN CERTIFICATE-----\n... Root Certificate bytes ...\n-----END CERTIFICATE-----\n"
}
Parameters
Name
Type
Description
Model
key
path
The container key.
string
listener
path
The listener name.
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
string
POST/{key}/listeners/{listener}/pkiUploads PKI keys and certificate for a listener.
Uploads a keystore that holds PKI key/cert data for a listener. The following is an example request and response.
Request:
POST /rest/uddi:978841b1-7088-11e4-8574-cb4613969888/listeners/https1?alias=https1&keystorePass=changeit&aliasPass=changeit HTTP/1.1
Content-Type: multipart/form-data; boundary=Jlo6Rm_FfX2_s3WQ5QhfUoY6qqLxTbdyHMSkf0W
--Jlo6Rm_FfX2_s3WQ5QhfUoY6qqLxTbdyHMSkf0W
Content-Disposition: form-data; name="fileUpload"; filename="test.jks"
Content-Type: application/octet-stream
Content-Transfer-Encoding: binary
<File content omitted>
Response:
HTTP/1.1 201 Created if creation successful
{
"Endpoint" : <Endpoint structure for listener>
}
Parameters
Accepts multipart/form-data
Name
Type
Description
Model
key
path
The container key.
string
listener
path
The listener name.
string
keystorePass
query
Keystore password.
string
alias
query
Alias in the keystore to use.
string
aliasPass
query
Alias password. Can be omitted if not needed or the same as the keystore password.
string
forceTrust
query
Add to trust store if not trusted already. If false and not trusted an error will be returned. Can be omitted. Default is false.
boolean
body
entity
The uploaded file.
base64Binary
Reponse
Produces application/jsonapplication/xml
Status Code
Reason
Model
200
Success
pkiAndCertificateInfo
pkiAndCertificateInfo {
atomLink {
availablePKIManagementOptions {
certificateInfo {
privateKeyExists( boolean )
Links( Collection of atomLink )
publicKey( string )
managementOptions( availablePKIManagementOptions )
certificateInfo( certificateInfo )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
availablePKIManagementOptions {
import( boolean )
export( boolean )
delete( boolean )
assign( boolean )
}
certificateInfo {
issuerDN( string )
effectiveDate( long )
subjectDN( string )
serialNo( string )
expirationDate( long )
}
POST/{key}/listeners/{listener}/pkiAdd PKI keys and certificate for a listener.
Parameters
Accepts application/json
Name
Type
Description
Model
forceTrust
query
Add to trust store if not trusted already
boolean
key
path
The container key.
string
listener
path
The listener name.
string
body
entity
The PKI data.
pkiSpec
pkiSpec {
aliasPassword( string )
privateKey( string )
external( boolean, required )
certificateChain( string )
alias( string )
algorithm( string )
}
Reponse
Produces application/jsonapplication/xml
Status Code
Reason
Model
200
Success
pkiAndCertificateInfo
pkiAndCertificateInfo {
atomLink {
availablePKIManagementOptions {
certificateInfo {
privateKeyExists( boolean )
Links( Collection of atomLink )
publicKey( string )
managementOptions( availablePKIManagementOptions )
certificateInfo( certificateInfo )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
availablePKIManagementOptions {
import( boolean )
export( boolean )
delete( boolean )
assign( boolean )
}
certificateInfo {
issuerDN( string )
effectiveDate( long )
subjectDN( string )
serialNo( string )
expirationDate( long )
}
GET/{key}/pki/outbound/infoReturns the outbound PKI configuration.
Parameters
Name
Type
Description
Model
key
path
The container key.
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
pkiAndCertificateInfo
pkiAndCertificateInfo {
atomLink {
availablePKIManagementOptions {
certificateInfo {
privateKeyExists( boolean )
Links( Collection of atomLink )
publicKey( string )
managementOptions( availablePKIManagementOptions )
certificateInfo( certificateInfo )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
availablePKIManagementOptions {
import( boolean )
export( boolean )
delete( boolean )
assign( boolean )
}
certificateInfo {
issuerDN( string )
effectiveDate( long )
subjectDN( string )
serialNo( string )
expirationDate( long )
}
GET/{key}/listeners/{listener}/pki/infoReturns the listener PKI configuration (if any).
Parameters
Name
Type
Description
Model
key
path
The container key.
string
listener
path
The listener name.
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
pkiAndCertificateInfo
pkiAndCertificateInfo {
atomLink {
availablePKIManagementOptions {
certificateInfo {
privateKeyExists( boolean )
Links( Collection of atomLink )
publicKey( string )
managementOptions( availablePKIManagementOptions )
certificateInfo( certificateInfo )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
availablePKIManagementOptions {
import( boolean )
export( boolean )
delete( boolean )
assign( boolean )
}
certificateInfo {
issuerDN( string )
effectiveDate( long )
subjectDN( string )
serialNo( string )
expirationDate( long )
}
