For the complete documentation index, see llms.txt. This page is also available as Markdown.

NSF Folders Commands

Nested Shared Folders for folder-level commands

Overview

With the introduction of Nested Shared Folders with Role-Based Folder Permissions, we’ve rebuilt the vault’s folder, sharing and permissions model from the ground up, delivering a more flexible and scalable experience for every user and team.

Operations Supported

The Following operations are supported by NSF Shared Folders

Note: In case you are using classic permission model, please refer to Shared Folder Commands

Create Folder command

Creates a new folder in Keeper NSF using the v3 API. Optionally places the folder under a parent, assigns a color, and controls whether permissions are inherited from the parent.

DotNet CLI

Command: nsf-mkdir

Parameters:

Parameter

Description

--name

Name of the folder to create (required)

--parent

UID of the parent folder. If omitted, the folder is created at the Keeper NSF root

--color

Optional folder color

--no-inherit

If specified, the new folder will not inherit permissions from its parent

Examples:

DotNet SDK

Function:

Batch Create Folder Command:

Power Commander

Command: New-KeeperNSFFolder

Alias: nsf-mkdir

Parameters:

Parameter

Description

-Name

Name of the folder to create (required)

-ParentFolderUid

UID of the parent folder. If omitted, the folder is created at the Keeper NSF root

-Color

Optional folder color

-NoInheritPermissions

If specified, the new folder will not inherit permissions from its parent

Examples:

Batch Support:

Command : New-KeeperNSFFolders

Alias : nsf-mkdirs

Parameter
Description

-FilePath

Path to UTF-8 JSON batch file

-Json

Inline JSON

-DownloadSampleFolders

Write sample JSON (default: nsf-folders-update-batch.sample.json)

Examples :

Python CLI

Command: nsf-mkdir

Parameters:

folder Folder name (use "//" to embed a literal "/" in the name) --color {none, red, orange, yellow, green, blue, gray} Folder colour --no-inherit Do not inherit parent folder permissions

Example:

Python SDK

Function : create_nsf_folder

Update folder command

Renames a Keeper NSF folder and/or changes its color. Folder can be referenced by UID or by name.

DotNet CLI

Command: nsf-rndir

Parameters:

Parameter
Description

--name

New folder name

--color

New folder color: none, red, orange, yellow, green, blue, gray, grey

Examples:

DotNet SDK

Function:

Batch Update Folder Command:

Power Commander

Command: Set-KeeperNSFFolder

Alias: nsf-rndir

Parameters:

Parameter
Description

-Folder

Folder UID or name (required)

-Name

New folder name

-Color

New folder color: none, red, orange, yellow, green, blue, gray, grey

Examples:

Batch Support:

Command: Set-KeeperNSFFolders

Alias: nsf-folders-update

Parameter
Description

-FilePath

Path to UTF-8 JSON batch file

-Json

Inline JSON

-DownloadSampleFolders

Write sample JSON (default: nsf-folders-update-batch.sample.json)

JSON schema — folders array; each item: uid (required), optional name, color, inherit_permissions (false only).

Examples:

Python CLI

Command: nsf-rndir

Parameters:

folder folder path or UID -n, --name NAME - folder new name --color {none, red, orange, yellow, green, blue, gray} Folder color -q, --quiet Suppress success message

Example:

Python SDK

Function : update_nsf_folder

Remove folder command

Removes one or more Keeper NSF folders. Always runs a preview first, prints the impact, and asks for confirmation unless -Force is supplied.

DotNet CLI

Command: nsf-rmdir

Parameters:

Parameter
Description

-o or --operation

folder-trash (default, recoverable) or delete-permanent (irreversible cascade delete)

-f or --force

Skip the confirmation prompt after preview

--dry-run

Preview only; do not remove folders

Examples:

DotNet SDK

Function:

Batch Remove Folder Command:

Power Commander

Command: Remove-KeeperNSFFolder

Alias: nsf-rmdir

Parameters:

Parameter
Description

-Folder

One or more folder UIDs or names. Accepts pipeline input

-Operation

folder-trash (default, recoverable) or delete-permanent (irreversible cascade delete)

-Force

Skip the confirmation prompt after preview

-DryRun

Preview only; do not remove folders

Examples:

Batch Support: Command: Remove-KeeperNSFFolders

Alias: nsf-rmdirs

Parameter
Description

-FilePath

Path to UTF-8 JSON batch file

-Json

Inline JSON

-DownloadSampleFolders

Write sample JSON (default: nsf-folders-remove-batch.sample.json)

-Force

Skip confirmation after preview

-DryRun

Preview only

JSON schema — folders (or removals) array; each item: uid / folder_uid (required), optional operation (folder-trash default, or delete-permanent).

Examples:

Python CLI

Command: nsf-rmdir

Parameters:

FOLDER Folder UID(s) or name(s) to remove (max 100) --operation, -o {folder-trash, delete-permanent} Removal operation (default: folder-trash) -q, --quiet Suppress per-folder impact detail --force, -f Skip confirmation after preview --dry-run Preview only; do not delete

Example:

Python SDK

Function : remove_nsf_folders

Share Folder command

Grants or removes user access on a Keeper NSF folder.

DotNet CLI

Command: nsf-share-folder

Parameters:

Parameter
Description

position 0

UID of the folder to share (required)

--action

grant (default) or remove

--email

One or more user email addresses to grant or revoke access for (required)

--role

