Give Feedback

pydo.nfs.create_access_point()

Generated on 7 Jul 2026 from pydo version v0.39.0

Copy page as Markdown View page as Markdown

Usage

client.nfs.create_access_point(
    share_id="baf4827c-6fa9-456f-9dbd-9ddfcacd0720",
    body={
        "name": "other-vpc",
        "path": "/other-vpc",
        "access_policy": {...},
        ...,
    },
)

Returns JSONRaises HttpResponseError

Description

To create a new access point on an NFS share, send a POST request to /v2/nfs/shares/{share_id}/access_points.

A successful request will return the newly created access point and an action object.

The parent share must be in ACTIVE or INACTIVE status. Validation failures and precondition errors (such as an ineligible share state) return 400 Bad Request. Duplicate name or path conflicts return 409 Conflict.

Parameters

share_id string required

The unique identifier of the NFS share.

name string required

Example: other-vpc

The name for the access point. Must be unique per share. Must be 2–63
characters and match ^[a-zA-Z0-9][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$.
The name default is reserved (case-insensitive) for the implicit default
access point created with each share.

path string required

Example: /other-vpc

The export sub-path. Must start with /, must not be exactly / (reserved
for the default access point), must be at most 1024 characters, may contain
only alphanumerics, -, _, ., and /, and must not contain .. path
segments.

access_policy object required

Provider-agnostic NFS access policy for an access point. Network CIDRs are
managed by attach, detach, and managed-access workflows and are not part of
this policy.

Show child properties

anonuid integer required

Example: 65534

UID used for squashed users. Currently only 65534 is supported.

anongid integer required

Example: 65534

GID used for squashed users. Currently only 65534 is supported.

protocols array of strings required

Example: ['NFS4', 'NFS']

Allowed NFS protocols for this export.

squash_config string required

The squash mode applied to the access point export.

One of: NO_SQUASH, ROOT_SQUASH, ALL_SQUASH

identity_enforcement_enabled boolean required

Example: False

Whether identity enforcement is enabled for this export.

vpc_id string required

Example: 3f34cdb2-1e4f-4100-b5c7-f55f2762085f

Required. The VPC this access point will be pinned to. A storage gateway is
provisioned (or reused) in this VPC, and the access point becomes mountable from
this VPC regardless of whether the parent share is currently attached to it.

Request Sample

Show Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

req = {
  "name": "other-vpc",
  "path": "/other-vpc",
  "vpc_id": "3f34cdb2-1e4f-4100-b5c7-f55f2762085f",
  "access_policy": {
    "anonuid": 65534,
    "anongid": 65534,
    "protocols": [
      "NFS4",
      "NFS"
    ],
    "squash_config": "ROOT_SQUASH",
    "identity_enforcement_enabled": False
  }
}

resp = client.nfs.create_access_point(share_id="baf4827c-6fa9-456f-9dbd-9ddfcacd0720", body=req)

Response Example

Show Response Example

{
  "access_point": {
    "id": "7659ce91-354d-4f61-9cda-ae2c7feb61d9",
    "name": "other-vpc",
    "share_id": "baf4827c-6fa9-456f-9dbd-9ddfcacd0720",
    "path": "/other-vpc",
    "vpc_id": "3f34cdb2-1e4f-4100-b5c7-f55f2762085f",
    "status": "ACCESS_POINT_CREATING",
    "is_default": false,
    "created_at": "2026-06-25T08:11:12Z",
    "updated_at": "",
    "access_policy": {
      "anonuid": 65534,
      "anongid": 65534,
      "protocols": [
        "NFS4",
        "NFS"
      ],
      "squash_config": "ROOT_SQUASH",
      "identity_enforcement_enabled": false
    }
  },
  "action": {
    "id": "084c3b9c-2382-441b-92d4-10b095bb5d7c",
    "region_slug": "s2r1",
    "resource_id": "7659ce91-354d-4f61-9cda-ae2c7feb61d9",
    "resource_type": "SHARE",
    "type": "CREATE_ACCESS_POINT",
    "status": "IN_PROGRESS",
    "started_at": "2026-06-25T08:11:12Z"
  }
}

More Information

See /v2/nfs/shares/{share_id}/access_points in the API reference for additional detail on responses, headers, parameters, and more.