Skip to main content

Key filter

POST https://daas.digicert.com/apicontroller/v1/key/filter

Use this endpoint to get a list of SSH key filters based on the selected filter criteria. This endpoint Is helpful when you wish to filter out the keys based on filter criteria available. While the Key list endpoint helps you get the entire list of keys available, the key filter endpoint allows you to narrow down the list of keys based on selected filter criteria available.

Example requests and responses

Example 1. cURL
curl --location --request POST ' https://daas.digicert.com/apicontroller/v1/key/filter' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
	"accountId": 5153289,
	"searchCriteriaList": [],
	"divisionIds": [],
	"startIndex": 1,
	"pageSize": 50,
	"filterSelected": "authenticationMethods",
	"sortedColumnId": "ip",
	"sortOrder": "ASC"
}'

Request parameters

Name

Req/Opt

Type

Description

accountId

required

string

Account ID.

searchCriteriaList

optional

array

Filter results by specified values. The array includes key, operation and value. For definitions, see the Filter options for searchCriteriaList table below.

Example:

searchCriteriaList:[
  {
    "key":"duplicateKeys",
    "operation":"EQUALS",
    "value":["Yes"]
  }
]

divisionIds

required

array

User's division IDs.

startIndex

optional

integer

Index of the first result.

Default: 1

pageSize

optional

integer

Number of records per page.

Allowed values: 0 to 512

Default: 50

filterSelected

required

string

The value to show in the results for each sensor that meets the search criteria.

Allowed values: name, ip, port, type, scanName, authenticationMethods, keyAlgorithm, protocol, duplicateKeys.

sortedColumnId

optional

string

Sort results by specified parameter.

Allowed values: serialNumber, ip, port, scanName, serverSecurity, isCertPresent, cn

Default: isCertPresent

sortOrder

optional

string

Sort direction.

Allowed values: DESC (descending: 9-0, Z-A), ASC (ascending: 0-9, A-Z)

Default: DESC

Response parameters

Name

Type

Description

error

object

Includes error codes, if any.

data

object

Object with information about the filter results.

.. filterName

string

Specified filter key.

.. displayName

string

Friendly name of the filter key as it appears in the UI.

.. values

array

List of sensors that meet the search criteria. The value shown for each sensor is the value set for the filterSelected parameter in the request body.

Filter options for searchCriteriaList

The array includes key, operation and value.

Key

Operation

Value

keyName

EQUALS

Key name

ip

EQUALS

IP address

port

EQUALS

22

authenticationMethods

EQUALS

gssapi-keyex, gssapi-with-mic, hostbased., keyboard-interactive, password, publickey, unavailable

duplicateKeys

EQUALS

No, Yes

type

EQUALS

SSH

rotationLimit

EQUALS

6 months, 9 months1 year, 2 years.

keyAlgorithm

EQUALS

ECDSA SHA2 NISTP256 256, RSA1 1024, RSA1 2048, SSH DSS 1024, SSH RSA 1024, SSH ED25519 256, SSH RSA 2048, SSH RSA 3072, SSH RSA 4096.

protocol

EQUALS

SSH1, SSH2

scanName

EQUALS

Scan name

In this section: