Give Feedback

godo.Nfs.DeleteWithOptions()

Generated on 5 Nov 2026 from godo version v1.236.0

Copy page as Markdown View page as Markdown

Usage

client.Nfs.DeleteWithOptions(ctx context.Context, nfsShareId string, opts *godo.NfsDeleteOptions) (*godo.Response, error)

Description

DeleteWithOptions deletes an NFS share. Set DeleteSnapshots to delete active snapshots with the share; otherwise the API returns 412 when snapshots exist.

This method sends a DELETE request to /v2/nfs/{}.

Parameters

nfsShareId string required
opts *godo.NfsDeleteOptions

Fields of `godo.NfsDeleteOptions`

NfsDeleteOptions represents the options for deleting an NFS share.

Region string: Region is retained for compatibility with the existing NFS API.
DeleteSnapshots bool: DeleteSnapshots deletes the share's active snapshots along with it.

Returns

*godo.Response: The HTTP response, with pagination Links, Meta, and Rate limit information.
error: Non-nil when the request fails. API errors are returned as *godo.ErrorResponse.

Fields of `godo.Response`

Response is a DigitalOcean response. This wraps the standard http.Response returned from DigitalOcean.

Response *http.Response
Links *godo.Links: Links that were returned with the response. These are parsed from
request body and not the header.
Meta *godo.Meta: Meta describes generic information about the response.
Monitor string: Monitoring URI
Rate godo.Rate

Request Sample

Show Request Sample

package main

import (
	"context"
	"log"
	"os"

	"github.com/digitalocean/godo"
)

func main() {
	client := godo.NewFromToken(os.Getenv("DIGITALOCEAN_TOKEN"))
	ctx := context.TODO()

	_, err := client.Nfs.DeleteWithOptions(ctx, "<your-nfs-share-id>", &godo.NfsDeleteOptions{
		Region: "<your-region>",
		DeleteSnapshots: true,
	})
	if err != nil {
		log.Fatal(err)
	}
}