How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nasuni Volumes API

The Volumes API from Nasuni — 52 operation(s) for volumes.

Nasuni Volumes API is one of 30 APIs that Nasuni publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Volumes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a changelog.

This API exposes 76 operations across 52 paths, and defines 88 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 6 base URLs: https://hostname/api/v1, https://hostname/api/v1.1, https://hostname/api/v1.2, https://am1.portal.api.nasuni.com, https://eu1.portal.api.nasuni.com, https://ap1.portal.api.nasuni.com.

76 operations 52 paths 88 schemas 9 DELETE48 GET6 PATCH13 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://hostname/api/v1.2
Authentication
API Key, API Key, API Key, API Key, HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 6

Nasuni Volumes API declares 6 security schemes for authenticating requests. An API key is passed in the header as Authorization (AuthToken). An API key is passed in the header as x-service-key (ServiceKeyHeader). An API key is passed in the header as x-service-secret (ServiceSecretHeader). An API key is passed in the header as x-user-key (UserKeyHeader). It accepts HTTP bearer tokens (JWT) (HTTPBearer). It supports OAuth 2.0 (OAuth2ClientCredentials) using the clientCredentials flow.

  • AuthToken — This header is required to make authenticated requests. The value format is: Token [yourauthtoken]
  • ServiceKeyHeader — Service key for programmatic API access. Must be used together with x-service-secret.
  • ServiceSecretHeader — Service secret for programmatic API access. Must be used together with x-service-key.
  • UserKeyHeader — User key for user-specific API access.
  • HTTPBearer — Bearer token obtained from /auth/token endpoint.
  • OAuth2ClientCredentials — Standard OAuth2 Client Credentials flow (RFC 6749 §4.4). Send clientid (service key) and clientsecret (service secret) as form-encoded body parameters to the t…

Paths & Operations 76

Across 52 paths, the API surfaces 76 operations — 9 DELETE, 48 GET, 6 PATCH, 13 POST. Each is listed below with its method, path, parameters, and response codes.

