Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: FlashArray REST Active Directory Remote Protection Group 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 Protection Group Snapshots
description: 'A remote protection group snapshot represents a protection group snapshot that resides on an
offload target with the source side of the remote protection group snapshot being another array
that is connected to the local array. The local array can only see the remote protection group
snapshots of other arrays if the two arrays are connected.
'
paths:
/api/2.52/remote-protection-group-snapshots:
get:
tags:
- Remote Protection Group Snapshots
summary: Pure Storage List Remote Protection Group Snapshots
description: 'Displays a list of remote protection group 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/RemoteProtectionGroupSnapshotGetResponse'
'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/RemoteProtectionGroupSnapshotGetResponse'
post:
tags:
- Remote Protection Group Snapshots
summary: Pure Storage Create Remote Protection Group Snapshot and Tags
description: 'Creates remote protection group snapshots.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Allow_throttle_snapshot'
- $ref: '#/components/parameters/Apply_retention'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Convert_source_to_baseline'
- $ref: '#/components/parameters/For_replication'
- $ref: '#/components/parameters/Ids'
- $ref: '#/components/parameters/Names'
- $ref: '#/components/parameters/OnSingle'
- $ref: '#/components/parameters/Replicate'
- $ref: '#/components/parameters/Replicate_now'
- $ref: '#/components/parameters/Source_ids'
- $ref: '#/components/parameters/Source_names'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RemoteProtectionGroupSnapshotPost'
required: false
x-codegen-request-body-name: remote-protection-group-snapshot
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RemoteProtectionGroupSnapshotResponse'
x-codegen-request-body-name: remote-protection-group-snapshot
delete:
tags:
- Remote Protection Group Snapshots
summary: Pure Storage Delete a Remote Protection Group Snapshot
description: 'Deletes a remote protection group snapshot that has been destroyed and is pending eradication.
Eradicated remote protection group snapshots cannot be recovered.
Remote protection group snapshots are destroyed using the `PATCH` method.
The `names` parameter represents the name of the protection group 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/Ids'
- $ref: '#/components/parameters/Names'
- $ref: '#/components/parameters/OnSingle'
responses:
'200':
description: OK
content: {}
patch:
tags:
- Remote Protection Group Snapshots
summary: Pure Storage Modify a Remote Protection Group Snapshot
description: 'Modifies a remote protection group snapshot, removing it from the offload target and
destroying the snapshot.
The `on` parameter represents the name of the offload target.
The `ids` or `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/Ids'
- $ref: '#/components/parameters/Names'
- $ref: '#/components/parameters/OnSingle'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/_destroyedPatchPost'
required: true
x-codegen-request-body-name: remote-protection-group-snapshot
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RemoteProtectionGroupSnapshotResponse'
x-codegen-request-body-name: remote-protection-group-snapshot
/api/2.52/remote-protection-group-snapshots/transfer:
get:
tags:
- Remote Protection Group Snapshots
summary: Pure Storage List Remote Protection Groups with Transfer Statistics
description: 'Displays a list of remote protection groups 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/RemoteProtectionGroupSnapshotTransferGetResponse'
'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/RemoteProtectionGroupSnapshotTransferGetResponse'
/api/2.52/remote-protection-group-snapshots/test:
post:
tags:
- Remote Protection Group Snapshots
summary: Pure Storage Create an Attempt to Take Remote Protection Group Snapshot
description: 'Creates an attempt to take a remote protection group snapshot without
actually taking it, to test if the snapshot can be successfully taken.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Allow_throttle_snapshot'
- $ref: '#/components/parameters/Apply_retention'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Convert_source_to_baseline'
- $ref: '#/components/parameters/For_replication'
- $ref: '#/components/parameters/Ids'
- $ref: '#/components/parameters/Names'
- $ref: '#/components/parameters/OnSingle'
- $ref: '#/components/parameters/Replicate'
- $ref: '#/components/parameters/Replicate_now'
- $ref: '#/components/parameters/Source_ids'
- $ref: '#/components/parameters/Source_names'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RemoteProtectionGroupSnapshotPost'
required: false
x-codegen-request-body-name: remote-protection-group-snapshot
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TestResultWithResourceWithIdPostResponse'
x-codegen-request-body-name: remote-protection-group-snapshot
components:
schemas:
TestResultWithResourceWithId:
allOf:
- $ref: '#/components/schemas/TestResult'
- $ref: '#/components/schemas/_context'
- type: object
properties:
resource:
description: 'A reference to the object being tested.
'
title: FixedReference
allOf:
- $ref: '#/components/schemas/_fixedReference'
TestResultWithResourceWithIdPostResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/TestResultWithResourceWithId'
RemoteProtectionGroupSnapshotTransferResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/RemoteProtectionGroupSnapshotTransfer'
RemoteProtectionGroupSnapshotPost:
allOf:
- $ref: '#/components/schemas/RemoteProtectionGroupSnapshot'
- type: object
properties:
destroyed:
type: boolean
readOnly: true
suffix:
description: 'Specifies a name suffix for the snapshots created. The snapshot is created on the FlashArray
specified by the `on` parameter. The `on` parameter cannot refer to an offload target.
Snapshots with suffixes specified have names in the form `PGROUP.SUFFIX` instead of the
default `PGROUP.NNN` form. The names of all snapshots created by a single command that
specifies this option have the same suffix.
'
type: string
tags:
description: 'The list of tags to be upserted with the object.
'
type: array
items:
$ref: '#/components/schemas/Tag'
Tag:
allOf:
- $ref: '#/components/schemas/_context'
- type: object
properties:
copyable:
description: 'Specifies whether or not to include the tag when copying the parent resource.
If set to `true`, the tag is included in resource copying.
If set to `false`, the tag is not included.
If not specified, defaults to `true`.
'
type: boolean
example: true
key:
description: 'Key of the tag. Supports up to 64 Unicode characters.
'
type: string
example: environment
namespace:
description: 'Optional namespace of the tag.
Namespace identifies the category of the tag. Omitting the namespace
defaults to the namespace `default`. The `pure*` namespaces are
reserved for plugins and integration partners. It is recommended
that customers avoid using reserved namespaces.
'
type: string
example: default
resource:
$ref: '#/components/schemas/_fixedReference'
value:
description: 'Value of the tag. Supports up to 256 Unicode characters.
'
type: string
example: staging
_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
_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
_builtIn:
description: '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 a controller. Others are created by the system in response to some event
(e.g., alerts, audit records).
Typically, a user can''t create, delete or rename a built-in resource. A few
can be created or deleted, but not renamed because the names are meaningful
to Purity (e.g., VIFs).
'
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 locally unique, system-generated name. The name cannot be modified.
'
type: string
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'
RemoteProtectionGroupSnapshotResponse:
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/RemoteProtectionGroupSnapshot'
RemoteProtectionGroupSnapshotTransferGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/RemoteProtectionGroupSnapshotTransferResponse'
- $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.
If applicable, the values are displayed for each field.
'
type: array
items:
$ref: '#/components/schemas/RemoteProtectionGroupSnapshotTransfer'
TestResult:
type: object
properties:
component_address:
description: Address of the component running the test.
type: string
example: 10.230.94.21
component_name:
description: Name of the component running the test.
type: string
example: CT0
description:
description: What the test is doing.
type: string
example: Testing phonehome connectivity
destination:
description: The URI of the target server being tested.
type: string
example: ra.cloud-support.purestorage.com
enabled:
description: 'Whether the object being tested is enabled or not.
Returns a value of `true` if the the service is enabled.
Returns a value of `false` if the service is disabled.
'
type: boolean
example: true
result_details:
description: Additional information about the test result.
type: string
example: Timeout connecting to phonehome endpoint
success:
description: 'Whether the object being tested passed the test or not.
Returns a value of `true` if the specified test has succeeded.
Returns a value of `false` if the specified test has failed.
'
type: boolean
test_type:
description: 'Displays the type of test being performed. The returned values are determined
by the `resource` being tested and its configuration.
Values include `array-admin-group-searching`, `binding`, `connecting`, `phonehome`,
`phonehome-ping`, `remote-assist`, `rootdse-searching`, `read-only-group-searching`,
`storage-admin-group-searching`, and `validate-ntp-configuration`.
'
type: string
example: phonehome
_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
_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
RemoteProtectionGroupSnapshotGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/RemoteProtectionGroupSnapshotResponse'
- $ref: '#/components/schemas/_errorContextResponse'
RemoteProtectionGroupSnapshotTransfer:
allOf:
- $ref: '#/components/schemas/_resource'
- $ref: '#/components/schemas/_transfer'
- $ref: '#/components/schemas/_context'
- description: 'The transfer statistics for snapshot replication.
'
type: object
properties:
source:
description: 'The original protection group from which this snapshot was taken.
'
title: Reference
allOf:
- $ref: '#/components/schemas/_reference'
_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
_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
RemoteProtectionGroupSnapshot:
allOf:
- $ref: '#/components/schemas/_builtIn'
- $ref: '#/components/schemas/_context'
- description: 'A remote protection group snapshot is a collection of point-in-time
consistent volume snapshots, for volumes associated with the remote
protection group when the snapshot was taken.
'
type: object
properties:
created:
description: 'The creation time of the snapshot on the original source of the snapshot.
Measured in milliseconds since the UNIX epoch.
'
type: integer
format: int64
readOnly: true
example: 1503520993
destroyed:
description: 'Destroyed and pending eradication? If not specified, defaults to false.
'
type: boolean
is_local:
description: 'The status of whether or not the remote protection group snapshot is replicated from
the current array.
'
type: boolean
readOnly: true
remote:
description: 'The offload target where the remote protection group snapshot is located.
'
title: FixedReference
allOf:
- $ref: '#/components/schemas/_fixedReference'
source:
description: 'The original protection group from which this snapshot was taken.
'
title: FixedReference
allOf:
- $ref: '#/components/schemas/_fixedReference'
suffix:
description: 'The suffix that is appended to the `source_name` value to generate the full
remote protection group snapshot name in the form `PGROUP.SUFFIX`.
If the suffix is not specified, the system constructs the snapshot name in the form
`PGROUP.NNN`, where `PGROUP` is the protection group name, and `NNN` is a monotonically
increasing number.
'
type: string
time_remaining:
description: 'The time remaining until eradication, measured in milliseconds,
if the snapshot has been destroyed.
'
type: integer
format: int64
readOnly: true
_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
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
parameters:
OnSingle:
name: 'on'
in: query
description: 'Performs the operation on the target name specified.
For example, `targetName01`.
'
schema:
type: string
Replicate_now:
name: replicate_now
in: query
description: 'If set to `true`, replicates the snapshots to each allowed target.
The `replicate` and `replicate_now` parameters cannot be used together.
'
schema:
type: boolean
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_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
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
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
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
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
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
For_replication:
name: for_replication
in: query
description: 'If `true`, destroys and eradicates the snapshot after 1 hour.
'
schema:
type: boolean
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
f
# --- truncated at 32 KB (37 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/openapi/pure-storage-remote-protection-group-snapshots-api-openapi.yml