---
title: "Get key details"
source_url: https://dev.digicert.com/certcentral-apis/discovery-api/keys/get-key-details.html
api_method: POST
api_endpoint: "/apicontroller/v1/key/getKeyDetails"
api_url: "https://daas.digicert.com/apicontroller/v1/key/getKeyDetails"
---

**POST** `https://daas.digicert.com/apicontroller/v1/key/getKeyDetails`

Use this endpoint to get information about an SSH key.

## Example requests and responses

## cURL

```bash
curl --location --request POST 'https://daas.digicert.com/apicontroller/v1/key/getKeyDetails' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw ' {
	"ip": "10.100.33.105",
	"port": 22,
	"accountId": 5153289,
	"divisionId": 678010,
	"keyName": "1573175425789f5639e63ec2766ccdd6",
	"scanName": null
}'
```

## 200 OK

```json
{
    "error": null,
    "data": {
	"securityLevel": "Not secure",
	"ip": "10.100.33.105",
	"port": 22,
	"type": "SSH",
	"supportedAuthMethods": ["gssapi-keyex", "gssapi-with-mic", "publickey"],
	"algorithm": "SSH RSA 2048",
	"protocol": "SSH2",
	"duplicates": true,
	"rotationElapsed": false,
	"firstDiscovered": 1626943436385,
        "createdDate": 1650442456390,
        "filePath":"/home/cwsadmin/19Apr2022_agent3.0/test/keycert3.pem",
        "isRootKey": false,
        "isOrphanKey": false,
        "source": "Agent",
        "lastDiscovered": 1650442456390,
        "serverHost": "19Apr2022",
        "isProtectedKey": false
	}
}
```

## Request parameters

<table class="params-table">
<thead>
<tr>
<th>Name</th>
<th>Req/Opt</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>ip</td>
<td>required</td>
<td>string</td>
<td>IP address related to the key.</td>
</tr>
<tr>
<td>port</td>
<td>required</td>
<td>integer</td>
<td>Default SSH enabled port .<br><strong>Default value</strong>: <code>22</code></td>
</tr>
<tr>
<td>accountId</td>
<td>required</td>
<td>string</td>
<td>Account ID.</td>
</tr>
<tr>
<td>divisionId</td>
<td>required</td>
<td>integer</td>
<td>Division ID.</td>
</tr>
<tr>
<td>keyName</td>
<td>required</td>
<td>string</td>
<td>Name of the key.</td>
</tr>
<tr>
<td>scanName</td>
<td>required</td>
<td>string</td>
<td>Name of the scan.</td>
</tr>
</tbody>
</table>

## Response parameters

<table class="params-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>error</td>
<td>object</td>
<td>Includes the error code, if any.</td>
</tr>
<tr>
<td>data</td>
<td>object</td>
<td>Object container for response.</td>
</tr>
<tr>
<td>.. securityLevel</td>
<td>string</td>
<td>Security status of the key.<br><strong>Possible values</strong>: <code>Secure</code>, <code>Not secure</code></td>
</tr>
<tr>
<td>.. ip</td>
<td>string</td>
<td>IP address related to the key.</td>
</tr>
<tr>
<td>.. port</td>
<td>integer</td>
<td>Most SSH configurations use the default port 22.</td>
</tr>
<tr>
<td>.. type</td>
<td>string</td>
<td>Type of the key.<br><strong>Possible values</strong>: <code>SSH</code></td>
</tr>
<tr>
<td>.. supportedAuthMethods</td>
<td>array</td>
<td>List of methods configured on your server for authenticating the SSH key.<br><strong>Possible values</strong>: <code>gssapi-keyex</code>, <code>gssapi-with-mic</code>, <code>hostbased</code>, <code>keyboard-interactive</code>, <code>password</code>, <code>publickey</code>, <code>unavailable</code></td>
</tr>
<tr>
<td>.. algorithm</td>
<td>string</td>
<td>Hashing algorithm and keysize (or length) in bits of the SSH key.<br><strong>Possible values</strong>: <code>ECDSA SHA2 NISTP256 256</code>, <code>RSA1 1024</code>, <code>RSA1 2048</code>, <code>SSH DSS 1024</code>, <code>SSH RSA 1024</code>, <code>SSH ED25519 256</code>, <code>SSH RSA 2048</code>, <code>SSH RSA 3072</code>, <code>SSH RSA 4096</code>.</td>
</tr>
<tr>
<td>… protocol</td>
<td>string</td>
<td>Protocol used to set up an encrypted connection between the systems to communicate over the internet.<br><strong>Possible values</strong>: <code>SSH1</code>, <code>SSH2</code>.</td>
</tr>
<tr>
<td>.. duplicates</td>
<td>boolean</td>
<td>If <code>true</code>, the key has duplicates, otherwise, <code>false</code>.</td>
</tr>
<tr>
<td>.. rotationElapsed</td>
<td>boolean</td>
<td>If <code>true</code>, the timeframe for rotating the key has elapsed, and the key should be replaced. Otherwise, <code>false</code>.</td>
</tr>
<tr>
<td>.. firstDiscovered</td>
<td>integer</td>
<td>Timestamp for when the key was first discovered.<br><strong>Format:</strong>epoch in millisecond.<br>Epoch corresponds to 0 hours, 0 minutes, and 0 seconds (00:00:00) Coordinated Universal Time (UTC) on a specific date, which varies from system to system.<br><strong>Example: <code>1596781119000</code></strong></td>
</tr>
<tr>
<td>.. createdDate</td>
<td>integer</td>
<td>Date and time when the key was created.<br><strong>Format:</strong>epoch in millisecond.<br><strong>Example: <code>1598299200000</code></strong></td>
</tr>
<tr>
<td>.. filePath</td>
<td>string</td>
<td>File path of the key.<br>Values are comma-separated.</td>
</tr>
<tr>
<td>.. isRootKey</td>
<td>boolean</td>
<td>Whether it is a root key.</td>
</tr>
<tr>
<td>.. isOrphanKey</td>
<td>boolean</td>
<td>Whether it is an orphan key.<br>A key is orphaned when it cannot be used further because the pair is no longer on the server.</td>
</tr>
<tr>
<td>.. source</td>
<td>string</td>
<td>The source used to identify the key.<br><strong>Possible values</strong>: <code>Agent</code>, <code>Sensor</code>.</td>
</tr>
<tr>
<td>.. lastDiscovered</td>
<td>integer</td>
<td>Date the key was last found by CertCentral Discovery scan.</td>
</tr>
<tr>
<td>.. serverHost</td>
<td>string</td>
<td>Server host associated with the key.</td>
</tr>
<tr>
<td>.. isProtectedKey</td>
<td>boolean</td>
<td>Whether it is a protected key.</td>
</tr>
</tbody>
</table>