Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: FlashArray REST Active Directory Support 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: Support
description: 'Enables Support to fix bugs and help customers solve problems. Support tools include proxy,
phonehome, and remote assist.
'
paths:
/api/2.52/support:
get:
tags:
- Support
summary: Pure Storage List Connection Paths
description: 'Displays connection paths between the current array and each connected 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/SupportGetResponse'
patch:
tags:
- Support
summary: Pure Storage Create Connection Path
description: 'Creates a connection path from the array to another array.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SupportPatch'
required: true
x-codegen-request-body-name: support
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SupportResponse'
x-codegen-request-body-name: support
/api/2.52/support/remote-assist-sessions:
get:
tags:
- Support
summary: Pure Storage List Remote Assist Session
description: 'Displays settings for remote assist sessions.
'
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/SupportRemoteAssistSessionsGetResponse'
patch:
tags:
- Support
summary: Pure Storage Modify Remote Assist Session
description: 'Modifies settings for remote assist sessions.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SupportRemoteAssistSessionsPatch'
required: true
x-codegen-request-body-name: support
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SupportRemoteAssistSessionsResponse'
x-codegen-request-body-name: support
/api/2.52/support/remote-assist-sessions/settings:
get:
tags:
- Support
summary: Pure Storage List Remote Assist Session Global Settings
description: 'Displays global settings for remote assist sessions.
'
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/SupportRemoteAssistSessionsSettingsGetResponse'
patch:
tags:
- Support
summary: Pure Storage Update Remote Assist Session Global Settings
description: 'Updates global settings for remote assist sessions.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SupportRemoteAssistSessionsSettings'
required: true
x-codegen-request-body-name: support
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SupportRemoteAssistSessionsSettingsResponse'
x-codegen-request-body-name: support
/api/2.52/support/system-manifest:
get:
tags:
- Support
summary: Pure Storage List the System Manifest
description: The creation and return of the system manifest as a `JSON` object.
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/SupportSystemManifestResponse'
/api/2.52/support/test:
get:
tags:
- Support
summary: Pure Storage List Pure Storage Support Connection Data
description: Displays information about whether the array can connect to Pure Storage Support by establishing a secure shell or secure HTTP connection and verifies that messages can be exchanged.
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/Test_type'
- $ref: '#/components/parameters/Total_item_count'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TestResultGetResponse'
/api/2.52/support-diagnostics/details:
get:
tags:
- Support
summary: Pure Storage List Diagnostics Details
description: 'Displays the diagnostics tests details.
'
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/SupportDiagnosticsDetailsGetResponse'
/api/2.52/support-diagnostics/settings:
get:
tags:
- Support
summary: Pure Storage List Diagnostics Tools Version and Last Updated Date
description: 'Displays diagnostics tools version and last updated date.
'
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/SupportDiagnosticsGetResponse'
patch:
tags:
- Support
summary: Pure Storage Update Diagnostics Tools
description: 'Update diagnostics tools from downloaded bundle.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/PurityDefault'
responses:
'200':
description: 'The diagnostics tools were updated successfully.
'
content:
application/json:
schema:
$ref: '#/components/schemas/SupportDiagnosticsResponse'
/api/2.26/support:
get:
tags:
- Support
summary: Pure Storage GET Support
description: List Phone Home, Remote Assistance and Edge Management settings.
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Ids'
- $ref: '#/components/parameters/Names'
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/SupportGetResponse'
patch:
tags:
- Support
summary: Pure Storage PATCH Support
description: Modify Phone Home, Remote Assistance and Edge Management settings.
parameters:
- $ref: '#/components/parameters/XRequestId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Support_2'
required: true
x-codegen-request-body-name: support
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/SupportResponse'
x-codegen-request-body-name: support
/api/2.26/support/system-manifest:
get:
tags:
- Support
summary: Pure Storage List the System Manifest
description: Create and return the system manifest as a JSON object.
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'
- $ref: '#/components/parameters/Total_only'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SupportSystemManifestResponse_2'
'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/SupportSystemManifestResponse_2'
/api/2.26/support/test:
get:
tags:
- Support
summary: Pure Storage GET Support-test
description: Test if the Phone Home and Remote Assistance settings are functioning properly.
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Sort_2'
- $ref: '#/components/parameters/Test_type'
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/TestResultGetResponse_2'
components:
parameters:
Test_type:
name: test_type
in: query
description: 'Specifies the type of test. Valid values are `all`, `phonehome`, and `remote-assist`.
If not specified, defaults to `all`.
'
schema:
type: string
PurityDefault:
name: purity_default
in: query
description: 'Set diagnostics tool to default version.
'
schema:
type: boolean
Context_names_get:
name: context_names
in: query
description: 'Performs the operation on the unique contexts specified.
If specified, each context name must be the name of an array in the same fleet or
the name of the fleet itself.
If not specified, the context will default to the array that received this request.
Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided `context`.
Enter multiple names in comma-separated format.
For example, `name01,name02`.
'
style: form
explode: false
schema:
type: array
items:
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
Allow_errors:
name: allow_errors
in: query
description: 'If set to `true`, the API will allow the operation to continue even if there are errors.
Any errors will be returned in the `errors` field of the response.
If set to `false`, the operation will fail if there are any errors.
'
schema:
type: boolean
default: false
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
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
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
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
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:
name: filter
in: query
description: 'Narrows down the results to only the response objects
that satisfy the filter criteria.
'
schema:
type: string
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
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
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
XRequestId:
name: X-Request-ID
in: header
description: 'Supplied by client during request or generated by server.
'
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:
SupportRemoteAssistSessionsResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SupportRemoteAssistSessions'
SupportDiagnosticsDetailsResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SupportDiagnosticsDetails'
Support_2:
allOf:
- $ref: '#/components/schemas/_builtIn'
- type: object
properties:
edge_agent_update_enabled:
description: The switch to enable opt-in for edge agent updates.
type: boolean
edge_management_enabled:
description: The switch to enable opt-in for edge management.
type: boolean
phonehome_enabled:
description: The switch to enable phonehome.
type: boolean
proxy:
type: string
remote_assist_active:
description: The switch to open all remote-assist sessions.
type: boolean
remote_assist_duration:
description: 'Specifies the duration of the remote-assist session in milliseconds.
This parameter should only be provided when establishing a new session.
It determines the length of time the session will remain active after it''s initiated.
'
type: integer
format: int64
example: 86400000
remote_assist_expires:
description: The time when the session expires.
type: string
readOnly: true
remote_assist_opened:
description: The time when the session opened.
type: string
readOnly: true
remote_assist_paths:
type: array
readOnly: true
items:
$ref: '#/components/schemas/_support_remote_assist_paths'
remote_assist_status:
description: 'The status of the remote-assist sessions.
Valid values are `connected`, `partially_connected`, `reconnecting`,
and `disconnected`.
'
type: string
readOnly: true
example: connected
SupportResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/Support'
_fixedReferenceWithoutType:
type: object
properties:
id:
description: 'A globally unique, system-generated ID.
The ID cannot be modified.
'
type: string
readOnly: true
name:
description: 'The resource name, such as volume name, file system name,
snapshot name, and so on.
'
type: string
readOnly: true
x-readOnly: true
_supportRemoteAssistSessionsPaths:
type: object
properties:
component_name:
description: 'The name of the local controller running the remote assist session.
'
type: string
example: CT0
status:
description: 'The status of the remote assist session on the local controller.
Values include `connected`, `connecting`, `disconnected`, and `session-active`.
'
type: string
example: connected
SupportRemoteAssistSessionsSettings:
type: object
properties:
default_access_level:
description: 'The default access level that support will have when connecting to the array.
Values include `restricted` and `elevated`.
'
type: string
SupportSystemManifest_2:
allOf:
- $ref: '#/components/schemas/_context'
- type: object
description: 'system manifest.
'
properties:
system-manifest:
type: string
description: 'The system manifest for the array, delivered as a JSON object.
'
readOnly: true
TestResult:
type: object
properties:
component_address:
description: Address of the component running the test.
type: string
example: 10.230.94.21
component_name:
description: Name of the component running the test.
type: string
example: CT0
description:
description: What the test is doing.
type: string
example: Testing phonehome connectivity
destination:
description: The URI of the target server being tested.
type: string
example: ra.cloud-support.purestorage.com
enabled:
description: 'Whether the object being tested is enabled or not.
Returns a value of `true` if the the service is enabled.
Returns a value of `false` if the service is disabled.
'
type: boolean
example: true
result_details:
description: Additional information about the test result.
type: string
example: Timeout connecting to phonehome endpoint
success:
description: 'Whether the object being tested passed the test or not.
Returns a value of `true` if the specified test has succeeded.
Returns a value of `false` if the specified test has failed.
'
type: boolean
test_type:
description: 'Displays the type of test being performed. The returned values are determined
by the `resource` being tested and its configuration.
Values include `array-admin-group-searching`, `binding`, `connecting`, `phonehome`,
`phonehome-ping`, `remote-assist`, `rootdse-searching`, `read-only-group-searching`,
`storage-admin-group-searching`, and `validate-ntp-configuration`.
'
type: string
example: phonehome
_context:
type: object
properties:
context:
description: 'The context in which the operation was performed.
Valid values include a reference to any array which is a member of the same fleet
or to the fleet itself.
Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided `context`.
'
readOnly: true
title: FixedReference
allOf:
- $ref: '#/components/schemas/_fixedReference'
SupportGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/SupportResponse'
_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
SupportRemoteAssistSessionsPatch:
type: object
properties:
access_level_override:
description: 'Overrides the default access level for the remote assist session only.
Values include `restricted` and `elevated`.
If not provided, the remote assist session will use the default_access_level setting.
'
type: string
active:
description: 'The status of a remote assist session. If set to `true`, enables the remote assist session.
If set to `false`, disables the remote assist session.
'
type: boolean
duration:
description: 'Specifies the duration of the remote assist session in milliseconds.
This parameter should only be provided when establishing a new session.
This parameter determines the length of time the session will remain active
after initiation.
Defaults to 86400000 (24h) with a min of 14400000 (4h) and a max of 172800000 (48h).
'
type: integer
format: int64
example: 86400000
_fixedReference:
allOf:
- $ref: '#/components/schemas/_fixedReferenceWithoutType'
- type: object
properties:
resource_type:
description: 'Type of the object (full name of the endpoint).
Valid values are the unique part of the resource''s REST endpoint.
For example, a reference to a file system would have a
`resource_type` of `file-systems`.
'
type: string
readOnly: true
SupportRemoteAssistSessionsSettingsGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/SupportRemoteAssistSessionsSettingsResponse'
_supportRemoteAssistPaths:
type: object
properties:
component_name:
description: 'The name of the local controller that is running the remote assist session.
'
type: string
example: CT0
status:
description: 'The status of the remote assist session on the local controller.
Values include `connected`, `connecting`, `disconnected`, and `session-active`.
'
type: string
example: connected
SupportDiagnosticsDetailsGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/SupportDiagnosticsDetailsResponse'
SupportDiagnosticsDetails:
description: 'Details of diagnostics tests tasks
'
type: object
properties:
result_details:
description: 'Additional details related to the test.
This field also provides remediation information.
'
type: string
readOnly: true
example: enabled
severity:
description: Severity level of the test. Valid values are `info`, `warning`, and `critical`.
type: string
test_name:
description: 'Name of the test that was performed.
'
type: string
test_type:
description: 'The category to which the test belongs to.
'
type: string
readOnly: true
example: generic
TestResultGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/TestResultResponse'
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
_support_remote_assist_paths:
type: object
properties:
component_name:
description: The name of the FM.
type: string
status:
description: 'The status of the remote-assist session on the local FM.
Valid values are `reconnecting`, `connected`, `disconnected`,
and `unknown`.
'
type: string
example: connected
SupportPatch:
type: object
properties:
phonehome_enabled:
description: 'The status of phonehome. If set to `true`, enable phonehome.
If set to `false`, disable phonehome.
'
type: boolean
phonehome_excludes:
description: 'A list of of items to exclude form phonehome.
Valid values include `application-insights`.
'
type: array
items:
type: string
example: application-insights
proxy:
description: 'The value of the current proxy, which is used for connecting to cloud services such as
phonehome, remote assist, etc.
Specify the server name, including the scheme and proxy port number.
'
type: string
example: http:/
# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/openapi/pure-storage-support-api-openapi.yml