openapi: 3.0.1 info: title: FlashArray REST Active Directory Volume Groups 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: Volume Groups description: 'Volume groups organize volumes into logical groupings. If virtual volumes are configured, each volume group on the FlashArray array represents its associated virtual machine, and inside each of those volumes groups are the FlashArray volumes that are assigned to the virtual machine. Volume groups that are associated with virtual machines have names that begin with `vvol-` and end with the virtual machine name. ' paths: /api/2.52/volume-groups: get: tags: - Volume Groups summary: Pure Storage List Volume Groups description: 'Displays a list of volume groups, including those pending eradication. ' 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/Destroyed' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/VolumeGroupGetResponse' '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/VolumeGroupGetResponse' post: tags: - Volume Groups summary: Pure Storage Create a Volume Group and Upsert Tags. description: 'Creates a volume group. The volume group itself does not contain any meaningful content; instead, it acts as a container that is used to organize volumes. Once a volume group has been created, volumes can be created inside the volume group or moved into and out of the volume group. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/VolumeGroupPost' required: true x-codegen-request-body-name: volume-group responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/VolumeGroupResponse' x-codegen-request-body-name: volume-group delete: tags: - Volume Groups summary: Pure Storage Delete a Volume Group description: 'Deletes a volume group that has been destroyed and is pending eradication. Eradicated volume groups cannot be recovered. Volume groups are destroyed through the PATCH method. The `ids` or `names` parameter is required, but they cannot be set together. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Eradicate_contents' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' responses: '200': description: OK content: {} patch: tags: - Volume Groups summary: Pure Storage Modify a Volume Group description: 'Modifies a volume group. You can rename, destroy, recover, or set QoS limits for a volume group. To rename a volume group, set `name` to the new name. To destroy a volume group, set `destroyed=true`. To recover a volume group that has been destroyed and is pending eradication, set `destroyed=false`. Sets the bandwidth and IOPS limits of a volume group through the respective `bandwidth_limit` and `iops_limit` parameter. The `ids` or `names` parameter is required, but they cannot be set together. Sets the priority adjustment for a volume group using the `priority_adjustment_operator` and `priority_adjustment_value` fields. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Destroy_contents' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/VolumeGroupPatch' required: true x-codegen-request-body-name: volume-group responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/VolumeGroupResponse' x-codegen-request-body-name: volume-group /api/2.52/volume-groups/performance: get: tags: - Volume Groups summary: Pure Storage List Volume Group Performance Data description: 'Displays real-time and historical performance data, real-time latency data, and average I/O sizes for each volume group and and as a total of all volume groups across the entire array. ' 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/Destroyed' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $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' - $ref: '#/components/parameters/Total_only' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ResourcePerformanceGetResponse' '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/ResourcePerformanceGetResponse' /api/2.52/volume-groups/qos: get: tags: - Volume Groups summary: Pure Storage List Volume Group QoS Config description: 'Displays real-time and historical QoS configuration data for each volume group. ' 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/Destroyed' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $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/VolumeGroupQosGetResponse' '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/VolumeGroupQosGetResponse' /api/2.52/volume-groups/space: get: tags: - Volume Groups summary: Pure Storage List Volume Group Space Information description: 'Displays the provisioned size and physical storage consumption data for each volume group. ' 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/Destroyed' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $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' - $ref: '#/components/parameters/Total_only' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceSpaceGetResponse' '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/ResourceSpaceGetResponse' /api/2.52/volume-groups/volumes: get: tags: - Volume Groups summary: Pure Storage List Volume Groups with Volumes description: Displays a list of volume groups that contain volumes. 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/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/MemberGetResponse' '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/MemberGetResponse' /api/2.52/volume-groups/tags: get: tags: - Volume Groups summary: Pure Storage List Tags description: Displays the list of tags. 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/Resource_destroyed' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' - $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: - Volume Groups summary: Pure Storage Delete Tags description: Deletes specified tags. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Keys' - $ref: '#/components/parameters/Namespaces_delete' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' responses: '200': description: OK content: {} /api/2.52/volume-groups/tags/batch: put: tags: - Volume Groups summary: Pure Storage Update Tags description: Updates tags for all specified objects. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' requestBody: description: A list of tags to be created or, if one already exists, updated. content: application/json: schema: maxItems: 30 minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/TagBatch' 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 components: schemas: TagGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/TagResponse' - $ref: '#/components/schemas/_errorContextResponse' _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' MemberResponse: type: object properties: items: description: 'Displays a list of all items after filtering. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty. ' type: array items: $ref: '#/components/schemas/Member' Member: allOf: - $ref: '#/components/schemas/_context' - type: object properties: group: $ref: '#/components/schemas/_reference' member: $ref: '#/components/schemas/_reference' VolumeGroupGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/VolumeGroupResponse' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: total: description: 'The aggregate value of all items after filtering. Where meaningful, the average value is displayed instead. If applicable, the values are displayed for each field. ' type: array items: $ref: '#/components/schemas/VolumeGroup' _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 _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 TagBatch: 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: description: 'A reference to the parent object. ' title: Reference allOf: - $ref: '#/components/schemas/_reference' value: description: 'Value of the tag. Supports up to 256 Unicode characters. ' type: string example: staging _containerQosCeilings: type: object properties: bandwidth_limit: description: 'The maximum QoS bandwidth limit for the container. Whenever throughput exceeds the bandwidth limit, throttling occurs. Measured in bytes per second. Maximum limit is 512 GB/s. ' title: Qos_bw_limit_type allOf: - $ref: '#/components/schemas/_qos_bw_limit_type' iops_limit: description: 'The QoS IOPs limit for the container. ' title: Qos_iops_limit_type allOf: - $ref: '#/components/schemas/_qos_iops_limit_type' _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 TagResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Tag' ResourcePerformanceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: 'Performance data. If `total_only=true`, the `items` list will be empty. ' type: array items: $ref: '#/components/schemas/ResourcePerformance' total: description: '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 field where meaningful. ' type: array items: $ref: '#/components/schemas/ResourcePerformance' _qos_bw_limit_type: type: integer format: int64 minimum: 1048576 maximum: 549755813888 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 QosMetricsCeilings: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_containerQosCeilings' - $ref: '#/components/schemas/_context' - type: object properties: time: description: 'The timestamp of when the data was taken, measured in milliseconds since the UNIX epoch. ' type: integer format: int64 readOnly: true x-readOnly: true _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 VolumeGroup: allOf: - $ref: '#/components/schemas/_context' - $ref: '#/components/schemas/_resource' - description: 'Volume groups organize FlashArray volumes into logical groupings. ' type: object properties: destroyed: description: 'Returns a value of `true` if the volume group has been destroyed and is pending eradication. Before the `time_remaining` period has elapsed, the destroyed volume group can be recovered by setting `destroyed=false`. After the `time_remaining` period has elapsed, the volume group is permanently eradicated and cannot be recovered. ' type: boolean pod: description: 'A reference to the pod. ' title: Reference allOf: - $ref: '#/components/schemas/_reference' priority_adjustment: $ref: '#/components/schemas/_priorityAdjustment' qos: $ref: '#/components/schemas/_qos' space: title: Space allOf: - $ref: '#/components/schemas/_space' time_remaining: description: 'The amount of time left until the destroyed volume group is permanently eradicated, measured in milliseconds. ' type: integer format: int64 readOnly: true volume_count: description: The number of volumes in the volume group. type: integer format: int64 readOnly: true example: 3 workload: $ref: '#/components/schemas/_workloadConfigurationFixedReference' VolumeGroupPatch: allOf: - $ref: '#/components/schemas/_resource' - description: 'Volume groups organize FlashArray volumes into logical groupings. ' type: object properties: destroyed: description: 'Returns a value of `true` if the volume group has been destroyed and is pending eradication. Before the `time_remaining` period has elapsed, the destroyed volume group can be recovered by setting `destroyed=false`. After the `time_remaining` period has elapsed, the volume group is permanently eradicated and cannot be recovered. ' type: boolean priority_adjustment: $ref: '#/components/schemas/_priorityAdjustment' qos: $ref: '#/components/schemas/_qos_patch' space: title: Space allOf: - $ref: '#/components/schemas/_space' VolumeGroupPost: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_resource' - description: 'Volume groups organize FlashArray volumes into logical groupings. ' type: object properties: destroyed: description: 'If set to `true`, destroys a volume group. If set to `false`, recovers a destroyed volume group. If not specified, defaults to `false`. ' type: boolean readOnly: true priority_adjustment: $ref: '#/components/schemas/_priorityAdjustment' qos: $ref: '#/components/schemas/_qos' space: title: Space allOf: - $ref: '#/components/schemas/_space' tags: description: 'The list of tags to be upserted with the object. ' type: array items: $ref: '#/components/schemas/Tag' time_remaining: description: 'The amount of time left until the destroyed volume group is permanently eradicated, measured in milliseconds. ' type: integer format: int64 readOnly: true volume_count: description: 'The number of volumes in the volume group. ' type: integer format: int64 readOnly: true example: 3 MemberGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/MemberResponse' - $ref: '#/components/schemas/_errorContextResponse' _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 _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 _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 ResourceSpace: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_context' - type: object properties: space: description: 'Displays size and space consumption information. ' title: Space allOf: - $ref: '#/components/schemas/_space' time: description: 'The timestamp of when the data was taken, measured in milliseconds since the UNIX epoch. ' type: integer format: int64 readOnly: true x-readOnly: true _qos_iops_limit_type: type: integer format: int64 minimum: 100 maximum: 100000000 ResourceSpaceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: 'Displays a list of all items after filtering. If applicable, the values are displayed for each name. If `total_only=true`, the `items` list will be empty. ' type: array items: $ref: '#/components/schemas/ResourceSpace' total: description: 'The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. If applicable, the values are displayed for each field. ' type: array items: $ref: '#/components/schemas/ResourceSpace' _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' _qos_patch: type: object properties: bandwidth_limit: description: 'The maximum QoS bandwidth limit for the volume, measured in `bytes per second`. Throttling occurs when throughput exceeds this limit. The maximum supported limit is `512 GB/s`. Specifying an empty string `""` unsets the limit. ' title: QosBandwidthLimitPatch oneOf: - $ref: '#/components/schemas/_qos_bw_limit_type' - $ref: '#/components/schemas/_limit_unset_value' iops_limit: description: 'The QoS `IOPS` limit for the volume. Specifying an empty string `""` unsets the limit. ' title: QosIopsLimitPatch oneOf: - $ref: '#/components/schemas/_qos_iops_limit_type' - $ref: '#/components/schemas/_limit_unset_value' _limit_unset_value: type: string minLength: 0 maxLength: 0 VolumeGroupResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/VolumeGroup' VolumeGroupQosGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: 'QoS configuration data. ' type: array items: $ref: '#/components/schemas/QosMetricsCeilings' _qos: type: object properties: bandwidth_limit: description: 'The maximum QoS bandwidth limit for the volume. Whenever throughput exceeds the bandwidth limit, throttling occurs. Measured in bytes per second. Maximum limit is 512 GB/s. ' title: Qos_bw_limit_type allOf: - $ref: '#/components/schemas/_qos_bw_limit_type' iops_limit: description: 'The QoS IOPs limit for the volume. ' title: Qos_iops_limit_type allOf: - $ref: '#/components/schemas/_qos_iops_limit_type' _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 ResourcePerformance: allOf: - $ref: '#/components/schemas/_performance' - $ref: '#/components/schemas/_performance_others' - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_context' _workloadConfigurationFixedReference: description: 'The reference to the workload managing the resource. The `name` and `configuration` values may display as the string `(unknown)` briefly following a failover. ' allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' - type: object properties: configuration: description: 'The name of the preset configuration object. ' type: string readOnly: true _priorityAdjustment: type: object properties: priority_adjustment_operator: description: 'Valid values are `+`, `-`, and `=`. The values `+` and `-` may be applied to volumes and volume groups to reflect the relative importance of their workloads. Volumes and volume groups can be assigned a priority adjustment of -10, 0, or +10. In addition, volumes can be assigned values of =-10, =0, or =+10. Volumes with settings of -10, 0, +10 can be modified by the priority adjustment setting of a volume group that contains the volume. However, if a volume has a priority adjustment set with the `=` operator (for example, =+10), it retains that value and is unaffected by any volume group priority adjustment settings. ' type: string priority_adjustment_value: description: 'Adjust priority by the specified amount, using the `priority_adjustment_operator`. Valid values are 0 and +10 for `+` and `-` operators, -10, 0, and +10 for the `=` operator. ' type: integer format: int32 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 parameters: 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 Filter: name: filter in: query description: 'Narrows down the results to only the response objects that satisfy the filter criteria. ' schema: type: string Offset: name: offset in: query description: 'The starting position based on the results of the query in relation to the full set of response objects returned. ' schema: type: integer format: int32 minimum: 0 example: 10 Keys: name: keys in: query description: 'A comma-separated list of tag keys. ' style: form explode: false schema: type: array items: type: string Allow_errors: name: allow_errors in: query description: 'If set to `true`, the API will allow the operation to continue even if there are errors. Any errors will be returned in the `errors` field of the response. If set to `false`, the operation will fail if there are any errors. ' schema: type: boolean default: false 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 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 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 Resource_names: name: resource_names in: query description: 'A comma-separated list of resource names. The `resource_ids` or `resource_names` parameter is required, but they cannot be set together. ' style: form explode: false schema: type: array items: type: string Resource_ids: name: resource_ids in: query description: 'A comma-separated list of resource IDs. The `resource_ids` or `resource_names` parameter is required, but they cannot be set together. ' style: form explode: false schema: type: array items: type: string 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 XRequestId: name: X-Request-ID in: header description: 'Supplied by client during request or generated by server. ' schema: type: string Eradicate_contents: name: eradicate_contents in: query description: 'Set to `true` to eradicate contents (e.g., volumes, protection groups, snapshots) and containers (e.g., realms, pods, volume groups). This enables you to eradicate containers with contents. ' schema: type: boolean Limit: name: limit in: query description: 'Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. ' schema: type: integer format: int32 minimum: 0 example: 10 Namespaces: name: namespaces in: query description: 'A comma-separated list of namespaces. ' style: form explode: false schema: type: array items: type: string Namespaces_delete: name: namespaces in: query description: 'A comma-separated list of namespaces. Only one namespace is allowed per delete request. ' style: form explode: false schema: type: array items: type: string Authorization: name: Authorization in: header description: 'Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`) ' schema: type: string 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 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 Resource_destroyed: name: resource_destroyed in: query description: 'If set to `true`, returns only objects from destroyed resources. Returns an error if the name of a live resource is specified in the `resource_names` query parameter. If set to `false`, returns only objects from live resources. Returns an error if the name of a destroyed resource is specified in the `resource_names` query parameter. ' schema: type: boolean Context_names_get: name: context_names in: query description: 'Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet or the name of the fleet itself. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided `context`. Enter multiple names in comma-separated format. For example, `name01,name02`. ' style: form explode: false schema: type: array items: type: string Member_ids: name: member_ids in: query description: 'Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The `member_ids` or `member_names` parameter is required, but they cannot be set together. ' style: form explode: false schema: type: array items: type: string Member_names: name: member_names in: query description: 'Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`. ' style: form explode: false schema: type: array items: type: string Ids: name: ids in: query description: "A comma-separated list of unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n if ids or names is not provided, but it cannot be used together with name or names.\n" style: form explode: false schema: type: array items: type: string Destroy_contents: name: destroy_contents in: query description: 'Set to `true` to destroy contents (e.g., volumes, protection groups, snapshots) and containers (e.g., realms, pods, volume groups), including eradicating containers with content. ' schema: type: boolean 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 Group_names: name: group_names in: query description: 'Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`. ' style: form explode: false schema: type: array items: type: string Group_ids: name: group_ids in: query description: 'A comma-separated list of group IDs. ' style: form explode: false schema: type: array items: type: string Destroyed: name: destroyed in: query description: 'If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. If not set, lists both objects that are destroyed and those that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds. If object name(s) or id(s) are specified, then each object referenced must exist. If `destroyed` is set to `true`, then each object referenced must also be destroyed. If `destroyed` is set to `false`, then each object referenced must also not be destroyed. An error is returned if any of these conditions are not met. ' schema: type: boolean 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