openapi: 3.0.1
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:
schemas:
SupportRemoteAssistSessionsSettingsResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SupportRemoteAssistSessionsSettings'
_errorContextResponseErrors:
type: object
properties:
context:
description: 'Contains information relating to the cause of this error,
or the name of the object that was being processed when the error was encountered.
This may be `null` for more general errors.
'
type: string
location_context:
description: 'Contains information relating to the context in which the request was executing
when the error occurred.
For example, this may be the name of an array in the same fleet.
This may be `null` for more general errors, or if no explicit `context` parameter
was provided with the request.
'
title: FixedReference
allOf:
- $ref: '#/components/schemas/_fixedReference'
message:
description: A description of the error which occurred.
type: string
example: Resource does not exist.
_errorContextResponse:
type: object
properties:
errors:
description: The list of errors encountered when attempting to perform an operation.
type: array
readOnly: true
items:
$ref: '#/components/schemas/_errorContextResponseErrors'
SupportRemoteAssistSessionsGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/SupportRemoteAssistSessionsResponse'
SupportRemoteAssistSessions:
description: 'Remote assist session settings.
'
type: object
properties:
access_level:
description: 'The access level for this remote assist session.
This is set to default_access_level unless access_level_override is provided.
Values include `restricted` and `elevated`.
'
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
expires:
description: 'The timestamp when the session expires, measured in milliseconds since the UNIX epoch.
'
type: integer
format: int64
readOnly: true
example: 1574633337678
opened:
description: 'The timestamp when the session opened, measured in milliseconds since the UNIX epoch.
'
type: integer
format: int64
readOnly: true
example: 1574460534674
paths:
type: array
readOnly: true
items:
$ref: '#/components/schemas/_supportRemoteAssistSessionsPaths'
status:
description: 'The status of the remote assist session.
Values include `connected`, `connecting`, `disconnected`, and `session-active`.
'
type: string
readOnly: true
example: connected
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
TestResultResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/TestResult'
SupportDiagnosticsDetailsGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/SupportDiagnosticsDetailsResponse'
SupportDiagnosticsDetailsResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SupportDiagnosticsDetails'
_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
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
SupportSystemManifestResponse_2:
allOf:
- $ref: '#/components/schemas/PageInfo_2'
- $ref: '#/components/schemas/_errorContextResponse'
- type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SupportSystemManifest_2'
_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
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
TestResultGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/TestResultResponse'
SupportSystemManifestResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SupportSystemManifest'
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
SupportResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/Support'
SupportRemoteAssistSessionsResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SupportRemoteAssistSessions'
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://proxy.example.com:8080
remote_assist_active:
description: 'The status of a remote assist session. If set to `true`, enable the remote assist session.
If set to `false`, disable the remote assist session.
'
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.
This parameter determines the length of time the session will remain active
after it is initiated.
'
type: integer
format: int64
example: 86400000
_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
Support:
allOf:
- $ref: '#/components/schemas/SupportPatch'
- type: object
properties:
phonehome_enabled:
description: 'If set to `true`, enables phonehome.
If set to `false`, disables phonehome.
'
type: boolean
phonehome_excludes:
description: 'A list of items that are excluded from phonehome data collection.
'
type: array
items:
type: string
example: application-insights
proxy:
description: 'The value of the current proxy, which is used to connect to cloud services such as
phonehome and remote assist.
Specify the server name, including the scheme and proxy port number.
'
type: string
example: http://proxy.example.com:8080
remote_assist_active:
description: 'If set to `true`, enables the remote assist session.
If set to `false`, disables the remote assist session.
'
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 timestamp when the session expires, measured in milliseconds since the UNIX epoch.
'
type: integer
format: int64
readOnly: true
example: 1574633337678
remote_assist_opened:
description: 'The timestamp when the session opened, measured in milliseconds since the UNIX epoch.
'
type: integer
format: int64
readOnly: true
example: 1574460534674
remote_assist_paths:
type: array
readOnly: true
items:
$ref: '#/components/schemas/_supportRemoteAssistPaths'
remote_assist_status:
description: 'The status of the remote assist session.
Values include `connected`, `connecting`, `disconnected`, and `session-active`.
'
type: string
readOnly: true
example: connected
SupportGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/SupportResponse'
_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'
TestResultGetResponse_2:
allOf:
- $ref: '#/components/schemas/TestResultResponse'
- type: object
properties:
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
SupportDiagnosticsGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/SupportDiagnosticsResponse'
_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
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
SupportDiagnosticsDetails:
description: 'De
# --- 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