openapi: 3.0.1 info: title: FlashArray REST Active Directory Protection 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: Protection Groups description: 'A protection group defines a set of volumes, hosts, or host groups (called members) that are protected together through snapshots with point-in-time consistency across the member volumes. The members within the protection group have common data protection requirements and the same snapshot, replication, and retention schedules. ' paths: /api/2.52/protection-groups: get: tags: - Protection Groups summary: Pure Storage List Protection Groups description: 'Displays a list of protection groups, including their associated source arrays or pods, replication targets, hosts, host groups, and volumes. The list includes protection groups that were created on the local array or realm to replicate snapshot data to other arrays, pods or offload targets, created on a remote array or pod and replicated asynchronously to this array or realm, or created inside a pod on a remote array or realm and stretched to the local array or realm. ' 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/ProtectionGroupGetResponse' '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/ProtectionGroupGetResponse' post: tags: - Protection Groups summary: Pure Storage Create a Protection Group and Upsert Tags description: 'Creates a protection group on the local array or realm for asynchronous replication. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Overwrite' - $ref: '#/components/parameters/Protection_group_source_ids' - $ref: '#/components/parameters/Protection_group_source_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupPost' required: false x-codegen-request-body-name: protection-group responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupResponse' x-codegen-request-body-name: protection-group delete: tags: - Protection Groups summary: Pure Storage Delete a Protection Group description: 'Deletes a protection group that has been destroyed and is pending eradication. Eradicated protection groups cannot be recovered. Protection groups are destroyed through the `PATCH` method. The `names` parameter is required. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' responses: '200': description: OK content: {} patch: tags: - Protection Groups summary: Pure Storage Modify a Protection Group description: 'Modifies the protection group schedules to generate and replicate snapshots to another array, pod or to an external storage system. Renames or destroys a protection group. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/ProtectionGroup' required: true x-codegen-request-body-name: protection-group responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupResponse' x-codegen-request-body-name: protection-group /api/2.52/protection-groups/hosts: get: tags: - Protection Groups summary: Pure Storage List Protection Groups with Host Members description: Displays a list of protection groups that have host members. 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_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/MemberNoIdMemberGetResponse' '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/MemberNoIdMemberGetResponse' post: tags: - Protection Groups summary: Pure Storage Create an Action to Add a Host to a Protection Group description: 'Creates an action to add a host member to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. The `group_names` parameter represents the name of the protection group, and the `member_names` parameter represents the name of the host. The `group_names` and `member_names` parameters are required and must be set together. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Member_names' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/MemberNoIdMemberResponse' delete: tags: - Protection Groups summary: Pure Storage Delete a Host from a Protection Group description: 'Deletes a host member from a protection group. After the member has been removed, it is no longer protected by the group. Any protection group snapshots that were taken before the member was removed will not be affected. Removing a member from a protection group does not delete the member from the array or realm, and the member can be added back to the protection group at any time. The `group_names` parameter represents the name of the protection group, and the `member_names` parameter represents the name of the host. The `group_names` and `member_names` parameters are required and must be set together. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Member_names' responses: '200': description: OK content: {} /api/2.52/protection-groups/host-groups: get: tags: - Protection Groups summary: Pure Storage List Protection Groups with Host Group Members description: Displays a list of protection groups that have host group members. 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_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/MemberNoIdMemberGetResponse' '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/MemberNoIdMemberGetResponse' post: tags: - Protection Groups summary: Pure Storage Creates an Action to Add a Host Group to a Protection Group description: 'Creates an action to add a host group member to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. The `group_names` parameter represents the name of the protection group, and the `member_names` parameter represents the name of the host group. The `group_names` and `member_names` parameters are required and must be set together. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Member_names' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/MemberNoIdMemberResponse' delete: tags: - Protection Groups summary: Pure Storage Delete a Host Group from a Protection Group description: 'Deletes a host group member from a protection group. After the member has been removed, it is no longer protected by the group. Protection group snapshots taken before the member was removed will not be affected. Removing a member from a protection group does not delete the member from the array or realm, and the member can be added back to the protection group at any time. The `group_names` parameter represents the name of the protection group, and the `member_names` parameter represents the name of the host group. The `group_names` and `member_names` parameters are required and must be set together. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Member_names' responses: '200': description: OK content: {} /api/2.52/protection-groups/performance/replication: get: tags: - Protection Groups summary: Pure Storage List Protection Group Replication Performance Data description: 'Displays the total number of bytes of replication data transmitted and received per second. The data is grouped by protection 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/ProtectionGroupPerformanceResponse' '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/ProtectionGroupPerformanceResponse' /api/2.52/protection-groups/performance/replication/by-array: get: tags: - Protection Groups summary: Pure Storage List Protection Group Replication Performance Data with Array Details description: 'Displays the total number of bytes of replication data transmitted and received per second. The data is grouped by protection group and includes the names of the source array and targets for each protection 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/ProtectionGroupPerformanceArrayResponse' '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/ProtectionGroupPerformanceArrayResponse' /api/2.52/protection-groups/space: get: tags: - Protection Groups summary: Pure Storage List Protection Group Space Information description: 'Displays provisioned size and physical storage consumption data for each protection 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/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/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/protection-groups/tags: get: tags: - Protection 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: - Protection 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/protection-groups/tags/batch: put: tags: - Protection 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 /api/2.52/protection-groups/targets: get: tags: - Protection Groups summary: Pure Storage List Protection Groups with Targets description: 'Displays a list of protection groups that have target arrays, pods, or offload targets. ' 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/ProtectionGroupTargetGetResponse' '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/ProtectionGroupTargetGetResponse' post: tags: - Protection Groups summary: Pure Storage Create an Action to Add a Target to a Protection Group description: 'Creates an action to add an array, pod, or offload target to a protection group. The `group_names` parameter represents the name of the protection group. The `member_names` parameter represents the name of the array, pod, or offload target that is being added to the protection group. The `group_names` and `member_names` parameters are required and must be set together. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupTargetResponse' delete: tags: - Protection Groups summary: Pure Storage Delete a Target from a Protection Group description: 'Deletes an array, pod, or offload target from a protection group. The `group_names` parameter represents the name of the protection group. The `member_names` parameter represents the name of the array, pod, or offload target that is being removed from the protection group. The `group_names` and `member_names` parameters are required and must be set together. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' responses: '200': description: OK content: {} patch: tags: - Protection Groups summary: Pure Storage Modify a Protection Group Target description: 'Modifies the source array or pod to replicate protection group data to the target, or disallows the source array or pod from replicating protection group data to the target. The `allowed` parameter must be set from the target array or realm. The `group_names` parameter represents the name of the protection group. The `allowed` and `group_names` parameters are required and must be set together. Offload targets do not support the `allowed` parameter. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/TargetProtectionGroupPostPatch' required: true x-codegen-request-body-name: target responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupTargetResponse' x-codegen-request-body-name: target /api/2.52/protection-groups/volumes: get: tags: - Protection Groups summary: Pure Storage List Protection Groups with Volume Members description: 'Displays a list of protection groups that have volume members. ' 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/Pgroup_group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Include_remote' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Member_destroyed' - $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/ProtectionGroupsVolumesGetResponse' '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/ProtectionGroupsVolumesGetResponse' post: tags: - Protection Groups summary: Pure Storage Create a Volume to Add it to a Protection Group description: 'Creates a volume member and adds it to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. The `group_names` parameter represents the name of the protection group, and the `member_names` and `member_ids` parameters represent the names or IDs of the volume. The `group_names` parameter, and either the `member_names` or `member_ids` parameters are required and must be set together. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupsVolumesResponse' delete: tags: - Protection Groups summary: Pure Storage Delete a Volume from a Protection Group description: 'Deletes a volume member from a protection group. After the member has been deleted, it is no longer protected by the group. Any protection group snapshots that were taken before the member was deleted are not affected. Deleting a member from a protection group does not delete the member from the array or realm, and the member can be added back to the protection group at any time. The `group_names` parameter represents the name of the protection group, and the `member_names` and `member_ids` parameters represent the names or IDs of the volume. The `group_names` parameter, and either the `member_names` or `member_ids` parameters are required and must be set together. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' responses: '200': description: OK content: {} components: schemas: ProtectionGroupsVolumes: allOf: - $ref: '#/components/schemas/_context' - type: object properties: group: $ref: '#/components/schemas/_reference' member: $ref: '#/components/schemas/_protectionGroupsVolumesMember' ProtectionGroupResponse: 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/ProtectionGroup' 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 ProtectionGroupGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/ProtectionGroupResponse' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: total: description: 'The aggregate value of all items after filtering. When applicable, the average value is displayed instead. If applicable, the values are displayed for each field. ' type: array items: $ref: '#/components/schemas/ProtectionGroup' _retentionPolicy: description: The snapshot retention policy. type: object properties: all_for_sec: description: 'The length of time to keep the specified snapshots. Measured in seconds. Prior to 6.8.2 the range of 60 to 34560000 is accepted. In 6.8.2 and onwards the range of 60 to 2147483647 is accepted. ' type: integer format: int32 example: 86400 days: description: 'The number of days to keep the snapshots after the `all_for_sec` period has passed. Prior to 6.6.4 the range of 0 to 4000 is accepted. In 6.6.4 and onwards the range of 0 to 2147483647 is accepted. In 6.10.0 and onwards -1 may be used to keep snapshots forever. ' type: integer format: int32 example: 7 per_day: description: 'Deprecated. per_day is deprecated in favor of per_period and period_length_ms. The number of snapshots to keep per day after the `all_for_sec` period has passed. Prior to 6.8.2 the range of 0 to 1440 is accepted. In 6.8.2 and onwards the range of 0 to 2147483647 is accepted. Equivalent to per_period when period_length_ms is 1 day, 86400000 ' type: integer format: int32 example: 3 per_period: description: 'The number of snapshots to keep per period_length_ms after the `all_for_sec` period has passed. The range of 0 to 2147483647 is accepted. ' type: integer format: int32 example: 3 period_length_ms: description: 'The length of time per_period should cover. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days. A minimum of 86400000, 1 day, is accepted. ' type: integer format: int64 example: 86400000 _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 _aggregate_replication_performance: type: object properties: bytes_per_sec: description: The total number of bytes of replication data transmitted and received per second. type: integer format: int64 minimum: 0 readOnly: true x-readOnly: true ProtectionGroupsVolumesResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/ProtectionGroupsVolumes' _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 _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 MemberNoIdMemberGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/MemberNoIdMemberResponse' - $ref: '#/components/schemas/_errorContextResponse' _snapshot_schedule: description: The replication or snapshot schedule. type: object properties: at: description: 'The time of day the snapshot is scheduled to be taken and retained on the local array or immediately replicated to the target(s). Measured in seconds since midnight. The `at` value is only used if the `frequency` parameter is in days (e.g., `259200000`, which is equal to 3 days). ' type: integer format: int64 example: 7200 x-minimum: 0 x-maximum: 86399 enabled: description: If set to `true`, the policy is enabled. type: boolean example: false frequency: description: The frequency of the scheduled action. Measured in milliseconds. type: integer format: int64 example: 259200000 x-minimum: 300000 x-maximum: 34560000000 ProtectionGroupEradicationConfig: description: The configuration of the eradication feature. type: object properties: manual_eradication: description: 'Manual eradication status of objects like protection group and protection group snapshots. If manual_eradication is `disabled`, you cannot eradicate objects. Values include `disabled` and `enabled`. ' type: string readOnly: true example: enabled x-readOnly: true _referenceNoId: type: object properties: name: description: 'The resource name, such as volume name, pod name, snapshot name, and so on. ' type: string _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 _replication_schedule: allOf: - $ref: '#/components/schemas/_snapshot_schedule' - description: 'The schedule of a replication action. ' type: object properties: blackout: description: 'The range of time when to suspend replication. To clear the blackout period, set to an empty string (""). ' title: Time_window allOf: - $ref: '#/components/schemas/_time_window' 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 TagResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Tag' MemberNoIdMemberResponse: type: object properties: items: description: 'Displays a list of all items after filtering. The values are displayed for each name, if meaningful. ' type: array items: $ref: '#/components/schemas/MemberNoIdMember' TargetProtectionGroupPostPatch: type: object properties: allowed: description: 'If set to `true`, the target array has allowed the source array to replicate protection group data to the target array. If set to `false`, the target array has not allowed the source array to replicate protection group data to the target. ' type: boolean example: true protection_group: $ref: '#/components/schemas/_fixedReference' target: $ref: '#/components/schemas/_fixedReferenceNoId' ProtectionGroupPerformanceResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: 'A list of protection group performance objects. ' type: array items: $ref: '#/components/schemas/ProtectionGroupPerformance' _fixedReferenceNoId: type: object properties: name: description: 'The resource name, such as volume name, pod name, snapshot name, and so on. ' type: string readOnly: true x-readOnly: true _time_window: type: object properties: end: description: The window end time. Measured in milliseconds since midnight. The time must be set on the hour. (e.g., `28800000`, which is equal to 8:00 AM). type: integer format: int64 example: 46800000 start: description: The window start time. Measured in milliseconds since midnight. The time must be set on the hour. (e.g., `18000000`, which is equal to 5:00 AM). type: integer format: int64 example: 3600000 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' 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 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' ProtectionGroupPerformanceArray: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_aggregate_replication_performance' - $ref: '#/components/schemas/_context' - type: object properties: source: description: 'The source array from where the data is replicated. ' type: string readOnly: true target: description: 'The target to where the data is replicated. ' type: string 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 x-readOnly: true _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 ProtectionGroup: allOf: - $ref: '#/components/schemas/_context' - $ref: '#/components/schemas/_resource' - description: 'A protection group defines a set of either volumes, hosts, or host groups (called members) that are protected together through snapshots with point-in-time consistency across the member volumes. The members within the protection group have common data protection requirements and share the same snapshot, replication, and retention schedules. ' type: object properties: destroyed: description: 'Has this protection group been destroyed? To destroy a protection group, patch to `true`. To recover a destroyed protection group, patch to `false`. If not specified, defaults to `false`. ' type: boolean eradication_config: $ref: '#/components/schemas/ProtectionGroupEradicationConfig' host_count: description: Number of hosts in this protection group. type: integer format: int64 readOnly: true example: 3 host_group_count: description: Number of host groups in this protection group. type: integer format: int64 readOnly: true example: 3 is_local: description: 'If set to `true`, the protection group belongs to the local array. If set to `false`, the protection group belongs to the remote array. ' type: boolean readOnly: true pod: description: The pod in which the protection group resides. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' replication_schedule: description: The schedule settings for asynchronous replication. title: Replication_schedule allOf: - $ref: '#/components/schemas/_replication_schedule' retention_lock: description: 'The valid values are `ratcheted` and `unlocked`. The default value for a newly created protection group is `unlocked`. Set `retention_lock` to `ratcheted` to enable SafeMode restrictions on the protection group. Contact Pure Technical Services to change `retention_lock` to `unlocked`. ' type: string example: unlocked snapshot_schedule: description: The schedule settings for protection group snapshots. title: Snapshot_schedule allOf: - $ref: '#/components/schemas/_snapshot_schedule' source: description: The array or pod on which the protection group was created. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' source_retention: description: 'The retention policy for the source array of the protection group. ' title: RetentionPolicy allOf: - $ref: '#/components/schemas/_retentionPolicy' space: description: 'Displays provisioned size and physical storage consumption data for each protection group. ' title: Space allOf: - $ref: '#/components/schemas/_space' target_count: description: The number of targets to where this protection group replicates. type: integer format: int64 readOnly: true example: 3 target_retention: description: 'The retention policy for the target(s) of the protection group. ' title: RetentionPolicy allOf: - $ref: '#/components/schemas/_retentionPolicy' time_remaining: description: 'The amount of time left until the destroyed protection group is permanently eradicated. Measured in milliseconds. Before the `time_remaining` period has elapsed, the destroyed protection group can be recovered by setting `destroyed=false`. ' type: integer format: int64 readOnly: true volume_count: description: The number of volumes in the protection group. type: integer format: int64 readOnly: true example: 3 workload: $ref: '#/components/schemas/_workloadConfigurationFixedReference' _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 MemberNoIdMember: allOf: - $ref: '#/components/schemas/_context' - type: object properties: group: description: 'The resource in which the host, volume, or other item in the environment is a member. ' title: Reference allOf: - $ref: '#/components/schemas/_reference' member: description: 'The member of the resource. ' title: ReferenceNoId allOf: - $ref: '#/components/schemas/_referenceNoId' _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 _protectionGroupsVolumesMember: allOf: - $ref: '#/components/schemas/_reference' - type: object properties: destroyed: description: 'Returns a value of `true` if the volume has been destroyed and is pending eradication. Through the `volumes` endpoint, the user can see `time_remaining` of the destroyed volume, recover, or eradicate the destroyed volume. ' type: boolean _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' ProtectionGroupTargetResponse: type: object properties: items: description: 'Displays a list of all items after filtering. If applicable, the values are displayed for each name. ' type: array items: $ref: '#/components/schemas/TargetProtectionGroup' ProtectionGroupPost: type: object properties: tags: description: 'The list of tags to be upserted with the object. ' type: array items: $ref: '#/components/schemas/Tag' ProtectionGroupsVolumesGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/ProtectionGroupsVolumesResponse' - $ref: '#/components/schemas/_errorContextResponse' _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 ProtectionGroupTargetGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/ProtectionGroupTargetResponse' - $ref: '#/components/schemas/_errorContextResponse' 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 ProtectionGroupPerformanceArrayResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: 'Lists performance data, broken down by array. ' type: array items: $ref: '#/components/schemas/ProtectionGroupPerformanceArray' TargetProtectionGroup: allOf: - $ref: '#/components/schemas/_context' - type: object properties: allowed: description: 'If set to `true`, the target array or pod allows the source array to replicate protection group data to the target. If set to `false`, the target array or pod does not allow the source array to replicate protection group data to the target. ' type: boolean example: true group: $ref: '#/components/schemas/_reference' member: $ref: '#/components/schemas/_referenceWithType' status: description: 'The replication status of the target. Valid values are `replicating`, `suspended`, and `disallowed`. If `allowed` is `true` and protection group data is replicating to the target, `status` will display `replicating`. If `allowed` is `true`, but replication is suspended due to the target being demoted, linked, stretched or there is a missing realm connection to the target; `status` will display `suspended`. Replication will resume automatically once the conditions for suspend no longer hold. If `allowed` is `false`, `status` will display `disallowed`. ' type: string example: suspended ProtectionGroupPerformance: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_aggregate_replication_performance' - $ref: '#/components/schemas/_context' - type: object properties: time: description: 'The time when the sample performance data was taken. Measured in milliseconds since the UNIX epoch. ' type: integer format: int64 readOnly: true x-readOnly: true _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: Protection_group_source_ids: name: source_ids in: query description: 'The id of the protection group or protection group snapshot to be copied into a new or existing protection group. If the destination protection group and all of its volumes already exist, include the `overwrite` parameter to overwrite all of the existing volumes with the snapshot contents. If including the `overwrite` parameter, the names of the volumes that are being overwritten must match the names of the volumes that are being restored. If the source is a protection group, the latest snapshot of the protection group will be used as the source during the copy operation. ' style: form explode: false schema: type: array items: 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 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 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 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 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 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: 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 Member_destroyed: name: member_destroyed in: query description: 'If true, returns only destroyed member objects. Returns an error if a name of a live member object is specified in the member_names query param. If false, returns only live member objects. Returns an error if a name of a destroyed member object is specified in the member_names query param. ' schema: type: boolean 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 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 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 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 Protection_group_source_names: name: source_names in: query description: 'The name of the protection group or protection group snapshot to be copied into a new or existing protection group. If the destination protection group and all of its volumes already exist, include the `overwrite` parameter to overwrite all of the existing volumes with the snapshot contents. If including the `overwrite` parameter, the names of the volumes that are being overwritten must match the names of the volumes that are being restored. If the source is a protection group, the latest snapshot of the protection group will be used as the source during the copy operation. ' style: form explode: false schema: type: array items: type: string 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 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 Namespaces: name: namespaces in: query description: 'A comma-separated list of namespaces. ' 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 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 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 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 Keys: name: keys in: query description: 'A comma-separated list of tag keys. ' style: form explode: false schema: type: array items: 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 Overwrite: name: overwrite in: query description: 'If set to `true`, overwrites an existing object during an object copy operation. If set to `false` or not set at all and the target name is an existing object, the copy operation fails. Required if the `source` body parameter is set and the source overwrites an existing object during the copy operation. ' schema: type: boolean 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 Include_remote: name: include_remote in: query description: 'If set to `true` the response will include remote membership for protection groups that belong to the remote arrays or realms as well as local volumes. Defaults to `false`. ' schema: type: boolean Pgroup_group_ids: name: group_ids in: query description: 'Performs the operation on the unique group id specified. Provide multiple resource IDs in comma-separated format. The group_ids or names parameter is required, but they cannot be set together. ' style: form explode: false schema: type: array items: type: string Names: name: names in: query description: 'Performs the operation on the unique names specified. Enter multiple names in comma-separated format. For example, `name01,name02`. If there is not at least one resource that matches each of the elements of `names`, then an error is returned, except when creating new resources. ' style: form explode: false schema: type: array items: type: string 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 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