Domino NetApp Volumes API

Authz
Volumes
Data transfers
Downloads
Filesystems
Snapshots
Tasks

Endpoints

Authz

Gets all permissions for requesting user

POST

/account/authz/permissions/authorizedactions

Description

Gets all permissions for requesting user with optional volume ID or project ID in context field

Body Parameter

Name Description Required

Name	Description	Required
`server.PermissionRequest`	Permissions to check user against server.PermissionRequest

server.PermissionRequest

Permissions to check user against server.PermissionRequest

Responses

Code	Message	Datatype
200	OK
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Volumes

Get if user has all provided volume permissions

POST

/account/authz/permissions/volume/:id

Description

Get if user has all provided volume permissions

Parameters

Name Description Required Type In

id ID of Volume to check permissions against string path

Name	Description	Required	Type	In
`id`	ID of Volume to check permissions against		string	path

Body Parameter

Name Description Required

Name	Description	Required
`server.VolumePermissionsRequest`	Volume permissions and user to check against server.VolumePermissionsRequest

server.VolumePermissionsRequest

Volume permissions and user to check against server.VolumePermissionsRequest

Responses

Code	Message	Datatype
200	OK
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Attach volume to project

POST

/rpc/attach-volume-to-project

Description

Attach volume to project

Body Parameter

Name Description Required

Name	Description	Required
`server.UpdateVolumeProject`	Project ID to attach to Volume ID server.UpdateVolumeProject

server.UpdateVolumeProject

Project ID to attach to Volume ID server.UpdateVolumeProject

Responses

Code	Message	Datatype
204	No Content
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Bulk copies volumes and contents to target project and allows for authorized user impersonation

POST

/rpc/bulk-copy-volumes-to-project

Description

Bulk copies volumes and contents to target project and allows for authorized user impersonation, does not copy snapshots and returns success/failure per volume

Body Parameter

Name Description Required

Name	Description	Required
`server.BulkCopyVolumesRequest`	Volume IDs to copy and target Project ID server.BulkCopyVolumesRequest

server.BulkCopyVolumesRequest

Volume IDs to copy and target Project ID server.BulkCopyVolumesRequest

Responses

Code	Message	Datatype
200	OK
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Check whether requesting user is over allowed volume limit

POST

/rpc/check-is-over-limit

Description

Check whether requesting user is over allowed volume limit

Responses

Code	Message	Datatype
200	OK
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Delete volume by ID

POST

/rpc/delete-volume

Description

Delete a volume by ID

Body Parameter

Name Description Required

Name	Description	Required
`server.VolumeIDRequest`	Volume ID to delete server.VolumeIDRequest

server.VolumeIDRequest

Volume ID to delete server.VolumeIDRequest

Responses

Code	Message	Datatype
204	No Content
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Detach volume from project

POST

/rpc/detach-volume-from-project

Description

Detach volume from project

Body Parameter

Name Description Required

Name	Description	Required
`server.UpdateVolumeProject`	Project ID to detach from Volume ID server.UpdateVolumeProject

server.UpdateVolumeProject

Project ID to detach from Volume ID server.UpdateVolumeProject

Responses

Code	Message	Datatype
204	No Content
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Get volume mounts by project ID

POST

/rpc/get-volume-mounts

Description

Get volume and snapshot mounts by project ID and optional data plane ID or volume ID

Body Parameter

Name Description Required

Name	Description	Required
`server.ListVolumeMountsRequest`	Filters to apply to returned volume mounts server.ListVolumeMountsRequest

server.ListVolumeMountsRequest

Filters to apply to returned volume mounts server.ListVolumeMountsRequest

Responses

Code	Message	Datatype
200	OK
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Mark volume for deletion

POST

/rpc/mark-volume-for-deletion

Description

Mark volume for deletion

Body Parameter

Name Description Required

Name	Description	Required
`server.VolumeIDRequest`	Volume ID to mark for deletion server.VolumeIDRequest

server.VolumeIDRequest

Volume ID to mark for deletion server.VolumeIDRequest

Responses

Code	Message	Datatype
204	No Content
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Restore volume to active state

POST

/rpc/restore-volume

Description

Restore volume to active state

Body Parameter

Name Description Required

