How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Pure Storage File Systems API

A FlashArray can contain up to 24 separate file systems, each with a number of directories thatcan be exported via supported protocols. Clients, using Active Directory or LDAP, can connectand access these exports using SMB or NFS.

Pure Storage File Systems API is one of 130 APIs that Pure Storage publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 12 JSON Schema definitions.

Tagged areas include Filesystem. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, code examples, a JSON-LD context, and 12 JSON Schemas.

This API exposes 38 operations across 21 paths, and defines 121 schemas. It is described by OpenAPI 3.2.0, at version 2.52.

Requests are made against a single base URL, /.

38 operations 21 paths 121 schemas 9 DELETE20 GET2 PATCH7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.52
Server
/
Resource Areas
1

Paths & Operations 38

Across 21 paths, the API surfaces 38 operations — 9 DELETE, 20 GET, 2 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.

File Systems 38

A FlashArray can contain up to 24 separate file systems, each with a number of directories that can be exported via supported protocols. Clients, using Active Directory or LDAP, c…

GET
/api/2.52/file-systems
Pure Storage List File Systems
15 params → 200207
POST
/api/2.52/file-systems
Pure Storage Create File System
7 params body → 200
DELETE
/api/2.52/file-systems
Pure Storage Delete File System
5 params → 200
PATCH
/api/2.52/file-systems
Pure Storage Modify a File System
5 params body → 200
GET
/api/2.26/file-systems
Pure Storage GET File-systems
14 params → 200207
POST
/api/2.26/file-systems
Pure Storage POST File-systems
9 params body → 200
DELETE
/api/2.26/file-systems
Pure Storage DELETE File-systems
4 params → 200
PATCH
/api/2.26/file-systems
Pure Storage PATCH File-systems
9 params body → 200
GET
/api/2.26/file-systems/data-eviction-policies
Pure Storage GET File-systems/data-eviction-policies
12 params → 200207
POST
/api/2.26/file-systems/data-eviction-policies
Pure Storage POST File-systems/data-eviction-policies
6 params → 200
DELETE
/api/2.26/file-systems/data-eviction-policies
Pure Storage DELETE File-systems/data-eviction-policies
6 params → 200
GET
/api/2.26/file-systems/groups/performance
Pure Storage GET File-systems/groups/performance
10 params → 200
GET
/api/2.26/file-systems/performance
Pure Storage GET File-systems/performance
13 params → 200
GET
/api/2.26/file-systems/audit-policies
Pure Storage GET File-systems/audit-policies
12 params → 200207
POST
/api/2.26/file-systems/audit-policies
Pure Storage POST File-systems/audit-policies
6 params → 200
DELETE
/api/2.26/file-systems/audit-policies
Pure Storage DELETE File-systems/audit-policies
6 params → 200
GET
/api/2.26/file-systems/policies
Pure Storage GET File-systems/policies
12 params → 200207
POST
/api/2.26/file-systems/policies
Pure Storage POST File-systems/policies
6 params → 200
DELETE
/api/2.26/file-systems/policies
Pure Storage DELETE File-systems/policies
6 params → 200
GET
/api/2.26/file-systems/policies-all
Pure Storage GET File-systems/policies-all
12 params → 200207
GET
/api/2.26/file-systems/users/performance
Pure Storage GET File-systems/users/performance
10 params → 200
GET
/api/2.26/file-systems/user-group-quota-policies
Pure Storage GET File-systems/user-group-quota-policies
12 params → 200207
POST
/api/2.26/file-systems/user-group-quota-policies
Pure Storage POST File-systems/user-group-quota-policies
8 params → 200
DELETE
/api/2.26/file-systems/user-group-quota-policies
Pure Storage DELETE File-systems/user-group-quota-policies
6 params → 200
GET
/api/2.26/file-systems/worm-data-policies
Pure Storage GET File-systems/worm-data-policies
12 params → 200207
GET
/api/2.26/file-systems/locks
Pure Storage Get a List of Active File Locks
12 params → 200
DELETE
/api/2.26/file-systems/locks
Pure Storage Invalidate File Locks
9 params → 200
GET
/api/2.26/file-systems/locks/clients
Pure Storage Get a List of Clients That Hold Active File Locks
6 params → 200
POST
/api/2.26/file-systems/locks/nlm-reclamations
Pure Storage Initiate NLM Reclamation.
2 params → 200
GET
/api/2.26/file-systems/sessions
Pure Storage Get a List of Active Sessions
9 params → 200
DELETE
/api/2.26/file-systems/sessions
Pure Storage Delete Sessions
7 params → 200
GET
/api/2.26/file-systems/space/storage-classes
Pure Storage GET File-systems/space/storage-classes
10 params → 200
GET
/api/2.26/file-systems/open-files
Pure Storage GET File-systems/open-files
11 params → 200
DELETE
/api/2.26/file-systems/open-files
Pure Storage DELETE File-systems/open-files
2 params → 200
GET
/api/2.26/file-systems/groups
Pure Storage GET File-systems/groups
12 params → 200207
GET
/api/2.26/file-systems/users
Pure Storage GET File-systems/users
13 params → 200207
GET
/api/1.5/file-systems
Pure Storage Get FlashArray and FlashBlade File Systems
9 params → 200400403404429500
GET
/api/1.5/file-systems/policies
Pure Storage Get FlashBlade File System / Policy Pairs
11 params → 200400403404429500

