openapi: 3.0.1
info:
title: FlashArray REST Active Directory Remote Protection Groups 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 Groups
description: 'A remote protection group represents a protection group that resides on an offload target with
the source side of the remote protection group being another array that is connected to the
local array. The local array can only see the remote protection groups of other arrays if the
two arrays are connected.
'
paths:
/api/2.52/remote-protection-groups:
get:
tags:
- Remote Protection Groups
summary: Pure Storage List Remote Protection Groups
description: 'Returns a list of remote protection groups.
'
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/Total_item_count'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RemoteProtectionGroupGetResponse'
'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/RemoteProtectionGroupGetResponse'
delete:
tags:
- Remote Protection Groups
summary: Pure Storage Delete a Remote Protection Group
description: 'Deletes a remote protection group that has been destroyed and is pending eradication.
Eradicated remote protection groups cannot be recovered.
Remote protection groups are destroyed through the `PATCH` method.
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'
responses:
'200':
description: OK
content: {}
patch:
tags:
- Remote Protection Groups
summary: Pure Storage Modify a Remote Protection Group
description: 'Modifies the snapshot retention schedule of a remote protection group.
Also destroys a remote protection group from the offload target.
Before the remote protection group can be destroyed,
the offload target must first be removed from the protection group via the source array.
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/RemoteProtectionGroup'
required: true
x-codegen-request-body-name: remote-protection-group
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RemoteProtectionGroupResponse'
x-codegen-request-body-name: remote-protection-group
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
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
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
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:
RemoteProtectionGroup:
allOf:
- $ref: '#/components/schemas/_builtIn'
- $ref: '#/components/schemas/_context'
- description: 'A remote protection group represents a protection group that is replicated
to an offload target.
'
type: object
properties:
destroyed:
description: 'Returns a value of `true` if the remote protection group has been destroyed
and is pending eradication.
The `time_remaining` value displays the amount of time left
until the destroyed remote protection group is permanently eradicated.
Before the `time_remaining` period has elapsed,
the destroyed remote protection group can be recovered by setting `destroyed=false`.
Once the `time_remaining` period has elapsed,
the remote protection group is permanently eradicated and can no longer be recovered.
'
type: boolean
is_local:
description: 'If set to `true`, the location reference is to the local array.
If set to `false`, the location reference is to a remote location,
such as a remote array or offload target.
'
type: boolean
readOnly: true
remote:
description: 'The offload target that the remote protection group is on.
'
title: FixedReference
allOf:
- $ref: '#/components/schemas/_fixedReference'
source:
description: 'The array where the remote protection group is replicated from.
'
title: FixedReference
allOf:
- $ref: '#/components/schemas/_fixedReference'
target_retention:
description: The retention policy for the remote protection group.
title: RetentionPolicy
allOf:
- $ref: '#/components/schemas/_retentionPolicy'
time_remaining:
description: 'Milliseconds remaining until eradication, if remote protection group
has been destroyed.
'
type: integer
format: int64
readOnly: true
_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'
_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
RemoteProtectionGroupResponse:
type: object
properties:
items:
description: 'Displays a list of all items after filtering.
The values are displayed for each name where meaningful.
'
type: array
items:
$ref: '#/components/schemas/RemoteProtectionGroup'
RemoteProtectionGroupGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/RemoteProtectionGroupResponse'
- $ref: '#/components/schemas/_errorContextResponse'
_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
_retentionPolicy:
description: The snapshot retention policy.
type: object
properties:
all_for_sec:
description: 'The length of time to keep the specified snapshots. Measured in seconds.
Prior to 6.8.2 the range of 60 to 34560000 is accepted.
In 6.8.2 and onwards the range of 60 to 2147483647 is accepted.
'
type: integer
format: int32
example: 86400
days:
description: 'The number of days to keep the snapshots after the `all_for_sec` period has passed.
Prior to 6.6.4 the range of 0 to 4000 is accepted.
In 6.6.4 and onwards the range of 0 to 2147483647 is accepted.
In 6.10.0 and onwards -1 may be used to keep snapshots forever.
'
type: integer
format: int32
example: 7
per_day:
description: 'Deprecated. per_day is deprecated in favor of per_period and period_length_ms.
The number of snapshots to keep per day after the `all_for_sec` period has passed.
Prior to 6.8.2 the range of 0 to 1440 is accepted.
In 6.8.2 and onwards the range of 0 to 2147483647 is accepted.
Equivalent to per_period when period_length_ms is 1 day, 86400000
'
type: integer
format: int32
example: 3
per_period:
description: 'The number of snapshots to keep per period_length_ms after the `all_for_sec` period has passed.
The range of 0 to 2147483647 is accepted.
'
type: integer
format: int32
example: 3
period_length_ms:
description: 'The length of time per_period should cover. Measured in milliseconds.
Must be a multiple of 86400000 to represent a whole number of days.
A minimum of 86400000, 1 day, is accepted.
'
type: integer
format: int64
example: 86400000
_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'
_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
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