Name	Description	Required
`server.VolumeIDRequest`	Volume ID to restore to active state server.VolumeIDRequest

server.VolumeIDRequest

Volume ID to restore to active state server.VolumeIDRequest

Responses

Code	Message	Datatype
204	No Content
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Get domino staging volume name

GET

/staging-volume

Description

Get domino staging volume name

Responses

Code	Message	Datatype
200	OK
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

List volumes

GET

/volumes

Description

List volumes

Parameters

Name Description Required Type In

limit Limit integer query

offset Offset integer query

order Order string query

search Search string query

sort_by Sort by string query

filter_strictly_by_volume_roles Filter strictly by volume roles boolean query

project_id Project ID List of string query

data_plane_id Data Plane ID List of string query

status Status List of string query

Name	Description	Type	In
`limit`	Limit	integer	query
`offset`	Offset	integer	query
`order`	Order	string	query
`search`	Search	string	query
`sort_by`	Sort by	string	query
`filter_strictly_by_volume_roles`	Filter strictly by volume roles	boolean	query
`project_id`	Project ID	List of string	query
`data_plane_id`	Data Plane ID	List of string	query
`status`	Status	List of string	query

Responses

Code	Message	Datatype
200	OK
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Create new volume

POST

/volumes

Description

Create new volume

Body Parameter

Name Description Required

Name	Description	Required
`server.CreateVolumeRequest`	Volume to create server.CreateVolumeRequest

server.CreateVolumeRequest

Volume to create server.CreateVolumeRequest

Responses

Code	Message	Datatype
200	OK
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Get volume by ID

GET

/volumes/{id}

Description

Get volume by ID

Parameters

Name Description Required Type In

id ID of volume to retrieve string path

Name	Description	Required	Type	In
`id`	ID of volume to retrieve		string	path

Responses

Code	Message	Datatype
200	OK
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Update Volume

PATCH

/volumes/{id}

Description

Update Volume

Parameters

Name Description Required Type In

id ID of volume to retrieve string path

Name	Description	Required	Type	In
`id`	ID of volume to retrieve		string	path

Body Parameter

Name Description Required

Name	Description	Required
`server.UpdateVolumeRequest`	Name and description fields to update server.UpdateVolumeRequest

server.UpdateVolumeRequest

Name and description fields to update server.UpdateVolumeRequest

Responses

Code	Message	Datatype
200	OK
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Get the connection snippets for a given volume to access as a datasource

GET

/volumes/{id}/connection-snippets

Description

Get the connection snippets for a given volume to access as a datasource

Parameters

Name Description Required Type In

id Volume ID string path

Name	Description	Required	Type	In
`id`	Volume ID		string	path

Responses

Code	Message	Datatype
200	OK
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Get grants by Volume ID

GET

/volumes/{id}/grants

Description

Get grants by Volume ID

Parameters

Name Description Required Type In

id ID of volume to retrieve grants from string path

Name	Description	Required	Type	In
`id`	ID of volume to retrieve grants from		string	path

Responses

Code	Message	Datatype
200	OK
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Update grants by Volume ID

PUT

/volumes/{id}/grants

Description

Update grants by Volume ID

Parameters

Name Description Required Type In

id ID of volume to update grants string path

Name	Description	Required	Type	In
`id`	ID of volume to update grants		string	path

Body Parameter

Name Description Required

Name	Description	Required
`remotefs.VolumeGrantDTO`	New grants to replace current volume grants

remotefs.VolumeGrantDTO

New grants to replace current volume grants

Responses

Code	Message	Datatype
200	OK
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Get a volume by unique name

GET

/volumes/unique-name/{uniqueName}

Description

Get a volume by unique name

Parameters

Name Description Required Type In

uniqueName Unique name of volume to retrieve string path

Name	Description	Required	Type	In
`uniqueName`	Unique name of volume to retrieve		string	path

Responses

Code	Message	Datatype
200	OK
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Data transfers

Create new data transfer

POST

/data-transfers

Description

Create new data transfer

Body Parameter

Name Description Required

Name	Description	Required
`server.CreateDataTransfer`	Data transfer to create server.CreateDataTransfer

server.CreateDataTransfer

Data transfer to create server.CreateDataTransfer

Responses

