openapi: 3.0.1
info:
title: FlashArray REST Active Directory Hardware 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: Hardware
description: 'Operational status is reported by most of the hardware components in an array, including the
chassis, controller, and storage shelf.
'
paths:
/api/2.52/hardware:
get:
tags:
- Hardware
summary: Pure Storage List Hardware Component Information
description: Displays a list of hardware slots and bays and status of installed components.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $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/HardwareGetResponse'
patch:
tags:
- Hardware
summary: Pure Storage Modify Visual Identification
description: Modifies the visual identification of a specified hardware component, and causing the ID LED to turn on or off.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Names'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/HardwarePatch'
required: true
x-codegen-request-body-name: hardware
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/HardwareResponse'
x-codegen-request-body-name: hardware
/api/2.26/hardware:
get:
tags:
- Hardware
summary: Pure Storage GET Hardware
description: List hardware slots and bays and the status of installed components.
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'
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/HardwareGetResponse'
patch:
tags:
- Hardware
summary: Pure Storage PATCH Hardware
description: 'Controls the visual identification light of the specified hardware component.
'
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Ids'
- $ref: '#/components/parameters/Names'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Hardware_2'
required: true
x-codegen-request-body-name: hardware
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/HardwareResponse_2'
x-codegen-request-body-name: hardware
/api/1.5/hardware:
get:
tags:
- Hardware
summary: Pure Storage Get Hardware
description: 'Retrieves information about hardware components.
'
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/HardwareGetResponse'
'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:
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:
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
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
Filter:
name: filter
in: query
description: 'Narrows down the results to only the response objects
that satisfy the filter criteria.
'
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
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
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
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
XRequestId:
name: X-Request-ID
in: header
description: 'Supplied by client during request or generated by server.
'
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
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
Limit:
name: limit
in: query
description: 'Limits the size of the response to the specified number of objects on each page.
To return the total number of resources, set `limit=0`.
The total number of resources is returned as a `total_item_count` value.
If the page size requested is larger than the system maximum limit,
the server returns the maximum limit, disregarding the requested page size.
'
schema:
type: integer
format: int32
minimum: 0
example: 10
Authorization:
name: Authorization
in: header
description: 'Access token (in JWT format) required to use any API
endpoint (except `/oauth2`, `/login`, and `/logout`)
'
schema:
type: string
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
Authorization_2:
name: Authorization
in: header
description: 'Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
'
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
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
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
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
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
Sort:
name: sort
in: query
description: "Sorts the response objects by the specified fields. Sorting can be applied to any field name\n in the response, in ascending order by default, or in descending order by prefixing the\n field name with a minus sign (-). Multiple fields can be specified as a comma-separated\n list (e.g., sort volumes by size descending, then by name ascending). If sort is provided,\n the response will not include a continuation_token.\n"
style: form
explode: false
schema:
type: array
items:
pattern: ^[a-z]+(_[a-z]+)*-?
type: string
schemas:
Hardware_2:
allOf:
- $ref: '#/components/schemas/_builtIn'
- type: object
properties:
data_mac:
description: 'Ethernet (data) MAC address
'
type: string
readOnly: true
example: fa:16:3e:a1:c6:ce
details:
description: 'Details about the status of the component if not healthy.
'
type: string
readOnly: true
example: Temperature too high
identify_enabled:
description: 'State of an LED used to visually identify the component.
'
type: boolean
example: true
index:
description: 'Number that identifies the relative position of a hardware component
within the array.
'
type: integer
format: int32
readOnly: true
example: 1
management_mac:
description: 'Hardware component (burned-in) MAC address
'
type: string
readOnly: true
example: 24:a9:37:ca:a0:d0
model:
description: Model number of the hardware component.
type: string
readOnly: true
example: FB-8TB
part_number:
description: 'Part number of the hardware component.
'
type: string
readOnly: true
example: 83-0139-01
sensor_readings:
type: array
readOnly: true
items:
$ref: '#/components/schemas/HardwareTemperatures'
serial:
description: Serial number of the hardware component.
type: string
readOnly: true
example: S16445515B09553
slot:
description: 'Slot number occupied by the PCI Express card that hosts the component.
'
type: integer
format: int32
readOnly: true
example: 16
speed:
description: The maximum speed (in b/s) at which the component is capable of operating.
type: integer
format: int64
readOnly: true
example: 10000000000
status:
description: 'Component status.
Valid values are `critical`, `healthy`, `identifying`, `unhealthy`,
`unknown`, and `unused`.
'
type: string
readOnly: true
example: critical
temperature:
description: Temperature (in degrees celsius) reported by the component.
type: integer
format: int32
readOnly: true
example: 25
type:
description: 'Type of hardware component.
Valid values are `bay`, `ch`, `eth`, `fan`, `fb`, `fm`, `pwr`, and `xfm`.
'
type: string
readOnly: true
example: ch
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
HardwareTemperaturesThresholds:
description: 'The predefined temperature thresholds for the sensor, specifying acceptable operational limits.
'
type: object
properties:
critical:
description: 'The temperature level indicating that the system is under increased load.
While still operational, it may require monitoring or adjustments to maintain optimal performance.
'
type: number
format: double
readOnly: true
non_critical:
description: 'The temperature level at which the system operates normally without any concerns.
'
type: number
format: double
readOnly: true
unrecoverable:
description: 'The maximum temperature limit beyond which the system may experience irreversible failure.
Immediate action is required to prevent damage or shutdown.
'
type: number
format: double
readOnly: true
Hardware:
allOf:
- $ref: '#/components/schemas/_builtInResourceNoId'
- type: object
properties:
details:
description: 'Details about the status of the component if not healthy.
'
type: string
readOnly: true
example: Temperature too high
identify_enabled:
description: 'If `true`, the ID LED is lit to visually identify the component.
'
type: boolean
readOnly: true
example: true
index:
description: 'Number that identifies the relative position of a hardware component within the array.
'
type: integer
format: int32
readOnly: true
example: 1
model:
description: 'Model number of the hardware component.
'
type: string
readOnly: true
example: DFSC1
serial:
description: 'Serial number of the hardware component.
'
type: string
readOnly: true
example: PSMFL1717009B
slot:
description: 'Slot number occupied by the PCI Express card that hosts the component.
'
type: integer
format: int32
readOnly: true
example: 16
speed:
description: 'Speed (in bytes per second) at which the component is operating.
'
type: integer
format: int64
readOnly: true
example: 24000000000
status:
description: 'Component status.
Values include `critical`, `healthy`, `identifying`, `unhealthy`, `unknown`, and `unused`.
'
type: string
readOnly: true
example: critical
temperature:
description: 'Temperature (in degrees Celsius) reported by the component.
'
type: integer
format: int32
readOnly: true
example: 25
type:
description: 'The type of hardware component. Values include `chassis`, `cooling`, `controller`,
`direct_compress_accelerator`, `drive_bay`, `eth_port`, `fc_port`, `ib_port`, `sas_module`,
`sas_port`, `storage_shelf`, `temp_sensor`, and `power_supply`.
'
type: string
readOnly: true
example: controller
voltage:
description: 'Voltage (in Volts) reported by the component.
'
type: integer
format: int32
readOnly: true
example: 206
HardwareResponse_2:
type: object
properties:
items:
description: A list of hardware component objects.
type: array
items:
$ref: '#/components/schemas/Hardware_2'
HardwareTemperatures:
description: 'Provides detailed information about temperature readings from a sensor,
including its status and threshold limits.
'
type: object
properties:
name:
description: The name of the temperature sensor.
type: string
readOnly: true
reading:
description: The latest temperature measurement reported by the sensor.
type: number
format: double
readOnly: true
status:
description: 'The current operational state of the sensor,
indicating whether it is functioning normally or experiencing issues.
Possible values include HEALTHY, NON_CRITICAL, CRITICAL, UNRECOVERABLE, UNKNOWN.
'
type: string
readOnly: true
thresholds:
$ref: '#/components/schemas/HardwareTemperaturesThresholds'
HardwarePatch:
allOf:
- $ref: '#/components/schemas/_builtInResourceNoId'
- type: object
properties:
identify_enabled:
description: 'State of an LED used to visually identify the component.
'
type: boolean
example: true
index:
description: 'Number that identifies the relative position of a hardware component within the array.
'
type: integer
format: int32
example: 1
_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
HardwareGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/HardwareResponse'
HardwareResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/Hardware'
_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
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