encryption_keys

Creates, updates, deletes, gets or lists an encryption_keys resource.

Overview

Name	encryption_keys
Type	Resource
Id	nvidia.private_registry.encryption_keys

Fields

The following fields are returned by SELECT queries:

get_by_team

Name	Datatype	Description
name	string	Name of the artifact
display_name	string	Display name of the artifact (wire: displayName)
artifact_type	string	Artifact type (MODEL, MODEL_SCRIPT, HELM_CHART, REPOSITORY, COLLECTION, ENDPOINT, BLUEPRINT, PLAYBOOK, AGENT, API, SKILL) (wire: artifactType)
description	string	Description of the artifact

get

Name	Datatype	Description
name	string	Name of the artifact
display_name	string	Display name of the artifact (wire: displayName)
artifact_type	string	Artifact type (MODEL, MODEL_SCRIPT, HELM_CHART, REPOSITORY, COLLECTION, ENDPOINT, BLUEPRINT, PLAYBOOK, AGENT, API, SKILL) (wire: artifactType)
description	string	Description of the artifact

list_by_team

Name	Datatype	Description
encryption_key_id	string (regex)	The encryption key identifier in UUID format. (example: 196afcf4-d6c8-4116-aa25-34a718a14f43, pattern: <code>^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>) (wire: encryptionKeyId)
created	string (regex)	The creation timestamp of the key item in ISO-8601 format. Format: YYYY-MM-DDTHH:mm:ss.sssZ. (example: 2025-04-19T22:30:00.123Z, pattern: <code>\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d.\d+Z</code>)
description	string	Description of the encryption key

list

Name	Datatype	Description
encryption_key_id	string (regex)	The encryption key identifier in UUID format. (example: 196afcf4-d6c8-4116-aa25-34a718a14f43, pattern: <code>^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>) (wire: encryptionKeyId)
created	string (regex)	The creation timestamp of the key item in ISO-8601 format. Format: YYYY-MM-DDTHH:mm:ss.sssZ. (example: 2025-04-19T22:30:00.123Z, pattern: <code>\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d.\d+Z</code>)
description	string	Description of the encryption key

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_team	select	team_name, key_id	artifact_type	List artifacts for encryption key in org/team
get	select	key_id	artifact_type	List artifacts for encryption key in org
list_by_team	select	team_name		List encryption keys in org/team
list	select			List encryption keys in org
delete_by_team	delete	team_name, key_id		Revoke encryption key and disassociate from all artifacts in org/team
delete	delete	key_id		Revoke encryption key and disassociate from all artifacts in org

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
key_id	string (UTF-8)	Key ID
team_name	string (UTF-8)	Team name
artifact_type	string (UTF-8)	Artifact type
artifact_type	string (UTF-8)	Artifact type (wire: artifactType)

SELECT examples

get_by_team

List artifacts for encryption key in org/team

SELECT
name,
display_name,
artifact_type,
description
FROM nvidia.private_registry.encryption_keys
WHERE team_name = '{{ team_name }}' -- required
AND key_id = '{{ key_id }}' -- required
AND artifact_type = '{{ artifact_type }}'
;

get

List artifacts for encryption key in org

SELECT
name,
display_name,
artifact_type,
description
FROM nvidia.private_registry.encryption_keys
WHERE key_id = '{{ key_id }}' -- required
AND artifact_type = '{{ artifact_type }}'
;

list_by_team

List encryption keys in org/team

SELECT
encryption_key_id,
created,
description
FROM nvidia.private_registry.encryption_keys
WHERE team_name = '{{ team_name }}' -- required
;

list

List encryption keys in org

SELECT
encryption_key_id,
created,
description
FROM nvidia.private_registry.encryption_keys
;

DELETE examples

delete_by_team

Revoke encryption key and disassociate from all artifacts in org/team

DELETE FROM nvidia.private_registry.encryption_keys
WHERE team_name = '{{ team_name }}' --required
AND key_id = '{{ key_id }}' --required
;

delete

Revoke encryption key and disassociate from all artifacts in org

DELETE FROM nvidia.private_registry.encryption_keys
WHERE key_id = '{{ key_id }}' --required
;