GET SSH/Widget/Stats
Retrieves data from SSH dashboard widgets that provide SSH statistics.
Requirements
- Token scope: SSH
Headers
-
Content type: Content-Type:application/json.
- Token: The bearer access token that you received. For example, Authorization:Bearer 4MyGeneratedBearerTknz==. For more information, see Passing a bearer token in your API calls.
Parameters
|
Name |
Description |
|---|---|
|
GroupBy |
The widgetthat supplies stats: Format: Show the total number of keys by SSH key format. Key Length: Show the total number of keys by key length. Algorithm: The total number of keys by key algorithm. Trusts: The range of trusted keys. |
Returns
|
Name |
Description |
|---|---|
|
Name Value Pairs |
An object containing the distinct Formats, Key Lengths, Algorithms, or Trusts and the number of matching SSH keys for each. The format is: [Stat]: [Total number of keys in this category] |
Example: 1 Show dashboard by format
Request for Example 1
GET https://tpp.venafi.example/vedsdk/SSH/Widget/Stats?GroupBy=Format Authorization:Bearer 4MyGeneratedBearerTknz==
Response for Example 1
You get the totals by SSH Key format.
HTTP/1.1 200 OK
{
"OpenSSH":109,
"SSH1":6,
"SSH2":19
}
Example 2: Show dashboard key length
Request for Example 2
GET https://tpp.venafi.example/vedsdk/SSH/Widget/Stats?GroupBy=KeyLength Authorization:Bearer 4MyGeneratedBearerTknz==
Response for Example 2
You get the totals by SSH Key length.
HTTP/1.1 200 OK
{
"768":5,
"1024":35,
"2048":35
}
Example 3: Show dashboard algorithm
Request for Example 3
GET https://tpp.venafi.example/vedsdk/SSH/Widget/Stats?GroupBy=Algorithm Authorization:Bearer 4MyGeneratedBearerTknz==
Response for Example 3
HTTP/1.1 200 OK
{
"DSA":10,
"RSA":63,
"RSA1":2
}
Example 4: Show dashboard trusts
Request for Example 4
GET https://tpp.venafi.example/vedsdk/SSH/Widget/Stats?GroupBy=Trusts Authorization:Bearer 4MyGeneratedBearerTknz==
Response for Example 4
HTTP/1.1 200 OK
{
"0Trusts":6,
"1Trust":19,
"2-5Trusts":2
}