MetaDefender Storage Security API v1

Get Roles

Retrieve all ABAC roles. Set includePermissions to true to include the full permission list for each role.

Create Role

Create a new ABAC role. Provide an optional templateRoleId to inherit all permissions from an existing role; any IDs in permissionIds are merged on top of the template.

Get Role by ID

Retrieve a single role and its associated permissions by role ID.

Update Role

Replace an existing role's name and full permission set in a single operation. The supplied permissionIds become the role's complete permission list (previously assigned permissions not in the list are removed). Predefined system roles cannot be updated.

Delete Role

Permanently delete a role. Predefined system roles cannot be deleted.

Get Permissions

Retrieve all available ABAC permissions (action + resource pairs).

Create Permission

Create a new ABAC permission defined by an action and a resource.

Delete Permission

Permanently delete a permission by ID. Predefined base permissions cannot be deleted.

Assign Permission to Role

Assign a permission to the specified role.

Remove Permission from Role

Remove a permission from the specified role. Permissions that were assigned to a predefined role during initialization cannot be removed.

Assign Role to User

Assign a role to a user, optionally with an expiry date after which the assignment is no longer valid.

Replace User Roles

Atomically replace all role assignments for a user with the provided set of role IDs. All existing role bindings are removed and new ones are created in a single transaction.

Remove Role from User

Remove a role binding from a user using the role binding ID.

Assign Permission to User

Assign a permission directly to a user, optionally with an expiry date.

Remove Permission from User

Remove a directly assigned permission from a user using the user permission ID.

Add an account

Add a new storage account to the system

Bulk delete accounts

Deletes up to 100 accounts in a single request. Per-account ABAC (Accounts.Delete) plus per-cascaded-storage ABAC (Storages.Delete) are enforced. When forceDelete=true, child storages are cascade-deleted along with their scans. If any cascaded storage has a running scan, the request is rejected with HTTP 409. When forceDelete=false, accounts with children are returned in the failed list with localized reason; only empty accounts are deleted.

List accounts (paginated, filtered, sorted)

Returns a paginated, filtered, and sorted list of accounts. Supports multi-value filters: vendorType (StorageVendorType) and protocolType (StorageProtocolType). The autodiscoveryEnabled boolean filter restricts results to accounts with auto-discovery enabled or disabled. The includeStorages flag (default true) controls whether associated storage units are loaded per account; set to false to skip the per-account N+1 storage scan RPC calls. Default Count is 100 (maximum 100). Returns an IPagedResponse containing Items, TotalCount, StartIndex, and Count.

Update an account

Update an existing account's configuration

Delete an account

Permanently delete an account and its storage references

Fetch account by ID

Retrieve a single account's details by ID

Fetch available storage units for an account

List all storage units linked to a particular account

Fetch account sources

Fetch account sources

Fetch audit logs

Export configuration file

Export the current configuration settings to an archive. The file will be encrypted using the provided password.

Import configuration file

Get enabled modules

Retrieve external loggers

Update external logger state

Add a new Syslog server configuration

Update a Syslog server configuration

Add a new Kafka server configuration

Update a Kafka server configuration

Delete external logger

Rescan a file on demand

This request is used to update a scanned file with passwords, in case it is an encrypted archive andit could not be scanned because the passwords to decrypt it were not provided. It can also be used withoutproviding any passwords to simply rescan a specific file from a finished scan.

Enumerate processed files

Rescan multiple files on demand

This request is used to rescan and update existing files from a scan based on a filter.

Fetch processing results for a file

File processing is done asynchronously and each analysis request is tracked by a file ID. Because processing a file is a potentially time-consuming operation, scheduling a file for processing and retrieving the results needs to be done using two separate API calls.

This request needs to be made multiple times until the analysis is complete. Analysis completion can be tracked using the processingState and the progress values from the response..

Retrieve archive scan results

Retrieve the archive scan results using either the scanResultId or the parentId

Cancel a file in an ongoing scan

Add a group

Bulk delete groups

Deletes up to 100 groups in a single request. Per-group ABAC (Groups.Delete) plus per-cascaded-storage ABAC (Storages.Delete) are enforced. When forceDelete=true, child accounts and storages are cascade-deleted along with their scans. If any cascaded storage has a running scan, the request is rejected with HTTP 409. When forceDelete=false, groups with children are returned in the failed list with localized reason; only empty groups are deleted.