openapi: 3.0.1
info:
title: FlashArray REST Active Directory Software 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: Software
description: 'Software to be installed on the array.
'
paths:
/api/2.52/software:
get:
tags:
- Software
summary: Pure Storage List Software Packages
description: 'Displays a list of available software packages.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Ids'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Names'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Sort'
- $ref: '#/components/parameters/Total_item_count'
- $ref: '#/components/parameters/Versions'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SoftwareGetResponse'
post:
tags:
- Software
summary: Pure Storage Create a Software Package
description: 'Creates a software package download.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SoftwarePost'
required: true
x-codegen-request-body-name: software
responses:
'200':
description: 'The software package download was initiated. The download will start soon.
'
content:
application/json:
schema:
$ref: '#/components/schemas/SoftwareResponse'
x-codegen-request-body-name: software
delete:
tags:
- Software
summary: Pure Storage Delete a Software Package
description: 'Deletes a software package specified by software name and version.
A software package being used for an installation can be deleted if the installation is
`downloading`, `downloaded`, `aborted`, or `finished`. If the software package is currently
`downloading`, the download will be cancelled.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Names'
- $ref: '#/components/parameters/Software_versions'
responses:
'200':
description: OK
content: {}
/api/2.52/software-bundle:
get:
tags:
- Software
summary: Pure Storage List Software-bundle
description: 'Displays a list of software bundles.
'
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Ids'
- $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/SoftwareBundleGetResponse'
post:
tags:
- Software
summary: Pure Storage Create Software-bundle
description: 'Creates and initiates a software bundle download.
'
parameters:
- $ref: '#/components/parameters/XRequestId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SoftwareBundlePost'
required: true
x-codegen-request-body-name: source
responses:
'200':
description: 'The software bundle has started downloading successfully.
'
content:
application/json:
schema:
$ref: '#/components/schemas/SoftwareBundleResponse'
x-codegen-request-body-name: source
/api/2.52/software-check:
get:
tags:
- Software
summary: Pure Storage List Software Check Tasks
description: Displays a list of software check tasks.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Ids'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Names'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Software_names'
- $ref: '#/components/parameters/Software_versions'
- $ref: '#/components/parameters/Sort'
- $ref: '#/components/parameters/Total_item_count'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SoftwareChecksGetResponse'
post:
tags:
- Software
summary: Pure Storage Create a Software Check Task
description: 'Creates a software check task. If there are no previously queued or running
software check tasks, the new task immediately starts. Otherwise, it is queued and starts once
all previously queued or running software check tasks finish. To create a task, use a software
name and version.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Software_names'
- $ref: '#/components/parameters/Software_versions'
responses:
'200':
description: 'The software check record was created successfully.
'
content:
application/json:
schema:
$ref: '#/components/schemas/SoftwareChecksResponse'
delete:
tags:
- Software
summary: Pure Storage Delete a Software Check Task
description: 'Deletes a software check task specified by software name and version.
The check task must be queued. If the check task is running or passed/failed
then the task cannot be deleted.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Software_names'
- $ref: '#/components/parameters/Software_versions'
responses:
'200':
description: OK
content: {}
/api/2.52/software-installations:
get:
tags:
- Software
summary: Pure Storage List Software Upgrades
description: 'Displays a list of software upgrades, including currently running and past upgrades.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Continuation_token'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Ids'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Names'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Software_ids'
- $ref: '#/components/parameters/Software_names'
- $ref: '#/components/parameters/Sort'
- $ref: '#/components/parameters/Total_item_count'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SoftwareInstallationsGetResponse'
post:
tags:
- Software
summary: Pure Storage Create a Software Upgrade
description: 'Creates and initiates a software upgrade.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Software_idsRequired'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SoftwareInstallationPost'
required: true
x-codegen-request-body-name: software-installations
responses:
'200':
description: 'The software upgrade record was created successfully.
'
content:
application/json:
schema:
$ref: '#/components/schemas/SoftwareInstallationsResponse'
x-codegen-request-body-name: software-installations
patch:
tags:
- Software
summary: Pure Storage Modify Software Upgrade
description: 'Modifies a software upgrade by continuing, retrying, or aborting it.
All `override_checks` are updated before the command is issued if
`add_override_checks` is present.
The `override_checks` parameter is valid when `command` is set to `continue` or `retry`.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Software_installation_command_required'
- $ref: '#/components/parameters/Software_installation_current_step_idRequired'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SoftwareInstallationPatch'
required: false
x-codegen-request-body-name: software-installations
responses:
'200':
description: 'The `command` was issued and/or `override_checks` was updated.
'
content:
application/json:
schema:
$ref: '#/components/schemas/SoftwareInstallationsResponse'
x-codegen-request-body-name: software-installations
/api/2.52/software-installation-steps:
get:
tags:
- Software
summary: Pure Storage List Software Upgrade Steps
description: Displays a list of currently running and completed software upgrade steps.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Continuation_token'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Ids'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Names'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Software_installation_ids'
- $ref: '#/components/parameters/Sort'
- $ref: '#/components/parameters/Total_item_count'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SoftwareInstallationStepsGetResponse'
/api/2.52/software-patches:
get:
tags:
- Software
summary: Pure Storage List Software Patches
description: 'Displays a list of software patches.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Ids'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Names'
- $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/SoftwarePatchesGetResponse'
post:
tags:
- Software
summary: Pure Storage Create a Software Patch
description: 'Creates software patch download and installation.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- name: allow_ha_reduction
in: query
description: 'If Software Patch has ha_reduction_required set to true, `allow_ha_reduction` must be
set to `true` for Software Patch installation.
'
schema:
type: boolean
- name: name
in: query
description: Name of software patch to install
required: true
schema:
type: string
responses:
'200':
description: 'The software patch download was initiated. The download and installation will start soon.
'
content:
application/json:
schema:
$ref: '#/components/schemas/SoftwarePatchesResponse'
/api/2.52/software-patches/catalog:
get:
tags:
- Software
summary: Pure Storage List Available Software Patches
description: 'Displays a list of available software patches.
'
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/SoftwarePatchesGetResponse'
/api/2.52/software-versions:
get:
tags:
- Software
summary: Pure Storage List Software Versions
description: 'Displays a list of software versions.
'
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/SoftwareVersionsGetResponse'
/api/2.26/software-bundle:
get:
x-pure-block-remote-execution: true
tags:
- Software
summary: Pure Storage List Software-bundle
description: 'Displays a list of software bundles including the downloads which did not succeed.
'
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Continuation_token'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Ids_2'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Offset_2'
- $ref: '#/components/parameters/Sort_2'
- $ref: '#/components/parameters/Total_item_count'
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/SoftwareBundleGetResponse'
post:
x-pure-block-remote-execution: true
tags:
- Software
summary: Pure Storage Create Software-bundle
description: 'Creates and initiates a software bundle download. The upgrade won''t start automatically
after the download finishes. Only one software is being downloaded at a time.
Any previous currently running download will be cancelled. The endpoint is not idempotent.
'
parameters:
- $ref: '#/components/parameters/XRequestId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SoftwareBundlePost_2'
required: true
x-codegen-request-body-name: source
responses:
'200':
description: 'The software bundle has started downloading successfully.
'
headers:
X-Request-ID:
description: Supplied by client during request or generated by server.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/SoftwareBundleResponse'
x-codegen-request-body-name: source
/api/2.26/software-check:
get:
tags:
- Software
summary: Pure Storage List Software Check Tasks
description: Displays a list of software check tasks.
parameters:
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Ids_2'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Names'
- $ref: '#/components/parameters/Offset_2'
- $ref: '#/components/parameters/Software_names'
- $ref: '#/components/parameters/Software_versions'
- $ref: '#/components/parameters/Sort_2'
- $ref: '#/components/parameters/Total_item_count'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SoftwareChecksGetResponse'
post:
tags:
- Software
summary: Pure Storage Create a Software Check Task
description: 'Creates a software check task.
To create a task, use a software name and version.
If a task is already running, an error is returned.
'
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Software_names'
- $ref: '#/components/parameters/Software_versions'
responses:
'200':
description: 'The software check record was created successfully.
'
content:
application/json:
schema:
$ref: '#/components/schemas/SoftwareChecksResponse'
'403':
description: Another instance is already running
content: {}
/api/2.26/software-patches:
get:
tags:
- Software
summary: Pure Storage List Software Patches
description: 'Displays a list of software patches.
'
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Continuation_token'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Ids_2'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Names'
- $ref: '#/components/parameters/Offset_2'
- $ref: '#/components/parameters/Sort_2'
- $ref: '#/components/parameters/Total_item_count'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SoftwarePatchesGetResponse'
post:
tags:
- Software
summary: Pure Storage Create a Software Patch
description: 'Creates software patch download and installation.
'
parameters:
- $ref: '#/components/parameters/XRequestId'
- name: allow_ha_reduction
in: query
description: 'If Software Patch has ha_reduction_required set to true, `allow_ha_reduction` must be
set to `true` for Software Patch installation.
'
schema:
type: boolean
- name: name
in: query
description: Name of software patch to install
required: true
schema:
type: string
responses:
'200':
description: 'The software patch download was initiated. The download and installation will start soon.
'
content:
application/json:
schema:
$ref: '#/components/schemas/SoftwarePatchesResponse'
components:
schemas:
SoftwareInstallationStepsResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SoftwareInstallationStep'
SoftwareBundlePost:
description: The source of the software bundle.
type: object
properties:
source:
description: The source of the software bundle. Accepts HTTP, HTTPS or FTP, and paths.
type: string
example: ftp://local/upgrade_bundle.sh
_override_check:
type: object
properties:
args:
description: 'The name of the specific check within the override check to ignore so that the system can
continue with the software upgrade. The `name` parameter of the override check must be
specified with the `args` parameter. For example, if the HostIOCheck check fails on
hosts host01 and host02, the system displays a list of these host names in the failed
check. To override the HostIOCheck checks for host01 and host02, set `name=HostIOCheck`,
and set `args=host01,host02`. Enter multiple `args` in comma-separated format. Note that
not all checks have `args` values.
'
type: string
example: host1,host2,host3
name:
description: 'The name of the upgrade check to be overridden so the software upgrade can continue if the
check failed or is anticipated to fail during the upgrade process. Overriding the check
forces the system to ignore the check failure and continue with the upgrade. If the
check includes more specific checks that failed or are anticipated to fail, set them
using the `args` parameter. For example, the HostIOCheck check may include a list of hosts
that have failed or are anticipated to fail the upgrade check.
'
type: string
example: HostIOCheck
persistent:
description: 'If set to `true`, the system always ignores the failure of the specified upgrade
check and continues with the upgrade process.
If set to `false`, the system ignores the failure of the specified upgrade check until
the upgrade check finishes and the upgrade process is continued. For example, the
`continue` command is successfully issued in an `interactive` mode, or the first upgrade
check step successfully finishes in a `one-click` mode.
'
type: boolean
SoftwareVersion:
description: Version candidates for software upgrade.
type: object
properties:
details:
description: 'The description of the version.
'
type: string
name:
description: 'The name of the software.
'
type: string
example: Purity//FA
release_family:
description: 'The major and minor release number of the version.
'
type: string
example: 6.2.0
upgrade_hops:
description: 'The list of software versions the upgrade will go through.
'
type: array
items:
type: string
description: 'A software version in the upgrade path.
'
example:
- 6.1.3
- 6.2.0
version:
description: 'The version of the software.
'
type: string
example: 6.2.0
SoftwareChecksResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SoftwareCheck'
SoftwareInstallationPatch:
type: object
properties:
add_override_checks:
description: 'Adds the specified checks to the current list of override checks.
'
type: array
items:
$ref: '#/components/schemas/_override_check'
SoftwareBundle:
allOf:
- $ref: '#/components/schemas/_builtInRelationship'
- description: The software bundle to be installed on the array.
type: object
properties:
bytes_downloaded:
description: 'The number of bytes downloaded.
'
type: integer
format: int64
bytes_total:
description: 'The total number of bytes to download.
'
type: integer
format: int64
created:
description: 'The creation time in milliseconds since the UNIX epoch.
'
type: number
format: integer
details:
description: 'The detailed reason for the `status`.
'
type: string
download_progress:
description: 'The download progress in decimal format.
'
type: number
format: float
software_name:
description: 'The name of the software to be tested by the upgrade checks.
'
type: string
example: Purity//FA
software_version:
description: 'The version of the software to be tested by the upgrade checks.
'
type: string
example: 6.2.0
source:
description: 'The location of the upgrade bundle.
'
type: string
example: ftp://local/upgrade_bundle.sh
status:
description: 'The status of the software bundle.
Valid values are `downloading`, `failed`, `ready`, and `verifying`.
A status of `downloading` indicates that the array is downloading the upgrade bundle.
A status of `failed` indicates that the array has failed to download
the upgrade bundle.
A status of `ready` indicates that the upgrade bundle is ready to be installed.
A status of `verifying` indicates that the array is verifying the upgrade bundle.
'
type: string
example: downloading
SoftwareInstallationsResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SoftwareInstallation'
_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
_start_end_time:
description: A resource with a start time and end time.
type: object
properties:
end_time:
description: End time in milliseconds since the UNIX epoch.
type: integer
format: int64
example: 1567026888000
x-minimum: 0
start_time:
description: Start time in milliseconds since the UNIX epoch.
type: integer
format: int64
example: 1567026779000
x-minimum: 0
SoftwareInstallationPost:
description: Software upgrade attempt.
type: object
properties:
mode:
description: 'Mode that the upgrade is in. Valid values are `check-only`, `interactive`, `semi-interactive`,
and `one-click`.
The `check_only` mode is deprecated. Use `/software-checks`. In this mode, the upgrade only
runs pre-upgrade checks and returns.
In `interactive` mode, the upgrade pauses at several points, at which users must
enter certain commands to proceed.
In `semi-interactive` mode, the upgrade pauses if there are any upgrade check failures and
functions like `one-click` mode otherwise.
In `one-click` mode, the upgrade proceeds automatically without pausing.
'
type: string
example: interactive
override_checks:
description: 'A list of upgrade checks whose failures are overridden during the upgrade.
If any optional `args` are provided, they are validated later when the corresponding check
script runs.
'
type: array
items:
$ref: '#/components/schemas/_override_check'
upgrade_parameters:
description: 'A list of parameters to be sent to the upgrade process. These parameters can be used to
change the behavior of the upgrade process in specific ways such as enabling or disabling
features in the target version or changing the attributes of the appliance at upgrade time.
When there is a need or option to set an upgrade parameter, Pure Storage will provide
documentation for the specific parameter. If you have been provided documentation
related to a specific upgrade parameter,
follow the instructions in the documentation.
Otherwise, do not set any upgrade parameters.
'
type: array
items:
$ref: '#/components/schemas/_upgrade_parameters'
SoftwareChecksGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/SoftwareChecksResponse'
SoftwareInstallationStepsGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/SoftwareInstallationStepsResponse'
SoftwareVersionsGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/SoftwareVersionsResponse'
SoftwareInstallationStep:
allOf:
- $ref: '#/components/schemas/_resourceFixedNonUniqueName'
- $ref: '#/components/schemas/_start_end_time'
- description: 'Step needed to complete an upgrade.
'
type: object
properties:
checks:
description: 'A list of checks in this upgrade step.
'
type: array
items:
$ref: '#/components/schemas/_softwareInstallationStepsChecks'
description:
description: 'Detailed description of the step.
'
type: string
details:
description: 'Detailed result of the step used to diagnose step failures.
'
type: string
hop_version:
description: The version to which the current hop is upgrading.
type: string
example: 99.9.9
installation:
description: 'Referenced `software-installation` to which the step belongs.
'
title: Reference
allOf:
- $ref: '#/components/schemas/_reference'
status:
description: 'Status of the step. Valid values are `running` and `finished`.
A status of `running` indicates that the step has not finished.
A status of `finished` indicates that the check has finished.
'
type: string
Software:
allOf:
- $ref: '#/components/schemas/_resourceFixedNonUniqueName'
- description: Software to be installed on the array.
type: object
properties:
details:
description: 'The detailed reason for the `status`.
'
type: string
payload_id:
description: 'A checksum hash referring to the update bundle.
'
type: string
example: 4f7b319106401d072ff94808535cb3ce
progress:
description: 'The progress of the software upgrade. Displayed in decimal format.
'
type: number
format: float
status:
description: 'The status of the software package.
Valid values are `available`, `downloaded`, `downloading`, `download_failed`, `checking`,
`installing`, `new`, `paused`, `aborting`, `abort`, `canceled`, `partially_installed`, and
# --- truncated at 32 KB (55 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/openapi/pure-storage-software-api-openapi.yml