openapi: 3.0.1
info:
title: FlashArray REST Active Directory Bucket Replica Links 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: Bucket Replica Links
description: Object replication requires a replica link that connects a source bucket to a remote bucket. The configuration of a replica link includes remote credentials, bucket names, remote names, replication status information, and cascading state.
paths:
/api/2.26/bucket-replica-links:
get:
tags:
- Bucket Replica Links
summary: Pure Storage GET Bucket-replica-links
description: List bucket replica links for object replication.
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Allow_errors'
- $ref: '#/components/parameters/Context_names_get'
- $ref: '#/components/parameters/Continuation_token'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Ids'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Local_bucket_ids'
- $ref: '#/components/parameters/Local_bucket_names'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Remote_bucket_names'
- $ref: '#/components/parameters/Remote_ids'
- $ref: '#/components/parameters/Remote_names'
- $ref: '#/components/parameters/Sort'
- $ref: '#/components/parameters/Total_only'
responses:
'200':
description: OK
headers:
X-Request-ID:
description: Supplied by client during request or generated by server.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/BucketReplicaLinkGetResponse'
'207':
description: 'Partial success. Some resources were returned, but there
were also errors possibly preventing some resources from
being returned.
'
headers:
X-Request-ID:
description: Supplied by client during request or generated by server.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/BucketReplicaLinkGetResponse'
post:
tags:
- Bucket Replica Links
summary: Pure Storage POST Bucket-replica-links
description: Create a bucket replica link for object replication.
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Local_bucket_ids'
- $ref: '#/components/parameters/Local_bucket_names'
- $ref: '#/components/parameters/Remote_bucket_names'
- $ref: '#/components/parameters/Remote_credentials_ids'
- $ref: '#/components/parameters/Remote_credentials_names'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BucketReplicaLinkPost'
required: true
x-codegen-request-body-name: bucket-replica-link
responses:
'200':
description: OK
headers:
X-Request-ID:
description: Supplied by client during request or generated by server.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/BucketReplicaLinkResponse'
x-codegen-request-body-name: bucket-replica-link
delete:
tags:
- Bucket Replica Links
summary: Pure Storage DELETE Bucket-replica-links
description: Delete a bucket replica link.
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Ids'
- $ref: '#/components/parameters/Local_bucket_ids'
- $ref: '#/components/parameters/Local_bucket_names'
- $ref: '#/components/parameters/Remote_bucket_names'
- $ref: '#/components/parameters/Remote_ids'
- $ref: '#/components/parameters/Remote_names'
responses:
'200':
description: OK
headers:
X-Request-ID:
description: Supplied by client during request or generated by server.
schema:
type: string
content: {}
patch:
tags:
- Bucket Replica Links
summary: Pure Storage PATCH Bucket-replica-links
description: Modify the configuration of a bucket replica link including whether the link is paused and the object store remote credentials used.
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Ids'
- $ref: '#/components/parameters/Local_bucket_ids'
- $ref: '#/components/parameters/Local_bucket_names'
- $ref: '#/components/parameters/Remote_bucket_names'
- $ref: '#/components/parameters/Remote_ids'
- $ref: '#/components/parameters/Remote_names'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BucketReplicaLink'
required: true
x-codegen-request-body-name: bucket-replica-link
responses:
'200':
description: OK
headers:
X-Request-ID:
description: Supplied by client during request or generated by server.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/BucketReplicaLinkResponse'
x-codegen-request-body-name: bucket-replica-link
/api/1.5/bucket-replica-links:
get:
tags:
- Bucket Replica Links
summary: Pure Storage Get Bucket Replica Links
description: 'Retrieves information about bucket replica links.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Continuation_token_2'
- $ref: '#/components/parameters/Filter_2'
- $ref: '#/components/parameters/Ids_2'
- $ref: '#/components/parameters/Limit_2'
- $ref: '#/components/parameters/Member_ids_plus'
- $ref: '#/components/parameters/Member_names_plus'
- $ref: '#/components/parameters/Offset_2'
- $ref: '#/components/parameters/Sort_2'
- $ref: '#/components/parameters/Source_ids_plus'
- $ref: '#/components/parameters/Source_names_plus'
- $ref: '#/components/parameters/Target_ids_plus'
- $ref: '#/components/parameters/Target_names_plus'
responses:
'200':
description: OK
headers:
X-Request-ID:
description: Supplied by client during request or generated by server.
schema:
type: string
X-RateLimit-Remaining-second:
description: 'The number of requests remaining for the organization in that second.
'
schema:
type: integer
X-RateLimit-Remaining-minute:
description: 'The number of requests remaining for the organization in that minute.
'
schema:
type: integer
X-RateLimit-Limit-second:
description: The number of requests available per second.
schema:
type: integer
X-RateLimit-Limit-minute:
description: The number of requests available per minute.
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/BucketReplicaLinkGetResponse_2'
'400':
$ref: '#/components/responses/Error400'
'403':
$ref: '#/components/responses/Error403'
'404':
$ref: '#/components/responses/Error404'
'429':
$ref: '#/components/responses/Error429'
'500':
$ref: '#/components/responses/Error500'
components:
schemas:
_referenceWithoutType:
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
_replicaLink:
allOf:
- $ref: '#/components/schemas/_resourceNoName'
- type: object
properties:
lag:
description: 'Duration, in milliseconds, which represents how far behind the
replication `target` is from the `source`.
'
type: integer
format: int64
readOnly: true
example: 1560
paused:
description: 'Returns `true` if the replica link is paused.
'
type: boolean
example: false
recovery_point:
description: 'Time when the last piece of data was replicated, measured in
milliseconds since the UNIX epoch, and the recovery point of the
resource.
'
type: integer
format: int64
readOnly: true
example: 1565034592494
status:
description: 'Status of the replica link. Values include `replicating`, `idle`,
and `unhealthy`.
'
type: string
example: replicating
_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: FixedReference
allOf:
- $ref: '#/components/schemas/_fixedReference'
message:
description: A description of the error which occurred.
type: string
example: Resource does not exist.
_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'
BucketReplicaLinkGetResponse_2:
allOf:
- $ref: '#/components/schemas/PageInfo_2'
- $ref: '#/components/schemas/BucketReplicaLinkResponse_2'
_fixedReferenceNameOnly:
type: object
properties:
name:
type: string
readOnly: true
x-readOnly: true
Error:
type: object
properties:
errors:
description: The list of errors encountered.
type: array
items:
$ref: '#/components/schemas/_errorErrors'
ErrorNoContext:
type: object
properties:
message:
type: string
example: Something was wrong
_errorErrors:
type: object
properties:
context:
type: string
example: Error with ...
message:
type: string
example: Something was wrong
_timeAware:
type: object
properties:
_as_of:
description: The freshness of the data (timestamp in millis since epoch).
type: integer
format: int64
readOnly: true
example: 1502729489760
_fixedReferenceWithoutType:
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
BucketReplicaLinkResponse:
type: object
properties:
items:
description: A list of object store bucket replica link objects.
type: array
items:
$ref: '#/components/schemas/BucketReplicaLink'
total:
description: 'If `total_only` query param is `true`, then it will be a total of
all records after filtering and no items will be returned.
If `total_only` is `false`, then it will be a total of all records
on this page.
'
title: BucketReplicaLink
allOf:
- $ref: '#/components/schemas/BucketReplicaLink'
_resourceNoName:
description: 'An ordinary (as opposed to built-in) resource that can be created or deleted
by the user. This might be a virtual resource (e.g., a volume), or correspond
to something in the physical environment, like a host or a server.
'
allOf:
- $ref: '#/components/schemas/_timeAware'
- type: object
properties:
id:
description: A non-modifiable, globally unique ID chosen by the system.
type: string
readOnly: true
example: 2a989a09-c851-4d52-9ec6-ab728b1c04db
_referenceWritable:
allOf:
- $ref: '#/components/schemas/_referenceWithoutType'
- type: object
properties:
resource_type:
description: 'Type of the object (full name of the endpoint).
Valid values are `hosts`, `host-groups`, `network-interfaces`, `pods`,
`ports`, `pod-replica-links`, `subnets`, `volumes`, `volume-snapshots`,
`volume-groups`, `directories`, `policies/nfs`, `policies/smb`, `policies/snapshot`, etc.
'
type: string
x-aliases:
- _reference
BucketReplicaLinkResponse_2:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/BucketReplicaLink_2'
BucketReplicaLinkPost:
type: object
properties:
cascading_enabled:
description: 'If set to `true`, objects replicated to this bucket via a replica
link from another array will also be replicated by this link to
the remote bucket.
Defaults to `false`.
'
type: boolean
paused:
description: Create link in the paused state? Defaults to `false`.
type: boolean
_replicaLinkBuiltIn:
allOf:
- $ref: '#/components/schemas/_builtInRelationship'
- type: object
properties:
direction:
$ref: '#/components/schemas/_direction'
lag:
description: 'Duration in milliseconds that represents how far
behind the replication target is from the source.
This is the time difference between current time and `recovery_point`.
'
type: integer
format: int64
readOnly: true
status_details:
description: 'Detailed information about the status of the replica link when it is
unhealthy.
'
type: string
readOnly: true
BucketReplicaLink_2:
description: A replica link between two buckets.
allOf:
- $ref: '#/components/schemas/_replicaLink'
- description: A replica link between two buckets.
type: object
properties:
members:
description: The union of source and target buckets in the replica link.
type: array
items:
$ref: '#/components/schemas/_resourceWithLocation'
recovery_point:
description: 'Time when the last piece of data was replicated, in milliseconds since
the UNIX epoch, and the recovery point of the bucket.
'
type: integer
format: int64
readOnly: true
example: 1565034592494
sources:
description: The source buckets in the replica link.
type: array
items:
$ref: '#/components/schemas/_resourceWithLocation'
status_details:
description: 'Detailed information about the status of the replica link when it is
`unhealthy`.
'
type: string
targets:
description: The target buckets in the replica link.
type: array
items:
$ref: '#/components/schemas/_resourceWithLocation'
_resourceWithLocation:
description: 'An ordinary resource that exists in one location.
'
allOf:
- $ref: '#/components/schemas/_fixedReference_2'
- type: object
properties:
location:
$ref: '#/components/schemas/_fixedReferenceFqdn'
_fixedReferenceFqdn:
allOf:
- $ref: '#/components/schemas/_fixedReference_2'
- type: object
properties:
fqdn:
description: 'The fully qualified domain name of the appliance when `resource_type` is `arrays`,
`null` otherwise.
'
type: string
readOnly: true
example: example_name.dc1.example.com
_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: FixedReference
allOf:
- $ref: '#/components/schemas/_fixedReference'
BucketReplicaLinkGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/_errorContextResponse'
- $ref: '#/components/schemas/BucketReplicaLinkResponse'
_objectBacklog:
type: object
properties:
bytes_count:
description: 'The size of the objects in bytes that need to be replicated.
This does not include the size of custom metadata.
'
type: integer
format: int64
readOnly: true
delete_ops_count:
description: 'The number of DELETE operations that need to be replicated.
'
type: integer
format: int64
readOnly: true
other_ops_count:
description: 'The number of other operations that need to be replicated.
'
type: integer
format: int64
readOnly: true
put_ops_count:
description: 'The number of PUT operations that need to be replicated.
'
type: integer
format: int64
readOnly: true
_fixedReference_2:
type: object
properties:
id:
description: The opaque and unique id of this resource.
type: string
readOnly: true
example: 2a989a09-c851-4d52-9ec6-ab728b1c04db
name:
description: The name of this resource.
type: string
readOnly: true
example: example_name
resource_type:
description: 'The type of this resource represented by the name of its REST endpoint.
For example, "arrays", "network-interfaces", and "metrics".
The value may be `null` if the resource is not represented.
'
type: string
readOnly: true
example: example_resource_type
x-readOnly: true
PageInfo_2:
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
example: MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My
total_item_count:
description: Total number of items after applying filter params.
type: integer
format: int32
example: 1
_fixedReference:
allOf:
- $ref: '#/components/schemas/_fixedReferenceWithoutType'
- 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
_direction:
type: string
description: 'The direction of replication. Valid values are `inbound` and
`outbound`.
'
readOnly: true
x-read-only: true
_builtInRelationship:
type: object
properties:
id:
description: 'A non-modifiable, globally unique ID chosen by the system.
'
type: string
readOnly: true
BucketReplicaLink:
allOf:
- $ref: '#/components/schemas/_replicaLinkBuiltIn'
- $ref: '#/components/schemas/_context'
- type: object
properties:
cascading_enabled:
description: 'If set to `true`, objects replicated to this bucket via a replica
link from another array will also be replicated by this link to
the remote bucket.
Defaults to `false`.
'
type: boolean
readOnly: true
local_bucket:
description: 'Reference to a local bucket.
'
title: FixedReference
allOf:
- $ref: '#/components/schemas/_fixedReference'
object_backlog:
description: 'The number of pending operations and their size that are currently in the backlog.
'
title: ObjectBacklog
allOf:
- $ref: '#/components/schemas/_objectBacklog'
paused:
description: Is the replica link paused?
type: boolean
recovery_point:
description: 'Time, in milliseconds since UNIX epoch, where all object changes before this time are
guaranteed to have been replicated. Changes after this time may have been replicated.
'
type: integer
format: int64
readOnly: true
example: 1565034592494
remote:
description: 'Reference to the associated remote, which can either be a `target` or remote `array`.
If it is an `array`, then the `resource-type` field will not be populated.
'
title: FixedReference
allOf:
- $ref: '#/components/schemas/_fixedReference'
remote_bucket:
description: Reference to a remote bucket.
title: FixedReferenceNameOnly
allOf:
- $ref: '#/components/schemas/_fixedReferenceNameOnly'
remote_credentials:
description: 'Reference to a remote-credentials object to access the remote bucket.
'
title: ReferenceWritable
allOf:
- $ref: '#/components/schemas/_referenceWritable'
status:
description: 'Status of the replica link.
Values include `replicating`, `paused`, and `unhealthy`.
'
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
total_item_count:
description: Total number of items after applying `filter` params.
type: integer
format: int32
responses:
Error404:
description: NOT FOUND
headers:
X-Request-ID:
description: Supplied by client during request or generated by server.
schema:
type: object
X-RateLimit-Remaining-minute:
description: 'The number of requests remaining for the organization in that minute.
'
schema:
type: object
X-RateLimit-Remaining-second:
description: 'The number of requests remaining for the organization in that second.
'
schema:
type: object
X-RateLimit-Limit-minute:
description: The number of requests available per minute.
schema:
type: object
X-RateLimit-Limit-second:
description: The number of requests available per second.
schema:
type: object
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Error500:
description: INTERNAL SERVER ERROR
headers:
X-Request-ID:
description: Supplied by client during request or generated by server.
schema:
type: object
X-RateLimit-Remaining-minute:
description: 'The number of requests remaining for the organization in that minute.
'
schema:
type: object
X-RateLimit-Remaining-second:
description: 'The number of requests remaining for the organization in that second.
'
schema:
type: object
X-RateLimit-Limit-minute:
description: The number of requests available per minute.
schema:
type: object
X-RateLimit-Limit-second:
description: The number of requests available per second.
schema:
type: object
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Error403:
description: FORBIDDEN
headers:
X-Request-ID:
description: Supplied by client during request or generated by server.
schema:
type: object
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorNoContext'
Error400:
description: BAD REQUEST
headers:
X-Request-ID:
description: Supplied by client during request or generated by server.
schema:
type: object
X-RateLimit-Remaining-minute:
description: 'The number of requests remaining for the organization in that minute.
'
schema:
type: object
X-RateLimit-Remaining-second:
description: 'The number of requests remaining for the organization in that second.
'
schema:
type: object
X-RateLimit-Limit-minute:
description: The number of requests available per minute.
schema:
type: object
X-RateLimit-Limit-second:
description: The number of requests available per second.
schema:
type: object
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Error429:
description: TOO MANY REQUESTS
headers:
X-Request-ID:
description: Supplied by client during request or generated by server.
schema:
type: object
X-RateLimit-Remaining-minute:
description: 'The number of requests remaining for the organization in that minute.
'
schema:
type: object
X-RateLimit-Remaining-second:
description: 'The number of requests remaining for the organization in that second.
'
schema:
type: object
X-RateLimit-Limit-minute:
description: The number of requests available per minute.
schema:
type: object
X-RateLimit-Limit-second:
description: The number of requests available per second.
schema:
type: object
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorNoContext'
parameters:
Member_names_plus:
name: member_names
in: query
description: 'A list of member names. Member names separated by a `+` indicate that both
members must be present in each element. Member names separated by a `,`
indicate that at least one member must be present in each element.
If there is not at least one resource that matches each `member_name` element,
an error is returned.
Single quotes are required around all strings.
When using Try it Out in Swagger, a list of member names separated by a `+`
must be entered in the same item cell.
'
style: form
explode: false
schema:
type: array
items:
type: string
x-quoted: true
x-quoted: true
Local_bucket_ids:
name: local_bucket_ids
in: query
description: 'A comma-separated list of local bucket 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 `local_bucket_names`
query parameter.
'
style: form
explode: false
schema:
type: array
items:
type: string
Member_ids_plus:
name: member_ids
in: query
description: 'A list of member IDs. Member IDs separated by a `+` indicate that both
members must be present in each element. Member IDs separated by a `,`
indicate that at least one member must be present in each element.
If there is not at least one resource that matches each `member_id` element,
an error is returned.
Single quotes are required around all strings.
When using Try it Out in Swagger, a list of member IDs separated by a `+`
must be entered in the same item cell.
'
style: form
explode: false
schema:
type: array
items:
type: string
x-quoted: true
x-quoted: true
Remote_credentials_names:
name: remote_credentials_names
in: query
description: 'A comma-separated list of remote credentials names. If there is not at least
one resource that matches each of the elements, then an error is returned.
This cannot be prov
# --- truncated at 32 KB (44 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/openapi/pure-storage-bucket-replica-links-api-openapi.yml