API Reference

Nfs

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List NFS shares per region

client.Nfs.List(ctx, query) (*NfListResponse, error)

get/v2/nfs

To list NFS shares, send a GET request to /v2/nfs?region=${region}.

A successful request will return all NFS shares belonging to the authenticated user.

ParametersExpand Collapse

query NfListParams

Region param.Field[string]optional

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

ReturnsExpand Collapse

type NfListResponse struct{…}

Shares []NfListResponseShareoptional

ID string

The unique identifier of the NFS share.

CreatedAt Time

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.

SizeGib int64

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

Status NfListResponseSharesStatus

The current status of the share.

Accepts one of the following:

const NfListResponseSharesStatusCreating NfListResponseSharesStatus = "CREATING"

const NfListResponseSharesStatusActive NfListResponseSharesStatus = "ACTIVE"

const NfListResponseSharesStatusFailed NfListResponseSharesStatus = "FAILED"

const NfListResponseSharesStatusDeleted NfListResponseSharesStatus = "DELETED"

Host stringoptional

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

MountPath stringoptional

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

VpcIDs []stringoptional

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

List NFS shares per region

Go

HTTP

TypeScript

Python

Go

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := gradient.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  nfs, err := client.Nfs.List(context.TODO(), gradient.NfListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", nfs.Shares)
}

200 example

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

Returns Examples

200 example

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