openapi: 3.0.1
info:
title: FlashArray REST Active Directory Directory Snapshots 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 Snapshots
description: 'Directory snapshots are created manually or by adding snapshot policies to managed directories.
Each snapshot policy can be re-used for multiple directories.
'
paths:
/api/2.52/directory-snapshots:
get:
tags:
- Directory Snapshots
summary: Pure Storage List Directory Snapshots
description: 'Displays a list of directory snapshots, including those pending eradication.
'
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/Filter'
- $ref: '#/components/parameters/Ids'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Names'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Sort'
- $ref: '#/components/parameters/Source_ids'
- $ref: '#/components/parameters/Source_names'
- $ref: '#/components/parameters/Total_item_count'
- $ref: '#/components/parameters/Total_only'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DirectorySnapshotGetResponse'
'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/DirectorySnapshotGetResponse'
post:
tags:
- Directory Snapshots
summary: Pure Storage Create Directory Snapshot
description: 'Creates a snapshot of the contents of a directory.
The `source_ids` or `source_names` parameter is required, but they cannot be set together.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Source_ids'
- $ref: '#/components/parameters/Source_names'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DirectorySnapshotPost'
required: true
x-codegen-request-body-name: directory-snapshot
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DirectorySnapshotResponse'
x-codegen-request-body-name: directory-snapshot
delete:
tags:
- Directory Snapshots
summary: Pure Storage Delete Directory Snapshot
description: 'Deletes a directory snapshot that has been destroyed and is pending eradication.
Eradicated directory snapshots cannot be recovered.
Directory snapshots are destroyed by using the PATCH method.
The `ids` or `names` parameter is required, but they cannot be set together.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Ids'
- $ref: '#/components/parameters/Names'
responses:
'200':
description: OK
content: {}
patch:
tags:
- Directory Snapshots
summary: Pure Storage Modify Directory Snapshot
description: 'Modifies a directory snapshot. You can destroy, recover, or update the policy or time remaining
of a directory snapshot.
To destroy a directory snapshot, set `destroyed=true`.
To recover a directory snapshot that has been destroyed and is pending eradication,
set `destroyed=false`.
To rename a directory snapshot, set `name` to the new name.
The `ids` or `names` parameter is required, but they cannot be set together.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Ids'
- $ref: '#/components/parameters/Names'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DirectorySnapshotPatch'
required: true
x-codegen-request-body-name: directory-snapshot
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DirectorySnapshotResponse'
x-codegen-request-body-name: directory-snapshot
components:
parameters:
Total_only:
name: total_only
in: query
description: 'If set to `true`, returns the aggregate value of all items after filtering.
Where it makes more sense, the average value is displayed instead.
The values are displayed for each name where meaningful.
If `total_only=true`, the `items` list will be empty.
'
schema:
type: boolean
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
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
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
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
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
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
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
Names:
name: names
in: query
description: 'Performs the operation on the unique names specified.
Enter multiple names in comma-separated format.
For example, `name01,name02`.
If there is not at least one resource that matches
each of the elements of `names`, then an error is returned,
except when creating new resources.
'
style: form
explode: false
schema:
type: array
items:
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
Source_names:
name: source_names
in: query
description: 'Performs the operation on the source name specified.
Enter multiple source names in comma-separated format. For example, `name01,name02`.
'
style: form
explode: false
schema:
type: array
items:
type: string
Source_ids:
name: source_ids
in: query
description: 'Performs the operation on the source ID specified.
Enter multiple source IDs in comma-separated format.
'
style: form
explode: false
schema:
type: array
items:
type: string
Ids:
name: ids
in: query
description: "A comma-separated list of unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n if ids or names is not provided, but it cannot be used together with name or names.\n"
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
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'
_resource:
description: '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), or correspond to something in the environment, like a host or a
server.
'
type: object
properties:
id:
description: 'A globally unique, system-generated ID.
The ID cannot be modified and cannot refer to another resource.
'
type: string
readOnly: true
name:
description: 'A user-specified name.
The name must be locally unique and can be changed.
'
type: string
_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
DirectorySnapshotPost:
type: object
properties:
client_name:
description: 'The client name portion of the client visible snapshot name.
A full snapshot name is constructed in the form of `DIR.CLIENT_NAME.SUFFIX` where
`DIR` is the managed directory name, `CLIENT_NAME` is the value of this field, and
`SUFFIX` is the suffix. The client visible snapshot name is `CLIENT_NAME.SUFFIX`.
'
type: string
keep_for:
description: 'The time to keep the snapshots for, in milliseconds.
'
type: integer
format: int64
suffix:
description: 'The suffix portion of the client visible snapshot name.
A full snapshot name is constructed in the form of `DIR.CLIENT_NAME.SUFFIX` where
`DIR` is the managed directory name, `CLIENT_NAME` is the client name, and
`SUFFIX` is the value of this field.
The client visible snapshot name is `CLIENT_NAME.SUFFIX`.
If not specified, defaults to a monotonically increasing number generated by the system.
'
type: string
_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
DirectorySnapshotPatch:
allOf:
- $ref: '#/components/schemas/_destroyedPatchPost'
- type: object
properties:
client_name:
description: 'The client name portion of the client-visible snapshot name.
A full snapshot name is constructed in the form of `DIR.CLIENT_NAME.SUFFIX` where
`DIR` is the managed directory name, `CLIENT_NAME` is the value of this field, and
`SUFFIX` is the suffix. The client-visible snapshot name is `CLIENT_NAME.SUFFIX`.
The client name of a directory snapshot managed by a snapshot policy is not
changeable.
If the `name` and `client_name` parameters are both specified, `client_name`
must match the client name portion of `name`.
'
type: string
keep_for:
description: 'The amount of time to keep the snapshots, in milliseconds.
Can only be set on snapshots that are not managed by any snapshot policy.
Set to `""` to clear the keep_for value.
'
type: integer
format: int64
name:
description: 'The new name of a directory snapshot.
The name of a directory snapshot managed by a snapshot policy is not changeable.
'
type: string
policy:
description: 'The snapshot policy that manages this snapshot.
Set to `name` or `id` to `""` to clear the policy.
'
title: Reference
allOf:
- $ref: '#/components/schemas/_reference'
suffix:
description: 'The suffix portion of the client-visible snapshot name.
A full snapshot name is constructed in the form of `DIR.CLIENT_NAME.SUFFIX` where
`DIR` is the managed directory name, `CLIENT_NAME` is the client name, and
`SUFFIX` is the value of this field.
The client-visible snapshot name is `CLIENT_NAME.SUFFIX`.
The suffix of a directory snapshot managed by a snapshot policy is not changeable.
If the `name` and `suffix` parameters are both specified, `suffix` must match
the suffix portion of `name`.
'
type: string
DirectorySnapshotResponse:
type: object
properties:
items:
description: 'Displays a list of all items after filtering.
If applicable, the values are displayed for each name.
'
type: array
items:
$ref: '#/components/schemas/DirectorySnapshot'
_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
DirectorySnapshot:
allOf:
- $ref: '#/components/schemas/_resource'
- $ref: '#/components/schemas/_context'
- description: A point-in-time image of the contents of the directory.
type: object
properties:
client_name:
description: 'The customizable portion of the client-visible snapshot name.
A full snapshot name is constructed in the form of `DIR.CLIENT_NAME.SUFFIX` where
`DIR` is the full managed directory name, `CLIENT_NAME` is the client name,
and `SUFFIX` is the suffix.
The client-visible snapshot name is `CLIENT_NAME.SUFFIX`.
'
type: string
created:
description: 'The snapshot creation time, measured in milliseconds since the UNIX epoch.
'
type: integer
format: int64
readOnly: true
destroyed:
description: 'Returns a value of `true` if the snapshot has been destroyed and is pending eradication.
The `time_remaining` value displays the amount of time left until the destroyed directory
snapshot is permanently eradicated.
Before the `time_remaining` period has elapsed, the destroyed directory snapshot can be
recovered by setting `destroyed=false`.
Once the `time_remaining` period has elapsed,
the directory snapshot is permanently eradicated and can no longer be recovered.
'
type: boolean
eradication_config:
$ref: '#/components/schemas/DirectorySnapshotEradicationConfig'
policy:
description: 'The snapshot policy that manages this snapshot, if applicable.
'
title: FixedReference
allOf:
- $ref: '#/components/schemas/_fixedReference'
source:
description: 'The directory from which this snapshot was taken.
'
title: FixedReference
allOf:
- $ref: '#/components/schemas/_fixedReference'
space:
description: 'Displays size and space consumption details.
'
title: Space
allOf:
- $ref: '#/components/schemas/_space'
suffix:
description: 'The suffix that is appended to the `source_name` value and the `client_name` value to
generate the full directory snapshot name in the form of `DIR.CLIENT_NAME.SUFFIX` where
`DIR` is the managed directory name, `CLIENT_NAME` is the client name, and `SUFFIX` is
the suffix. If the suffix is a string, this field returns `null`. See the `name` value
for the full snapshot name including the suffix.
'
type: integer
format: int64
time_remaining:
description: 'The amount of time left until the directory snapshot is permanently eradicated, measured in
milliseconds.
Before the `time_remaining` period has elapsed, the snapshot can be recovered
by setting `destroyed=false` if it is destroyed, by setting `policy=""` if it is
managed by a snapshot policy, or by setting `keep_for=""` if it is a manual
snapshot.
'
type: integer
format: int64
readOnly: true
DirectorySnapshotGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/DirectorySnapshotResponse'
- $ref: '#/components/schemas/_errorContextResponse'
- type: object
properties:
total:
description: 'The aggregate value of all items after filtering.
When applicable, the average value is displayed instead.
If applicable, the values are displayed for each field.
'
type: array
items:
$ref: '#/components/schemas/DirectorySnapshot'
DirectorySnapshotEradicationConfig:
description: The configuration of the eradication feature.
type: object
properties:
manual_eradication:
description: 'Manual eradication status of directory snapshots.
If manual_eradication is `disabled`, you cannot eradicate objects.
Values include `disabled` and `enabled`.
'
type: string
readOnly: true
example: enabled
x-readOnly: true
_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
_destroyedPatchPost:
type: object
properties:
destroyed:
description: 'If set to `true`, destroys a resource. Once set to `true`,
the `time_remaining` value will display the amount of time left
until the destroyed resource is permanently eradicated.
Before the `time_remaining` period has elapsed, the destroyed resource
can be recovered by setting `destroyed=false`.
Once the `time_remaining` period has elapsed,
the resource is permanently eradicated and can no longer be recovered.
'
type: boolean
_space:
type: object
properties:
data_reduction:
description: 'The ratio of mapped sectors within a volume versus
the amount of physical space the data occupies after data compression and deduplication.
The data reduction ratio does not include thin provisioning savings.
For example, a data reduction ratio of 5:1 means that
for every 5 MB the host writes to the array, 1 MB is stored on the array''s flash modules.
'
type: number
format: float
readOnly: true
footprint:
description: 'The maximum amount of physical space the container consumes on an array,
ignoring any data shared outside the container, measured in bytes.
On Evergreen//One arrays, this is the maximum amount of effective used space.
The footprint metric is mostly used for capacity planning.
This field will be null in non-container contexts.
'
type: integer
format: int64
minimum: 0
readOnly: true
shared:
description: 'The physical space occupied by deduplicated data, meaning that the space is shared with other
volumes and snapshots as a result of data deduplication.
Measured in bytes.
On Evergreen//One arrays, this is the effective space contributed by data that is not unique
to a specific volume, managed directory, or snapshot, measured in bytes.
'
type: integer
format: int64
minimum: 0
readOnly: true
example: 111863360624
snapshots:
description: 'The physical space occupied by data unique to one or more snapshots.
Measured in bytes.
On Evergreen//One arrays, this is the effective space contributed by data unique to one or
more snapshots, measured in bytes.
'
type: integer
format: int64
minimum: 0
readOnly: true
system:
description: 'The physical space occupied by internal array metadata. Measured in bytes.
'
type: integer
format: int64
minimum: 0
readOnly: true
thin_provisioning:
description: 'The percentage of volume sectors that do not contain host-written data
because the hosts have not written data to them or the sectors have been explicitly trimmed.
'
type: number
format: float
minimum: 0
maximum: 1
readOnly: true
total_physical:
description: 'This field has been deprecated.
Use the `total_used` field, as it contains the same information.
'
type: integer
format: int64
minimum: 0
readOnly: true
total_provisioned:
description: 'The provisioned size of a volume for a single volume, host or host group,
protocol endpoint, managed directory, and containers can be infinite or measured in bytes.
Infinite is represented by `null`.
The provisioned size for a host or host group, includes all volumes
that are connected to the resource.
The provisioned size for a protocol endpoint is `null`.
The provisioned size for a managed directory is the quota limit if it
or its parent has a managed directory configured, otherwise it defaults to `null`.
The provisioned size for a container is the sum of the total_provisioned
of the object it contains, capped by the container''s quota limit
(or the container''s used_provisioned if current usage is above the quota limit), if any.
Provisioned size represents the storage capacity reported to hosts.
'
type: integer
format: int64
minimum: 0
readOnly: true
example: 19937690345472
total_reduction:
description: 'The ratio of provisioned sectors within a volume versus
the amount of physical space the data occupies
after reduction via data compression and deduplication
and with thin provisioning savings.
Total reduction is data reduction with thin provisioning savings.
For example, a total reduction ratio of 10:1 means that
for every 10 MB of provisioned space,
1 MB is stored on the array''s flash modules.
'
type: number
format: float
readOnly: true
total_used:
description: 'The total space contributed by customer data, measured in bytes.
'
type: integer
format: int64
minimum: 0
readOnly: true
unique:
description: 'The unique physical space occupied by customer data.
Unique physical space does not include shared space, snapshots, and internal array metadata.
Measured in bytes.
On Evergreen//One arrays, this is the effective space contributed by unique customer data,
measured in bytes.
Unique data does not include shared space, snapshots, and internal array metadata.
'
type: integer
format: int64
minimum: 0
readOnly: true
used_provisioned:
description: 'The amount of logical space a container has consumed,
compared against the quota limit if the container has one configured.
Used provisioned does not include destroyed objects inside the container.
Used provisioned can include destroyed objects for a destroyed container
and represents how much logical space it would take to recover the container.
'
type: integer
format: int64
minimum: 0
readOnly: true
example: 19937690345472
virtual:
description: 'The amount of logic
# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/openapi/pure-storage-directory-snapshots-api-openapi.yml