Code	Message	Datatype
200	OK
400	Bad Request
403	Forbidden
404	Not Found
409	Conflict
423	Locked
500	Internal Server Error

Get data transfer by ID

GET

/data-transfers/{id}

Description

Get data transfer by ID

Parameters

Name Description Required Type In

id ID of data transfer to retrieve string path

Name	Description	Required	Type	In
`id`	ID of data transfer to retrieve		string	path

Responses

Code	Message	Datatype
200	OK
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Callback for data transfer from filetask

POST

/data-transfers/{id}/callback

Description

Callback for data transfer from filetask

Parameters

Name Description Required Type In

id ID of data transfer targetted for callback from filetask string path

Name	Description	Required	Type	In
`id`	ID of data transfer targetted for callback from filetask		string	path

Responses

Code	Message	Datatype
200	OK
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Downloads

Create download archive

POST

/downloads

Description

Create download archive

Body Parameter

Name Description Required

Name	Description	Required
`server.CreateDownloadArchiveRequest`	Create download request server.CreateDownloadArchiveRequest

server.CreateDownloadArchiveRequest

Create download request server.CreateDownloadArchiveRequest

Responses

Code	Message	Datatype
200	OK
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Get download task status

GET

/downloads/{id}

Description

Get download task status

Parameters

Name Description Required Type In

id ID of downloads task string path

volume_id ID of volume download task originates from string query

Name	Description	Required	Type	In
`id`	ID of downloads task		string	path
`volume_id`	ID of volume download task originates from		string	query

Responses

Code	Message	Datatype
200	OK
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Filesystems

List filesystem

GET

/filesystems

Description

List filesystem

Parameters

Name Description Required Type In

limit Limit integer query

offset Offset integer query

order Order string query

search Search string query

sort_by Sort by string query

data_plane_id Data Plane ID List of string query

Name	Description	Type	In
`limit`	Limit	integer	query
`offset`	Offset	integer	query
`order`	Order	string	query
`search`	Search	string	query
`sort_by`	Sort by	string	query
`data_plane_id`	Data Plane ID	List of string	query

Responses

Code	Message	Datatype
200	OK
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Create new filesystem

POST

/filesystems

Description

Create new filesystem

Body Parameter

Name Description Required

server.Filesystem

Filesystem to create server.Filesystem

Responses

Code	Message	Datatype
200	OK
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Get filesystem by ID

GET

/filesystems/{id}

Description

Get filesystem by ID

Parameters

Name Description Required Type In

id ID of filesystem to retrieve string path

include_hostname Whether to include the data plane host name in response boolean query

Responses

Code	Message	Datatype
200	OK
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Update filesystem

PUT

/filesystems/{id}

Description

Update a filesystem. Can be updated if there are volumes associated with the filesystem

Parameters

Name Description Required Type In

id ID of filesystem to update string path

Body Parameter

Name Description Required

server.Filesystem

Filesystem to update server.Filesystem

Responses

Code	Message	Datatype
200	OK
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Delete filesystem by ID

DELETE

/filesystems/{id}

Description

Delete a filesystem by ID

Parameters

Name Description Required Type In

id ID of filesystem to delete string path

Responses

Code	Message	Datatype
204	No Content
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

List available PVCs in the domino-compute namespace with the netapp-storage label

GET

/root-pvcs

Description

List available PVCs in the domino-compute namespace with the netapp-storage label

Parameters

Name Description Required Type In

data_plane_id Data Plane ID string query

Responses

Code	Message	Datatype
200	OK
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Snapshots

Create new snapshot from a run

POST

/rpc/create-snapshot-from-run

Description

Create new snapshot from a volumes mounted in a run, must be called by super user

Body Parameter

Name Description Required

server.CreateSnapshotFromRun

Snapshot to create from run ID server.CreateSnapshotFromRun

Responses

Code	Message	Datatype
200	OK
400	Bad Request
403	Forbidden
404	Not Found
409	Conflict
423	Locked
500	Internal Server Error

Delete snapshot by ID

POST

/rpc/delete-snapshot

Description

Delete a snapshot by ID

Body Parameter

Name Description Required

server.SnapshotIDRequest

Snapshot ID to delete server.SnapshotIDRequest

Responses

Code	Message	Datatype
204	No Content
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Restore snapshot to active state

