openapi: 3.0.1
info:
title: FlashArray REST Active Directory Arrays 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: Arrays
description: 'Array features provide the ability to configure settings that affect the operation
of the array as a whole and monitor array I/O performance.
'
paths:
/api/2.52/arrays:
get:
tags:
- Arrays
summary: Pure Storage List Arrays
description: 'Displays general array properties including the array name, login banner,
idle timeout for management sessions, and NTP servers.
'
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/Filter'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Sort'
- $ref: '#/components/parameters/Total_item_count'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayGetResponse'
'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/ArrayGetResponse'
delete:
tags:
- Arrays
summary: Pure Storage Delete an Array
description: 'Deletes an array. For physical appliances, deleting an array restores the hardware to factory
settings. This entails deleting all data, metadata, configuration, and logs. The array returns
to the state it was in prior to any configuration changes being made. If the hardware is reused,
it must be as a different array with a new ID.
For virtual appliances, deleting an array puts it into an unusable state.
Virtual resources (e.g., virtual machines) can later be freed, which deletes any remaining data,
metadata, configuration, and logs. Prior to factory reset, an array must be manually prepared
(e.g., all volumes and snapshots must be eradicated) and a factory reset token must be created.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Eradicate_all_data'
- $ref: '#/components/parameters/Factory_reset_token'
responses:
'200':
description: OK
content: {}
patch:
tags:
- Arrays
summary: Pure Storage Modify an Array
description: 'Modifies general array properties such as the array name, login banner, idle timeout for
management sessions, and NTP servers.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Arrays'
required: true
x-codegen-request-body-name: array
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayResponse'
x-codegen-request-body-name: array
/api/2.52/arrays/cache:
get:
tags:
- Arrays
summary: Pure Storage DIMM Cache Status
description: The status of the DIMM cache.
parameters:
- $ref: '#/components/parameters/History_end_time'
- $ref: '#/components/parameters/History_resolution'
- $ref: '#/components/parameters/History_start_time'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CacheGetResponse'
/api/2.52/arrays/cloud-config:
get:
tags:
- Arrays
summary: Pure Storage List CBS Array Configuration Status
description: 'Displays the configuration status of the CBS array, including the progress of the
configuration upgrade. Requests for non-CBS arrays will receive an error response.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Sort'
- $ref: '#/components/parameters/Total_item_count'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CloudConfigGetResponse'
patch:
tags:
- Arrays
summary: Pure Storage Modify CBS Array Configuration
description: 'Modifies the configuration of the CBS array. This should trigger a backend
process that will upgrade the CBS array configuration. The array can be
upgraded only to models defined by the supported configurations endpoint. When an
existing array upgrade request is in progress, any new request to upgrade
the array will receive an error response. For non-CBS arrays, this
feature is not supported and requests will receive an error response.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
requestBody:
description: The requested configuration of the CBS array hardware.
content:
application/json:
schema:
$ref: '#/components/schemas/CloudConfigPatch'
required: true
x-codegen-request-body-name: config
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CloudConfigPatchResponse'
x-codegen-request-body-name: config
/api/2.52/arrays/cloud-config/supported-configs:
get:
tags:
- Arrays
summary: Pure Storage List CBS Array Supported Upgrade Target Configs
description: 'Displays the list of supported configurations to which the CBS array can be upgraded.
Requests for non-CBS arrays will receive an error response.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Continuation_token'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Sort'
- $ref: '#/components/parameters/Total_item_count'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CloudConfigSupportedConfigsGetResponse'
/api/2.52/arrays/cloud-capacity:
get:
tags:
- Arrays
summary: Pure Storage List CBS Array Capacity Status
description: 'Displays the capacity status of the CBS array including the progress of the
capacity update. Requests for non-CBS arrays will receive an error response.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Sort'
- $ref: '#/components/parameters/Total_item_count'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CloudCapacityGetResponse'
patch:
tags:
- Arrays
summary: Pure Storage Modify CBS Array Capacity
description: 'Modifies the raw capacity of the CBS array. This should trigger a backend
process that will update the CBS array capacity. The array capacity can be
updated only to values defined by the capacity steps endpoint.
When an existing capacity update request is in progress, any new request to update
of the capacity will receive an error response.
For non-CBS arrays, this feature is not supported and requests will receive an error response.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
requestBody:
description: The requested capacity of the CBS array.
content:
application/json:
schema:
$ref: '#/components/schemas/CloudCapacityStatus'
required: true
x-codegen-request-body-name: capacity
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CloudCapacityPatchResponse'
x-codegen-request-body-name: capacity
/api/2.52/arrays/cloud-capacity/supported-steps:
get:
tags:
- Arrays
summary: Pure Storage List CBS Array Capacity Steps
description: 'Displays the list of supported raw capacity sizes in bytes the CBS array can be
upgraded to. Requests for non-CBS arrays will receive an error response.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Continuation_token'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Sort'
- $ref: '#/components/parameters/Total_item_count'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CloudCapacityStepsGetResponse'
/api/2.52/arrays/cloud-provider-tags:
get:
tags:
- Arrays
summary: Pure Storage List User Tags on the Cloud.
description: Displays the list of user tags on deployed cloud resources of a CBS array.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Continuation_token'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Sort'
- $ref: '#/components/parameters/Total_item_count'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CloudProviderTagGetResponse'
delete:
tags:
- Arrays
summary: Pure Storage Delete User Tags from the Cloud.
description: Deletes user tags from deployed cloud resources of a CBS array.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Keys'
responses:
'200':
description: OK
content: {}
/api/2.52/arrays/cloud-provider-tags/batch:
put:
tags:
- Arrays
summary: Pure Storage Update User Tags on the Cloud.
description: Updates users tags to deployed cloud resources of a CBS array.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
requestBody:
description: A list of tags to be created or, if already existing, updated.
content:
application/json:
schema:
maxItems: 50
minItems: 1
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/CloudProviderTag'
required: true
x-codegen-request-body-name: tag
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CloudProviderTagResponse'
x-codegen-request-body-name: tag
/api/2.52/arrays/erasures:
get:
tags:
- Arrays
summary: Pure Storage List Factory Reset Details
description: 'Displays a list of factory reset processes.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Sort'
- $ref: '#/components/parameters/Total_item_count'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayErasureGetResponse'
post:
tags:
- Arrays
summary: Pure Storage Create a Process for Factory Reset
description: 'Creates the initiation of the factory reset process
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Eradicate_all_data_required'
- $ref: '#/components/parameters/Preserve_configuration_data_required'
- $ref: '#/components/parameters/Skip_phonehome_check'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayErasureResponse'
delete:
tags:
- Arrays
summary: Pure Storage Delete Factory Reset
description: 'Deletes the factory reset process when it is `failed`.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
responses:
'200':
description: OK
content: {}
patch:
tags:
- Arrays
summary: Pure Storage Update Factory Reset
description: 'Modifies the factory reset process to finalize.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Delete_sanitization_certificate_required'
- $ref: '#/components/parameters/Eradicate_all_data_required'
- $ref: '#/components/parameters/Finalize_array_erasure_required'
- $ref: '#/components/parameters/Reinstall_image_required'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayErasurePatch'
required: false
x-codegen-request-body-name: erasure_patch
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayErasureResponse'
x-codegen-request-body-name: erasure_patch
/api/2.52/arrays/eula:
get:
tags:
- Arrays
summary: Pure Storage List End User Agreement and Signature
description: Displays the End User Agreement and signature.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Sort'
- $ref: '#/components/parameters/Total_item_count'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/EulaGetResponse'
patch:
tags:
- Arrays
summary: Pure Storage Modify Signature on the End User Agreement
description: Modifies the signature on the End User Agreement.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Eula'
required: false
x-codegen-request-body-name: eula
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/EulaResponse'
x-codegen-request-body-name: eula
/api/2.52/arrays/factory-reset-token:
get:
tags:
- Arrays
summary: Pure Storage List Factory Reset Tokens
description: Displays a list of tokens used to perform a factory reset on the array.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Sort'
- $ref: '#/components/parameters/Total_item_count'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayFactoryResetTokenGetResponse'
post:
tags:
- Arrays
summary: Pure Storage Create a Factory Reset Token
description: 'Creates a token that can be used to perform a factory reset on the array.
Factory reset tokens can only be created after the array has been prepared
for reset (e.g., all volumes and snapshots must first be eradicated).
After a token has been created, operations that would take the array out of
the prepared state are disabled (e.g., creating volumes) until all
tokens have been deleted.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayFactoryResetTokenResponse'
delete:
tags:
- Arrays
summary: Pure Storage Delete a Factory Reset Token
description: Deletes an existing token that could be used to perform a factory reset on the array.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
responses:
'200':
description: OK
content: {}
/api/2.52/arrays/ntp-test:
get:
tags:
- Arrays
summary: Pure Storage List NTP Test Results
description: Displays test results for configured NTP servers.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TestResultGetResponse'
/api/2.52/arrays/performance:
get:
tags:
- Arrays
summary: Pure Storage List Array Front-end Performance Data
description: 'Displays real-time and historical front-end performance data at the array
level including latency, bandwidth, IOPS, average I/O size, and queue depth.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/History_end_time'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Perf_protocol_type'
- $ref: '#/components/parameters/Perf_protocol_group'
- $ref: '#/components/parameters/History_resolution'
- $ref: '#/components/parameters/Sort'
- $ref: '#/components/parameters/History_start_time'
- $ref: '#/components/parameters/Total_item_count'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayPerformanceGetResponse'
/api/2.52/arrays/performance/by-link:
get:
tags:
- Arrays
summary: Pure Storage List Array Front-end IO Performance Data by Link
description: 'Displays real-time and historical front-end performance data at the array
level including latency, bandwidth, IOPS, average I/O size, and queue depth.
Group output is shown by link. A link represents a set of arrays that an I/O operation
depends on.
For local-only I/Os, this is a local array. For mirrored I/Os, this is a set of synchronous
replication peer arrays.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/History_end_time'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/History_resolution'
- $ref: '#/components/parameters/Sort'
- $ref: '#/components/parameters/History_start_time'
- $ref: '#/components/parameters/Total_item_count'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayPerformanceByLinkGetResponse'
/api/2.52/arrays/space:
get:
tags:
- Arrays
summary: Pure Storage List Array Space Information
description: 'Displays real-time and historical array space information including unique
volume and snapshot space, shared space, data reduction, provisioned
capacity, usable capacity, and parity.
'
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/History_end_time'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/History_resolution'
- $ref: '#/components/parameters/Sort'
- $ref: '#/components/parameters/History_start_time'
- $ref: '#/components/parameters/Total_item_count'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ArraySpaceGetResponse'
'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/ArraySpaceGetResponse'
/api/2.52/arrays/tags:
get:
tags:
- Arrays
summary: Pure Storage List Tags
description: 'Displays the list of tags on array objects.
'
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/Filter'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Namespaces'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Sort'
- $ref: '#/components/parameters/Total_item_count'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TagGetResponse'
'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/TagGetResponse'
delete:
tags:
- Arrays
summary: Pure Storage Delete Tags
description: 'Deletes specified tags on array objects.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Keys'
- $ref: '#/components/parameters/Namespaces'
responses:
'200':
description: OK
content: {}
/api/2.52/arrays/tags/batch:
put:
tags:
- Arrays
summary: Pure Storage Update Tags
description: 'Updates tags.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
requestBody:
description: A list of tags to be created or, if they already exist, updated.
content:
application/json:
schema:
maxItems: 30
minItems: 1
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/NonCopyableTag'
required: true
x-codegen-request-body-name: tag
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TagResponse'
x-codegen-request-body-name: tag
/api/2.26/arrays:
get:
tags:
- Arrays
summary: Pure Storage GET Arrays
description: List array attributes such as the array name, ID, version, and NTP servers.
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/Limit'
- $ref: '#/components/parameters/Offset_2'
- $ref: '#/components/parameters/Sort_2'
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/ArrayGetResponse'
'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/ArrayGetResponse'
patch:
tags:
- Arrays
summary: Pure Storage PATCH Arrays
description: Modify the general configuration of the array including banner text, array name, NTP servers, and time zone.
parameters:
- $ref: '#/components/parameters/XRequestId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Array'
required: true
x-codegen-request-body-name: array
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/ArrayResponse_2'
x-codegen-request-body-name: array
/api/2.26/arrays/eula:
get:
tags:
- Arrays
summary: Pure Storage GET Arrays/eula
description: List the End User Agreement and signature.
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Continuation_token'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Offset_2'
- $ref: '#/components/parameters/Sort_2'
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/EulaGetResponse'
patch:
tags:
- Arrays
summary: Pure Storage PATCH Arrays/eula
description: Modifies the signature on the End User Agreement.
parameters:
- $ref: '#/components/parameters/XRequestId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Eula'
required: false
x-codegen-request-body-name: eula
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/EulaResponse'
x-codegen-request-body-name: eula
/api/2.26/arrays/factory-reset-token:
get:
tags:
- Arrays
summary: Pure Storage List Factory Reset Tokens
description: Displays a list of tokens used to perform a factory reset on the array.
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Continuation_token'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Offset_2'
- $ref: '#/components/parameters/Sort_2'
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/ArrayFactoryResetTokenGetResponse'
post:
tags:
- Arrays
summary: Pure Storage Create a Factory Reset Token
description: 'Creates a token that can be used to perform a factory reset on the array.
Factory reset tokens can only be created after the array has been prepared
for reset (e.g., all file systems, buckets, and snapshots must first be eradicated).
After a token has been created, operations that would take the array out of
the prepared state (e.g., creating file systems) are disabled until all
tokens have been deleted.
'
parameters:
- $ref: '#/components/parameters/XRequestId'
responses:
'200':
description: OK
headers:
X-Request-ID:
description: Supplied by client during request or generated b
# --- truncated at 32 KB (191 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/openapi/pure-storage-arrays-api-openapi.yml