openapi: 3.0.1 info: title: FlashArray REST Active Directory Arrays 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: Arrays description: 'Array features provide the ability to configure settings that affect the operation of the array as a whole and monitor array I/O performance. ' paths: /api/2.52/arrays: get: tags: - Arrays summary: Pure Storage List Arrays description: 'Displays general array properties including the array name, login banner, idle timeout for management sessions, and NTP servers. ' parameters: - $ref: '#/components/parameters/Authorization' - $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' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ArrayGetResponse' '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/ArrayGetResponse' delete: tags: - Arrays summary: Pure Storage Delete an Array description: 'Deletes an array. For physical appliances, deleting an array restores the hardware to factory settings. This entails deleting all data, metadata, configuration, and logs. The array returns to the state it was in prior to any configuration changes being made. If the hardware is reused, it must be as a different array with a new ID. For virtual appliances, deleting an array puts it into an unusable state. Virtual resources (e.g., virtual machines) can later be freed, which deletes any remaining data, metadata, configuration, and logs. Prior to factory reset, an array must be manually prepared (e.g., all volumes and snapshots must be eradicated) and a factory reset token must be created. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Eradicate_all_data' - $ref: '#/components/parameters/Factory_reset_token' responses: '200': description: OK content: {} patch: tags: - Arrays summary: Pure Storage Modify an Array description: 'Modifies general array properties such as the array name, login banner, idle timeout for management sessions, and NTP servers. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/Arrays' required: true x-codegen-request-body-name: array responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ArrayResponse' x-codegen-request-body-name: array /api/2.52/arrays/cache: get: tags: - Arrays summary: Pure Storage DIMM Cache Status description: The status of the DIMM cache. parameters: - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/History_start_time' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CacheGetResponse' /api/2.52/arrays/cloud-config: get: tags: - Arrays summary: Pure Storage List CBS Array Configuration Status description: 'Displays the configuration status of the CBS array, including the progress of the configuration upgrade. Requests for non-CBS arrays will receive an error response. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CloudConfigGetResponse' patch: tags: - Arrays summary: Pure Storage Modify CBS Array Configuration description: 'Modifies the configuration of the CBS array. This should trigger a backend process that will upgrade the CBS array configuration. The array can be upgraded only to models defined by the supported configurations endpoint. When an existing array upgrade request is in progress, any new request to upgrade the array will receive an error response. For non-CBS arrays, this feature is not supported and requests will receive an error response. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' requestBody: description: The requested configuration of the CBS array hardware. content: application/json: schema: $ref: '#/components/schemas/CloudConfigPatch' required: true x-codegen-request-body-name: config responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CloudConfigPatchResponse' x-codegen-request-body-name: config /api/2.52/arrays/cloud-config/supported-configs: get: tags: - Arrays summary: Pure Storage List CBS Array Supported Upgrade Target Configs description: 'Displays the list of supported configurations to which the CBS array can be upgraded. Requests for non-CBS arrays will receive an error response. ' 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/CloudConfigSupportedConfigsGetResponse' /api/2.52/arrays/cloud-capacity: get: tags: - Arrays summary: Pure Storage List CBS Array Capacity Status description: 'Displays the capacity status of the CBS array including the progress of the capacity update. Requests for non-CBS arrays will receive an error response. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CloudCapacityGetResponse' patch: tags: - Arrays summary: Pure Storage Modify CBS Array Capacity description: 'Modifies the raw capacity of the CBS array. This should trigger a backend process that will update the CBS array capacity. The array capacity can be updated only to values defined by the capacity steps endpoint. When an existing capacity update request is in progress, any new request to update of the capacity will receive an error response. For non-CBS arrays, this feature is not supported and requests will receive an error response. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' requestBody: description: The requested capacity of the CBS array. content: application/json: schema: $ref: '#/components/schemas/CloudCapacityStatus' required: true x-codegen-request-body-name: capacity responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CloudCapacityPatchResponse' x-codegen-request-body-name: capacity /api/2.52/arrays/cloud-capacity/supported-steps: get: tags: - Arrays summary: Pure Storage List CBS Array Capacity Steps description: 'Displays the list of supported raw capacity sizes in bytes the CBS array can be upgraded to. Requests for non-CBS arrays will receive an error response. ' 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/CloudCapacityStepsGetResponse' /api/2.52/arrays/cloud-provider-tags: get: tags: - Arrays summary: Pure Storage List User Tags on the Cloud. description: Displays the list of user tags on deployed cloud resources of a CBS 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/CloudProviderTagGetResponse' delete: tags: - Arrays summary: Pure Storage Delete User Tags from the Cloud. description: Deletes user tags from deployed cloud resources of a CBS array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Keys' responses: '200': description: OK content: {} /api/2.52/arrays/cloud-provider-tags/batch: put: tags: - Arrays summary: Pure Storage Update User Tags on the Cloud. description: Updates users tags to deployed cloud resources of a CBS array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' requestBody: description: A list of tags to be created or, if already existing, updated. content: application/json: schema: maxItems: 50 minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/CloudProviderTag' required: true x-codegen-request-body-name: tag responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CloudProviderTagResponse' x-codegen-request-body-name: tag /api/2.52/arrays/erasures: get: tags: - Arrays summary: Pure Storage List Factory Reset Details description: 'Displays a list of factory reset processes. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ArrayErasureGetResponse' post: tags: - Arrays summary: Pure Storage Create a Process for Factory Reset description: 'Creates the initiation of the factory reset process ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Eradicate_all_data_required' - $ref: '#/components/parameters/Preserve_configuration_data_required' - $ref: '#/components/parameters/Skip_phonehome_check' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ArrayErasureResponse' delete: tags: - Arrays summary: Pure Storage Delete Factory Reset description: 'Deletes the factory reset process when it is `failed`. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' responses: '200': description: OK content: {} patch: tags: - Arrays summary: Pure Storage Update Factory Reset description: 'Modifies the factory reset process to finalize. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Delete_sanitization_certificate_required' - $ref: '#/components/parameters/Eradicate_all_data_required' - $ref: '#/components/parameters/Finalize_array_erasure_required' - $ref: '#/components/parameters/Reinstall_image_required' requestBody: content: application/json: schema: $ref: '#/components/schemas/ArrayErasurePatch' required: false x-codegen-request-body-name: erasure_patch responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ArrayErasureResponse' x-codegen-request-body-name: erasure_patch /api/2.52/arrays/eula: get: tags: - Arrays summary: Pure Storage List End User Agreement and Signature description: Displays the End User Agreement and signature. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/EulaGetResponse' patch: tags: - Arrays summary: Pure Storage Modify Signature on the End User Agreement description: Modifies the signature on the End User Agreement. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' requestBody: content: application/json: schema: $ref: '#/components/schemas/Eula' required: false x-codegen-request-body-name: eula responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/EulaResponse' x-codegen-request-body-name: eula /api/2.52/arrays/factory-reset-token: get: tags: - Arrays summary: Pure Storage List Factory Reset Tokens description: Displays a list of tokens used to perform a factory reset on the array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ArrayFactoryResetTokenGetResponse' post: tags: - Arrays summary: Pure Storage Create a Factory Reset Token description: 'Creates a token that can be used to perform a factory reset on the array. Factory reset tokens can only be created after the array has been prepared for reset (e.g., all volumes and snapshots must first be eradicated). After a token has been created, operations that would take the array out of the prepared state are disabled (e.g., creating volumes) until all tokens have been deleted. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ArrayFactoryResetTokenResponse' delete: tags: - Arrays summary: Pure Storage Delete a Factory Reset Token description: Deletes an existing token that could be used to perform a factory reset on the array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' responses: '200': description: OK content: {} /api/2.52/arrays/ntp-test: get: tags: - Arrays summary: Pure Storage List NTP Test Results description: Displays test results for configured NTP servers. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TestResultGetResponse' /api/2.52/arrays/performance: get: tags: - Arrays summary: Pure Storage List Array Front-end Performance Data description: 'Displays real-time and historical front-end performance data at the array level including latency, bandwidth, IOPS, average I/O size, and queue depth. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Perf_protocol_type' - $ref: '#/components/parameters/Perf_protocol_group' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ArrayPerformanceGetResponse' /api/2.52/arrays/performance/by-link: get: tags: - Arrays summary: Pure Storage List Array Front-end IO Performance Data by Link description: 'Displays real-time and historical front-end performance data at the array level including latency, bandwidth, IOPS, average I/O size, and queue depth. Group output is shown by link. A link represents a set of arrays that an I/O operation depends on. For local-only I/Os, this is a local array. For mirrored I/Os, this is a set of synchronous replication peer arrays. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ArrayPerformanceByLinkGetResponse' /api/2.52/arrays/space: get: tags: - Arrays summary: Pure Storage List Array Space Information description: 'Displays real-time and historical array space information including unique volume and snapshot space, shared space, data reduction, provisioned capacity, usable capacity, and parity. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ArraySpaceGetResponse' '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/ArraySpaceGetResponse' /api/2.52/arrays/tags: get: tags: - Arrays summary: Pure Storage List Tags description: 'Displays the list of tags on array objects. ' parameters: - $ref: '#/components/parameters/Authorization' - $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/Namespaces' - $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/TagGetResponse' '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/TagGetResponse' delete: tags: - Arrays summary: Pure Storage Delete Tags description: 'Deletes specified tags on array objects. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Keys' - $ref: '#/components/parameters/Namespaces' responses: '200': description: OK content: {} /api/2.52/arrays/tags/batch: put: tags: - Arrays summary: Pure Storage Update Tags description: 'Updates tags. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' requestBody: description: A list of tags to be created or, if they already exist, updated. content: application/json: schema: maxItems: 30 minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/NonCopyableTag' required: true x-codegen-request-body-name: tag responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TagResponse' x-codegen-request-body-name: tag /api/2.26/arrays: get: tags: - Arrays summary: Pure Storage GET Arrays description: List array attributes such as the array name, ID, version, and NTP servers. 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' 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/ArrayGetResponse' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ArrayGetResponse' patch: tags: - Arrays summary: Pure Storage PATCH Arrays description: Modify the general configuration of the array including banner text, array name, NTP servers, and time zone. parameters: - $ref: '#/components/parameters/XRequestId' requestBody: content: application/json: schema: $ref: '#/components/schemas/Array' required: true x-codegen-request-body-name: array 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/ArrayResponse_2' x-codegen-request-body-name: array /api/2.26/arrays/eula: get: tags: - Arrays summary: Pure Storage GET Arrays/eula description: List the End User Agreement and signature. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $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/EulaGetResponse' patch: tags: - Arrays summary: Pure Storage PATCH Arrays/eula description: Modifies the signature on the End User Agreement. parameters: - $ref: '#/components/parameters/XRequestId' requestBody: content: application/json: schema: $ref: '#/components/schemas/Eula' required: false x-codegen-request-body-name: eula 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/EulaResponse' x-codegen-request-body-name: eula /api/2.26/arrays/factory-reset-token: get: tags: - Arrays summary: Pure Storage List Factory Reset Tokens description: Displays a list of tokens used to perform a factory reset on the array. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $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/ArrayFactoryResetTokenGetResponse' post: tags: - Arrays summary: Pure Storage Create a Factory Reset Token description: 'Creates a token that can be used to perform a factory reset on the array. Factory reset tokens can only be created after the array has been prepared for reset (e.g., all file systems, buckets, and snapshots must first be eradicated). After a token has been created, operations that would take the array out of the prepared state (e.g., creating file systems) are disabled until all tokens have been deleted. ' parameters: - $ref: '#/components/parameters/XRequestId' 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/ArrayFactoryResetTokenResponse' delete: tags: - Arrays summary: Pure Storage Delete a Factory Reset Token description: 'Deletes any existing token that could be used to perform a factory reset on the array. ' parameters: - $ref: '#/components/parameters/XRequestId' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: {} /api/2.26/arrays/http-specific-performance: get: tags: - Arrays summary: Pure Storage GET Arrays/http-specific-performance description: List the HTTP performance metrics of the array. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/End_time' - $ref: '#/components/parameters/Resolution' - $ref: '#/components/parameters/Start_time' 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/ArrayHttpSpecificPerformanceGet' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ArrayHttpSpecificPerformanceGet' /api/2.26/arrays/nfs-specific-performance: get: tags: - Arrays summary: Pure Storage GET Arrays/nfs-specific-performance description: List the NFS performance metrics of the array. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/End_time' - $ref: '#/components/parameters/Resolution' - $ref: '#/components/parameters/Start_time' 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/ArrayNfsSpecificPerformanceGet' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ArrayNfsSpecificPerformanceGet' /api/2.26/arrays/performance: get: tags: - Arrays summary: Pure Storage GET Arrays/performance description: Lists the overall performance metrics of the array. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/End_time' - $ref: '#/components/parameters/Protocol' - $ref: '#/components/parameters/Resolution' - $ref: '#/components/parameters/Start_time' 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/ArrayPerformanceGetResponse_2' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ArrayPerformanceGetResponse_2' /api/2.26/arrays/performance/replication: get: tags: - Arrays summary: Pure Storage GET Arrays/performance/replication description: List replication performance metrics. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/End_time' - $ref: '#/components/parameters/Resolution' - $ref: '#/components/parameters/Start_time' - $ref: '#/components/parameters/Type_for_performance' 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/ArrayPerformanceReplicationGetResp' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ArrayPerformanceReplicationGetResp' /api/2.26/arrays/s3-specific-performance: get: tags: - Arrays summary: Pure Storage GET Arrays/s3-specific-performance description: List the S3 performance metrics of the array. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/End_time' - $ref: '#/components/parameters/Resolution' - $ref: '#/components/parameters/Start_time' 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/ArrayS3SpecificPerformanceGetResp' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ArrayS3SpecificPerformanceGetResp' /api/2.26/arrays/space: get: tags: - Arrays summary: Pure Storage GET Arrays/space description: List available and used storage space on the array. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/End_time' - $ref: '#/components/parameters/Resolution' - $ref: '#/components/parameters/Start_time' - $ref: '#/components/parameters/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/ArraySpaceGetResponse_2' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ArraySpaceGetResponse_2' /api/2.26/arrays/space/storage-classes: get: tags: - Arrays summary: Pure Storage GET Arrays/space/storage-classes description: List available and used storage space for storage classes on the array. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/End_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Resolution' - $ref: '#/components/parameters/Sort_2' - $ref: '#/components/parameters/Start_time' - $ref: '#/components/parameters/StorageClassNames' - $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/ArraySpaceStorageClassGetResponse' /api/2.26/arrays/supported-time-zones: get: tags: - Arrays summary: Pure Storage GET Arrays/supported-time-zones description: List supported time zones for the array. parameters: - $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_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/ArraysSupportedTimeZonesGetResponse' /api/2.26/arrays/erasures: post: summary: Pure Storage Create a Process for Factory Reset description: 'Creates the initiation of the factory reset process. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Eradicate_all_data_required_2' - $ref: '#/components/parameters/Preserve_configuration_data_required_2' - $ref: '#/components/parameters/Skip_phonehome_check_2' responses: 200: description: OK content: application/json: schema: $ref: '#/components/schemas/ArrayErasureResponse' tags: - Arrays patch: summary: Pure Storage Factory Reset - Finalize description: 'After the process has been completed, we need to finalize the factory reset process. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Delete_sanitization_certificate_required_2' - $ref: '#/components/parameters/Eradicate_all_data_required_2' - $ref: '#/components/parameters/Finalize_array_erasure_required_2' responses: 200: description: OK content: application/json: schema: $ref: '#/components/schemas/ArrayErasureResponse' tags: - Arrays get: summary: Pure Storage Get Factory Reset Status description: 'Get the factory reset process status. ' parameters: - $ref: '#/components/parameters/XRequestId' responses: 200: description: OK content: application/json: schema: $ref: '#/components/schemas/ArrayErasureGetResponse' tags: - Arrays delete: summary: Pure Storage Stop Factory Reset description: 'Stops the factory reset process when it is `failed`. ' parameters: - $ref: '#/components/parameters/XRequestId' responses: 200: description: OK tags: - Arrays /api/1.5/arrays: get: tags: - Arrays summary: Pure Storage Get Arrays description: 'Retrieves information about FlashArray and FlashBlade storage appliances. ' parameters: - $ref: '#/components/parameters/Authorization_2' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token_2' - $ref: '#/components/parameters/Filter_2' - $ref: '#/components/parameters/Fqdns' - $ref: '#/components/parameters/Ids' - $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/ArrayGetResponse_2' '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' /api/1.5/arrays/support-contracts: get: tags: - Arrays summary: Pure Storage Get Array Support Contracts description: 'Retrieves the support contracts associated with arrays. ' parameters: - $ref: '#/components/parameters/Authorization_2' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token_2' - $ref: '#/components/parameters/Filter_2' - $ref: '#/components/parameters/Limit_2' - $ref: '#/components/parameters/Offset_3' - $ref: '#/components/parameters/Resource_fqdns' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' - $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/SupportContractGetResponse' '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' /api/1.5/arrays/tags: get: tags: - Arrays summary: Pure Storage Get Array Tags description: 'Retrieves the tags associated with specified arrays. ' parameters: - $ref: '#/components/parameters/Authorization_2' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token_2' - $ref: '#/components/parameters/Filter_2' - $ref: '#/components/parameters/Keys_2' - $ref: '#/components/parameters/Limit_2' - $ref: '#/components/parameters/Namespaces_2' - $ref: '#/components/parameters/Offset_3' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' 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/TagGetResponse_2' '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' delete: tags: - Arrays summary: Pure Storage Delete Array Tags description: 'Deletes array tags from Pure1. ' parameters: - $ref: '#/components/parameters/Authorization_2' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Keys_2' - $ref: '#/components/parameters/Namespaces_2' - $ref: '#/components/parameters/Resource_idsRequired' - $ref: '#/components/parameters/Resource_namesRequired' 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: {} '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' /api/1.5/arrays/tags/batch: put: tags: - Arrays summary: Pure Storage Create or Update Array Tags description: 'Creates or updates array tags contextual to Pure1 only. ' parameters: - $ref: '#/components/parameters/Authorization_2' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Namespaces_2' - $ref: '#/components/parameters/Resource_idsRequired' - $ref: '#/components/parameters/Resource_namesRequired' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TagBatchRequired' 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/TagResponse' '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: schemas: ArrayEncryption: description: If the user does not have sufficient access, all fields will return `null`. type: object properties: data_at_rest: title: ArrayencryptionDataAtRest allOf: - $ref: '#/components/schemas/_arrayencryptionDataAtRest' module_version: description: 'The version of the Purity encryption module installed on the array. Security certifications are carried out on a per-version basis. On non-encrypt builds, an encryption module may be installed without being enabled. Values include `FA-1.0`, `FA-1.1`, `FA-1.2`, `FA-1.3`, and so on. ' type: string readOnly: true example: FA-1.3 x-readOnly: true ArraysSupportedTimeZonesGetResponse: allOf: - $ref: '#/components/schemas/PageInfo_2' - type: object properties: items: type: array items: $ref: '#/components/schemas/_timeZone' _eula_signature: type: object properties: accepted: description: Accepted time in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true example: 1577880000000 company: description: 'The company of the person who accepted the End User Agreement. This field is deprecated and the response will be `null`. Modification to this field will be ignored. ' type: string example: Example Inc. name: description: 'The name of the person who accepted the End User Agreement. This field is deprecated and the response will be `null`. Modification to this field will be ignored. ' type: string example: John Doe title: description: 'The title of the person who accepted the End User Agreement. This field is deprecated and the response will be `null`. Modification to this field will be ignored. ' type: string example: Admin ArrayPerformance_2: allOf: - $ref: '#/components/schemas/_builtIn_2' - $ref: '#/components/schemas/_context_2' - type: object properties: bytes_per_op: description: 'Average operation size (read bytes+write bytes/read ops+write ops). ' type: number format: double minimum: 0 readOnly: true bytes_per_read: description: Average read size in bytes per read operation. type: number format: double minimum: 0 readOnly: true bytes_per_write: description: Average write size in bytes per write operation. type: number format: double minimum: 0 readOnly: true others_per_sec: description: Other operations processed per second. type: number format: double minimum: 0 readOnly: true read_bytes_per_sec: description: Bytes read per second. type: number format: double minimum: 0 readOnly: true reads_per_sec: description: Read requests processed per second. type: number format: double minimum: 0 readOnly: true time: description: Sample time in milliseconds since UNIX epoch. type: integer format: int64 readOnly: true usec_per_other_op: description: 'Average time, measured in microseconds, it takes the array to process other operations. ' type: number format: double minimum: 0 readOnly: true usec_per_read_op: description: 'Average time, measured in microseconds, it takes the array to process a read request. ' type: number format: double minimum: 0 readOnly: true usec_per_write_op: description: 'Average time, measured in microseconds, it takes the array to process a write request. ' type: number format: double minimum: 0 readOnly: true write_bytes_per_sec: description: Bytes written per second. type: number format: double minimum: 0 readOnly: true writes_per_sec: description: Write requests processed per second. type: number format: double minimum: 0 readOnly: true x-readOnly: true _builtIn_2: 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 _builtInNoId: type: object properties: name: description: Name of the object (e.g., a file system or snapshot). type: string readOnly: true StorageClassSpace: allOf: - $ref: '#/components/schemas/_fixedReferenceNameOnly' - type: object properties: capacity: description: Usable capacity in bytes. type: integer format: int64 example: 10995116277760 space: $ref: '#/components/schemas/_space_2' time: description: Sample time in milliseconds since UNIX epoch. type: integer format: int64 _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 ErrorNoContext: type: object properties: message: type: string example: Something was wrong TestResultResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/TestResult' Array: allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_context_2' - type: object properties: _as_of: description: Array time in milliseconds since UNIX epoch. type: integer format: int64 readOnly: true banner: description: 'A string to be shown when logging in to the array. ' type: string example: Restricted area. Authorized personnel only. default_inbound_tls_policy: description: 'The default TLS policy governing inbound traffic from clients accessing the array. This TLS policy will be applied for any IP addresses on the system that do not have a specific policy applied to them at a more granular level. ' title: ReferenceWritable allOf: - $ref: '#/components/schemas/_referenceWritable' encryption: readOnly: true title: ArrayEncryption allOf: - $ref: '#/components/schemas/_arrayEncryption' eradication_config: title: ArrayEradicationConfig allOf: - $ref: '#/components/schemas/_arrayEradicationConfig' idle_timeout: description: 'Idle timeout in milliseconds. Valid values are in the range of 300000 and 10800000. Setting this value to 0 disables timeouts. ' type: integer format: int32 example: 300000 network_access_policy: description: 'The network access policy governing which clients are allowed or denied access to different array interfaces. ' title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference_2' ntp_servers: type: array items: type: string example: time.acme.com os: description: 'Valid values are `Purity//FA` and `Purity//FB`. ' type: string readOnly: true example: Purity//FB product_type: description: 'For `FlashBlade//S` arrays, the value is determined by the blades in the system. The value will be `FlashBlade` for all older arrays. Valid values are `FlashBlade`, `FlashBlade//S`, `FlashBlade//S200`, and `FlashBladeS500`. ' type: string readOnly: true revision: type: string readOnly: true example: 2017.11.07_8f3ab6f5 security_update: description: 'The name of the installed security update that currently applies to the system. This field will be `null` if either no security update has been installed, or if the most recently installed security update is no longer needed by the current FlashBlade software due to the current software fully incorporating the update. ' type: string readOnly: true example: fb-2022-04-04 smb_mode: description: 'The current SMB mode of the array. This controls the type of authentication that is used by the array for SMB. Possible values include `ad-auto`, `ad-rfc2307`, `guest`, and `native`. Modifying this value requires the assistance of Pure Storage Support. ' type: string readOnly: true time_zone: description: 'The time zone to use for the array. In particular this affects the CLI formatting and the default snapshot policy time zone. ' type: string example: America/Los_Angeles version: type: string readOnly: true example: 2.1.0 _referenceWritable: allOf: - $ref: '#/components/schemas/_referenceWithoutType' - type: object properties: resource_type: description: 'Type of the object (full name of the endpoint). Valid values are `hosts`, `host-groups`, `network-interfaces`, `pods`, `ports`, `pod-replica-links`, `subnets`, `volumes`, `volume-snapshots`, `volume-groups`, `directories`, `policies/nfs`, `policies/smb`, `policies/snapshot`, etc. ' type: string x-aliases: - _reference ArrayFactoryResetTokenGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/ArrayFactoryResetTokenResponse' Cache: allOf: - $ref: '#/components/schemas/_builtIn' - description: The DIMM cache status. type: object readOnly: true properties: cache_type: description: The cache type. type: string example: DRAM space: $ref: '#/components/schemas/_cacheSpace' status: description: The cache status. type: string example: healthy Tag: allOf: - $ref: '#/components/schemas/_context' - type: object properties: copyable: description: 'Specifies whether or not to include the tag when copying the parent resource. If set to `true`, the tag is included in resource copying. If set to `false`, the tag is not included. If not specified, defaults to `true`. ' type: boolean example: true key: description: 'Key of the tag. Supports up to 64 Unicode characters. ' type: string example: environment namespace: description: 'Optional namespace of the tag. Namespace identifies the category of the tag. Omitting the namespace defaults to the namespace `default`. The `pure*` namespaces are reserved for plugins and integration partners. It is recommended that customers avoid using reserved namespaces. ' type: string example: default resource: $ref: '#/components/schemas/_fixedReference' value: description: 'Value of the tag. Supports up to 256 Unicode characters. ' type: string example: staging _performance_others: type: object properties: mirrored_others_per_sec: description: The number of mirrored other requests processed per second. type: integer format: int64 minimum: 0 readOnly: true others_per_sec: description: The number of other requests processed per second. type: integer format: int64 minimum: 0 readOnly: true usec_per_mirrored_other_op: description: 'The average time it takes the array to process a mirrored I/O other request, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true usec_per_other_op: description: 'The average time it takes the array to process an I/O other request, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true x-readOnly: true ArrayNfsSpecificPerformanceGet: allOf: - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/_errorContextResponse_2' - type: object properties: items: description: A list of NFS specific array performance metrics objects. type: array items: $ref: '#/components/schemas/ArrayNfsSpecificPerformance' RelationshipPerformanceReplication: allOf: - $ref: '#/components/schemas/_builtInRelationship' - $ref: '#/components/schemas/_context_2' - type: object properties: aggregate: description: 'Total bytes transmitted or received per second for all types of replication. ' title: Replication_performance allOf: - $ref: '#/components/schemas/_replication_performance' continuous: description: 'Object backlog information and total bytes transmitted or received per second for continuous replication. Continuous replication includes object replication. ' title: ContinuousReplicationPerformance allOf: - $ref: '#/components/schemas/_continuousReplicationPerformance' periodic: description: 'Total bytes transmitted or received per second for periodic replication. Periodic replication includes file system replication, which is snapshot based. ' title: Replication_performance allOf: - $ref: '#/components/schemas/_replication_performance' time: description: Sample time in milliseconds since UNIX epoch. type: integer format: int64 readOnly: true x-readOnly: true ArrayPerformanceGetResponse_2: allOf: - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/_errorContextResponse_2' - type: object properties: items: description: A list of array performance metrics objects. type: array items: $ref: '#/components/schemas/ArrayPerformance_2' _builtIn: 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). ' type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource. ' type: string readOnly: true name: description: 'A locally unique, system-generated name. The name cannot be modified. ' type: string readOnly: true NonCopyableTag: type: object properties: key: description: 'Key of the tag. Supports up to 64 Unicode characters. ' type: string example: environment namespace: description: 'Optional namespace of the tag. Namespace identifies the category of the tag. Omitting the namespace defaults to the namespace `default`. The `pure*` namespaces are reserved for plugins and integration partners. It is recommended that customers avoid using reserved namespaces. ' type: string example: default resource: $ref: '#/components/schemas/_fixedReference' value: description: 'Value of the tag. Supports up to 256 Unicode characters. ' type: string example: staging CloudConfigSupportedConfigsGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - type: object properties: items: type: array items: $ref: '#/components/schemas/CloudConfigSupported' ArrayPerformanceByLink: allOf: - $ref: '#/components/schemas/ArrayPerformance' - description: 'Array-level front-end I/O performance per link. A link represents a set of arrays that an I/O operation depends on. ' type: object properties: link: description: 'List of IDs and array names for the link ' type: array items: $ref: '#/components/schemas/_resource' CloudConfigAutomaticCapacityUpgradePatch: type: object properties: enabled: description: 'Indicates if the automatic capacity upgrade is enabled. ' type: boolean example: true max_capacity: description: 'The maximum capacity for the automatic upgrade in bytes. ' type: integer format: int64 example: 30786325577728 ArraySpaceGetResponse_2: allOf: - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/_errorContextResponse_2' - type: object properties: items: description: A list of array space metrics objects. type: array items: $ref: '#/components/schemas/ArraySpace_2' CloudProviderTagResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/CloudProviderTag' _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 _arrayEradicationConfig: type: object properties: eradication_delay: description: 'The file eradication delay is in milliseconds. Automatically eradicate destroyed filesystems and snapshots after the delay time. Valid values are `86400000` and any multiple of `86400000` in the range of `86400000` and `2592000000`. Any other values will be rounded down to the nearest multiple of `86400000`. ' type: integer format: int64 readOnly: true example: 86400000 manual_eradication: description: 'Manual eradication status is applied on the array level. If status is all-disabled, you cannot eradicate buckets and file systems. If status is file-disabled then you can not eradicate files systems. If status is object-disabled then you can not eradicate buckets. If status is all-enabled then you can eradicate file systems and buckets. Values include `all-enabled`, `file-disabled`, `object-disabled`, and `all-disabled`. ' type: string readOnly: true ArrayS3SpecificPerformance: allOf: - $ref: '#/components/schemas/_builtIn_2' - $ref: '#/components/schemas/_context_2' - type: object properties: others_per_sec: description: Other operations processed per second. type: number format: double minimum: 0 read_buckets_per_sec: description: Read buckets requests processed per second. type: number format: double minimum: 0 read_objects_per_sec: description: Read object requests processed per second. type: number format: double minimum: 0 time: description: Sample time in milliseconds since UNIX epoch. type: integer format: int64 usec_per_other_op: description: 'Average time, measured in microseconds, it takes the array to process other operations. ' type: number format: double minimum: 0 usec_per_read_bucket_op: description: 'Average time, measured in microseconds, it takes the array to process a read bucket request. ' type: number format: double minimum: 0 usec_per_read_object_op: description: 'Average time, measured in microseconds, it takes the array to process a read object request. ' type: number format: double minimum: 0 usec_per_write_bucket_op: description: 'Average time, measured in microseconds, it takes the array to process a write bucket request. ' type: number format: double minimum: 0 usec_per_write_object_op: description: 'Average time, measured in microseconds, it takes the array to process a write object request. ' type: number format: double minimum: 0 write_buckets_per_sec: description: Write buckets requests processed per second. type: number format: double minimum: 0 write_objects_per_sec: description: Write object requests processed per second. type: number format: double minimum: 0 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 _space: type: object properties: data_reduction: description: 'The ratio of mapped sectors within a volume versus the amount of physical space the data occupies after data compression and deduplication. The data reduction ratio does not include thin provisioning savings. For example, a data reduction ratio of 5:1 means that for every 5 MB the host writes to the array, 1 MB is stored on the array''s flash modules. ' type: number format: float readOnly: true footprint: description: 'The maximum amount of physical space the container consumes on an array, ignoring any data shared outside the container, measured in bytes. On Evergreen//One arrays, this is the maximum amount of effective used space. The footprint metric is mostly used for capacity planning. This field will be null in non-container contexts. ' type: integer format: int64 minimum: 0 readOnly: true shared: description: 'The physical space occupied by deduplicated data, meaning that the space is shared with other volumes and snapshots as a result of data deduplication. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by data that is not unique to a specific volume, managed directory, or snapshot, measured in bytes. ' type: integer format: int64 minimum: 0 readOnly: true example: 111863360624 snapshots: description: 'The physical space occupied by data unique to one or more snapshots. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by data unique to one or more snapshots, measured in bytes. ' type: integer format: int64 minimum: 0 readOnly: true system: description: 'The physical space occupied by internal array metadata. Measured in bytes. ' type: integer format: int64 minimum: 0 readOnly: true thin_provisioning: description: 'The percentage of volume sectors that do not contain host-written data because the hosts have not written data to them or the sectors have been explicitly trimmed. ' type: number format: float minimum: 0 maximum: 1 readOnly: true total_physical: description: 'This field has been deprecated. Use the `total_used` field, as it contains the same information. ' type: integer format: int64 minimum: 0 readOnly: true total_provisioned: description: 'The provisioned size of a volume for a single volume, host or host group, protocol endpoint, managed directory, and containers can be infinite or measured in bytes. Infinite is represented by `null`. The provisioned size for a host or host group, includes all volumes that are connected to the resource. The provisioned size for a protocol endpoint is `null`. The provisioned size for a managed directory is the quota limit if it or its parent has a managed directory configured, otherwise it defaults to `null`. The provisioned size for a container is the sum of the total_provisioned of the object it contains, capped by the container''s quota limit (or the container''s used_provisioned if current usage is above the quota limit), if any. Provisioned size represents the storage capacity reported to hosts. ' type: integer format: int64 minimum: 0 readOnly: true example: 19937690345472 total_reduction: description: 'The ratio of provisioned sectors within a volume versus the amount of physical space the data occupies after reduction via data compression and deduplication and with thin provisioning savings. Total reduction is data reduction with thin provisioning savings. For example, a total reduction ratio of 10:1 means that for every 10 MB of provisioned space, 1 MB is stored on the array''s flash modules. ' type: number format: float readOnly: true total_used: description: 'The total space contributed by customer data, measured in bytes. ' type: integer format: int64 minimum: 0 readOnly: true unique: description: 'The unique physical space occupied by customer data. Unique physical space does not include shared space, snapshots, and internal array metadata. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by unique customer data, measured in bytes. Unique data does not include shared space, snapshots, and internal array metadata. ' type: integer format: int64 minimum: 0 readOnly: true used_provisioned: description: 'The amount of logical space a container has consumed, compared against the quota limit if the container has one configured. Used provisioned does not include destroyed objects inside the container. Used provisioned can include destroyed objects for a destroyed container and represents how much logical space it would take to recover the container. ' type: integer format: int64 minimum: 0 readOnly: true example: 19937690345472 virtual: description: 'The amount of logically written data that a volume or a snapshot references. Measured in bytes. ' type: integer format: int64 minimum: 0 readOnly: true _referenceWithoutType: type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified. ' type: string name: description: 'The resource name, such as volume name, pod name, snapshot name, and so on. ' type: string ArrayErasureGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/ArrayErasureResponse' Eula: type: object properties: agreement: description: The End User Agreement text. type: string readOnly: true signature: $ref: '#/components/schemas/_eula_signature' EulaResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Eula' _continuousReplicationPerformance: allOf: - $ref: '#/components/schemas/_replication_performance' - type: object properties: object_backlog: description: 'The total number of pending object operations and their size that are currently in the backlog. ' title: ObjectBacklog allOf: - $ref: '#/components/schemas/_objectBacklog' x-readOnly: true ArrayNfsSpecificPerformance: allOf: - $ref: '#/components/schemas/_builtIn_2' - $ref: '#/components/schemas/_context_2' - type: object properties: accesses_per_sec: description: ACCESS requests processed per second. type: number format: double minimum: 0 aggregate_file_metadata_creates_per_sec: description: 'Sum of file-level or directory-level create-like metadata requests per second. Includes CREATE, LINK, MKDIR, and SYMLINK. ' type: number format: double minimum: 0 aggregate_file_metadata_modifies_per_sec: description: 'Sum of file-level or directory-level modify-like and delete-like metadata requests per second. Includes REMOVE, RENAME, RMDIR, and SETATTR. ' type: number format: double minimum: 0 aggregate_file_metadata_reads_per_sec: description: 'Sum of file-level or directory-level read-like metadata requests per second. Includes GETATTR, LOOKUP, PATHCONF, READDIR, READDIRPLUS, and READLINK. ' type: number format: double minimum: 0 aggregate_other_per_sec: description: 'Sum of all other requests processed per second. This includes COMMIT, MKNOD, NULL, NLM operations, and operations which are supported for NFSv4.1 but not NFSv3. ' type: number format: double minimum: 0 aggregate_share_metadata_reads_per_sec: description: 'Sum of share-level read-like metadata requests per second. Includes ACCESS, FSINFO, and FSSTAT. ' type: number format: double minimum: 0 aggregate_usec_per_file_metadata_create_op: description: 'Average time, measured in microseconds, it takes the array to process a file-level or directory-level create-like metadata request. Includes CREATE, LINK, MKDIR, and SYMLINK. ' type: number format: double minimum: 0 aggregate_usec_per_file_metadata_modify_op: description: 'Average time, measured in microseconds, it takes the array to process a file-level or directory-level modify-like or delete-like metadata request. Includes REMOVE, RENAME, RMDIR, and SETATTR. ' type: number format: double minimum: 0 aggregate_usec_per_file_metadata_read_op: description: 'Average time, measured in microseconds, it takes the array to process a file-level or directory-level read-like metadata request. Includes GETATTR, LOOKUP, PATHCONF, READDIR, READDIRPLUS, and READLINK. ' type: number format: double minimum: 0 aggregate_usec_per_other_op: description: 'Average time, measured in microseconds, it takes the array to process all other requests. This includes COMMIT, MKNOD, NULL, NLM operations, and operations which are supported for NFSv4.1 but not NFSv3. ' type: number format: double minimum: 0 aggregate_usec_per_share_metadata_read_op: description: 'Average time, measured in microseconds, it takes the array to process a share-level read-like metadata request. Includes ACCESS, FSINFO, and FSSTAT. ' type: number format: double minimum: 0 creates_per_sec: description: CREATE requests processed per second. type: number format: double minimum: 0 fsinfos_per_sec: description: FSINFO requests processed per second. type: number format: double minimum: 0 fsstats_per_sec: description: FSSTAT requests processed per second. type: number format: double minimum: 0 getattrs_per_sec: description: GETATTR requests processed per second. type: number format: double minimum: 0 links_per_sec: description: LINK requests processed per second. type: number format: double minimum: 0 lookups_per_sec: description: LOOKUP requests processed per second. type: number format: double minimum: 0 mkdirs_per_sec: description: MKDIR requests processed per second. type: number format: double minimum: 0 pathconfs_per_sec: description: PATHCONF requests processed per second. type: number format: double minimum: 0 readdirpluses_per_sec: description: READDIRPLUS requests processed per second. type: number format: double minimum: 0 readdirs_per_sec: description: READDIR requests processed per second. type: number format: double minimum: 0 readlinks_per_sec: description: READLINK requests processed per second. type: number format: double minimum: 0 reads_per_sec: description: READ requests processed per second. type: number format: double minimum: 0 removes_per_sec: description: REMOVE requests processed per second. type: number format: double minimum: 0 renames_per_sec: description: RENAME requests processed per second. type: number format: double minimum: 0 rmdirs_per_sec: description: RMDIR requests processed per second. type: number format: double minimum: 0 setattrs_per_sec: description: SETATTR requests processed per second. type: number format: double minimum: 0 symlinks_per_sec: description: SYMLINK requests processed per second. type: number format: double minimum: 0 time: description: Sample time in milliseconds since UNIX epoch. type: integer format: int64 usec_per_access_op: description: 'Average time, measured in microseconds, it takes the array to process an ACCESS request. ' type: number format: double minimum: 0 usec_per_create_op: description: 'Average time, measured in microseconds, it takes the array to process a CREATE request. ' type: number format: double minimum: 0 usec_per_fsinfo_op: description: 'Average time, measured in microseconds, it takes the array to process an FSINFO request. ' type: number format: double minimum: 0 usec_per_fsstat_op: description: 'Average time, measured in microseconds, it takes the array to process an FSSTAT request. ' type: number format: double minimum: 0 usec_per_getattr_op: description: 'Average time, measured in microseconds, it takes the array to process a GETATTR request. ' type: number format: double minimum: 0 usec_per_link_op: description: 'Average time, measured in microseconds, it takes the array to process a LINK request. ' type: number format: double minimum: 0 usec_per_lookup_op: description: 'Average time, measured in microseconds, it takes the array to process a LOOKUP request. ' type: number format: double minimum: 0 usec_per_mkdir_op: description: 'Average time, measured in microseconds, it takes the array to process a MKDIR request. ' type: number format: double minimum: 0 usec_per_pathconf_op: description: 'Average time, measured in microseconds, it takes the array to process a PATHCONF request. ' type: number format: double minimum: 0 usec_per_read_op: description: 'Average time, measured in microseconds, it takes the array to process a READ request. ' type: number format: double minimum: 0 usec_per_readdir_op: description: 'Average time, measured in microseconds, it takes the array to process a READDIR request. ' type: number format: double minimum: 0 usec_per_readdirplus_op: description: 'Average time, measured in microseconds, it takes the array to process a READDIRPLUS request. ' type: number format: double minimum: 0 usec_per_readlink_op: description: 'Average time, measured in microseconds, it takes the array to process a READLINK request. ' type: number format: double minimum: 0 usec_per_remove_op: description: 'Average time, measured in microseconds, it takes the array to process a REMOVE request. ' type: number format: double minimum: 0 usec_per_rename_op: description: 'Average time, measured in microseconds, it takes the array to process a RENAME request. ' type: number format: double minimum: 0 usec_per_rmdir_op: description: 'Average time, measured in microseconds, it takes the array to process an RMDIR request. ' type: number format: double minimum: 0 usec_per_setattr_op: description: 'Average time, measured in microseconds, it takes the array to process a SETATTR request. ' type: number format: double minimum: 0 usec_per_symlink_op: description: 'Average time, measured in microseconds, it takes the array to process a SYMLINK request. ' type: number format: double minimum: 0 usec_per_write_op: description: 'Average time, measured in microseconds, it takes the array to process a WRITE request. ' type: number format: double minimum: 0 writes_per_sec: description: WRITE requests processed per second. type: number format: double minimum: 0 _errorErrors: type: object properties: context: type: string example: Error with ... message: type: string example: Something was wrong Eradication_config: description: The configuration of eradication feature. type: object properties: disabled_delay: description: 'The eradication delay in milliseconds for destroyed objects that cannot be manually eradicated. Destroyed objects that cannot be manually eradicated will be automatically eradicated after the configured delay time passes. Valid values are `86400000` and any multiple of `86400000` in the range of `86400000` and `2592000000`. Any other values are rounded down to the nearest multiple of `86400000`. ' type: integer format: int64 example: 86400000 enabled_delay: description: 'The eradication delay in milliseconds for destroyed objects that can be manually eradicated. Destroyed objects that can be manually eradicated will be automatically eradicated after the configured delay time passes. Valid values are `86400000` and any multiple of `86400000` in the range of `86400000` and `2592000000`. Any other values are rounded down to the nearest multiple of `86400000`. ' type: integer format: int64 example: 86400000 eradication_delay: description: 'Eradication delay in milliseconds for all destroyed objects. Automatically eradicate destroyed objects after the configured delay time passes. Updating this field will update both `eradication_disabled_delay` and `eradication_enabled_delay` if both `eradication_disabled_delay` and `eradication_enabled_delay` have the same value. If `eradication_disabled_delay` and `eradication_enabled_delay` have different values, trying to configure `eradication_delay` will result in an error. This field has been deprecated and will be removed in a future REST version. Valid values are `86400000` and any multiple of `86400000` in the range of `86400000` and `2592000000`. Any other values are rounded down to the nearest multiple of `86400000`. ' type: integer format: int64 example: 86400000 manual_eradication: description: 'Manual eradication status applied on the array level. If status is `all-disabled`, you cannot eradicate objects, files, and directories. If at least one local object has `manual_eradication` disabled, then the status will be `partially-disabled`. Values include `all-disabled`, `partially-disabled`, and `all-enabled`. If the user does not have sufficient access, this field will return `null`. ' type: string readOnly: true example: all-disabled _resource: description: 'An ordinary (as opposed to built-in) resource that can be created, named, renamed or deleted by the user. This might be a virtual resource (e.g., a file system), or correspond to something in the environment, like a host or a server. ' type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource. ' type: string readOnly: true name: description: 'A user-specified name. The name must be locally unique and can be changed. ' type: string TagResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Tag' CloudConfigPatchResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/CloudConfig' ArraySpaceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: type: array items: $ref: '#/components/schemas/ArraySpace' TestResultGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/TestResultResponse' ArrayHttpSpecificPerformance: allOf: - $ref: '#/components/schemas/_builtIn_2' - $ref: '#/components/schemas/_context_2' - type: object properties: others_per_sec: description: Other operations processed per second. type: number format: double minimum: 0 read_dirs_per_sec: description: Read directory requests processed per second. type: number format: double minimum: 0 read_files_per_sec: description: Read file requests processed per second. type: number format: double minimum: 0 time: description: Sample time in milliseconds since UNIX epoch. type: integer format: int64 usec_per_other_op: description: 'Average time, measured in microseconds, it takes the array to process other operations. ' type: number format: double minimum: 0 usec_per_read_dir_op: description: 'Average time, measured in microseconds, it takes the array to process a read directory request. ' type: number format: double minimum: 0 usec_per_read_file_op: description: 'Average time, measured in microseconds, it takes the array to process a read file request. ' type: number format: double minimum: 0 usec_per_write_dir_op: description: 'Average time, measured in microseconds, it takes the array to process a write directory request. ' type: number format: double minimum: 0 usec_per_write_file_op: description: 'Average time, measured in microseconds, it takes the array to process a write file request. ' type: number format: double minimum: 0 write_dirs_per_sec: description: Write directory requests processed per second. type: number format: double minimum: 0 write_files_per_sec: description: Write file requests processed per second. type: number format: double minimum: 0 _timeZone: allOf: - $ref: '#/components/schemas/_builtInNoId' CloudConfigModel: type: object properties: current: description: The current model of the CBS array. type: string example: CBS-V10MP2R2 details: description: 'Details about the hardware upgrade. This field can contain error details or progress information when the status is `upgrading`. The default value is an empty string. ' type: string example: '' override_checks: description: A list of upgrade checks to be overridden. type: array items: type: string example: - HostIOCheck - HostPathsCheck requested: description: A requested model of the CBS array. type: string example: CBS-V20MP2R2 status: description: 'The status of the hardware upgrade process. Can be one of `idle`, `paused`, `upgrading`. ' type: string example: upgrading step: description: 'The current step of the hardware upgrade process. Can be `pre-upgrade-check`, `upgrade-ct0`, `failover` and so on. The default value is an empty string. ' type: string example: mid-upgrade-check CloudCapacityPatchResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/CloudCapacityStatus' ArrayS3SpecificPerformanceGetResp: allOf: - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/_errorContextResponse_2' - type: object properties: items: description: A list of S3 specific array performance metrics objects. type: array items: $ref: '#/components/schemas/ArrayS3SpecificPerformance' SupportContract: type: object properties: end_date: description: 'Date when the support contract ended. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch. ' type: integer format: int64 example: 1582502400000 resource: $ref: '#/components/schemas/_fixedReferenceFqdn' start_date: description: 'Date when the support contract started. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch. ' type: integer format: int64 example: 1550966400000 TagPut: type: object properties: key: description: Key of the tag. type: string example: example_key value: description: Value of the tag. type: string example: value123 CloudProviderTagGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/CloudProviderTagResponse' _fixedReferenceFqdn: allOf: - $ref: '#/components/schemas/_fixedReference_3' - type: object properties: 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 ArrayGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/ArrayResponse' - $ref: '#/components/schemas/_errorContextResponse' CloudConfigModelPatch: type: object properties: add_override_checks: description: 'A list of upgrade checks to be overridden. ' type: array items: type: string example: - HostIOCheck - HostPathsCheck requested: description: 'A supported model for the CBS array. ' type: string example: CBS-V20MP2R2 ArrayFactoryResetToken: allOf: - $ref: '#/components/schemas/_resource' - description: 'A token that is required to perform a factory reset of the array. A factory reset of the array permanently eradicates all data and deletes all configurations, restoring the state of the array to the original manufacturer settings. ' type: object properties: token: description: 'A random number required as input to perform a factory reset of the array. ' type: integer format: int64 readOnly: true example: 4671919 _objectBacklog: type: object properties: bytes_count: description: 'The size of the objects in bytes that need to be replicated. This does not include the size of custom metadata. ' type: integer format: int64 readOnly: true delete_ops_count: description: 'The number of DELETE operations that need to be replicated. ' type: integer format: int64 readOnly: true other_ops_count: description: 'The number of other operations that need to be replicated. ' type: integer format: int64 readOnly: true put_ops_count: description: 'The number of PUT operations that need to be replicated. ' type: integer format: int64 readOnly: true _fixedReference_2: 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 ArrayGetResponse_2: allOf: - $ref: '#/components/schemas/PageInfo_3' - $ref: '#/components/schemas/ArrayResponse_3' CloudConfigGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - type: object properties: items: type: array items: $ref: '#/components/schemas/CloudConfig' _arrayencryptionDataAtRest: description: 'Data at rest encryption properties. ' type: object properties: algorithm: description: 'The algorithm used to encrypt data on the array. Values include `AES-256-CTR` and `null`. ' type: string example: AES-256-CTR enabled: description: 'Returns a value of `true` if data at rest encryption is enabled on the array. ' type: boolean ArrayErasurePatch: type: object properties: image_source: description: 'Source of the ISO image to download. Valid values include `auto` and URLs. `auto` means download the image from Pure1 cloud, and a URL means download the image from the specified URL. Default value is `auto`. ' type: string example: auto image_version: description: 'Version of the image to download. `image_version` is optional, and the default value is the current running Purity version. If `image_source` is `auto`, the image with the specified version will be downloaded from Pure1 cloud. If `image_source` is a URL, `image_version` will be used to compare to the downloaded image version for the purpose of validation. ' type: string example: 6.6.6 _arrayEncryption: type: object properties: data_at_rest: title: ArrayEncryptionDataAtRest allOf: - $ref: '#/components/schemas/_arrayEncryptionDataAtRest' x-readOnly: true ArrayResponse_3: type: object properties: items: type: array items: $ref: '#/components/schemas/Array_2' CloudConfigAutomaticCapacityUpgrade: type: object properties: details: description: 'This field displays error details, warnings, and progress information. The default value is an empty string. ' type: string example: Automatic capacity upgrade will be triggered once the array is full enabled: description: 'Indicates if the automatic capacity upgrade is enabled. ' type: boolean example: true max_capacity: description: 'The maximum capacity for the automatic upgrade in bytes. ' type: integer format: int64 example: 30786325577728 _builtInRelationship: type: object properties: id: description: 'A non-modifiable, globally unique ID chosen by the system. ' type: string readOnly: true EulaGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/EulaResponse' ArrayErasure: allOf: - $ref: '#/components/schemas/_resource' - description: 'Status and detailed information of the factory reset process. ' type: object properties: details: description: 'The detailed reason of the `status`. ' type: string image_download_progress: description: 'The progress of the ISO image download, displayed in decimal format. ' type: number format: float example: 0.32 image_source: description: 'Source of the ISO image to download. Valid values include `auto` and URLs. `auto` means download the image from Pure1 cloud, and a URL means download the image from the specified URL. ' type: string example: auto image_version: description: 'Version of the image to download and install. ' type: string example: 6.6.6 sanitization_certificate: description: 'The sanitization certificate of the factory reset, which complies with the standard described in NIST SP800-88R1 section 4.8. ' type: string status: description: 'The status of the factory reset process. Valid values include `resetting`, `reset_failed`, `reimage_failed`, `waiting_for_finalize`, `downloading`, `downloaded`, and `download_failed`. A status of `resetting` indicates that the factory reset is running. A status of `reset_failed` indicates that the factory reset encountered a failure. A status of `reimage_failed` indicates that the factory reset failed to reimage the array. A status of `waiting_for_finalize` indicates that the factory reset has finished sanitizing drives, and is waiting to be finalized. A status of `downloading` indicates that the factory reset is downloading ISO image. A status of `downloaded` indicates that the factory reset completed ISO image download. A status of `download_failed` indicates that the factory reset failed to download ISO image. ' type: string example: resetting 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 CloudCapacityStepsGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - type: object properties: items: type: array items: $ref: '#/components/schemas/CloudCapacityStep' TagGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/TagResponse' - $ref: '#/components/schemas/_errorContextResponse' CloudCapacityGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/CloudCapacityPatchResponse' _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' Array_2: allOf: - $ref: '#/components/schemas/_builtInAsOf' - description: 'A FlashArray or FlashBlade storage appliance. ' type: object properties: fqdn: description: The fully qualified domain name of the array. type: string readOnly: true example: https://array01.dc1.example.com model: description: Model of the array. type: string readOnly: true example: FA-m70r2 os: description: 'Valid values are `Elasticity`, `Purity`, `Purity//FA` and `Purity//FB`. ' type: string readOnly: true example: Purity//FA version: type: string readOnly: true example: 5.0.0 _fixedReferenceNameOnly: type: object properties: name: type: string readOnly: true x-readOnly: true ArrayPerformance: allOf: - $ref: '#/components/schemas/_performance' - $ref: '#/components/schemas/_performance_others' - $ref: '#/components/schemas/_builtIn' - type: object properties: local_queue_usec_per_op: description: 'Deprecated. The number displayed here may not be accurate and in later versions of the product this field will always display `null`. Instead, use `queue_usec_per_mirrored_write_op`, `queue_usec_per_read_op`, and `queue_usec_per_write_op` fields to measure IO queuing. ' type: integer format: int64 minimum: 0 readOnly: true queue_depth: description: 'Deprecated. The number displayed here may not be accurate and in later versions of the product this field will always display `null`. Instead, use `queue_usec_per_mirrored_write_op`, `queue_usec_per_read_op`, and `queue_usec_per_write_op` fields to measure IO queuing. ' type: integer format: int64 minimum: 0 readOnly: true x-readOnly: true _arrayEncryptionDataAtRest: description: Data at Rest Encryption properties. type: object properties: algorithms: description: The algorithms used to encrypt data at rest on the array. type: array readOnly: true items: type: string example: - AES-256-GCM enabled: description: Returns a value of `true` if Data at Rest Encryption is enabled. type: boolean readOnly: true entropy_source: description: 'The entropy source used to generate the Data at Rest Encryption key on the array. ' type: string readOnly: true example: rdseed x-readOnly: true Error: type: object properties: errors: description: The list of errors encountered. type: array items: $ref: '#/components/schemas/_errorErrors' 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 _reference: type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified. ' type: string name: description: 'The resource name, such as volume name, pod name, snapshot name, and so on. ' type: string x-aliases: - _referenceWithoutType ArrayFactoryResetTokenResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/ArrayFactoryResetToken' ArrayResponse_2: type: object properties: items: description: A list of array objects. type: array items: $ref: '#/components/schemas/Array' _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: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' message: description: A description of the error which occurred. type: string example: Resource does not exist. x-aliases: - _errorContextResponseErrors _errorContextResponse_2: 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' ArrayPerformanceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - type: object properties: items: type: array items: $ref: '#/components/schemas/ArrayPerformance' ArrayHttpSpecificPerformanceGet: allOf: - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/_errorContextResponse_2' - type: object properties: items: description: A list of http specific array performance metrics objects. type: array items: $ref: '#/components/schemas/ArrayHttpSpecificPerformance' ArraySpaceStorageClassGetResponse: allOf: - $ref: '#/components/schemas/PageInfo_2' - type: object properties: items: description: A list of array space metrics objects for each storage class. type: array items: $ref: '#/components/schemas/StorageClassSpace' total: description: 'Total of all records after filtering. If `total_only` query param is `true`, then no items will be returned. ' type: array items: $ref: '#/components/schemas/StorageClassSpace' CloudCapacityStep: type: object properties: supported_capacity: description: 'A possible supported raw capacity of the CBS array in bytes. ' type: integer format: int64 example: 10995116277760 ArraySpace_2: allOf: - $ref: '#/components/schemas/_builtIn_2' - $ref: '#/components/schemas/_context_2' - type: object properties: capacity: description: Usable capacity in bytes. type: integer format: int64 example: 10995116277760 parity: description: 'A representation of data redundancy on the array. Data redundancy is rebuilt automatically by the system whenever parity is less than 1.0. ' type: number format: float example: 0.99 space: $ref: '#/components/schemas/_space_2' time: description: Sample time in milliseconds since UNIX epoch. type: integer format: int64 _space_2: type: object properties: available_provisioned: description: 'The amount of space left that the current object can grow before writes are stopped due to a hard limit quota being hit. This is total_provisioned minus the virtual space used for file-systems and buckets. For array and object store accounts it is total_provisioned minus the virtual space used by non-destroyed file-systems and buckets. ' type: integer format: int64 minimum: 0 example: 19937690345472 available_ratio: description: 'The ratio of the available space versus the total provisioned space. ' type: number format: float minimum: 0 maximum: 1 data_reduction: description: Reduction of data. type: number format: float readOnly: true destroyed: description: 'Unique physical space (excluding snapshots) occupied by destroyed data within the child containers, in bytes. For buckets and filesystems, the destroyed space will be 0 as they cannot have child containers. For the whole array, the space will be the sum of all destroyed buckets and filesystems. ' type: integer format: int64 readOnly: true destroyed_virtual: description: 'The amount of destroyed logically written data within the child containers, in bytes. For buckets and filesystems, the destroyed virtual space will be 0 as they cannot have child containers. For the whole array, the space will be the sum of all destroyed buckets and filesystems. ' type: integer format: int64 readOnly: true shared: description: 'The space contributed by data that is not unique to a managed directory, or snapshot, measured in bytes. ' type: integer format: int64 readOnly: true snapshots: description: Physical usage by snapshots, other than unique in bytes. type: integer format: int64 readOnly: true total_physical: description: 'Deprecated. See total_used for the newer functionality. The total physical space consumed by the file system, measured in bytes. ' type: integer format: int64 minimum: 0 readOnly: true total_provisioned: description: 'The effective provisioned size of the container, at which a hard limit will be applied. For a bucket with a `quota_limit` value and `hard_limit_enabled` set to `true`, this is its `quota_limit` value, unless the available space of the associated object store account, as defined by its `quota_limit` value, would prevent the bucket from reaching its own `quota_limit` value. In such a case, `total_provisioned` will reflect the smaller value. For a file system with a `provisioned` value and `hard_limit_enabled` set to `true`, this is the `provisioned` value of the file system. For an object store account with a `quota_limit` value and `hard_limit_enabled` set to `true`, this is the `quota_limit` value of the object store account. For the array, this is the sum of the file systems and accounts. Measured in bytes. ' type: integer format: int64 minimum: 0 example: 19937690345472 total_used: description: 'The total space consumed by customer data, measured in bytes. ' type: integer format: int64 minimum: 0 readOnly: true unique: description: 'Unique physical space occupied by customer data, in bytes. Excludes snapshots, destroyed. ' type: integer format: int64 readOnly: true virtual: description: 'The amount of logically written data, in bytes. Excludes destroyed data. ' type: integer format: int64 readOnly: true example: 19937690345472 TagBatchRequired: description: 'A list of tags to be upserted. ' type: array items: $ref: '#/components/schemas/TagPut' x-codegen-request-body-name: tag SupportContractResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/SupportContract' _fixedReferenceWithType: allOf: - $ref: '#/components/schemas/_fixedReference' - 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 x-aliases: - _fixedReference CloudCapacityStatus: allOf: - $ref: '#/components/schemas/_builtIn' - type: object properties: current_capacity: description: 'The current raw capacity of the CBS array in bytes. ' type: integer format: int64 readOnly: true example: 10995116277760 details: description: 'Details about the capacity update. This field can contain error details when status is `failed` or progress information when status is `expanding`. For status `idle` the value is null. ' type: string readOnly: true requested_capacity: description: 'The requested raw capacity of the CBS array in bytes. When the capacity update process finishes, it should be the same as `current_capacity`. ' type: integer format: int64 example: 10995116277760 status: description: 'The status of the capacity update process. Can be one of `idle`, `failed`, `expanding`. ' type: string readOnly: true example: idle SupportContractGetResponse: allOf: - $ref: '#/components/schemas/PageInfo_3' - $ref: '#/components/schemas/SupportContractResponse' CloudConfigSupported: type: object properties: supported_models: description: List of supported models for an upgrade. type: array items: type: string description: A supported model for the CBS array. example: CBS-V20MP2R2 Space: description: If the user does not have sufficient access, all fields will return `null`. allOf: - $ref: '#/components/schemas/_space' - type: object properties: replication: description: 'The sum of replication space consumed by all pods on this array. ' type: integer format: int64 minimum: 0 readOnly: true shared_effective: description: 'This field has been deprecated. It will return `null`. Use the `shared` field in the future, as it contains the same information for Evergreen//One arrays. ' type: integer format: int64 minimum: 0 readOnly: true snapshots_effective: description: 'This field has deprecated. It will return `null`. Use the `snapshots` field in the future, as it contains the same information for Evergreen//One arrays. ' type: integer format: int64 minimum: 0 readOnly: true total_effective: description: 'This field has been deprecated. It will return `null`. PUse the `total_physical` field instead, as it contains the same information for Evergreen//One arrays. ' type: integer format: int64 minimum: 0 readOnly: true unique_effective: description: 'This field has been deprecated. It will return `null`. Use the `unique` field in the future, as it contains the same information for Evergreen//One arrays. ' type: integer format: int64 minimum: 0 readOnly: true CacheGetResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Cache' description: Displays DIMM Cache status. TagGetResponse_2: allOf: - $ref: '#/components/schemas/PageInfo_3' - $ref: '#/components/schemas/TagResponse' _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: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' _context_2: 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_2' CloudProviderTag: type: object properties: details: description: 'Details about the status of the tag if not healthy. ' type: string readOnly: true example: partially applied key: description: 'Key of the tag. Supports UTF-8 Unicode characters. Please refer to the offical document from cloud providers for limitations. ' type: string example: environment value: description: 'Value of the tag. Supports UTF-8 Unicode characters. Please refer to the offical document from cloud providers for limitations. ' type: string example: staging Arrays: allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_context' - type: object properties: _as_of: description: 'The time in milliseconds since UNIX epoch. ' type: integer format: int64 readOnly: true example: 1684403432765 banner: type: string example: Restricted area. Authorized personnel only. capacity: description: 'The usable capacity in bytes. If the user does not have sufficient access, this field will return `null`. ' type: integer format: int64 readOnly: true example: 10995116277760 console_lock_enabled: description: 'If `true`, console lock is enabled for the array. If the user does not have sufficient access, this field will return `null`. ' type: boolean example: false encryption: title: ArrayEncryption allOf: - $ref: '#/components/schemas/ArrayEncryption' eradication_config: $ref: '#/components/schemas/Eradication_config' idle_timeout: description: 'The idle timeout in milliseconds. Valid values include `0` and any multiple of `60000` in the range of `300000` and `10800000`. Any other values are rounded down to the nearest multiple of `60000`. ' type: integer format: int32 example: 300000 network_access_policy: description: 'The network access policy for the array. ' title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' ntp_servers: description: 'NTP Servers. If the user does not have sufficient access, this field will return `null`. ' type: array items: type: string example: time.acme.com ntp_symmetric_key: description: 'The text of ntp symmetric authentication key. Supported formats include a hex-encoded string no longer than 64 characters, or an ASCII string no longer than 20 characters, excluding "#". Any configured key will be masked as "****" on return. If the user does not have sufficient access, this field will return `null`. ' type: string os: description: 'Specifies the operating system. Valid values are `Purity`, `Purity//FA`, and `Purity//FB`. ' type: string readOnly: true example: Purity//FA parity: description: 'A representation of data redundancy on the array. Data redundancy is rebuilt automatically by the system whenever parity is less than `1.0`. If the user does not have sufficient access, this field will return `null`. ' type: number format: float readOnly: true example: 0.99 scsi_timeout: description: 'The SCSI timeout. If not specified, defaults to `60s`. If the user does not have sufficient access, this field will return `null`. ' type: integer format: int32 example: 60000 space: title: Space allOf: - $ref: '#/components/schemas/Space' time_zone: description: 'The time zone of the array. ' type: string readOnly: true example: America/Los_Angeles version: type: string readOnly: true example: 5.0.0 ArrayPerformanceByLinkGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/ArrayPerformanceByLinkResponse' CloudConfigPatch: type: object properties: automatic_capacity_upgrade: description: The requested configuration of the automatic capacity upgrade. title: CloudConfigAutomaticCapacityUpgradePatch allOf: - $ref: '#/components/schemas/CloudConfigAutomaticCapacityUpgradePatch' model: description: The requested model configuration of the CBS array. title: CloudConfigModelPatch allOf: - $ref: '#/components/schemas/CloudConfigModelPatch' 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 ArrayPerformanceByLinkResponse: type: object properties: items: description: 'Array-level front-end I/O performance metrics grouped by link. A link represents a set of arrays that an I/O operation depends on. ' type: array items: $ref: '#/components/schemas/ArrayPerformanceByLink' _fixedReference_3: 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 _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_2' message: description: A description of the error which occurred. type: string example: Resource does not exist. _cacheSpace: type: object properties: total_available_cache_size: description: The DRAM cache available on the primary controller, measured in bytes. type: integer format: int64 example: 3298534883328 total_installed_cache_size: description: The DRAM cache installed on both controllers, measured in bytes. type: integer format: int64 example: 6597069766656 _replication_performance: type: object properties: received_bytes_per_sec: description: Total bytes received per second. type: number format: double minimum: 0 readOnly: true transmitted_bytes_per_sec: description: Total bytes transmitted per second. type: number format: double minimum: 0 readOnly: true x-readOnly: true ArrayErasureResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/ArrayErasure' CloudConfig: type: object properties: automatic_capacity_upgrade: description: 'Automatic capacity upgrade configuration of the CBS array. ' title: CloudConfigAutomaticCapacityUpgrade allOf: - $ref: '#/components/schemas/CloudConfigAutomaticCapacityUpgrade' id: description: 'A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource. ' type: string example: 0f58952a-35e4-7457-b1dd-23454257a1f1 model: description: The model configuration of the CBS array. title: CloudConfigModel allOf: - $ref: '#/components/schemas/CloudConfigModel' name: description: 'A locally unique, system-generated name. The name cannot be modified. ' type: string example: string _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 ArrayPerformanceReplicationGetResp: allOf: - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/_errorContextResponse_2' - type: object properties: items: type: array items: $ref: '#/components/schemas/RelationshipPerformanceReplication' _referenceWithType: allOf: - $ref: '#/components/schemas/_reference' - type: object properties: resource_type: description: 'Type of the object (full name of the endpoint). Valid values are `hosts`, `host-groups`, `network-interfaces`, `pods`, `ports`, `pod-replica-links`, `subnets`, `volumes`, `volume-snapshots`, `volume-groups`, `directories`, `policies/nfs`, `policies/smb`, and `policies/snapshot`, etc. ' type: string x-aliases: - _reference _performance: type: object properties: bytes_per_mirrored_write: description: 'The average I/O size per mirrored write, measured in bytes. ' type: integer format: int64 minimum: 0 readOnly: true bytes_per_op: description: 'The average I/O size for both read and write (all) operations. ' type: integer format: int64 minimum: 0 readOnly: true bytes_per_read: description: 'The average I/O size per read, measured in bytes. ' type: integer format: int64 minimum: 0 readOnly: true bytes_per_write: description: 'The average I/O size per write, measured in bytes. ' type: integer format: int64 minimum: 0 readOnly: true cached_read_bytes_per_sec: description: The number of cached bytes read, measured in bytes per second. type: integer format: int64 minimum: 0 readOnly: true cached_reads_per_sec: description: The number of cached read requests, measured in requests per second. type: integer format: int64 minimum: 0 readOnly: true mirrored_write_bytes_per_sec: description: 'The number of mirrored bytes written per second. ' type: integer format: int64 minimum: 0 readOnly: true mirrored_writes_per_sec: description: 'The number of mirrored writes per second. ' type: integer format: int64 minimum: 0 readOnly: true non_cached_read_bytes_per_sec: description: The number of non-cached bytes read, measured in bytes per second. type: integer format: int64 minimum: 0 readOnly: true non_cached_reads_per_sec: description: The number of non-cached read requests, measured in requests per second. type: integer format: int64 minimum: 0 readOnly: true qos_rate_limit_usec_per_mirrored_write_op: description: 'The average time it takes the array to process a mirrored I/O write request, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true qos_rate_limit_usec_per_read_op: description: 'The average time spent waiting due to QoS rate limiting for a read request, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true qos_rate_limit_usec_per_write_op: description: 'The average time that a write I/O request spends waiting as a result of the volume reaching its QoS bandwidth limit, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true qos_scheduling_usec_per_mirrored_write_op: description: 'The average time that a mirrored write I/O gets delayed due to QoS scheduling, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true qos_scheduling_usec_per_read_op: description: 'The average time that a read I/O gets delayed due to QoS scheduling, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true qos_scheduling_usec_per_write_op: description: 'The average time that a write I/O gets delayed due to QoS scheduling, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true queue_usec_per_mirrored_write_op: description: 'The average time that a mirrored write I/O request spends in the kernel waiting to be served, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true queue_usec_per_read_op: description: 'The average time that a read I/O request spends in the kernel waiting to be served, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true queue_usec_per_write_op: description: 'The average time that a write I/O request spends in the kernel waiting to be served, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true read_bytes_per_sec: description: 'The number of bytes read per second. ' type: integer format: int64 minimum: 0 readOnly: true read_cache_hit_ratio: description: The ratio of read requests served directly from the cache. type: number format: float minimum: 0 maximum: 1 readOnly: true reads_per_sec: description: 'The number of read requests processed per second. ' type: integer format: int64 minimum: 0 readOnly: true san_usec_per_mirrored_write_op: description: 'The average time required to transfer data from the initiator to the array for a mirrored write request, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true san_usec_per_read_op: description: 'The average time required to transfer data from the array to the initiator for a read request, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true san_usec_per_write_op: description: 'The average time required to transfer data from the initiator to the array for a write request, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true service_usec_per_mirrored_write_op: description: 'The average time required for the array to service a mirrored write request, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true service_usec_per_read_op: description: 'The average time required for the array to service a read request, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true service_usec_per_read_op_cache_reduction: description: 'The percentage reduction in `service_usec_per_read_op` due to data cache hits. For example, a value of 0.25 indicates that the value of `service_usec_per_read_op` is 25% lower than it would have been without any data cache hits. ' type: number format: float minimum: 0 maximum: 1 service_usec_per_read_op_cached: description: 'The average time required for the array to service a read request that is satisfied by a cache hit, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true service_usec_per_read_op_non_cached: description: 'The average time required for the array to service a read request that is not satisfied by a cache hit, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true service_usec_per_write_op: description: 'The average time required for the array to service a write request, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true time: description: 'The time when the sample performance data was taken, measured in milliseconds since the UNIX epoch. ' type: integer format: int64 readOnly: true usec_per_mirrored_write_op: description: 'The average time it takes the array to process a mirrored I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time. ' type: integer format: int64 minimum: 0 readOnly: true usec_per_read_op: description: 'The average time it takes the array to process an I/O read request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time. ' type: integer format: int64 minimum: 0 readOnly: true usec_per_write_op: description: 'The average time it takes the array to process an I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time. ' type: integer format: int64 minimum: 0 readOnly: true write_bytes_per_sec: description: The number of bytes written per second. type: integer format: int64 minimum: 0 readOnly: true writes_per_sec: description: The number of write requests processed per second. type: integer format: int64 minimum: 0 readOnly: true x-readOnly: true ArraySpace: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_context' - type: object properties: capacity: description: 'Currently entitled usable capacity. ' type: integer format: int64 readOnly: true example: 10995116277760 capacity_installed: description: 'Usable capacity of the array if entitled to full capacity for all drives. ' type: integer format: int64 example: 46179488366592 parity: description: 'A representation of data redundancy on the array. Data redundancy is rebuilt automatically by the system whenever parity is less than 1.0. ' type: number format: float readOnly: true example: 0.99 space: title: Space allOf: - $ref: '#/components/schemas/Space' time: type: integer format: int64 readOnly: true ArrayResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Arrays' _fixedReference: 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 x-aliases: - _fixedReferenceWithoutType parameters: Skip_phonehome_check_2: name: skip_phonehome_check in: query required: true description: 'A flag to skip phonehome connectivity check. Arrays that intentionally disable phonehome or do not permit connectivity to Pure Storage''s cloud servers must set this flag to `true` in order to start factory reset. ' schema: type: boolean default: false Resource_names: name: resource_names in: query description: 'A comma-separated list of resource names. If there is not at least one resource that matches each `resource_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 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 History_start_time: name: start_time in: query description: 'Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution. ' schema: type: integer format: int64 Authorization_2: name: Authorization in: header description: 'Access token (in JWT format) required to use any API endpoint (except `/oauth2`) ' schema: type: string Ids: 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 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 Factory_reset_token: name: factory_reset_token in: query description: 'A token required to perform a factory reset. ' schema: type: integer format: int64 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 Delete_sanitization_certificate_required_2: name: delete_sanitization_certificate in: query required: true description: 'Must be `true` to finalize factory reset and acknowledge the deletion of sanitization certificate. ' schema: type: boolean default: true Finalize_array_erasure_required_2: name: finalize in: query required: true description: 'Must be `true` to finalize factory reset. ' schema: type: boolean default: true 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 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 XRequestId: name: X-Request-ID in: header description: 'Supplied by client during request or generated by server. ' schema: type: string 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 Preserve_configuration_data_required: name: preserve_configuration_data in: query description: 'A comma-separated list of configuration data types to preserve. A value of `all` will preserve all configuration data types. Valid values include `all`. ' required: true style: form explode: false schema: type: array items: type: string Skip_phonehome_check: name: skip_phonehome_check in: query description: 'A flag to skip phonehome connectivity check. If `skip_phonehome_check` is not set, the factory reset will fail if phonehome connectivity check fails. Arrays that intentionally disable phonehome or do not permit connectivity to Pure Storage''s cloud servers must set this flag to `true` in order to start factory reset. ' schema: type: boolean Resource_fqdns: name: resource_fqdns in: query description: 'A comma-separated list of resource FQDNs. If there is not at least one resource that matches each `resource_fqdn` 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 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 Eradicate_all_data: name: eradicate_all_data in: query description: 'Set to `true` to perform a factory reset. ' schema: type: boolean Delete_sanitization_certificate_required: name: delete_sanitization_certificate in: query description: 'Set to `true` to finalize factory reset and acknowledge the deletion of sanitization certificate. ' required: true schema: type: boolean Reinstall_image_required: name: reinstall_image in: query description: 'Set to `true` to reinstall image, or `false` to skip reinstalling image. ' required: true schema: type: boolean 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 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 Resolution: name: resolution in: query description: 'The desired ms between samples. Available resolutions may depend on data type, `start_time` and `end_time`. In general `1000`, `30000`, `300000`, `1800000`, `7200000`, and `86400000` are possible values. ' schema: type: integer format: int64 minimum: 0 example: 30000 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 Start_time: name: start_time in: query description: 'When the time window starts (in milliseconds since epoch). ' schema: type: integer format: int64 minimum: 0 example: 1514764800000 History_end_time: name: end_time in: query description: 'Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution. ' schema: type: integer format: int64 Namespaces_2: name: namespaces in: query description: 'A comma-separated list of namespaces. Single quotes are required around all strings. ' style: form explode: false schema: type: array items: type: string x-quoted: true x-quoted: true Context_names: name: context_names in: query description: 'Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element 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`. ' style: form explode: false schema: type: array items: type: string Perf_protocol_type: name: protocol in: query description: 'Protocol type. Valid values are `nfs`, `smb`, `s3`, and `all`. ' 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 Eradicate_all_data_required: name: eradicate_all_data in: query description: 'Set to `true` to perform a factory reset. ' required: true schema: type: boolean Namespaces: name: namespaces in: query description: 'A comma-separated list of namespaces. ' style: form explode: false schema: type: array items: type: string Resource_idsRequired: name: resource_ids in: query description: 'REQUIRED: either `resource_ids` or `resource_names`. A comma-separated list of resource IDs. If there is not at least one resource that matches each `resource_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 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 Fqdns: name: fqdns in: query description: 'A comma-separated list of resource FQDNs. If there is not at least one resource that matches each `fqdn` 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 Keys_2: name: keys in: query description: 'A comma-separated list of tag keys. 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 Preserve_configuration_data_required_2: name: preserve_configuration_data in: query required: true description: 'For the initial phase `none` is only acceptable value for this parameter ' schema: type: string default: none Keys: name: keys in: query description: 'A comma-separated list of tag keys. ' style: form explode: false schema: type: array items: type: string Type: name: type in: query description: 'Display the metric of a specified object type. Valid values are `array`, `file-system`, and `object-store`. If not specified, defaults to `array`. ' schema: type: string History_resolution: name: resolution in: query description: 'The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution. ' schema: type: integer format: int64 minimum: 0 example: 30000 Perf_protocol_group: name: protocol_group in: query description: 'Protocol group type. Valid values are `block`, `file`, `object-store`, and `all`. ' 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 Resource_ids: name: resource_ids in: query description: 'A comma-separated list of resource IDs. If there is not at least one resource that matches each `resource_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 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 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 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 StorageClassNames: name: storage_class_names in: query description: 'A comma-separated list of storage class names. Valid values include `S500X-S` and `S500X-A`. ' style: form explode: false schema: type: array items: type: string Resource_namesRequired: name: resource_names in: query description: 'REQUIRED: either `resource_ids` or `resource_names`. A comma-separated list of resource names. If there is not at least one resource that matches each `resource_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 End_time: name: end_time in: query description: 'When the time window ends (in milliseconds since epoch). ' schema: type: integer format: int64 minimum: 0 example: 1514764800000 Finalize_array_erasure_required: name: finalize in: query description: 'Must be `true` to finalize factory reset. ' required: true schema: type: boolean Type_for_performance: name: type in: query description: 'Display the metric of a specified object type. Valid values are `all`, `file-system`, and `object-store`. If not specified, defaults to `all`. ' schema: type: string Protocol: name: protocol in: query description: 'Display the performance of a specified protocol. Valid values are `all`, `HTTP`, `SMB`, `NFS`, and `S3`. If not specified, defaults to `all`, which will provide the combined performance of all available protocols. ' schema: type: string Eradicate_all_data_required_2: name: eradicate_all_data in: query required: true description: 'Set to `true` to perform a factory reset. ' schema: type: boolean default: true responses: 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' 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' 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'