v8

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2025-10-165266542.4 MB
DigitalOcean-public.v2-new_NFS

Get an NFS share

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

A successful request will return the NFS share.

get/v2/nfs/{nfs_id}

Path parameters

nfs_idstring required

The unique ID of the NFS share

Query parameters

regionstring required

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

Response

The response will be a JSON object with a key called share. The value will be an object containing the standard attributes associated with an NFS share.

Example response

{
  "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"
    ]
  }
}