POST

/rpc/restore-snapshot

Description

Restore snapshot to active state

Body Parameter

Name Description Required

server.SnapshotIDRequest

Snapshot ID to restore to active state server.SnapshotIDRequest

Responses

Code	Message	Datatype
204	No Content
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

List snapshots

GET

/snapshots

Description

List snapshots

Parameters

Name Description Required Type In

limit Limit integer query

offset Offset integer query

order Order string query

search Search string query

sort_by Sort by string query

volume_id Volume ID List of string query

run_id Volume ID List of string query

Responses

Code	Message	Datatype
200	OK
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Create new snapshot

POST

/snapshots

Description

Create new snapshot

Body Parameter

Name Description Required

server.CreateSnapshot

Snapshot to create server.CreateSnapshot

Responses

Code	Message	Datatype
200	OK
400	Bad Request
403	Forbidden
404	Not Found
409	Conflict
423	Locked
500	Internal Server Error

Get snapshot by ID

GET

/snapshots/{id}

Description

Get snapshot by ID

Parameters

Name Description Required Type In

id ID of snapshot to retrieve string path

Responses

Code	Message	Datatype
200	OK
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Update Snapshot by ID

PUT

/snapshots/{id}

Description

Update Snapshot by ID

Parameters

Name Description Required Type In

id ID of Snapshot to update string path

Body Parameter

Name Description Required

server.UpdateSnapshot

Snapshot to update server.UpdateSnapshot

Responses

Code	Message	Datatype
200	OK
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Add snapshot tag

POST

/snapshots/{id}/tags

Description

Add a tag to a snapshot

Parameters

Name Description Required Type In

id ID of snapshot to add tag to string path

Body Parameter

Name Description Required

server.CreateSnapshotTagRequest

Snapshot tag to add server.CreateSnapshotTagRequest

Responses

Code	Message	Datatype
204	No Content
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Delete snapshot tag

DELETE

/snapshots/{id}/tags/{name}

Description

Delete a tag from a snapshot

Parameters

Name Description Required Type In

id ID of snapshot to delete tag from string path

name Tag name to delete from snapshot string path

Responses

Code	Message	Datatype
204	No Content
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Get snapshot by volume ID and snapshot version

GET

/volumes/{id}/snapshots/{version}

Description

Get snapshot by volume ID and snapshot version

Parameters

Name Description Required Type In

id Volume ID string path

version Snapshot version integer path

Responses

Code	Message	Datatype
200	OK
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Tasks

Get import blobs task update

GET

/tasks/import-blobs/{key}/update

Description

Get import blobs task update

Parameters

Name Description Required Type In

key Key of import blobs task string path

Responses

Code	Message	Datatype
200	OK
400	Bad Request
403	Forbidden
404	Not Found
500	Internal Server Error

Models

remotefs.Action

Type

Example

string

copy

remotefs.ConnectionSnippet

Field Name

Required

Type

language

remotefs.SnippetLanguage

snippet

String

remotefs.DataTransfer

Field Name

Required

Type

createdAt

String

createdBy

remotefs.UserSummary

destinationVolumeId

String

filetaskKey

String

labels

Object<String>

status

remotefs.DataTransferStatus

taskUpdate

remotefs.TaskUpdate

type

remotefs.DataTransferType

updatedAt

String

updatedBy

remotefs.UserSummary

remotefs.DataTransferStatus

Type

Example

string

Failed

Started

Succeeded

remotefs.DataTransferType

Type

Example

string

flows-artifact-export

remotefs.FileCollisionSetting

Type

Example

string

Rename

Overwrite

Ignore

remotefs.Filesystem

Field Name

Required

Type

Description

createdAt

String

createdBy

remotefs.UserSummary

dataPlaneId

String

dataPlaneName

String

hostname

String

Data plane prefix (e.g. mydp1029), "" for local data plane

String

isDataPlaneDefault

Boolean

maxSnapshotsPerVolume

Integer

name

String

numVolumes

Integer

rootPvc

String

storageClass

String

updatedAt

String

updatedBy

remotefs.UserSummary

remotefs.FiletaskTask

Field Name

Required

Type

String

key

String

status

String

update

remotefs.TaskUpdate