Schemas 121

The contract defines 121 schemas that model the data the API accepts and returns. The most detailed are FileSystemPost_2 (18 properties), _space (12 properties), FileSystemOpenFile (8 properties), _smb (4 properties). Each schema is shown below with its type and property counts.

_arrays
object
1 property
FileSystemUsersPerformanceGetResponse
object
2 properties
ContainerEradicationConfig
object
The status of the eradication functionality
1 property
FileSystemSpaceStorageClassGetResponse
FileSystemPatch_2
_referenceWithoutType
object
2 properties
_userSubject
object
3 properties
DataEvictionPoliciesMembersResponse
object
1 property
_nfs_2
object
2 properties
FileSession
FileSystemOpenFilesGetResponse
_fileSystemEradicationConfig
object
Configuration settings related to file system eradication.
2 properties
FileSystemPerformanceGetResponse
_referenceWritable
WormDataPoliciesMembersResponse
object
1 property
_builtIn
object
2 properties
_space
object
12 properties
Error
object
1 property
UserGroupQuotaLimitedBy
_errorcontextresponseErrors
object
3 properties
_http
object
1 property
AuditFileSystemsPoliciesMembersResponse
object
1 property
FileSystemResponse_2
object
1 property
FileSystem_2
PolicyMemberContextGetResponse
_workloadConfigurationReferencePost
object
The workload to which the resource is added. Set one of id or name, and configuration to add the resource to the workload and configure it based on the configu…
WormDataPoliciesMembersGetResponse
FileSystemOpenFilesResponse
object
1 property
FileSystem_3
UserGroupQuotaPoliciesMembersGetResponse
FileLockGetResponse
_errorContextResponse_2
object
1 property
FileSystemResponse_3
object
1 property
FileSystemPost_2
object
18 properties
FileSystemLockNlmReclamation
_builtInAsOf
A built-in resource. Many are singletons predefined by Purity (e.g., support settings). Some correspond to a piece of software, like an app, or hardware, like…
FileSessionGetResponse
FileSystemClient
_newName
object
1 property
_smb
object
4 properties
PolicyMember
object
2 properties
FileSystemPost
object
1 property
FileSystemUsersGetResponse
PolicyMembersResponse
object
1 property
_multiProtocolPost
object
2 properties
_destroyedPatchPost
object
1 property
_user
object
2 properties
_fixedReferenceNameOnly
object
1 property
FileSystemPerformance
_timeAware
object
1 property
_fixedReferenceWithType
_resource
object
An ordinary (as opposed to built-in) resource that can be created, named, renamed or deleted by the user. This might be a virtual resource (e.g., a file system…
2 properties
PolicyMemberContextResponse
object
1 property
_fixedReference_2
_smb_2
object
1 property
FileSystemUserPerformance
_errorErrors
object
2 properties
_workloadConfigurationReferencePatch
object
The instruction for removing the resource from the workload. Setting the id or name of the workload to an empty string ("") removes the resource.
FileSystem
_http_2
object
1 property
_nfsPatch
FileSystemGetResponse
StorageClassInfo
_realmsReference
object
1 property
_fixedLocationReference
_fixedReferenceFqdn
_workloadConfigurationReference_2
object
A reference to the workload that is managing this resource. The name and configuration may show as the string "(unknown)" briefly after a failover.
_workloadConfigurationReference
object
A reference to the workload that is managing this resource. The name and configuration may show as the string "(unknown)" briefly after a failover.
FileSystemGetResponse_2
FileSystemClientsResponse
object
1 property
_workloadConfigurationReferencePost_2
object
The workload to which the resource is added. Set one of id or name, and configuration to add the resource to the workload and configure it based on the configu…
AuditFileSystemsPoliciesMembersGetResponse
FileSystemGroup
_referenceWithFixedType
object
3 properties
PolicyMemberContext
FileSystemGroupsResponse
object
1 property
_workloadConfigurationReferencePatch_2
object
Set the id or name of the workload to an empty string to remove the resource from the workload.
_fixedReference_3
object
3 properties
FileSystemStorageClassSpace
PageInfo_2
object
2 properties
PolicyMembersGetResponse
_errorContextResponse
object
1 property
_fixedReferenceNoId
object
2 properties
UserGroupQuotaPoliciesMembersResponse
object
1 property
DataEvictionPoliciesMembersGetResponse
_group
object
2 properties
PageInfo
object
3 properties
FileSessionResponse
object
1 property
FileSystemOpenFile
object
8 properties
_builtInNoId
object
1 property
FileSystemUser
FileSystemGroupPerformance
_fixedReferenceWithoutType
object
2 properties
_context_2
object
1 property
_reference
object
2 properties
_referenceNameOnly
object
1 property
FileSystemUsersResponse
object
1 property
_arraysBuiltIn
A built-in resource that exists on one or multiple arrays.
FileSystemGroupsPerformanceGetResponse
object
2 properties
FileSystemGroupsGetResponse
_reference_2
object
3 properties
_context
object
1 property
ErrorNoContext
object
1 property
_fixedReference
object
2 properties
_groupSubject
object
3 properties
PolicyMember_2
An association between a policy and a member.
_locationReference
_smbPost
FileLockResponse
object
1 property
FileSystemPatch
FileLock
_fileLockRange
object
The range in bytes (offset, length) the lock covers within a file. If the lock reaches the end of the file, the length will be null. If the lock is set for the…
2 properties
FileLockNlmReclamationResponse
object
1 property
_user_no_id
object
1 property
_nfs
object
4 properties
FileSystemClientsGetResponse
_multiProtocol
object
2 properties
FileSystemGetResponse_3
FileSystemResponse
object
1 property
PageInfo_3
object
2 properties
_errorContextResponseErrors
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pure-storage-file-systems-api-openapi.yml Raw ↑

Other APIs Pure Storage publishes across the network.

Portworx Kubernetes API
Pure Storage Active Directory API
Pure Storage Administrators API
Pure Storage Alert Watchers API
Pure Storage Alerts API
Pure Storage API Clients API
Pure Storage Apps API
Pure Storage Array Connections API
Pure Storage Arrays API
Pure Storage Audit Log Target for File Systems API
Pure Storage Audit Log Target for Object Store API
Pure Storage Audits API
Where this information came from

This is an independent, third-party profile of Pure Storage File Systems API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.