API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Nfs

Create a new NFS share

client.nfs.create(NfCreateParams { name, region, size_gib, vpc_ids } body, RequestOptionsoptions?): NfCreateResponse { share }

post/v2/nfs

List NFS shares per region

client.nfs.list(NfListParams { region } query, RequestOptionsoptions?): NfListResponse { shares }

get/v2/nfs

Get an NFS share

client.nfs.retrieve(stringnfsID, NfRetrieveParams { region } query, RequestOptionsoptions?): NfRetrieveResponse { share }

get/v2/nfs/{nfs_id}

Delete an NFS share

client.nfs.delete(stringnfsID, NfDeleteParams { region } params, RequestOptionsoptions?): void

delete/v2/nfs/{nfs_id}

Initiate an NFS action

client.nfs.initiateAction(stringnfsID, NfInitiateActionParamsbody, RequestOptionsoptions?): NfInitiateActionResponse { action }

post/v2/nfs/{nfs_id}/actions

NfsSnapshots

List NFS snapshots per region

client.nfs.snapshots.list(SnapshotListParams { region, share_id } query, RequestOptionsoptions?): SnapshotListResponse { snapshots }

get/v2/nfs/snapshots

Get an NFS snapshot by ID

client.nfs.snapshots.retrieve(stringnfsSnapshotID, SnapshotRetrieveParams { region } query, RequestOptionsoptions?): SnapshotRetrieveResponse { snapshot }

get/v2/nfs/snapshots/{nfs_snapshot_id}

Delete an NFS snapshot

client.nfs.snapshots.delete(stringnfsSnapshotID, SnapshotDeleteParams { region } params, RequestOptionsoptions?): void

delete/v2/nfs/snapshots/{nfs_snapshot_id}