Volumes 76
GET
/volumes/
List all volumes
2 params → 200401429
POST
/volumes/
Create volume
body → 202401429
GET
/volumes/{volume_guid}/
Get a volume
1 param → 200401429
PATCH
/volumes/{volume_guid}/
Update volume
1 param body → 202400401404429
GET
/volumes/{volume_guid}/filers/
List filer specific settings of a volume.
3 params → 200401429
GET
/volumes/{volume_guid}/filers/{filer_serial}/
Get volume settings for a specific filer.
2 params → 200401429
PATCH
/volumes/{volume_guid}/filers/{filer_serial}/
Update the settings for a volume on a specific Filer
2 params body → 202400401404409429
GET
/volumes/filers/shares/
List all shares across all volumes and filers.
2 params → 200401429
GET
/volumes/{volume_guid}/filers/shares/
List all shares of a volume.
3 params → 200401429
GET
/volumes/{volume_guid}/filers/{filer_serial}/shares/
List all shares of a volume on a specific filer.
4 params → 200401429
POST
/volumes/{volume_guid}/filers/{filer_serial}/shares/
Create share
2 params body → 202400401403429
GET
/volumes/{volume_guid}/filers/{filer_serial}/shares/{share_id}/
Get a share
3 params → 200401429
DELETE
/volumes/{volume_guid}/filers/{filer_serial}/shares/{share_id}/
Delete a share
3 params → 202401403429
PATCH
/volumes/{volume_guid}/filers/{filer_serial}/shares/{share_id}/
Update share
3 params body → 202400401403429
GET
/volumes/filers/exports/
List all exports.
2 params → 200401429
GET
/volumes/{volume_guid}/filers/exports/
List all exports of a volume.
3 params → 200401429
GET
/volumes/{volume_guid}/filers/{filer_serial}/exports/
List exports of a volume for a specific filer.
4 params → 200401429
POST
/volumes/{volume_guid}/filers/{filer_serial}/exports/
Create export
2 params body → 202400401403429
GET
/volumes/{volume_guid}/filers/{filer_serial}/exports/{export_id}/
Get an export
3 params → 200401429
DELETE
/volumes/{volume_guid}/filers/{filer_serial}/exports/{export_id}/
Delete export
3 params → 202401403404429
PATCH
/volumes/{volume_guid}/filers/{filer_serial}/exports/{export_id}/
Update export
3 params body → 202400401403429
GET
/volumes/filers/ftp-directories/
List all FTP directories.
2 params → 200401429
GET
/volumes/{volume_guid}/filers/ftp-directories/
List all FTP directories of a volume.
3 params → 200401429
GET
/volumes/{volume_guid}/filers/{filer_serial}/ftp-directories/
List FTP directories of a volume for a specific filer.
4 params → 200401429
GET
/volumes/{volume_guid}/filers/{filer_serial}/ftp-directories/{ftpdir_id}/
Get a FTP directory.
3 params → 200401429
GET
/volumes/filer-connections/
List all volume connections.
2 params → 200401429
GET
/volumes/{volume_guid}/filer-connections/
List all volume connections for a specific volume.
3 params → 200401429
GET
/volumes/{volume_guid}/filer-connections/{filer_serial}/
Get a volume connection.
2 params → 200401429
GET
/volumes/filers/antivirus-violations/
List all antivirus violations.
2 params → 200401429
GET
/volumes/{volume_guid}/filers/antivirus-violations/
List all antivirus violations of a volume.
3 params → 200401429
GET
/volumes/{volume_guid}/filers/{filer_serial}/antivirus-violations/
List antivirus violations of a volume for a specific filer.
4 params → 200401429
GET
/volumes/{volume_guid}/filers/{filer_serial}/antivirus-violations/{antivirus_id}/
Get an antivirus violation.
3 params → 200401429
DELETE
/volumes/{volume_guid}/filers/{filer_serial}/antivirus-violations/{antivirus_id}/
Delete antivirus violation
4 params → 202401403404429
GET
/volumes/{volume_guid}/filers/{filer_serial}/exports/{export_id}/nfs_host_options/
List NFS host options for an export
5 params → 200401429
POST
/volumes/{volume_guid}/filers/{filer_serial}/exports/{export_id}/nfs_host_options/
Create NFS host option
3 params body → 202400401403429
GET
/volumes/{volume_guid}/filers/{filer_serial}/exports/{export_id}/nfs_host_options/{host_option_id}/
Get a host option for an export
4 params → 200401429
DELETE
/volumes/{volume_guid}/filers/{filer_serial}/exports/{export_id}/nfs_host_options/{host_option_id}/
Delete host option
4 params → 202401403404429
PATCH
/volumes/{volume_guid}/filers/{filer_serial}/exports/{export_id}/nfs_host_options/{host_option_id}/
Update an existing host option
4 params body → 202400401403429
GET
/volumes/folder-quotas/
List folder quotas
2 params → 200401429
GET
/volumes/{volume_guid}/folder-quotas/
List folder quotas for a volume
3 params → 200401404429
POST
/volumes/{volume_guid}/folder-quotas/
Create folder quota
1 param body → 200401409429
GET
/volumes/{volume_guid}/folder-quotas/{folder_quota_id}/
Get folder quota
2 params → 200401404429
DELETE
/volumes/{volume_guid}/folder-quotas/{folder_quota_id}/
Delete folder quota
2 params → 202401404429
PATCH
/volumes/{volume_guid}/folder-quotas/{folder_quota_id}/
Update folder quota
2 params body → 202401404405429
GET
/volumes/filers/snapshots/
List snapshot statuses
2 params → 200401429
GET
/volumes/{volume_guid}/filers/snapshots/
List snapshot statuses for a volume
3 params → 200401429
GET
/volumes/{volume_guid}/filers/{filer_serial}/snapshots/
List snapshot status for a volume and Filer
2 params → 200401429
POST
/volumes/{volume_guid}/filers/{filer_serial}/snapshots/
Request snapshot for volume
2 params → 202401409429
POST
/volumes/{volume_guid}/global-lock-folders/
Enable global locking and its various modes on a specified path
1 param body → 202400401403409429
GET
/volumes/filers/paths/
Get a list of all known paths
→ 200401403429
GET
/volumes/{volume_guid}/filers/paths/
Get a list of all known paths with a specific volume
1 param → 200401403404429
GET
/volumes/{volume_guid}/filers/{filer_serial}/paths/
Get a list of all known paths with a specific volume and filer
2 params → 200401403404429
GET
/volumes/{volume_guid}/filers/{filer_serial}/path/{path}
Get info on a specific path
3 params → 200401403404429
POST
/volumes/{volume_guid}/filers/{filer_serial}/path/{path}
Refresh info about a given path
refreshPathInfo 3 params → 202400401403404405429
POST
/volumes/{volume_guid}/filers/{filer_serial}/cache-path/{path}
Bring path into cache
3 params body → 202400401403404409429
POST
/volumes/{volume_guid}/filers/{filer_serial}/make-dir-path/
Try to make the given directory path
2 params body → 202400401403404409429
GET
/volumes/filers/pinned-folders/
Get a list of all pinned folders
2 params → 200401403429
GET
/volumes/{volume_guid}/filers/pinned-folders/
Get a list of all pinned folders in a volume
3 params → 200401403404429
GET
/volumes/{volume_guid}/filers/{filer_serial}/pinned-folders/
Get a list of pinned folders in a volume for a specific filer
4 params → 200401404429
POST
/volumes/{volume_guid}/filers/{filer_serial}/pinned-folders/
Set pinning mode
2 params body → 202400401403404405409429
GET
/volumes/{volume_guid}/filers/{filer_serial}/pinned-folder/{path}
Get pinning status for the path
3 params → 200401404429
DELETE
/volumes/{volume_guid}/filers/{filer_serial}/pinned-folder/{path}
Disable pinning mode on a folder
3 params → 202401403404405409429
GET
/volumes/filers/auto-cached-folders/
Get a list of all auto cache enabled folders
2 params → 200401403429
GET
/volumes/{volume_guid}/filers/auto-cached-folders/
Get a list of all auto cache enabled folders in a volume
3 params → 200401403404429
GET
/volumes/{volume_guid}/filers/{filer_serial}/auto-cached-folders/
List auto cache enabled folders for a volume on a filer
4 params → 200401403404429
POST
/volumes/{volume_guid}/filers/{filer_serial}/auto-cached-folders/
Set auto caching mode
2 params body → 200400401403404405409429
GET
/volumes/{volume_guid}/filers/{filer_serial}/auto-cached-folder/{path}
Get auto cache folder status for a folder
3 params → 200401404429
DELETE
/volumes/{volume_guid}/filers/{filer_serial}/auto-cached-folder/{path}
Disable auto cache mode on a folder
3 params → 202401403404405409429
DELETE
/volumes/{volume_guid}/global-lock-folders/{path}
Disable global locking on a specified path
2 params → 202401403404429
GET
/volumes
Get Volumes
get_volumes_volumes_get → 200401403422500
GET
/volumes/{volume_id}/edges/{edge_id}/snapshots
Get Snapshot Status
get_snapshot_status_volumes__volume_id__edges__edge_id__snapshots_get 2 params → 200401403404422500
POST
/volumes/{volume_id}/edges/{edge_id}/snapshots
Start Snapshot
start_snapshot_volumes__volume_id__edges__edge_id__snapshots_post 2 params → 202401403422500
DELETE
/volumes/{volume_id}/edges/{edge_id}/snapshots
Cancel Snapshot
cancel_snapshot_volumes__volume_id__edges__edge_id__snapshots_delete 2 params → 202401403422500
GET
/volumes/{volume_id}
Get Volume
get_volume_volumes__volume_id__get 1 param → 200401403404422500
GET
/volumes/{volume_id}/details
Get Volume Details
get_volume_details_volumes__volume_id__details_get 1 param → 200401403404422500
GET
/volumes/{volume_id}/capacity-history
Get Volume Capacity History
get_volume_capacity_history_volumes__volume_id__capacity_history_get 1 param → 200401403404422500

