openapi: 3.0.1
info:
title: FlashArray REST Active Directory Directory Exports API
version: '2.52'
description: 'Active Directory configuration authenticates users for NFS using Kerberos or SMB using Kerberos
or New Technology LAN Manager (NTLM). Active Directory is also used to authorize users by
mapping identities across the NFS and SMB protocols by using LDAP queries.
'
servers:
- url: /
tags:
- name: Directory Exports
description: 'Managed directory exports are created by adding NFS or SMB export policies to managed
directories.
'
paths:
/api/2.52/directory-exports:
get:
tags:
- Directory Exports
summary: Pure Storage List Directory Exports
description: 'Displays a list of directory exports.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Allow_errors'
- $ref: '#/components/parameters/Context_names_get'
- $ref: '#/components/parameters/Continuation_token'
- $ref: '#/components/parameters/Destroyed'
- $ref: '#/components/parameters/Directory_ids'
- $ref: '#/components/parameters/Directory_fqnames'
- $ref: '#/components/parameters/Export_names'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Directory_export_fqnames'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Policy_ids'
- $ref: '#/components/parameters/Policy_fqnames'
- $ref: '#/components/parameters/Sort'
- $ref: '#/components/parameters/Total_item_count'
- $ref: '#/components/parameters/Workload_ids'
- $ref: '#/components/parameters/Workload_names'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DirectoryExportGetResponse'
'207':
description: 'Partial success. Some resources were returned, but there
were also errors possibly preventing some resources from
being returned.
'
content:
application/json:
schema:
$ref: '#/components/schemas/DirectoryExportGetResponse'
post:
tags:
- Directory Exports
summary: Pure Storage Create Directory Exports
description: 'Creates an export of a managed directory.
The `directory_ids` or `directory_names` parameter is required, but cannot be set together.
The `policy_ids` or `policy_names` parameter is required, but cannot be set together.
When server reference is not provided, the `_array_server` is set as effective default.
The API provides two options for identifying an export object. One option is to reference
it by its fully qualified export name, or alternatively, by a combination of
parameters—specifically, the `server` and `export_name`. All identifying parameters must
always be provided, either explicitly or as part of the fully qualified name.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Directory_ids'
- $ref: '#/components/parameters/Directory_fqnames'
- $ref: '#/components/parameters/Directory_export_fqnames'
- $ref: '#/components/parameters/Policy_ids'
- $ref: '#/components/parameters/Policy_fqnames'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DirectoryExportPost'
required: true
x-codegen-request-body-name: exports
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DirectoryExportResponse'
x-codegen-request-body-name: exports
delete:
tags:
- Directory Exports
summary: Pure Storage Delete Directory Exports
description: 'Deletes one or more directory exports.
If any of the `export_names` is not unique across the system,
`policy_ids` or `policy_names` must be specified to determine the exports.
When server reference is not provided, the `_array_server` is set as effective default.
The API provides two options for identifying an export object. One option is to reference
it by its fully qualified export name, or alternatively, by a combination of
parameters-specifically, the `server_names` (or `server_ids`) and `export_names`. All
identifying parameters must always be provided, either explicitly or as part of the
fully qualified name.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Directory_ids'
- $ref: '#/components/parameters/Directory_fqnames'
- $ref: '#/components/parameters/Export_names'
- $ref: '#/components/parameters/Directory_export_fqnames'
- $ref: '#/components/parameters/Policy_ids'
- $ref: '#/components/parameters/Policy_fqnames'
- $ref: '#/components/parameters/Server_ids'
- $ref: '#/components/parameters/Server_fqnames'
responses:
'200':
description: OK
content: {}
patch:
tags:
- Directory Exports
summary: Pure Storage Modify Directory Exports
description: 'Modifies a directory export.
Used for manually renaming, enabling, and disabling directory exports.
To rename a directory export, set ''export_name'' to the new name.
When server reference is not provided, the `_array_server` is set as effective default.
The API provides two options for identifying an export object. One option is to reference
it by its fully qualified export name, or alternatively, by a combination of
parameters—specifically, the `server` and `export_name`. All identifying parameters must
always be provided, either explicitly or as part of the fully qualified name.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Directory_ids'
- $ref: '#/components/parameters/Directory_fqnames'
- $ref: '#/components/parameters/Export_names'
- $ref: '#/components/parameters/Directory_export_fqnames'
- $ref: '#/components/parameters/Policy_ids'
- $ref: '#/components/parameters/Policy_fqnames'
- $ref: '#/components/parameters/Server_ids'
- $ref: '#/components/parameters/Server_fqnames'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DirectoryExportPatch'
required: true
x-codegen-request-body-name: export
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DirectoryExportResponse'
x-codegen-request-body-name: export
components:
parameters:
Export_names:
name: export_names
in: query
description: 'Performs the operation on the export names specified. Enter multiple names in comma-separated
format. For example, `name01,name02`.
'
style: form
explode: false
schema:
type: array
items:
type: string
Filter:
name: filter
in: query
description: 'Narrows down the results to only the response objects
that satisfy the filter criteria.
'
schema:
type: string
Offset:
name: offset
in: query
description: 'The starting position based on the results of the query
in relation to the full set of response objects returned.
'
schema:
type: integer
format: int32
minimum: 0
example: 10
Directory_export_fqnames:
name: names
in: query
description: 'Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
Combines the export containment hierarchy (server), the protocol (smb or nfs)
and the export_name.
For example, `server01::smb::export01,server01::nfs::export01`.
'
style: form
explode: false
schema:
type: array
items:
type: string
Allow_errors:
name: allow_errors
in: query
description: 'If set to `true`, the API will allow the operation to continue even if there are errors.
Any errors will be returned in the `errors` field of the response.
If set to `false`, the operation will fail if there are any errors.
'
schema:
type: boolean
default: false
Policy_ids:
name: policy_ids
in: query
description: 'Performs the operation on the unique policy IDs specified.
Enter multiple policy IDs in comma-separated format.
The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
'
style: form
explode: false
schema:
type: array
items:
type: string
Continuation_token:
name: continuation_token
in: query
description: 'A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set `continuation_token` to the system-generated token taken from the `x-next-token`
header field of the response.
A query has reached its last page when the response does not include a token.
Pagination requires the `limit` and `continuation_token`
query parameters.
'
schema:
type: string
Directory_fqnames:
name: directory_names
in: query
description: 'Performs the operation on the managed directory names specified.
Enter multiple full managed directory names in comma-separated format.
The name is expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, `fs:dir01,pod01::fs:dir01`.
'
style: form
explode: false
schema:
type: array
items:
type: string
Context_names:
name: context_names
in: query
description: 'Performs the operation on the context specified.
If specified, the context names must be an array of size 1, and the single element
must be the name of an array in the same fleet or the name of the fleet itself. If
not specified, the context will default to the array that received this request.
Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided `context`.
'
style: form
explode: false
schema:
type: array
items:
type: string
Workload_ids:
name: workload_ids
in: query
description: 'A comma-separated list of workload IDs. If, after filtering, there is not at least one
resource that matches each of the elements, then an error is returned. This cannot be provided
together with the `workload_names` query parameter.
'
style: form
explode: false
schema:
type: array
items:
type: string
Directory_ids:
name: directory_ids
in: query
description: 'Performs the operation on the unique managed directory IDs specified.
Enter multiple managed directory IDs in comma-separated format.
The `directory_ids` or `directory_names` parameter is required, but they cannot be set together.
'
style: form
explode: false
schema:
type: array
items:
type: string
XRequestId:
name: X-Request-ID
in: header
description: 'Supplied by client during request or generated by server.
'
schema:
type: string
Limit:
name: limit
in: query
description: 'Limits the size of the response to the specified number of objects on each page.
To return the total number of resources, set `limit=0`.
The total number of resources is returned as a `total_item_count` value.
If the page size requested is larger than the system maximum limit,
the server returns the maximum limit, disregarding the requested page size.
'
schema:
type: integer
format: int32
minimum: 0
example: 10
Policy_fqnames:
name: policy_names
in: query
description: 'Performs the operation on the policy names specified.
Enter multiple policy names in comma-separated format.
The name is expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, `policy01,pod01::policy01`.
'
style: form
explode: false
schema:
type: array
items:
type: string
Authorization:
name: Authorization
in: header
description: 'Access token (in JWT format) required to use any API
endpoint (except `/oauth2`, `/login`, and `/logout`)
'
schema:
type: string
Context_names_get:
name: context_names
in: query
description: 'Performs the operation on the unique contexts specified.
If specified, each context name must be the name of an array in the same fleet or
the name of the fleet itself.
If not specified, the context will default to the array that received this request.
Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided `context`.
Enter multiple names in comma-separated format.
For example, `name01,name02`.
'
style: form
explode: false
schema:
type: array
items:
type: string
Server_ids:
name: server_ids
in: query
description: 'A comma-separated list of server IDs.
'
style: form
explode: false
schema:
type: array
items:
type: string
Total_item_count:
name: total_item_count
in: query
description: 'If set to `true`, the `total_item_count` matching the
specified query parameters is calculated and returned in
the response. If set to `false`, the `total_item_count`
is `null` in the response. This may speed up queries
where the `total_item_count` is large. If not specified,
defaults to `false`.
'
schema:
type: boolean
Workload_names:
name: workload_names
in: query
description: 'A comma-separated list of workload names. If, after filtering, there is not at least one
resource that matches each of the elements, then an error is returned. This cannot be provided
together with the `workload_ids` query parameter.
'
style: form
explode: false
schema:
type: array
items:
type: string
Server_fqnames:
name: server_names
in: query
description: 'Server names providing the context for the operation.
Names are expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, `server01,server02`.
'
style: form
explode: false
schema:
type: array
items:
type: string
Destroyed:
name: destroyed
in: query
description: 'If set to `true`, lists only destroyed objects that are in the eradication pending state.
If set to `false`, lists only objects that are not destroyed.
If not set, lists both objects that are destroyed and those that are not destroyed.
For destroyed objects, the time remaining is displayed in milliseconds.
If object name(s) or id(s) are specified, then each object referenced must exist.
If `destroyed` is set to `true`, then each object referenced must also be destroyed.
If `destroyed` is set to `false`, then each object referenced must also not be destroyed.
An error is returned if any of these conditions are not met.
'
schema:
type: boolean
Sort:
name: sort
in: query
description: "Sorts the response objects by the specified fields. Sorting can be applied to any field name\n in the response, in ascending order by default, or in descending order by prefixing the\n field name with a minus sign (-). Multiple fields can be specified as a comma-separated\n list (e.g., sort volumes by size descending, then by name ascending). If sort is provided,\n the response will not include a continuation_token.\n"
style: form
explode: false
schema:
type: array
items:
pattern: ^[a-z]+(_[a-z]+)*-?
type: string
schemas:
_errorContextResponse:
type: object
properties:
errors:
description: The list of errors encountered when attempting to perform an operation.
type: array
readOnly: true
items:
$ref: '#/components/schemas/_errorcontextresponseErrors'
ExportPolicyAttachmentMixin:
type: object
properties:
enabled:
description: 'Returns a value of `true` if and only if the export policy that manages this
export is enabled AND this export is enabled.
'
type: boolean
readOnly: true
export_name:
description: 'The export name for accessing this export.
'
type: string
status:
description: 'Explains why `enabled` is `false`, or whether there is a name conflict with
another export. Valid values include `policy_disabled`, `export_disabled`, and
`name_conflict`.
'
type: string
readOnly: true
_reference:
type: object
properties:
id:
description: 'A globally unique, system-generated ID.
The ID cannot be modified.
'
type: string
name:
description: 'The resource name, such as volume name, pod name,
snapshot name, and so on.
'
type: string
x-aliases:
- _referenceWithoutType
_errorcontextresponseErrors:
type: object
properties:
context:
description: 'Contains information relating to the cause of this error,
or the name of the object that was being processed when the error was encountered.
This may be `null` for more general errors.
'
type: string
location_context:
description: 'Contains information relating to the context in which the request was executing
when the error occurred.
For example, this may be the name of an array in the same fleet.
This may be `null` for more general errors, or if no explicit `context` parameter
was provided with the request.
'
title: FixedReferenceWithType
allOf:
- $ref: '#/components/schemas/_fixedReferenceWithType'
message:
description: A description of the error which occurred.
type: string
example: Resource does not exist.
x-aliases:
- _errorContextResponseErrors
_fixedReferenceWithType:
allOf:
- $ref: '#/components/schemas/_fixedReference'
- type: object
properties:
resource_type:
description: 'Type of the object (full name of the endpoint).
Valid values are the unique part of the resource''s REST endpoint.
For example, a reference to a file system would have a
`resource_type` of `file-systems`.
'
type: string
readOnly: true
x-aliases:
- _fixedReference
DirectoryExportPost:
type: object
properties:
export_enabled:
description: 'Indicates whether the export is enabled.
If set to `true`, the export is enabled.
If not specified, defaults to `true`.
'
type: boolean
example: false
export_name:
description: 'The name of the export to create.
Export names must be unique within the same protocol and server.
'
type: string
server:
description: 'Server to which the directory export is attached to.
'
title: Reference
allOf:
- $ref: '#/components/schemas/_reference'
DirectoryExportPatch:
type: object
properties:
export_enabled:
description: 'If set to `true`, the export is enabled.
If not specified, defaults to `true`.
'
type: boolean
example: false
export_name:
description: 'The new name of the export.
Export names must be unique within the same protocol.
'
type: string
_serverReference:
description: 'An object that is server-aware and can be associated to a server.
'
type: object
properties:
server:
description: 'Reference to the server the object belongs to. When the value is empty or set to `null`
it means the object lives outside of a server scope.
'
readOnly: true
title: FixedReferenceWithType
allOf:
- $ref: '#/components/schemas/_fixedReferenceWithType'
DirectoryExportGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/DirectoryExportResponse'
- $ref: '#/components/schemas/_errorContextResponse'
DirectoryExportResponse:
type: object
properties:
items:
description: 'Displays a list of all items after filtering.
The values are displayed for each name if meaningful.
'
type: array
items:
$ref: '#/components/schemas/DirectoryExport'
DirectoryExport:
allOf:
- $ref: '#/components/schemas/_context'
- $ref: '#/components/schemas/ExportPolicyAttachmentMixin'
- $ref: '#/components/schemas/_serverReference'
- type: object
properties:
destroyed:
description: 'Returns a value of `true` if the managed directory of the export has been destroyed and is
pending eradication.
The export can be recovered by recovering the destroyed managed directory.
'
type: boolean
readOnly: true
directory:
description: The managed directory of the export.
title: FixedReferenceWithType
allOf:
- $ref: '#/components/schemas/_fixedReferenceWithType'
enabled:
description: 'Returns a value of `true` if the export policy that manages this export is enabled.
'
type: boolean
readOnly: true
export_name:
description: The export name for accessing this export.
type: string
readOnly: true
name:
description: 'Name of the export configuration object.
Combines the export containment hierarchy (server), the protocol (SMB or NFS)
and the user-visible `export_name`.
'
type: string
example: server01::nfs::export01
path:
description: 'The path of the exported managed directory.
'
type: string
readOnly: true
policy:
description: 'The export policy that manages this export.
An export can be managed by at most one export policy.
'
title: FixedReferenceWithType
allOf:
- $ref: '#/components/schemas/_fixedReferenceWithType'
workload:
$ref: '#/components/schemas/_workloadConfigurationFixedReference'
_context:
type: object
properties:
context:
description: 'The context in which the operation was performed.
Valid values include a reference to any array which is a member of the same fleet
or to the fleet itself.
Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided `context`.
'
readOnly: true
title: FixedReferenceWithType
allOf:
- $ref: '#/components/schemas/_fixedReferenceWithType'
_fixedReference:
type: object
properties:
id:
description: 'A globally unique, system-generated ID.
The ID cannot be modified.
'
type: string
readOnly: true
name:
description: 'The resource name, such as volume name, file system name,
snapshot name, and so on.
'
type: string
readOnly: true
x-readOnly: true
x-aliases:
- _fixedReferenceWithoutType
_workloadConfigurationFixedReference:
description: 'The reference to the workload managing the resource. The `name` and `configuration` values
may display as the string `(unknown)` briefly following a failover.
'
allOf:
- $ref: '#/components/schemas/_fixedReferenceWithType'
- type: object
properties:
configuration:
description: 'The name of the preset configuration object.
'
type: string
readOnly: true
PageInfo:
type: object
properties:
continuation_token:
description: 'Continuation token that can be provided in the `continuation_token`
query param to get the next page of data.
If you use the continuation token to page through data you
are guaranteed to get all items exactly once regardless of
how items are modified. If an item is added or deleted during
the pagination then it may or may not be returned.
The continuation token is generated if the limit is less
than the remaining number of items, and the default sort is used
(no sort is specified).
'
type: string
more_items_remaining:
description: 'Returns a value of `true` if subsequent items can be retrieved.
'
type: boolean
example: false
total_item_count:
description: 'The total number of records after applying all filter query parameters.
The `total_item_count` will be calculated if and only if the corresponding
query parameter `total_item_count` is set to `true`. If this query parameter
is not set or set to `false`, a value of `null` will be returned.
'
type: integer
format: int32