List NFS snapshots per region

client.Nfs.Snapshots.List(ctx, query) (*NfSnapshotListResponse, error)

get/v2/nfs/snapshots

To list all NFS snapshots, send a GET request to /v2/nfs/snapshots?region=${region}&share_id={share_id}.

A successful request will return all NFS snapshots belonging to the authenticated user in the specified region.

Optionally, you can filter snapshots by a specific NFS share by including the share_id query parameter.

ParametersExpand Collapse

query NfSnapshotListParams

Region param.Field[string]optional

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

ShareID param.Field[string]optional

The unique ID of an NFS share. If provided, only snapshots of this specific share will be returned.

ReturnsExpand Collapse

type NfSnapshotListResponse struct{…}

Snapshots []NfSnapshotListResponseSnapshotoptional

ID string

The unique identifier of the snapshot.

CreatedAt Time

The timestamp when the snapshot was created.

formatdate-time

Name string

The human-readable name of the snapshot.

Region string

The DigitalOcean region slug where the snapshot is located.

ShareID string

The unique identifier of the share from which this snapshot was created.

formatuuid

SizeGib int64

The size of the snapshot in GiB.

formatuint64

Status NfSnapshotListResponseSnapshotsStatus

The current status of the snapshot.

Accepts one of the following:

const NfSnapshotListResponseSnapshotsStatusUnknown NfSnapshotListResponseSnapshotsStatus = "UNKNOWN"

const NfSnapshotListResponseSnapshotsStatusCreating NfSnapshotListResponseSnapshotsStatus = "CREATING"

const NfSnapshotListResponseSnapshotsStatusActive NfSnapshotListResponseSnapshotsStatus = "ACTIVE"

const NfSnapshotListResponseSnapshotsStatusFailed NfSnapshotListResponseSnapshotsStatus = "FAILED"

const NfSnapshotListResponseSnapshotsStatusDeleted NfSnapshotListResponseSnapshotsStatus = "DELETED"

List NFS snapshots per region

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"),
  )
  snapshots, err := client.Nfs.Snapshots.List(context.TODO(), gradient.NfSnapshotListParams{

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

{
  "snapshots": [
    {
      "id": "0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
      "created_at": "2023-11-14T16:29:21Z",
      "name": "daily-backup",
      "region": "atl1",
      "share_id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "size_gib": 1024,
      "status": "CREATING"
    }
  ]
}

Returns Examples

{
  "snapshots": [
    {
      "id": "0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
      "created_at": "2023-11-14T16:29:21Z",
      "name": "daily-backup",
      "region": "atl1",
      "share_id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "size_gib": 1024,
      "status": "CREATING"
    }
  ]
}