Search encryption keys

get

https://{host}/platform/tenantdata/v1/encryption-keys

Returns a list of encryption keys.

A VPN encryption key defines shared secret between the tenant and the Intelligent Risk Platform. The VPN encryption key enables on-premise SQL Server instances on the tenant's network to connect to the tenant's Data Bridge cluster via a VPN connection.

This operation supports response filtering based on property values. Depending on the property, you may use a combination of comparison operators, list operators, and logical operators. See Response-Filtering.

To perform this operation, the client must belong to a group that has been assigned the Admin or Data Bridge Admin role.

🪰
Entitlements
IC-VPN

Query Params

query

string

Query string to select response data based on property values.

Depending on the property, supports comparison operators and logical operators.

Property	Type	Comparison	List
`createdAt`	Timestamp	`=`, `!=`, `<`, `>`, `<=`, `>=`
`createdBy`	Timestamp	`=`, `!=`	`IN`, `NOT IN`, `LIKE`, `NOT LIKE`
`encryptionKeyName`	String	`=`, `!=`	`IN`, `NOT IN`, `LIKE`, `NOT LIKE`
`encryptionKeySubType`	String	`=`, `!=`	`IN`, `NOT IN`
`encryptionKeyType`	String	`=`, `!=`	`IN`, `NOT IN`
`expirationDate`	Timestamp	`=`, `!=`, `<`, `>`, `<=`, `>=`
`id`	Number	`=`, `!=`, `<`, `>`, `<=`, `>=`	`IN`, `NOT IN`
`startDate`	Timestamp	`=`, `!=`, `<`, `>`, `<=`, `>=`
`status`	String	`=`, `!=`	`IN`, `NOT IN`
`tenantId`	String	`=`, `!=`	`IN`, `NOT IN`

All properties support the AND logical operator, e.g. encryptionKType="VPN" AND status="IN-USE". To learn more, see Response Filtering.

sort

string

Comma-delimited list of properties. Sort order defined by one of ASC (ascending) or DESC (descending).

limit

int32

≤ 1000

Defaults to 100

Number of records returned per page. See Response Pagination.

offset

int32

Defaults to 0

Number of page displaying the returned records.

Responses

🪰Entitlements

200Success

400Bad Request

401Unauthorized

403Forbidden: Access to resource is denied. Client is not authorized to perform the View Encryption Keys action.

500Internal Server Error

🪰
Entitlements