Schemas 88

The contract defines 88 schemas that model the data the API accepts and returns. The most detailed are VolumeDetailsDto (29 properties), PathData_2 (26 properties), PathData (26 properties), Share_3 (24 properties). Each schema is shown below with its type and property counts.

Paging
object
The paging object provides a container for a listing of objects, defining the start, end, and total size of the listing. Any endpoint that returns a list of it…
6 properties
ExportReadOnlyField
boolean
If true, files and directories cannot be changed on the exported directory.
Error
object
2 properties
AntivirusViolation
object
Antivirus violation object
8 properties
Share
object
CIFS Share
23 properties
FtpDirectory
object
FTP directory object
17 properties
GroupNameField
string
Group name
Export
object
Export object
13 properties
UserNameField
string
User name
VolumeFilerSetting
object
Filer specfic volume settings.
11 properties
ExportSecOptionsField
array
Security options in use by the exported directory. Multiple options may be applied, but they cannot be repeated.
VolumeConnection
object
Volume to filer connection.
4 properties
ExportPerfModeField
string
Controls the method in which the NFS server replies to clients. Changing this may impact the safety of data if the Nasuni Filer is shut down abnormally! Possib…
Volume
object
Representation of a Volume object.
14 properties
ExportHostSpecField
string
Hostname, IP address with optional netmask, or @-prefixed netgroup names allowed to access the export. If blank, all hosts on your network can access the expor…
Link
object
2 properties
ExportAccessModeField
string
Controls what User IDs are allowed when a client writes to the exported directory. Possible values: 'rootsquash' - Normal Users Permitted 'norootsquash' - All…
GlobalLocking
object
Global locking object.
5 properties
NfsHostOption
object
An NFS Export Host Option object
7 properties
VolumeFilerSetting_2
object
Filer specfic volume settings.
11 properties
ExportPerfModeField_2
string
Controls the method in which the NFS server replies to clients. Changing this may impact the safety of data if the Nasuni Filer is shut down abnormally! Possib…
Volume_2
object
Representation of a Volume object.
18 properties 2 required
ExportReadOnlyField_2
boolean
If true, files and directories cannot be changed on the exported directory. Default is false.
FolderQuota
object
FolderQuota object
10 properties 3 required
AutoCachedFolders
object
Auto Cache Folder object.
5 properties
PinnedFolders
object
Pinned Folder object.
5 properties
Snapshot
object
Representation of a volume snapshot status
5 properties
Share_2
object
CIFS Share
23 properties 2 required
CachePath
object
Cache object
2 properties
ErrorResponse
object
1 property
PathData
object
Path information object
26 properties
Export_2
object
Export object
13 properties
ExportSecOptionsField_2
array
Security options in use by the exported directory. Multiple options may be applied, but they cannot be repeated.
Message
object
The message object is used to track an action that we want the Filer to perform.
11 properties
MessageResponse
object
1 property
ExportHostSpecField_2
string
A comma-separated list of the hostnames, IP addresses with optional netmasks, or @-prefixed netgroup names allowed to access the export. If blank, all hosts on…
Link_2
object
2 properties
AntivirusViolation_2
object
Antivirus violation object
8 properties
Error_2
object
2 properties
FtpDirectory_2
object
FTP directory object
17 properties
ExportAccessModeField_2
string
Controls what User IDs are allowed when a client writes to the exported directory. Possible values: 'rootsquash' - Normal Users Permitted - Default 'norootsqua…
GlobalLocking_2
object
Global locking object.
5 properties
NfsHostOption_2
object
An NFS Export Host Option object
7 properties
VolumeFilerSetting_3
object
Filer specfic volume settings.
11 properties
VolumeUpdateRemoteAccessField
object
Volume remote access settings
3 properties 3 required
ExportPerfModeField_3
string
Controls the method in which the NFS server replies to clients. Changing this may impact the safety of data if the Nasuni Filer is shut down abnormally! Possib…
Volume_3
object
Representation of a Volume object.
18 properties 2 required
Paging_2
object
The paging object provides a container for a listing of objects, defining the start, end, and total size of the listing. Any endpoint that returns a list of it…
6 properties
ExportReadOnlyField_3
boolean
If true, files and directories cannot be changed on the exported directory. Default is false.
FolderQuota_2
object
FolderQuota object
10 properties 3 required
AutoCachedFolders_2
object
Auto Cache Folder object.
5 properties
PinnedFolders_2
object
Pinned Folder object.
5 properties
Share_3
object
CIFS Share
24 properties 2 required
ErrorResponse_2
object
1 property
PathData_2
object
Path information object
26 properties
Export_3
object
Export object
13 properties
ExportSecOptionsField_3
array
Security options in use by the exported directory. Multiple options may be applied, but they cannot be repeated.
Message_2
object
The message object is used to track an action that we want the Filer to perform.
11 properties
VolumeUpdateQuotaField
integer
Maximum volume capacity in gigabytes. Set to 0 for unlimited. Quotas are applied after each successful snapshot.
VolumeUpdateQuota
object
1 property 1 required
ExportHostSpecField_3
string
A comma-separated list of the hostnames, IP addresses with optional netmasks, or @-prefixed netgroup names allowed to access the export. If blank, all hosts on…
AntivirusViolation_3
object
Antivirus violation object
8 properties
Link_3
object
2 properties
Error_3
object
2 properties
FtpDirectory_3
object
FTP directory object
17 properties
VolumeUpdateRemoteAccess
object
1 property 1 required
ExportAccessModeField_3
string
Controls what User IDs are allowed when a client writes to the exported directory. Possible values: 'rootsquash' - Normal Users Permitted - Default 'norootsqua…
TaskSummaryDto
object
Customer-facing job view: the rolled-up task state plus an optional, curated task-level reason. Deliberately carries no steps. Internal step reasons — unstruct…
15 properties 8 required
VolumeCapacityHistoryPointDto
object
2 properties 2 required
VolumeBaseDto
object
4 properties 1 required
VolumeCapacityHistoryResponseDto
object
2 properties 1 required
VolumeEdgesDto
object
3 properties 2 required
ConnectionPermission
string
ErrorResponse_3
object
2 properties 2 required
VolumesResponseDto
object
1 property
SecurityMode
string
Protocol
string
ValidationErrorResponse
object
2 properties 2 required
TaskState
string
VolumeDetailsDto
object
Enriched volume response — volume-scoped fields only. Display fields below are pre-formatted server-side (protocol, permissionpolicy, securitymode, snapshotret…
29 properties 1 required
SnapshotStatus
string
Public snapshot lifecycle vocabulary surfaced by the snapshot APIs. The persisted column (VolumeEdgeState.currentsnapshotstatus) has a single writer: the Event…
NocCloudProvider
string
Cloud provider identity as used by NOC (shortname).
SnapshotStatusResponseDto
object
Per-edge snapshot status — VolumeEdgeState.currentsnapshotstatus for a single (volumeid, edgeid). Defaults to idle when no state row exists (no UI difference).
3 properties 2 required
TaskInitiator
string
VolumeMasterDto
object
2 properties 1 required
PermissionPolicy
string
TaskExecutor
string
VolumeDto
object
13 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nasuni-volumes-api-openapi.yml Raw ↑

Other APIs Nasuni publishes across the network.

Nasuni Data API
Nasuni Portal MCP Server
Nasuni Account API
Nasuni Account Management API
Nasuni Activity Logs API
Nasuni AI Activate API
Nasuni Auth API
Nasuni Cloud Credentials API
Nasuni Configuration API
Nasuni Data API
Nasuni Edge Appliances (Edge) API
Nasuni File IQ Appliances (File IQ) API
Where this information came from

This is an independent, third-party profile of Nasuni Volumes API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.