Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Pure Storage Drives API
x-refined-note:
- x-logo differs across the merged source definitions and was not carried
- x-pure-description-ref differs across the merged source definitions and was not carried
version: '1.0'
description: 'Operations tagged Drives across 3 of this provider''s published API definitions: flasharray-rest-api-openapi.yml, flashblade-rest-api-openapi.yml, pure1-cloud-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /
- url: http://[array]/
- url: https://[array]/
- url: https://api-staging.pure1.purestorage.com/
tags:
- name: Drives
description: 'Drive data includes the name, type, status, capacity, protocol and other information
for all flash, NVRAM, and cache modules in an array.'
paths:
/api/2.52/drives:
get:
tags:
- Drives
summary: Pure Storage List Flash, NVRAM, and Cache Modules
description: Displays a list of flash, NVRAM, and cache modules that are installed in the array along with their attributes and status.
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/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/DriveGetResponse'
operationId: getApi252Drives
x-operation-id-source: derived
patch:
tags:
- Drives
summary: Pure Storage Modify Flash and NVRAM Modules
description: Modifies flash and NVRAM modules that have been added or connected but not yet admitted to the array.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Admit'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DriveResponse'
operationId: patchApi252Drives
x-operation-id-source: derived
servers:
- url: /
/api/2.26/drives:
get:
tags:
- Drives
summary: Pure Storage GET Drives
description: List array drive information.
parameters:
- $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_2'
- $ref: '#/components/parameters/Sort_2'
- $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/DriveGetResponse_2'
security:
- AuthorizationHeader: []
operationId: getApi226Drives
x-operation-id-source: derived
servers:
- url: http://[array]/
- url: https://[array]/
/api/1.5/drives:
get:
tags:
- Drives
summary: Pure Storage Get Drives
description: Retrieves information about FlashArray drives.
parameters:
- $ref: '#/components/parameters/Authorization_2'
- $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/Names_2'
- $ref: '#/components/parameters/Offset_3'
- $ref: '#/components/parameters/Sort_3'
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/DriveGetResponse'
'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'
security:
- AuthorizationHeader: []
operationId: getApi15Drives
x-operation-id-source: derived
servers:
- url: https://api-staging.pure1.purestorage.com/
components:
schemas:
Drive:
allOf:
- $ref: '#/components/schemas/_builtInResourceNoId'
- description: Information about a flash, NVRAM, or cache module.
type: object
properties:
capacity:
description: 'Entitled capacity of individual drive in bytes.
'
type: integer
format: int64
readOnly: true
example: 10000000000000
capacity_installed:
description: 'Raw capacity of individual drive in bytes.
'
type: integer
format: int64
readOnly: true
example: 42000000000000
details:
description: 'Details about the status of the module if not healthy.
'
type: string
readOnly: true
example: Cache module in wrong bay.
protocol:
description: 'Storage protocol of the module. Valid values are `NVMe` and `SAS`.
'
type: string
readOnly: true
example: SAS
status:
description: 'Current status of the module.
Valid values are `empty`, `failed`, `healthy`, `identifying`,
`missing`, `recovering`, `unadmitted`, `unhealthy`, `unrecognized`,
and `updating`.
'
type: string
readOnly: true
example: healthy
type:
description: 'The type of the module. Valid values are `cache`, `NVRAM`, `SSD`, and `virtual`.
'
type: string
readOnly: true
example: SSD
DriveGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/DriveResponse'
_builtInResourceNoId:
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, file systems, file system snapshots, volume snapshot).
'
type: object
properties:
name:
description: 'A locally unique, system-generated name. The name cannot be modified.
'
type: string
readOnly: true
DriveResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/Drive'
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
Drive_2:
allOf:
- $ref: '#/components/schemas/_builtIn'
- type: object
properties:
details:
description: 'Details about the status of the drive if not healthy.
'
type: string
readOnly: true
progress:
description: 'Reflects this drive''s current progress toward completing a planned
evacuation. If a planned evacuation is not occurring, the value will
be `null`.
'
type: number
format: float
minimum: 0
maximum: 1
readOnly: true
raw_capacity:
type: integer
format: int64
readOnly: true
status:
description: 'Current status of the drive. Valid values are `evacuated`,
`evacuating`, `healthy`, `unhealthy`, `unused`, and `updating`.
'
type: string
readOnly: true
type:
description: 'The type of the module. Valid values are `DFM` and `DFMe`.
'
type: string
readOnly: true
example: DFM
DriveGetResponse_2:
allOf:
- $ref: '#/components/schemas/PageInfo_2'
- type: object
properties:
items:
description: A list of drive objects.
type: array
items:
$ref: '#/components/schemas/Drive_2'
total:
type: object
allOf:
- $ref: '#/components/schemas/Drive_2'
- 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.
'
type: object
_builtIn:
type: object
properties:
id:
description: 'A non-modifiable, globally unique ID chosen by the system.
'
type: string
readOnly: true
name:
description: Name of the object (e.g., a file system or snapshot).
type: string
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
total_item_count:
description: Total number of items after applying `filter` params.
type: integer
format: int32
_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
_driveArrayStatus:
allOf:
- $ref: '#/components/schemas/_fixedReference'
- type: object
properties:
drive_count:
description: 'Count of drives in the array.
'
type: integer
format: int64
example: 24
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
total_capacity:
description: 'The total capacity of all drives in the array.
'
type: integer
format: int64
example: 7625244672
Drive_3:
allOf:
- $ref: '#/components/schemas/_builtInAsOf'
- description: 'Information about a flash, NVRAM, or cache module.
'
type: object
properties:
arrays:
description: 'A list of arrays that contain this drive.
Each drive should only exist on one array.
'
type: array
minItems: 1
items:
$ref: '#/components/schemas/_driveArrayStatus'
capacity:
description: 'Physical storage capacity of the module (in bytes).
'
type: number
format: int64
readOnly: true
example: 494927872
details:
description: 'Details about the status of the module if status is not `healthy`.
'
type: string
readOnly: true
example: Slow link speed.
protocol:
description: 'Storage protocol of the module. Values include `NVMe` and `SAS`.
'
type: string
readOnly: true
example: SAS
status:
description: 'Current status of the module. Values include `empty`, `failed`,
`healthy`, `identifying`, `missing`, `recovering`, `unadmitted`,
`unhealthy`, `unrecognized`, and `updating`.
'
type: string
readOnly: true
example: healthy
type:
description: 'The type of the module. Values include `cache`, `NVRAM`, `SSD`,
and `virtual`.
'
type: string
readOnly: true
example: SSD
_errorErrors:
type: object
properties:
context:
type: string
example: Error with ...
message:
type: string
example: Something was wrong
PageInfo_3:
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:
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
Error:
type: object
properties:
errors:
description: The list of errors encountered.
type: array
items:
$ref: '#/components/schemas/_errorErrors'
_builtInAsOf:
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).
'
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: 01c2889a-4124-49ff-8cbd-c33405ede123
name:
description: A non-modifiable, locally unique name chosen by the system.
type: string
readOnly: true
example: example_name
ErrorNoContext:
type: object
properties:
message:
type: string
example: Something was wrong
parameters:
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
Filter:
name: filter
in: query
description: 'Narrows down the results to only the response objects
that satisfy the filter criteria.
'
schema:
type: string
Sort:
name: sort
in: query
description: "Sorts the response objects by the specified fields. Sorting can be applied to any field name\n in the response, in ascending order by default, or in descending order by prefixing the\n field name with a minus sign (-). Multiple fields can be specified as a comma-separated\n list (e.g., sort volumes by size descending, then by name ascending). If sort is provided,\n the response will not include a continuation_token.\n"
style: form
explode: false
schema:
type: array
items:
pattern: ^[a-z]+(_[a-z]+)*-?
type: string
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
XRequestId:
name: X-Request-ID
in: header
description: 'Supplied by client during request or generated by server.
'
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
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
Admit:
name: admit
in: query
description: 'If `true`, admits any `unadmitted` drives into the system.
'
schema:
type: boolean
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
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
Sort_2:
name: sort
in: query
description: 'Sort the response by the specified fields (in descending order if ''-''
is appended to the field name).
NOTE: If you provide a sort you will not get a `continuation_token` in
the response.
'
style: form
explode: false
schema:
type: array
items:
pattern: ^[a-z]+(_[a-z]+)*-?
type: string
Total_only:
name: total_only
in: query
description: 'If set to `true`, returns the aggregate value of all items after filtering.
Where it makes more sense, the average value is displayed instead.
The values are displayed for each name where meaningful.
If `total_only=true`, the `items` list will be empty.
'
schema:
type: boolean
Offset_2:
name: offset
in: query
description: 'The offset of the first resource to return from a collection.
'
schema:
type: integer
format: int32
minimum: 0
example: 10
Ids:
name: ids
in: query
description: 'A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of `ids`, then an error is returned.
This cannot be provided together with the `name` or `names` query parameters.
'
style: form
explode: false
schema:
type: array
items:
type: string
Sort_3:
name: sort
in: query
description: 'Sort the response by the specified fields (in descending order if ''-''
is appended to the field name).
If you provide a sort you will not get a continuation token in
the response.
'
style: form
explode: false
schema:
type: array
items:
pattern: ^[a-z]+(_[a-z]+)*-?
type: string
Filter_2:
name: filter
in: query
description: 'Exclude resources that don''t match the specified criteria.
Single quotes are required around all strings inside the filters.
'
schema:
type: string
Continuation_token_2:
name: continuation_token
in: query
description: 'An opaque token used to iterate over a collection.
The token to use on the next request is returned in the
`continuation_token` field of the result.
Single quotes are required around all strings.
'
schema:
type: string
x-quoted: true
x-quoted: true
Names_2:
name: names
in: query
description: 'A comma-separated list of resource names.
If there is not at least one resource that matches each `name` element,
an error is returned.
Single quotes are required around all strings.
'
style: form
explode: false
schema:
type: array
items:
type: string
x-quoted: true
x-quoted: true
Authorization_2:
name: Authorization
in: header
description: 'Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
'
schema:
type: string
Offset_3:
name: offset
in: query
description: 'The offset of the first resource to return from a collection.
'
schema:
type: integer
format: int32
minimum: 0
Limit_2:
name: limit
in: query
description: 'Limit the size of the response to the specified number of resources.
A limit of 0 can be used to get the number of resources without getting
all of the resources. It will be returned in the total_item_count field.
If a client asks for a page size larger than the maximum number, the request
is still valid. In that case the server just returns the maximum number of
items, disregarding the client''s page size request. If not specified, defaults
to 1000.
'
schema:
type: integer
format: int32
Ids_2:
name: ids
in: query
description: 'A comma-separated list of resource IDs.
If there is not at least one resource that matches each `id` element,
an error is returned.
Single quotes are required around all strings.
'
style: form
explode: false
schema:
type: array
items:
type: string
x-quoted: true
x-quoted: true
responses:
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'
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'
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'
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'
securitySchemes:
AuthorizationHeader:
type: apiKey
name: x-auth-token
in: header
ApiToken:
type: apiKey
name: api-token
in: header
x-refined-from:
- flasharray-rest-api-openapi.yml
- flashblade-rest-api-openapi.yml
- pure1-cloud-api-openapi.yml