DigitalOcean API (unofficial showcase)
DELETE/v2/nfs/access_points/{access_point_id}

Delete an NFS access point

To delete an NFS access point, send a DELETE request to /v2/nfs/access_points/{access_point_id}.

A successful request will soft-delete the access point and return the deleted access point with status ACCESS_POINT_DELETED and an action object indicating the delete operation.

The default access point (is_default: true) cannot be deleted. Access points already in ACCESS_POINT_DELETED or ACCESS_POINT_FAILED status return 400 Bad Request.

1 parameter
access_point_idstringrequired
The unique identifier of the NFS access point.

7 status codes
200The response will be a JSON object containing the deleted access point (marked as DELETED) and an action object indicating the delete operation.
access_pointobjectrequired
Represents an NFS access point resource.
actionobjectrequired
The action that was submitted.
400The request could not be processed due to invalid arguments or an ineligible access point state.

3 documented failures

  • MISSING_NAME

    name is required

  • InvalidArgument

    the default access point cannot be deleted

  • INVALID_ACCESS_POINT_STATUS

    invalid access point status

codestringrequired
A service-defined error code.
messagestringrequired
A human-readable description of the error.
401Authentication failed due to invalid credentials.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
404The resource was not found.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
429The API rate limit has been exceeded.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
500There was a server error.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
defaultThere was an unexpected error.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.

Error handling

A 400 is returned: The request could not be processed due to invalid arguments or an ineligible access point state. A 401 is returned: Authentication failed due to invalid credentials. A 404 is returned: The resource was not found. A 429 is returned: The API rate limit has been exceeded. A 500 is returned: There was a server error. Any other status is an error: There was an unexpected error.