Access role for grant: viewer (default), shared-manager, content-manager, content-share-manager, full-manager

Examples:

DotNet SDK

Function:

Batch grant folder access command

Grants user or team access to NSF folders in batch (up to 500 entries per request). Independent of single-item nsf-share-folder / Set-KeeperNSFFolderAccess. Caller must have share/update-access on each folder.

Batch update folder access command

Updates existing user/team access on NSF folders in batch (up to 500 entries per request).

Batch revoke folder access command

Revokes user/team access from NSF folders in batch (up to 500 entries per request).

Power Commander

Command: Set-KeeperNSFFolderAccess

Alias: nsf-share-folder

Parameters:

Parameter
Description

-FolderUid

UID of the folder to share (required)

-Action

grant (default) or remove

-Email

One or more user email addresses to grant or revoke access for (required)

-Role

Access role for grant: viewer (default), shared-manager, content-manager, content-share-manager, full-manager

Examples:

Batch grant folder access command

Command: Share-KeeperNSFFolderAccesses

Alias: nsf-share-folders

Parameter
Description

-FilePath

Path to UTF-8 JSON batch file

-Json

Inline JSON

-DownloadSampleAccesses

Write sample JSON (default: nsf-folders-access-grant-batch.sample.json)

JSON schema — accesses array; each item: folder_uid, accessor (email / team name / team UID), optional role (default viewer), optional expire_in (e.g. 30d) or expire_at (ISO datetime).

Roles: viewer, share-manager, content-manager, content-share-manager, full-manager

Examples:

Batch update folder access command

Command: Update-KeeperNSFFolderAccesses

Alias: nsf-update-folder-access

Parameter
Description

-FilePath / -Json

Batch payload

-DownloadSampleAccesses

Write sample JSON (default: nsf-folders-access-update-batch.sample.json)

Examples:

Batch revoke folder access command

Command: Unshare-KeeperNSFFolderAccesses

Alias: nsf-unshare-folders

Parameter
Description

-FilePath / -Json

Batch payload

-DownloadSampleAccesses

Write sample JSON (default: nsf-folders-access-revoke-batch.sample.json)

JSON schema — accesses array; each item: folder_uid, accessor.

Examples:

Python CLI

Command: nsf-share-folder

Parameters:

folder folder UID or name -a, --action {grant, remove} grant (default) or remove access -e, --email USER email, team name/UID, or @existing for all folder accessors -r, --role {viewer, share-manager, content-manager, content-share-manager, full-manager} --expire-at TIMESTAMP --expire-in PERIOD

Example:

Python SDK

Function : grant_nsf_folder_access

Links (hard-links) a Keeper NSF record into a Keeper NSF folder, so the record appears in additional folders without being copied.

DotNet CLI

Command: nsf-ln

Parameters:

Parameter
Description

position 0

Record UID or title (required)

position 1

Destination folder UID, name, or / for the Keeper NSF root (required)

Examples:

DotNet SDK

Function:

Power Commander

Command: Link-KeeperNSFRecord

Alias: nsf-ln

Parameters:

Parameter
Description

-Record

Record UID or title (required)

-Folder

Destination folder UID, name, or / for the Keeper NSF root (required)

Examples:

Batch Support:

Command: Link-KeeperNSFRecords

Alias: nsf-lns

Parameter
Description

-FilePath / -Json

Batch payload

-DownloadSampleLinks

Write sample JSON (default: nsf-folder-records-link-batch.sample.json)

JSON schema — links array; each item: folder_uid, record_uid (aliases accepted). Empty folder_uid maps to NSF root.

Examples:

Python CLI

Command: nsf-ln

Parameters:

src record UID or title dst destination folder UID or name

Example:

Python SDK

Function : link_nsf_record_to_folder

Removes one or more Keeper NSF records using the v3 remove API. Always runs a preview first, prints the impact, and asks for confirmation unless -Force is supplied.

DotNet CLI

Command: nsf-rm

Parameters:

Parameter
Description

--folder

Folder UID or name that provides context (required for unlink)

-o or --operation

owner-trash (default), folder-trash, or unlink

-f or --force

Skip the confirmation prompt after preview

--dry-run

Preview only; do not remove records

Examples:

DotNet SDK

Function:

Power Commander

Command: Remove-KeeperNSFRecord

Alias: nsf-rm

Parameters:

Parameter
Description

-Record

One or more record UIDs or titles. Accepts pipeline input

-Folder

Folder UID or name that provides context (required for unlink)

-Operation

owner-trash (default), folder-trash, or unlink

-Force

Skip the confirmation prompt after preview

-DryRun

Preview only; do not remove records

Examples:

Batch Support:

Command: Unlink-KeeperNSFRecords

Alias: nsf-unln

Parameter
Description

-FilePath / -Json

Batch payload

-DownloadSampleUnlinks

Write sample JSON (default: nsf-folder-records-unlink-batch.sample.json)

JSON schema — unlinks array; each item: folder_uid, record_uid.

Examples:

Python CLI

Command: nsf-rm

Parameters:

RECORD Record UID(s) or title(s) to remove (max 500) --folder FOLDER Folder UID or name for operation context --operation, -o {owner-trash,folder-trash,unlink} Removal operation (default: owner-trash) --force, -f Skip confirmation after preview --dry-run Preview only; do not delete

Example:

Python SDK

Function : remove_nsf_records

Last updated

Was this helpful?