Key filter

  2 minute read  

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

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"
}'

200 OK

{
    "error": null,
    "data": {
		"filterName": "authenticationMethods",
		"displayName": "Authentication method",
		"values": ["gssapi-keyex", "gssapi-with-mic", "hostbased", "keyboard-interactive", "password", "publickey", "unavailable"]
	}
}

Request parameters

NameReq/OptTypeDescription
accountIdrequiredstringAccount ID.
searchCriteriaListoptionalarrayFilter results by specified values. The array includes key, operation and value. For definitions, see the Filter options for searchCriteriaList table below.
Example:
divisionIdsrequiredarrayUser’s division IDs.
startIndexoptionalintegerIndex of the first result.
Default: 1
pageSizeoptionalintegerNumber of records per page.
Allowed values: 0 to 512
Default: 50
filterSelectedrequiredstringThe 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.
sortedColumnIdoptionalstringSort results by specified parameter.
Allowed values: serialNumber, ip, port, scanName, serverSecurity, isCertPresent, cn
Default: isCertPresent
sortOrderoptionalstringSort direction.
Allowed values: DESC (descending: 9-0, Z-A), ASC (ascending: 0-9, A-Z)
Default: DESC

Response parameters

NameTypeDescription
errorobjectIncludes error codes, if any.
dataobjectObject with information about the filter results.
.. filterNamestringSpecified filter key.
.. displayNamestringFriendly name of the filter key as it appears in the UI.
.. valuesarrayList 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.

KeyOperationValue
keyNameEQUALSKey name
ipEQUALSIP address
portEQUALS22
authenticationMethodsEQUALSgssapi-keyex, gssapi-with-mic, hostbased., keyboard-interactive, password, publickey, unavailable
duplicateKeysEQUALSNo, Yes
typeEQUALSSSH
rotationLimitEQUALS6 months, 9 months1 year, 2 years.
keyAlgorithmEQUALSECDSA 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.
protocolEQUALSSSH1, SSH2
scanNameEQUALSScan name