API Reference

Nfs

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get an NFS share

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

get/v2/nfs/{nfs_id}

To get an NFS share, send a GET request to /v2/nfs/{nfs_id}?region=${region}.

A successful request will return the NFS share.

ParametersExpand Collapse

nfsID: string

query: NfRetrieveParams { region }

region: string

The DigitalOcean region slug (e.g., nyc2, atl1) where the NFS share resides.

ReturnsExpand Collapse

NfRetrieveResponse { share }

share?: Share { id, created_at, name, 6 more }

id: string

The unique identifier of the NFS share.

created_at: string

Timestamp for when the NFS share was created.

formatdate-time

name: string

The human-readable name of the share.

region: string

The DigitalOcean region slug (e.g., nyc2, atl1) where the NFS share resides.

size_gib: number

The desired/provisioned size of the share in GiB (Gibibytes). Must be >= 50.

status: "CREATING" | "ACTIVE" | "FAILED" | "DELETED"

The current status of the share.

Accepts one of the following:

"CREATING"

"ACTIVE"

"FAILED"

"DELETED"

host?: string

The host IP of the NFS server that will be accessible from the associated VPC

mount_path?: string

Path at which the share will be available, to be mounted at a target of the user's choice within the client

vpc_ids?: Array<string>

List of VPC IDs that should be able to access the share.

Get an NFS share

TypeScript

HTTP

TypeScript

Python

import Gradient from '@digitalocean/gradient';

const client = new Gradient({
  accessToken: 'My Access Token',
});

const nf = await client.nfs.retrieve('0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d', { region: 'region' });

console.log(nf.share);

200 example

{
  "share": {
    "id": "0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
    "name": "sammy-share-drive",
    "size_gib": 1024,
    "region": "atl1",
    "status": "ACTIVE",
    "created_at": "2023-01-01T00:00:00Z",
    "vpc_ids": [
      "796c6fe3-2a1d-4da2-9f3e-38239827dc91"
    ],
    "mount_path": "/123456/your-nfs-share-uuid",
    "host": "10.128.32.2"
  }
}

Returns Examples

200 example

{
  "share": {
    "id": "0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
    "name": "sammy-share-drive",
    "size_gib": 1024,
    "region": "atl1",
    "status": "ACTIVE",
    "created_at": "2023-01-01T00:00:00Z",
    "vpc_ids": [
      "796c6fe3-2a1d-4da2-9f3e-38239827dc91"
    ],
    "mount_path": "/123456/your-nfs-share-uuid",
    "host": "10.128.32.2"
  }
}