openapi: 3.0.1
info:
title: FlashArray REST Active Directory Remote Volume 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: Remote Volume Snapshots
description: 'A remote volume snapshot represents a volume snapshot that resides on an offload target with the
source side of the remote volume snapshot being another array that is connected to the local
array. The local array can only see the remote volume snapshots of other arrays if the two
arrays are connected.
'
paths:
/api/2.52/remote-volume-snapshots:
get:
tags:
- Remote Volume Snapshots
summary: Pure Storage List Remote Volume Snapshots
description: Displays a list of remote volume snapshots.
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/On_'
- $ref: '#/components/parameters/Sort'
- $ref: '#/components/parameters/Source_ids'
- $ref: '#/components/parameters/Source_names'
- $ref: '#/components/parameters/Total_item_count'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RemoteVolumeSnapshotGetResponse'
'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/RemoteVolumeSnapshotGetResponse'
post:
tags:
- Remote Volume Snapshots
summary: Pure Storage Create a Volume Snapshot on a Connected Remote Target or Offload Target
description: Creates a volume snapshot on the specified connected remote target or offload target.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/OnSingle'
- $ref: '#/components/parameters/Source_ids'
- $ref: '#/components/parameters/Source_names'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RemoteVolumeSnapshotPost'
required: true
x-codegen-request-body-name: remote-volume-snapshot
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RemoteVolumeSnapshotResponse'
x-codegen-request-body-name: remote-volume-snapshot
delete:
tags:
- Remote Volume Snapshots
summary: Pure Storage Delete a Remote Volume Snapshot
description: 'Deletes a remote volume snapshot
that has been destroyed and is pending eradication.
Eradicated remote volume snapshots cannot be recovered.
Remote volume snapshots are destroyed through the `PATCH` method.
The `names` parameter represents the name of the volume snapshot.
The `on` parameter represents the name of the offload target.
The `names` and `on` parameters are required and must be used together.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Names'
- $ref: '#/components/parameters/OnSingle'
- $ref: '#/components/parameters/Replication_snapshot'
responses:
'200':
description: OK
content: {}
patch:
tags:
- Remote Volume Snapshots
summary: Pure Storage Modify a Remote Volume Snapshot
description: 'Modifies a remote volume snapshot by destroying or recovering it from the offload target.
The `on` parameter represents the name of the offload target.
The `names` parameter and the `on` parameter are required and must be used together.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Names'
- $ref: '#/components/parameters/OnSingle'
- $ref: '#/components/parameters/Replication_snapshot'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/_destroyedPatchPost'
required: true
x-codegen-request-body-name: remote-volume-snapshot
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RemoteVolumeSnapshotResponse'
x-codegen-request-body-name: remote-volume-snapshot
/api/2.52/remote-volume-snapshots/transfer:
get:
tags:
- Remote Volume Snapshots
summary: Pure Storage List Remote Volume Snapshots with Transfer Statistics
description: 'Displays a list of remote volume snapshots and their transfer statistics.
'
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/On_'
- $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/RemoteVolumeSnapshotTransferGetResponse'
'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/RemoteVolumeSnapshotTransferGetResponse'
components:
parameters:
On_:
name: 'on'
in: query
description: 'Performs the operation on the target name specified.
Enter multiple target names in comma-separated format.
For example, `targetName01,targetName02`.
'
style: form
explode: false
schema:
type: array
items:
type: string
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
OnSingle:
name: 'on'
in: query
description: 'Performs the operation on the target name specified.
For example, `targetName01`.
'
schema:
type: string
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
Replication_snapshot:
name: replication_snapshot
in: query
description: 'If set to `true`, allow destruction/eradication of snapshots in use by replication.
If set to `false`, allow destruction/eradication of snapshots not in use by replication.
If not specified, defaults to `false`.
'
schema:
type: boolean
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
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:
RemoteVolumeSnapshotGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/RemoteVolumeSnapshotResponse'
- $ref: '#/components/schemas/_errorContextResponse'
RemoteVolumeSnapshotTransferResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/RemoteVolumeSnapshotTransfer'
_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
RemoteVolumeSnapshotTransferGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/RemoteVolumeSnapshotTransferResponse'
- $ref: '#/components/schemas/_errorContextResponse'
- type: object
properties:
total:
description: '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 field where meaningful.
'
type: array
items:
$ref: '#/components/schemas/RemoteVolumeSnapshotTransfer'
_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
_transfer:
type: object
properties:
completed:
description: 'The timestamp of when the snapshot replication process completed.
Measured in milliseconds since the UNIX epoch.
'
type: integer
format: int64
readOnly: true
data_transferred:
description: 'The number of bytes transferred from the source to the target
as part of the replication process.
Measured in bytes.
'
type: integer
format: int64
readOnly: true
destroyed:
description: 'Returns a value of `true` if the snapshot has been destroyed and is pending eradication.
The destroyed snapshot can be recovered by setting `destroyed=false`.
Once the eradication pending period has elapsed,
the snapshot is permanently eradicated and can no longer be recovered.
'
type: boolean
physical_bytes_written:
description: 'The amount of physical/logical data written to the target due to replication.
Measured in bytes.
'
type: integer
format: int64
readOnly: true
progress:
description: 'The percentage progress of the snapshot transfer from the source array to the target.
Displayed in decimal format.
'
type: number
format: float
readOnly: true
example: 0.66
started:
description: 'The timestamp of when the snapshot replication process started.
Measured in milliseconds since the UNIX epoch.
'
type: integer
format: int64
readOnly: true
RemoteVolumeSnapshotResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/RemoteVolumeSnapshot'
RemoteVolumeSnapshotPost:
type: object
properties:
suffix:
description: 'The suffix that is appended to the `source_name` value to generate the
full volume snapshot name in the form `VOL.SUFFIX`.
If the suffix is not specified, the system constructs the snapshot name
in the form `VOL.NNN`, where `VOL` is the volume name, and `NNN` is a
monotonically increasing number.
'
type: string
_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'
RemoteVolumeSnapshotTransfer:
allOf:
- $ref: '#/components/schemas/_resource'
- $ref: '#/components/schemas/_transfer'
- $ref: '#/components/schemas/_context'
- description: 'The transfer statistics for snapshot replication data.
'
type: object
_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
RemoteVolumeSnapshot:
allOf:
- $ref: '#/components/schemas/_resource'
- $ref: '#/components/schemas/_snapshot'
- $ref: '#/components/schemas/_context'
- description: 'A volume snapshot on a remote target.
'
type: object
properties:
remote:
description: 'Remote target where this volume snapshot is located.
'
title: FixedReference
allOf:
- $ref: '#/components/schemas/_fixedReference'
_snapshot:
type: object
properties:
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 volume snapshot is permanently eradicated.
Before the `time_remaining` period has elapsed, the destroyed volume snapshot can be recovered
by setting `destroyed=false`.
Once the `time_remaining` period has elapsed,
the volume snapshot is permanently eradicated and can no longer be recovered.
'
type: boolean
pod:
description: 'A reference to the pod.
'
title: FixedReference
allOf:
- $ref: '#/components/schemas/_fixedReference'
provisioned:
description: 'The provisioned space of the snapshot. Measured in bytes. The minimum size is 1048576 (1MB),
the maximum size is 4503599627370496 (4PB)
'
type: integer
format: int64
readOnly: true
source:
description: 'The volume from which this snapshot was taken.
For a replicated snapshot being viewed on the target side, the
`source` is the replica volume.
'
title: FixedReference
allOf:
- $ref: '#/components/schemas/_fixedReference'
suffix:
description: 'The suffix that is appended to the `source_name` value to generate the full
volume snapshot name in the form `VOL.SUFFIX`.
If the suffix is not specified, the system constructs the snapshot name in the form `VOL.NNN`,
where `VOL` is the volume name, and `NNN` is a monotonically increasing number.
'
type: string
time_remaining:
description: 'The amount of time left until the destroyed snapshot is permanently eradicated.
Measured in milliseconds.
Before the `time_remaining` period has elapsed, the destroyed snapshot can be recovered
by setting `destroyed=false`.
'
type: integer
format: int64
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