remotefs.Filter

Field Name

Required

Type

key

String

values

List of string

remotefs.FlowsArtifactVersionKey

Field Name

Required

Type

artifactId

String

execution

remotefs.FlowsExecutionIdentifier

Field Name

Required

Type

domain

String

name

String

project

String

remotefs.Meta

Field Name

Required

Type

filters

List of remotefs.Filter

order

String

pagination

remotefs.Pagination

String

sortBy

String

remotefs.Pagination

Field Name

Required

Type

limit

Integer

offset

Integer

totalCount

Integer

remotefs.Permission

Type

Example

string

ManageFilesystems

ViewFilesystems

CreateVolumes

ManageVolumesForExecution

ManageVolumes

ReadVolumes

ViewVolumes

MarkVolumesForDeletion

DeleteVolumes

EditSecurityVolumes

WorkbenchPermission.PerformNetAppActionsInProject

ReadUserPermissions

ImpersonateUser

remotefs.PermissionCode

Type

Example

string

data.manage_filesystems

data.view_filesystems

data.create_volumes

data.manage_volumes

data.manage_volumes_for_execution

data.read_volumes

data.view_volumes

data.mark_volumes_for_deletion

data.delete_volumes

data.edit_security_volumes

data.project.perform_net_app_actions_in_project

remotefs.Project

Field Name

Required

Type

Description

addedAt

String

addedBy

remotefs.UserSummary

name

String

projectId

String

References Mongo project ID

volumeId

String

remotefs.ResourceStatus

Type

Example

string

Active

MarkedForDeletion

Deleted

remotefs.Snapshot

Field Name

Required

Type

Description

createdAt

String

createdBy

remotefs.UserSummary

description

String

labels

Object<String>

System-specified, e.g. for Flows artifacts

lastMountedTime

String

runId

String

Optional field denoting resource associated with a run

status

remotefs.ResourceStatus

remotefs.SnapshotTag

Field Name

Required

Type

addedAt

String

addedBy

remotefs.UserSummary

name

String

remotefs.SnapshotTagSubPath

Field Name

Required

Type

subPath

String

tagName

String

remotefs.SnippetLanguage

Type

Example

string

Python

remotefs.TaskUpdate

Field Name

Required

Type

exportTargetId

String

key

remotefs.FlowsArtifactVersionKey

progress

Integer

remotefs.UserSummary

Field Name

Required

Type

firstName

String

lastName

String

userName

String

remotefs.Volume

Field Name

Required

Type

Description

capacity

Integer

Maximum size in bytes

createdAt

String

createdBy

remotefs.UserSummary

dataPlaneId

String

description

String

filesystemId

String

filesystemName

String

grants

List of remotefs.VolumeGrant

String

Links to ONTAP volume name

lastMountedTime

String

maxSnapshots

Integer

name

String

numSnapshots

Integer

path

String

projects

List of remotefs.Project

status

remotefs.ResourceStatus

storageSize

Integer

Used size in bytes

uniqueName

String

updatedAt

String

updatedBy

remotefs.UserSummary

remotefs.VolumeCopyDTO

Field Name

Required

Type

grants

List of remotefs.VolumeGrantDTO

sourceVolumeId

String

remotefs.VolumeGrant

Field Name

Required

Type

Description

isOrganization

Boolean

targetId

String

References Mongo user ID (including organizations)

targetName

String

targetRole

remotefs.VolumeRole

remotefs.VolumeGrantDTO

Field Name

Required

Type

targetId

String

targetRole

remotefs.VolumeRole

remotefs.VolumeMount

Field Name

Required

Type

canUserWrite

Boolean

latestSnapshotTagSubPaths

List of remotefs.SnapshotTagSubPath

name

String

persistentVolumeClaimName

String

snapshotSubPath

String

subPath

String

volumeId

String

remotefs.VolumeRole

Type

Example

string

VolumeOwner

VolumeEditor

VolumeReader

Service

server.BulkCopyVolumesRequest

Field Name

Required

Type

projectId

String

volumes

List of remotefs.VolumeCopyDTO

server.CopyVolumeOperationResult

Field Name

Required

Type

action

remotefs.Action

data

remotefs.Volume

error

String

sourceVolumeId

String

status

Integer

