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.Get(ctx, nfsID, query) (*NfGetResponse, error)

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 NfGetParams

Region param.Field[string]optional

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

ReturnsExpand Collapse

type NfGetResponse struct{…}

Share NfGetResponseShareoptional

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 NfGetResponseShareStatus

The current status of the share.

Accepts one of the following:

const NfGetResponseShareStatusCreating NfGetResponseShareStatus = "CREATING"

const NfGetResponseShareStatusActive NfGetResponseShareStatus = "ACTIVE"

const NfGetResponseShareStatusFailed NfGetResponseShareStatus = "FAILED"

const NfGetResponseShareStatusDeleted NfGetResponseShareStatus = "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.

Get an NFS share

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"),
  )
  nf, err := client.Nfs.Get(
    context.TODO(),
    "0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
    gradient.NfGetParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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"
  }
}