REST API Guide

10.2
- 10.5.3
- 10.5.0
- 10.4.0
- 10.2.3
- 10.2.2 HotFix 1
- 10.2.2
- 10.2.1

Back Next

Certificate Details REST API

Use the Certificate Details REST API to obtain the following Informatica Managed File Transfer information:

list of certificates

list of private key aliases available in the private keys key store

list of all trusted certificate aliases available in the trusted-certificates key store

list of all SSH private keys available in the SSH key manager

list of SSH keys with RSA or DSA encryption

This API uses the POST method.

Use the following URL for the REST API call:

POST http://<hostName>:<portNumber>/informaticamft/api/v1/certificates/search

is the host name or IP address of the Managed File Transfer server.

is the port number of the Managed File Transfer server. The default port for HTTP is 8000 and the default port for HTTPS is 8002, for example,

http://myserver:8000

https://myserver:8002

To receive a list of certificates, include a request body. To specify which type of list you want to receive, provide a request body in JSON to the REST API call. The following table describes the request body objects:

Object	Arguments
keyStoreType	The type of keystore to search. The following options apply: X509PRIVATEKEY : List of private key aliases available in the private keys key store. X509CERTIFICATE : List of all trusted certificate aliases available in the trusted-certificates key store. SSH_PRIVATE_KEY : List of SSH private keys.
algorithm	The type of information to search for. The following options apply: A : List of all SSH private keys available in the SSH key manager R : List of SSH keys with RSA encryption D : List of SSH keys with DSA encryption

The following table describes the response body objects:

Object	Arguments
id	The identifying number of the certificate or key.
name	The name of the certificate or key.
privateKey	Identifies if the object is a private key.
size	The size of the certificate or key.
type	Identifies the type of object.
alias	The alias of the certificate or key.
subject	The subject of the certificate or key.
issuer	The issuer of the certificate or key.
fingerprint	The fingerprint of the certificate or key.

Request Body Examples

The following code shows the request body syntax to obtain a list of private key aliases available in the private keys key store:

{   
   "keyStoreType":"X509PRIVATEKEY"
}

The following code shows the request body syntax to obtain a list of all trusted certificate aliases available in the trusted-certificates key store:

{   
   "keyStoreType":"X509CERTIFICATE"
}

The following code shows the request body syntax to obtain a list of all SSH private keys available in the SSH key manager:

{   
   "keyStoreType":"SSH_PRIVATE_KEY",
   "algorithm":"A"
}

The following code shows the request body syntax to obtain a list of SSH keys with RSA or DSA encryption:

{   
   "keyStoreType":"SSH_PRIVATE_KEY",
   "algorithm":"R"
}

Response Body Examples

The following code shows the response body syntax with a list of all SSH private keys available in the SSH key manager:

[   
   {   
      "id":1011,
      "name":"sshkey",
      "privateKey":false,
      "algorithm":"R",
      "size":1024,
      "fingerprint":"28:04:E7:76:05:EA:64:CD:F3:88:E3:35:04:A2:21:AF"
   },
   {   
      "id":1013,
      "name":"DSAKey",
      "privateKey":false,
      "algorithm":"D",
      "size":1024,
      "fingerprint":"4A:B6:03:23:88:BD:AC:82:52:8F:B3:D2:10:82:31:CC"
   }
]

The following code shows the response body syntax with a list of SSH keys with RSA or DSA encryption:

[   
   {   
      "id":1011,
      "name":"sshkey",
      "privateKey":false,
      "algorithm":"R",
      "size":1024,
      "fingerprint":"28:04:E7:76:05:EA:64:CD:F3:88:E3:35:04:A2:21:AF"
   }
]

Rename Saved Search

Table of Contents

REST API Guide

REST API Guide

Certificate Details REST API

Certificate Details REST API

Request Body Examples

Response Body Examples