server.CopyVolumeOperationResults

Field Name

Required

Type

results

List of server.CopyVolumeOperationResult

server.CreateDataTransfer

Field Name

Required

Type

destinationVolumeId

String

fileCollisionSetting

remotefs.FileCollisionSetting

payload

String

targetRelativePath

String

type

remotefs.DataTransferType

server.CreateDownloadArchiveRequest

Field Name

Required

Type

relativePaths

List of string

snapshotId

String

volumeId

String

server.CreateSnapshot

Field Name

Required

Type

description

String

tagNames

List of string

volumeId

String

server.CreateSnapshotFromRun

Field Name

Required

Type

Description

description

String

runId

String

Run ID associated with the snapshot

userId

String

User that initiated the run, set as snapshot creator

volumeId

String

server.CreateSnapshotTagRequest

Field Name

Required

Type

name

String

server.CreateVolumeRequest

Field Name

Required

Type

capacity

Integer

description

String

filesystemId

String

grants

List of remotefs.VolumeGrantDTO

name

String

projectId

String

server.Filesystem

Field Name

Required

Type

dataPlaneId

String

isDataPlaneDefault

Boolean

maxSnapshotsPerVolume

Integer

name

String

rootPvc

String

storageClass

String

server.HTTPError

Field Name

Required

Type

message

String

server.ListVolumeMountsRequest

Field Name

Required

Type

dataPlaneIds

List of string

projectIds

List of string

volumeIds

List of string

server.PaginatedFilesystems

Field Name

Required

Type

data

List of remotefs.Filesystem

server.PaginatedSnapshots

Field Name

Required

Type

data

List of remotefs.Snapshot

server.PaginatedVolumes

Field Name

Required

Type

data

List of remotefs.Volume

server.PermissionInfo

Field Name

Required

Type

code

remotefs.PermissionCode

context

server.PermissionInfoContext

String

server.PermissionInfoContext

Field Name

Required

Type

projectId

String

volumeId

String

server.PermissionRequest

Field Name

Required

Type

Description

actions

List of server.PermissionInfo

Effectively checking permissions, but using "actions" to be consistent with the rest of the API

server.PermissionResponse

Field Name

Required

Type

Description

actions

List of server.PermissionResponseInfo

Effectively are permissions, using "actions" for consistency

server.PermissionResponseInfo

Field Name

Required

Type

code

remotefs.PermissionCode

String

result

Boolean

server.Principal

Field Name

Required

Type

token

String

server.SnapshotIDRequest

Field Name

Required

Type

snapshotId

String

server.UpdateSnapshot

Field Name

Required

Type

description

String

server.UpdateVolumeProject

Field Name

Required

Type

projectId

String

volumeId

String

server.UpdateVolumeRequest

Field Name

Required

Type

description

String

name

String

server.VolumeIDRequest

Field Name

Required

Type

volumeId

String

server.VolumePermissionsRequest

Field Name

Required

Type

mustHave

List of remotefs.Permission

principal

server.Principal

User Guide

Admin Guide

API Guide

Release Notes

Domino NetApp Volumes API

Endpoints

Authz

Gets all permissions for requesting user

Description

Body Parameter

Responses

Volumes

Get if user has all provided volume permissions

Description

Parameters

Body Parameter

Responses

Attach volume to project

Description

Body Parameter

Responses

Bulk copies volumes and contents to target project and allows for authorized user impersonation

Description

Body Parameter

Responses

Check whether requesting user is over allowed volume limit

Description

Responses

Delete volume by ID

Description

Body Parameter

Responses

Detach volume from project

Description

Body Parameter

Responses

Get volume mounts by project ID

Description

Body Parameter

Responses

Mark volume for deletion

Description

Body Parameter

Responses

Restore volume to active state

Description

Body Parameter

Responses

Get domino staging volume name

Description

Responses

List volumes

Description

Parameters

Responses

Create new volume

Description

Body Parameter

Responses

Get volume by ID

Description

Parameters

Responses

Update Volume

Description

Parameters

Body Parameter

Responses

Get the connection snippets for a given volume to access as a datasource

Description

Parameters

Responses

Get grants by Volume ID

Description

Parameters

Responses

Update grants by Volume ID

Description

Parameters

Body Parameter