openapi: 3.0.1 info: title: FlashArray REST Active Directory Policies 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: Policies description: 'Policies are used to create exports (i.e., shares) and schedule snapshots. NFS and SMB policies can be created and have one or more rules applied to them. Each policy can be reused, creating exports for a number of managed directories. ' paths: /api/2.52/policies: get: tags: - Policies summary: Pure Storage List Policies description: 'Displays a list of policies. ' 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' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyGetResponse' '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/PolicyGetResponse' /api/2.52/policies/management-access: get: tags: - Policies summary: Pure Storage List Management Access Policies description: 'Displays a list of management access policies. ' 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/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/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/PolicyManagementAccessGetResponse' '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/PolicyManagementAccessGetResponse' post: tags: - Policies summary: Pure Storage Create Management Access Policies description: 'Creates one or more management access policies. To copy a policy, one of `source_names` or `source_ids` is required. To create a policy from scratch, policy body is required. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names_required' - $ref: '#/components/parameters/Source_ids' - $ref: '#/components/parameters/Source_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyManagementAccessPost' required: false x-codegen-request-body-name: policy responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyManagementAccessResponse' x-codegen-request-body-name: policy delete: tags: - Policies summary: Pure Storage Delete Management Access Policies description: 'Deletes one or more management access policies. One of `ids` or `names` 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: - Policies summary: Pure Storage Modify Management Access Policies description: 'Modifies one or more management access policies. One of `ids` or `names` is required. For renames, can only specify one old policy in `ids` or `names`. ' 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/PolicyManagementAccessPatch' required: true x-codegen-request-body-name: policy responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyManagementAccessResponse' x-codegen-request-body-name: policy /api/2.52/policies/management-access/members: get: tags: - Policies summary: Pure Storage List Management Access Policy Members description: Displays a list of management access policy 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/Limit' - $ref: '#/components/parameters/Member_idsUnrestricted' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_types' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Policy_idsUnrestricted' - $ref: '#/components/parameters/Policy_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberCleanGetResponse' '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/PolicyMemberCleanGetResponse' post: tags: - Policies summary: Pure Storage Create a Membership Between an Object and a Management Access Policy description: Creates a membership between one or more objects and a management access policy. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Policy_idsUnrestricted' - $ref: '#/components/parameters/Policy_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyMemberPost' required: true x-codegen-request-body-name: members responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberCleanResponse' x-codegen-request-body-name: members delete: tags: - Policies summary: Pure Storage Delete Membership Between Management Access Policies and Attached Object description: 'Deletes a membership between one or more management access policies and attached object. One of `policy_ids` or `policy_names` is required, as well as one of `member_ids` or `member_names`. `member_types` is required. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_types' - $ref: '#/components/parameters/Policy_idsUnrestricted' - $ref: '#/components/parameters/Policy_names' responses: '200': description: OK content: {} /api/2.52/policies/alert-watcher: get: tags: - Policies summary: Pure Storage List Alert-watcher Policies description: 'Displays a list of alert-watcher policies. ' 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' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyGetResponse' '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/PolicyGetResponse' post: tags: - Policies summary: Pure Storage Create Alert-watcher Policies description: 'Creates one or more alert-watcher policies. To copy a policy, the `source_names` or `source_ids` parameter is required, but they cannot be set together. To create a policy from scratch, policy body is required. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Source_ids' - $ref: '#/components/parameters/Source_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyPost' required: false x-codegen-request-body-name: policy responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyResponse' x-codegen-request-body-name: policy delete: tags: - Policies summary: Pure Storage Delete Alert-watcher Policies description: 'Deletes one or more alert-watcher policies. 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/Ids' - $ref: '#/components/parameters/Names' responses: '200': description: OK content: {} patch: tags: - Policies summary: Pure Storage Modify Alert-watcher Policies description: 'Modifies one or more alert-watcher policies. To enable a policy, set `enabled=true`. To disable a policy, set `enabled=false`. To rename a policy, set `name` to the new name. 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/Ids' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyPatch' required: true x-codegen-request-body-name: policy responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyResponse' x-codegen-request-body-name: policy /api/2.52/policies/alert-watcher/members: get: tags: - Policies summary: Pure Storage List Alert-watcher Policy Members description: Displays a list of alert-watcher policy 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/Destroyed' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_types' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberGetResponse' '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/PolicyMemberGetResponse' post: tags: - Policies summary: Pure Storage Create a Membership Between an Object and an Alert-watcher Policy description: Creates a membership between one or more objects and an alert-watcher policy. The `policy_ids` or `policy_names` parameter is required, but cannot be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyMemberPost' required: true x-codegen-request-body-name: members responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberResponse' x-codegen-request-body-name: members delete: tags: - Policies summary: Pure Storage Delete Membership Between Alert-watcher Policies and Attached Object description: Deletes a membership between one or more alert-watcher policies and attached object. The `policy_ids` or `policy_names` parameter is required, but cannot be set together. The `member_ids` or `member_names` parameter is required, but cannot be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_types' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' responses: '200': description: OK content: {} /api/2.52/policies/alert-watcher/rules: get: tags: - Policies summary: Pure Storage List Alert-watcher Policy Rules description: Displays a list of alert-watcher policy rules. 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/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyRuleAlertWatcherGetResponse' '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/PolicyRuleAlertWatcherGetResponse' post: tags: - Policies summary: Pure Storage Create Alert-watcher Policy Rules description: Creates one or more alert-watcher policy rules. Either the 'policy_ids' or 'policy_names' parameter is required, but both parameters cannot be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyRuleAlertWatcherPost' required: true x-codegen-request-body-name: rules responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyRuleAlertWatcherResponse' x-codegen-request-body-name: rules delete: tags: - Policies summary: Pure Storage Delete Alert-watcher Policy Rules description: Deletes one or more alert-watcher policy rules. Either the 'policy_ids' or 'policy_names' parameter is required, but both parameters cannot be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' responses: '200': description: OK content: {} patch: tags: - Policies summary: Pure Storage Modify Alert-watcher Policy Rules description: Modifies alert-watcher policy rules. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyRuleAlertWatcherPatch' required: true x-codegen-request-body-name: rules responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyRuleAlertWatcherResponse' x-codegen-request-body-name: rules /api/2.52/policies/alert-watcher/rules/test: get: tags: - Policies summary: Pure Storage List Rules of Alert-watcher Policy Rule Test description: Displays alert-watcher policy rule email test results. 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/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/TestResultWithResourceGetResponse' '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/TestResultWithResourceGetResponse' /api/2.52/policies/audit-file: get: tags: - Policies summary: Pure Storage List Audit Policies description: 'Displays a list of audit policies. ' 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' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyAuditFileGetResponse' '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/PolicyAuditFileGetResponse' post: tags: - Policies summary: Pure Storage Create Audit Policies description: 'Creates one or more audit policies. To copy a policy, the `source_names` or `source_ids` parameter is required, but they cannot be set together. To create a policy from scratch, policy body is required. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Source_ids' - $ref: '#/components/parameters/Source_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyAuditFilePost' required: false x-codegen-request-body-name: policy responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyAuditFileResponse' x-codegen-request-body-name: policy delete: tags: - Policies summary: Pure Storage Delete Audit Policies description: 'Deletes one or more audit policies. 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/Ids' - $ref: '#/components/parameters/Names' responses: '200': description: OK content: {} patch: tags: - Policies summary: Pure Storage Modify Audit Policies description: 'Modifies one or more audit policies. To enable a policy, set `enabled=true`. To disable a policy, set `enabled=false`. To rename a policy, set `name` to the new name. 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/Ids' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyAuditFilePatch' required: true x-codegen-request-body-name: policy responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyAuditFileResponse' x-codegen-request-body-name: policy /api/2.52/policies/audit-file/members: get: tags: - Policies summary: Pure Storage List Audit Policy Members description: Displays a list of audit policy 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/Destroyed' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_types' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberGetResponse' '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/PolicyMemberGetResponse' post: tags: - Policies summary: Pure Storage Create a Membership Between a Managed Directory and a Audit Policy description: Creates a membership between one or more managed directories and a audit policy. The `policy_ids` or `policy_names` parameter is required, but cannot be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyMemberPost' required: true x-codegen-request-body-name: members responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberResponse' x-codegen-request-body-name: members delete: tags: - Policies summary: Pure Storage Delete Membership Between Audit Policies and Managed Directories description: Deletes a membership between one or more audit policies and managed directories. The `policy_ids` or `policy_names` parameter is required, but cannot be set together. The `member_ids` or `member_names` parameter is required, but cannot be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_types' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' responses: '200': description: OK content: {} /api/2.52/policies/autodir: get: tags: - Policies summary: Pure Storage List Auto Managed Directory Policies description: 'Displays a list of auto managed directory policies. ' 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' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyGetResponse' '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/PolicyGetResponse' post: tags: - Policies summary: Pure Storage Create Auto Managed Directory Policies description: 'Creates one or more auto managed directory policies. To copy a policy, set one of either `source_names` or `source_ids`. Each policy can only have one entry. To create a policy from scratch, policy body is required. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Source_ids' - $ref: '#/components/parameters/Source_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyPost' required: false x-codegen-request-body-name: policy responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyResponse' x-codegen-request-body-name: policy delete: tags: - Policies summary: Pure Storage Delete Auto Managed Directory Policies description: 'Deletes one or more auto managed directory policies. 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/Ids' - $ref: '#/components/parameters/Names' responses: '200': description: OK content: {} patch: tags: - Policies summary: Pure Storage Modify Auto Managed Directory Policies description: 'Modifies one or more auto managed directory policies. To enable a policy, set `enabled=true`. To disable a policy, set `enabled=true`. To rename a policy, set `name` to the new name. 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/Ids' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyPatch' required: true x-codegen-request-body-name: policy responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyResponse' x-codegen-request-body-name: policy /api/2.52/policies/autodir/members: get: tags: - Policies summary: Pure Storage List Auto Managed Directories Policy Members description: 'Displays a list of auto managed directory policy 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/Destroyed' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_types' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberGetResponse' '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/PolicyMemberGetResponse' post: tags: - Policies summary: Pure Storage Create Auto Managed Directory Policies description: 'Creates a membership between one or more resources with an auto managed directory policy. Applicable resources are directories. The `policy_ids` or `policy_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/Policy_ids' - $ref: '#/components/parameters/Policy_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyMemberPost' required: true x-codegen-request-body-name: members responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberResponse' x-codegen-request-body-name: members delete: tags: - Policies summary: Pure Storage Delete Auto Managed Directory Policies description: 'Deletes one or more auto managed directory policies from resources. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together. The `member_ids` or `member_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/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_types' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' responses: '200': description: OK content: {} /api/2.52/policies/members: get: tags: - Policies summary: Pure Storage List Policy Members description: Displays a list of policy 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/Destroyed' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_types' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberGetResponse' '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/PolicyMemberGetResponse' /api/2.52/policies/network-access: get: tags: - Policies summary: Pure Storage List Network Access Policies description: 'The reporting interface or dataset that provides a `list` of all `network access policies`. ' 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' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyGetResponse' '207': description: 'The status indicating a partial success. While some `resources` were successfully returned, specific `errors` occurred during the operation that may have prevented the full set of requested data from being retrieved. ' content: application/json: schema: $ref: '#/components/schemas/PolicyGetResponse' post: tags: - Policies summary: Pure Storage Create Network Access Policies description: 'The operation that creates one or more `network access policies`. This action supports two modes: duplicating an existing policy by providing either `source_names` or `source_ids`, or instantiating a new policy from scratch by providing a `policy body`. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names_required' - $ref: '#/components/parameters/Source_ids' - $ref: '#/components/parameters/Source_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyPost' required: false x-codegen-request-body-name: policy responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyResponse' x-codegen-request-body-name: policy delete: tags: - Policies summary: Pure Storage Delete Network Access Policies description: 'The operation that deletes one or more `network access policies`. This action requires the specification of either `ids` or `names` to identify the target policies, though these parameters are mutually exclusive and cannot be used simultaneously within the same request. ' 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: - Policies summary: Pure Storage Modify Network Access Policies description: 'The operation that modifies one or more `network access policies`. This action supports updating the administrative state by adjusting the `enabled` attribute, as well as renaming policies via the `name` parameter. To identify the target policies, the specification of either `ids` or `names` is required; however, these parameters are mutually exclusive and cannot be used simultaneously. ' 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/PolicyPatch' required: true x-codegen-request-body-name: policy responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyResponse' x-codegen-request-body-name: policy /api/2.52/policies/network-access/members: get: tags: - Policies summary: Pure Storage List Network Access Policy Members description: 'The reporting interface or dataset that provides a `list` of all `members` associated with a `network access policy`. ' 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/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_types' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberGetResponse' '207': description: 'The status indicating a partial success. While some `resources` were successfully returned, specific `errors` occurred during the operation that may have prevented the full set of requested data from being retrieved. ' content: application/json: schema: $ref: '#/components/schemas/PolicyMemberGetResponse' /api/2.52/policies/network-access/rules: get: tags: - Policies summary: Pure Storage List Network Access Policy Rules description: 'The reporting interface or dataset that provides a `list` of all `rules` associated with a `network access policy`. ' 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/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Policy_idsUnrestricted' - $ref: '#/components/parameters/Policy_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyRuleNetworkAccessGetResponse' '207': description: 'The status indicating a partial success. While some `resources` were successfully returned, specific `errors` occurred during the operation that may have prevented the full set of requested data from being retrieved. ' content: application/json: schema: $ref: '#/components/schemas/PolicyRuleNetworkAccessGetResponse' post: tags: - Policies summary: Pure Storage Create Network Access Policy Rules description: 'The operation that creates one or more `network access policy rules`. This action requires the specification of either `policy_ids` or `policy_names` to identify the target policies, though these parameters are mutually exclusive and cannot be used simultaneously within the same request. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyRuleNetworkAccessPost' required: true x-codegen-request-body-name: rules responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyRuleNetworkAccessResponse' x-codegen-request-body-name: rules delete: tags: - Policies summary: Pure Storage Delete Network Access Policy Rules description: 'The operation that deletes one or more `network access policy rules`. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Policy_idsUnrestricted' - $ref: '#/components/parameters/Policy_names' responses: '200': description: OK content: {} patch: tags: - Policies summary: Pure Storage Modify Network Access Policy Rules description: 'The operation that modifies one or more `network access policy rules`. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Policy_idsUnrestricted' - $ref: '#/components/parameters/Policy_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyRuleNetworkAccessPatch' required: true x-codegen-request-body-name: rules responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyRuleNetworkAccessResponse' x-codegen-request-body-name: rules /api/2.52/policies/nfs: get: tags: - Policies summary: Pure Storage List NFS Policies description: 'Displays a list of NFS policies. ' 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/Workload_ids' - $ref: '#/components/parameters/Workload_names' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyNfsGetResponse' '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/PolicyNfsGetResponse' post: tags: - Policies summary: Pure Storage Create NFS Policies description: 'Creates one or more NFS policies or copies an existing policy. To copy a policy, the `source_names` or `source_ids` parameter is required, but they cannot be set together. To create a policy, policy body is required. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Source_ids' - $ref: '#/components/parameters/Source_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyNfsPost' required: false x-codegen-request-body-name: policy responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyNfsResponse' x-codegen-request-body-name: policy delete: tags: - Policies summary: Pure Storage Delete NFS Policies description: 'Deletes one or more NFS policies. 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/Ids' - $ref: '#/components/parameters/Names' responses: '200': description: OK content: {} patch: tags: - Policies summary: Pure Storage Modify NFS Policies description: 'Modifies one or more NFS policies. To enable a policy, set `enabled=true`. To disable a policy, set `enabled=false`. To rename a policy, set `name` to the new name. 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/Ids' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyNfsPatch' required: true x-codegen-request-body-name: policy responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyNfsResponse' x-codegen-request-body-name: policy /api/2.52/policies/nfs/client-rules: get: tags: - Policies summary: Pure Storage List NFS Client Policy Rules description: 'The list of NFS client policy rules. ' 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/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyRuleNfsClientGetResponse' '207': description: 'The state indicating partial success. Some resources were returned, but errors occurred that may have prevented the retrieval of all requested resources. ' content: application/json: schema: $ref: '#/components/schemas/PolicyRuleNfsClientGetResponse' post: tags: - Policies summary: Pure Storage Create NFS Client Policy Rules description: 'The creation of one or more NFS client policy rules. The `policy_ids` or `policy_names` parameter is required; however, these parameters cannot be specified together. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyRuleNfsClientPost' required: true x-codegen-request-body-name: rules responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyRuleNfsClientResponse' x-codegen-request-body-name: rules delete: tags: - Policies summary: Pure Storage Delete NFS Client Policy Rules. description: 'Deletes one or more NFS client policy rules. The `policy_ids` or `policy_names` parameter is required, but cannot be set together. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' responses: '200': description: OK content: {} patch: tags: - Policies summary: Pure Storage Modify NFS Client Policy Rules description: 'Modifies one or more NFS client policy rules. The `policy_ids` or `policy_names` parameter is required, but cannot be set together. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyRuleNfsClientPatch' required: true x-codegen-request-body-name: rules responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyRuleNfsClientResponse' x-codegen-request-body-name: rules /api/2.52/policies/nfs/members: get: tags: - Policies summary: Pure Storage List NFS Policy Members description: 'Displays a list of NFS policy 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/Destroyed' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_types' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_fqnames' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberExportGetResponse' '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/PolicyMemberExportGetResponse' post: tags: - Policies summary: Pure Storage Create NFS Policies description: 'Creates a membership between one or more resources and an NFS policy. Applicable resources are directories. The `policy_ids` or `policy_names` parameter is required, but cannot be set together. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_fqnames' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyMemberExportPost' required: true x-codegen-request-body-name: members responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberExportResponse' x-codegen-request-body-name: members delete: tags: - Policies summary: Pure Storage Delete NFS Policies description: 'Deletes one or more NFS policies from resources. The `policy_ids` or `policy_names` parameter is required, but cannot be set together. The `member_ids` or `member_names` parameter is required, but cannot be set together. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_types' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_fqnames' - $ref: '#/components/parameters/Server_ids' - $ref: '#/components/parameters/Server_fqnames' responses: '200': description: OK content: {} /api/2.52/policies/object-store-access: get: tags: - Policies summary: Pure Storage GET Policies/object-store-access description: The list of access policies and their associated attributes. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Exclude_rules' - $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' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ObjectStoreAccessPolicyGetResponse' '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/ObjectStoreAccessPolicyGetResponse' /api/2.52/policies/object-store-access/members: get: tags: - Policies summary: Pure Storage GET Policies/object-store-access/members description: List object store users and their access policies. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_types' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PolicyMemberObjectStoreAccessGetResponse' '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/PolicyMemberObjectStoreAccessGetResponse' post: tags: - Policies summary: Pure Storage POST Policies/object-store-access/members description: Grant access policies to an object store user. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_types' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PolicyMemberObjectStoreAccessResponse' delete: tags: - Policies summary: Pure Storage DELETE Policies/object-store-access/members description: Revokes an object store user's access policy. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_types' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: {} /api/2.52/policies/object-store-access/rules: get: tags: - Policies summary: Pure Storage GET Policies/object-store-access/rules description: The list of access policy rules and their associated attributes. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ObjectStoreAccessPolicyRuleGetResponse' '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/ObjectStoreAccessPolicyRuleGetResponse' /api/2.52/policies/password: get: tags: - Policies summary: Pure Storage List Password Policies description: 'Displays a list of password policies. ' 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/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/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/PolicyPasswordGetResponse' '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/PolicyPasswordGetResponse' patch: tags: - Policies summary: Pure Storage Modify Password Policies description: 'Modifies one or more password policies. To enable a policy, set `enabled=true`. To disable a policy, set `enabled=false`. ' 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/PolicyPassword' required: true x-codegen-request-body-name: policy responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyPasswordResponse' x-codegen-request-body-name: policy /api/2.52/policies/quota: get: tags: - Policies summary: Pure Storage List Quota Policies description: 'Displays a list of quota policies. ' 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/Workload_ids' - $ref: '#/components/parameters/Workload_names' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyQuotaGetResponse' '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/PolicyQuotaGetResponse' post: tags: - Policies summary: Pure Storage Create Quota Policies description: 'Creates one or more quota policies. To copy a policy, the `source_names` or `source_ids` parameter is required, but they cannot be set together. To create a policy from scratch, policy body is required. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Source_ids' - $ref: '#/components/parameters/Source_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyPost' required: false x-codegen-request-body-name: policy responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyQuotaResponse' x-codegen-request-body-name: policy delete: tags: - Policies summary: Pure Storage Delete Quota Policies description: 'Deletes one or more quota policies. 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/Ids' - $ref: '#/components/parameters/Names' responses: '200': description: OK content: {} patch: tags: - Policies summary: Pure Storage Modify Quota Policies description: 'Modifies one or more quota policies. To enable a policy, set `enabled=true`. To disable a policy, set `enabled=false`. To rename a policy, set `name` to the new name. 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/Ids' - $ref: '#/components/parameters/Ignore_usage' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyQuotaPatch' required: true x-codegen-request-body-name: policy responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyQuotaResponse' x-codegen-request-body-name: policy /api/2.52/policies/quota/members: get: tags: - Policies summary: Pure Storage List Quota Policy Members description: Displays a list of quota policy 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/Destroyed' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_types' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberGetResponse' '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/PolicyMemberGetResponse' post: tags: - Policies summary: Pure Storage Create a Membership Between a Managed Directory and a Quota Policy description: Creates a membership between one or more managed directories and a quota policy. The `policy_ids` or `policy_names` parameter is required, but cannot be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ignore_usage' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyMemberPost' required: true x-codegen-request-body-name: members responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberResponse' x-codegen-request-body-name: members delete: tags: - Policies summary: Pure Storage Delete Membership Between Quota Policies and Managed Directories description: Deletes a membership between one or more quota policies and managed directories. The `policy_ids` or `policy_names` parameter is required, but cannot be set together. The `member_ids` or `member_names` parameter is required, but cannot be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_types' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' responses: '200': description: OK content: {} /api/2.52/policies/quota/rules: get: tags: - Policies summary: Pure Storage List Quota Policy Rules description: Displays a list of quota policy rules. 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/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyRuleQuotaGetResponse' '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/PolicyRuleQuotaGetResponse' post: tags: - Policies summary: Pure Storage Create Quota Policy Rules description: Creates one or more quota policy rules. The `policy_ids` or `policy_names` parameter is required, but cannot be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ignore_usage' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyRuleQuotaPost' required: true x-codegen-request-body-name: rules responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyRuleQuotaResponse' x-codegen-request-body-name: rules delete: tags: - Policies summary: Pure Storage Delete Quota Policy Rules description: Deletes one or more quota policy rules. The `policy_ids` or `policy_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/Names' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' responses: '200': description: OK content: {} patch: tags: - Policies summary: Pure Storage Modify Quota Policy Rules description: Modifies quota policy rules. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ignore_usage' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyRuleQuotaPatch' required: true x-codegen-request-body-name: rules responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyRuleQuotaResponse' x-codegen-request-body-name: rules /api/2.52/policies/smb: get: tags: - Policies summary: Pure Storage List SMB Policies description: 'Displays a list of SMB policies. ' 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/Fqnames' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Workload_ids' - $ref: '#/components/parameters/Workload_names' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicySmbGetResponse' '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/PolicySmbGetResponse' post: tags: - Policies summary: Pure Storage Create SMB Policies description: 'Creates one or more SMB policies. To copy a policy, set one of either `source_names` or `source_ids`. Each policy can only have one entry. To create a policy from scratch, policy body is required. To create an SMB policy with access based enumeration enabled, set `access_based_enumeration_enabled=true`. To create an SMB policy with continuous availability enabled, set `continuous_availability=true`. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Fqnames' - $ref: '#/components/parameters/Source_ids' - $ref: '#/components/parameters/Source_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicySmbPost' required: false x-codegen-request-body-name: policy responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicySmbResponse' x-codegen-request-body-name: policy delete: tags: - Policies summary: Pure Storage Delete SMB Policies description: 'Deletes one or more SMB policies. 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/Ids' - $ref: '#/components/parameters/Fqnames' responses: '200': description: OK content: {} patch: tags: - Policies summary: Pure Storage Modify SMB Policies description: 'Modifies one or more SMB policies. To enable a policy, set `enabled=true`. To disable a policy, set `enabled=false`. To enable access based enumeration, set `access_based_enumeration_enabled=true`. To disable access based enumeration, set `access_based_enumeration_enabled=false`. To enable continuous availability, set `continuous_availability=true`. To disable continuous availability, set `continuous_availability=false`. To rename a policy, set `name` to the new name. 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/Ids' - $ref: '#/components/parameters/Fqnames' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicySmbPatch' required: true x-codegen-request-body-name: policy responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicySmbResponse' x-codegen-request-body-name: policy /api/2.52/policies/smb/client-rules: get: tags: - Policies summary: Pure Storage List SMB Client Policy Rules description: Displays a list of SMB client policy rules. 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/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyRuleSmbClientGetResponse' '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/PolicyRuleSmbClientGetResponse' post: tags: - Policies summary: Pure Storage Create SMB Client Policy Rules description: 'Creates one or more SMB client policy rules. The `policy_ids` or `policy_names` parameter is required, but cannot be set together. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyRuleSmbClientPost' required: true x-codegen-request-body-name: rules responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyRuleSmbClientResponse' x-codegen-request-body-name: rules delete: tags: - Policies summary: Pure Storage Delete SMB Client Policy Rules. description: 'Deletes one or more SMB client policy rules. The `policy_ids` or `policy_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/Names' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' responses: '200': description: OK content: {} /api/2.52/policies/smb/members: get: tags: - Policies summary: Pure Storage List SMB Policy Members description: 'Displays a list of SMB policy 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/Destroyed' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_types' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_fqnames' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberExportGetResponse' '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/PolicyMemberExportGetResponse' post: tags: - Policies summary: Pure Storage Create SMB Policies description: 'Creates a membership between one or more resources and an SMB policy. Applicable resources are directories. The `policy_ids` or `policy_names` parameter is required, but cannot be set together. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_fqnames' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyMemberExportPost' required: true x-codegen-request-body-name: members responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberExportResponse' x-codegen-request-body-name: members delete: tags: - Policies summary: Pure Storage Delete SMB Policies description: 'Deletes one or more SMB policies from resources. The `policy_ids` or `policy_names` parameter is required, but cannot be set together. The `member_ids` or `member_names` parameter is required, but cannot be set together. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_types' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_fqnames' - $ref: '#/components/parameters/Server_ids' - $ref: '#/components/parameters/Server_fqnames' responses: '200': description: OK content: {} /api/2.52/policies/snapshot: get: tags: - Policies summary: Pure Storage List Snapshot Policies description: 'Displays a list of snapshot policies. ' 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/Workload_ids' - $ref: '#/components/parameters/Workload_names' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyLockableGetResponse' '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/PolicyLockableGetResponse' post: tags: - Policies summary: Pure Storage Create Snapshot Policies description: 'Creates one or more snapshot policies. To copy a policy, set one of either `source_names` or `source_ids`. Each policy can only have one entry. To create a policy from scratch, policy body is required. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Source_ids' - $ref: '#/components/parameters/Source_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyPost' required: false x-codegen-request-body-name: policy responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyLockableResponse' x-codegen-request-body-name: policy delete: tags: - Policies summary: Pure Storage Delete Snapshot Policies description: 'Deletes one or more snapshot policies. 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/Ids' - $ref: '#/components/parameters/Names' responses: '200': description: OK content: {} patch: tags: - Policies summary: Pure Storage Modify Snapshot Policies description: 'Modifies one or more snapshot policies. To enable a policy, set `enabled=true`. To disable a policy, set `enabled=true`. To rename a policy, set `name` to the new name. To ratchet a policy, set `retention_lock=ratcheted`. 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/Ids' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyLockablePatch' required: true x-codegen-request-body-name: policy responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyLockableResponse' x-codegen-request-body-name: policy /api/2.52/policies/snapshot/members: get: tags: - Policies summary: Pure Storage List Snapshot Policy Members description: Displays a list of snapshot policy 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/Destroyed' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_types' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberGetResponse' '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/PolicyMemberGetResponse' post: tags: - Policies summary: Pure Storage Create Snapshot Policies description: Creates a membership between one or more resources and a snapshot policy. Applicable resources are directories. The `policy_ids` or `policy_names` parameter is required, but cannot be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyMemberPost' required: true x-codegen-request-body-name: members responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberResponse' x-codegen-request-body-name: members delete: tags: - Policies summary: Pure Storage Delete Snapshot Policies description: Deletes one or more snapshot policies from resources. The `policy_ids` or `policy_names` parameter is required, but cannot be set together. The `member_ids` or `member_names` parameter is required, but cannot be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_types' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' responses: '200': description: OK content: {} /api/2.52/policies/snapshot/rules: get: tags: - Policies summary: Pure Storage List Snapshot Policy Rules description: 'Displays a list of snapshot policy rules. ' 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/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyRuleSnapshotGetResponse' '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/PolicyRuleSnapshotGetResponse' post: tags: - Policies summary: Pure Storage Create Snapshot Policy Rules description: 'Creates one or more snapshot policy rules. The `policy_ids` or `policy_names` parameter is required, but cannot be set together. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyRuleSnapshotPost' required: true x-codegen-request-body-name: rules responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyRuleSnapshotResponse' x-codegen-request-body-name: rules delete: tags: - Policies summary: Pure Storage Delete Snapshot Policy Rules description: 'Deletes one or more snapshot policy rules. The `policy_ids` or `policy_names` parameter is required, but cannot be set together. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' responses: '200': description: OK content: {} patch: tags: - Policies summary: Pure Storage Modify Snapshot Policy Rules description: 'Modifies one or more snapshot policy rules. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyRuleSnapshotPatch' required: true x-codegen-request-body-name: rules responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyRuleSnapshotResponse' x-codegen-request-body-name: rules /api/2.52/policies/user-group-quota: get: tags: - Policies summary: Pure Storage List User-group-quota Policies description: 'Displays a list of user-group-quota policies. ' 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' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyGetResponse' '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/PolicyGetResponse' post: tags: - Policies summary: Pure Storage Create User-group-quota Policies description: 'Creates one or more user-group-quota policies. To copy a policy, the `source_names` or `source_ids` parameter is required, but they cannot be set together. To create a policy from scratch, policy body is required. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Source_ids' - $ref: '#/components/parameters/Source_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyPost' required: false x-codegen-request-body-name: policy responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyResponse' x-codegen-request-body-name: policy delete: tags: - Policies summary: Pure Storage Delete User-group-quota Policies description: 'Deletes one or more user-group-quota policies. 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/Ids' - $ref: '#/components/parameters/Names' responses: '200': description: OK content: {} patch: tags: - Policies summary: Pure Storage Modify User-group-quota Policies description: 'Modifies one or more user-group-quota policies. To enable a policy, set `enabled=true`. To disable a policy, set `enabled=false`. To rename a policy, set `name` to the new name. 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/Ids' - $ref: '#/components/parameters/Ignore_usageUserGroupQuota' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyPatch' required: true x-codegen-request-body-name: policy responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyResponse' x-codegen-request-body-name: policy /api/2.52/policies/user-group-quota/members: get: tags: - Policies summary: Pure Storage List User-group-quota Policy Members description: 'Displays a list of user-group-quota policy 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/Destroyed' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_types' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberGetResponse' '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/PolicyMemberGetResponse' post: tags: - Policies summary: Pure Storage Create a Membership Between a Managed Directory and a User-group-quota Policy description: 'Creates a membership between one or more managed directories and a user-group-quota policy. The `policy_ids` or `policy_names` parameter is required, but cannot be set together. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ignore_usageUserGroupQuota' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyMemberPost' required: true x-codegen-request-body-name: members responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberResponse' x-codegen-request-body-name: members delete: tags: - Policies summary: Pure Storage Delete Membership Between User-group-quota Policies and Managed Directories description: 'Deletes a membership between one or more user-group-quota policies and managed directories. The `policy_ids` or `policy_names` parameter is required, but cannot be set together. The `member_ids` or `member_names` parameter is required, but cannot be set together. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ignore_usageUserGroupQuota' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_types' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' responses: '200': description: OK content: {} /api/2.52/policies/user-group-quota/rules: get: tags: - Policies summary: Pure Storage List User-group-quota Policy Rules description: 'Displays a list of user-group-quota policy rules. ' 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/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyRuleUserGroupQuotaGetResponse' '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/PolicyRuleUserGroupQuotaGetResponse' post: tags: - Policies summary: Pure Storage Create User-group-quota Policy Rules description: 'Creates one or more user-group-quota policy rules. The `policy_ids` or `policy_names` parameter is required, but cannot be set together. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ignore_usageUserGroupQuota' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyRuleUserGroupQuotaPost' required: true x-codegen-request-body-name: rules responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyRuleUserGroupQuotaResponse' x-codegen-request-body-name: rules delete: tags: - Policies summary: Pure Storage Delete Quota Policy Rules description: 'Deletes one or more user-group-quota policy rules. The `policy_ids` or `policy_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/Ignore_usageUserGroupQuota' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' responses: '200': description: OK content: {} patch: tags: - Policies summary: Pure Storage Modify User-group-quota Policy Rules description: 'Modifies user-group-quota policy rules. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ignore_usageUserGroupQuota' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyRuleUserGroupQuotaPatch' required: true x-codegen-request-body-name: rules responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyRuleUserGroupQuotaResponse' x-codegen-request-body-name: rules /api/1.5/policies: get: tags: - Policies summary: Pure Storage Get Policies description: 'Retrieves policies and their rules. ' parameters: - $ref: '#/components/parameters/Authorization_2' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token_2' - $ref: '#/components/parameters/Filter_2' - $ref: '#/components/parameters/Ids_2' - $ref: '#/components/parameters/Limit_2' - $ref: '#/components/parameters/Names_2' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Sort_2' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string X-RateLimit-Remaining-second: description: 'The number of requests remaining for the organization in that second. ' schema: type: integer X-RateLimit-Remaining-minute: description: 'The number of requests remaining for the organization in that minute. ' schema: type: integer X-RateLimit-Limit-second: description: The number of requests available per second. schema: type: integer X-RateLimit-Limit-minute: description: The number of requests available per minute. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/PolicyGetResponse_2' '400': $ref: '#/components/responses/Error400' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '429': $ref: '#/components/responses/Error429' '500': $ref: '#/components/responses/Error500' /api/1.5/policies/file-systems: get: tags: - Policies summary: Pure Storage Get Policy / FlashBlade File System Pairs description: 'Retrieves pairs of policy references and their FlashBlade file system members. ' parameters: - $ref: '#/components/parameters/Authorization_2' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token_2' - $ref: '#/components/parameters/Filter_2' - $ref: '#/components/parameters/Limit_2' - $ref: '#/components/parameters/Member_ids_2' - $ref: '#/components/parameters/Member_names_2' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Policy_ids_2' - $ref: '#/components/parameters/Policy_names_2' - $ref: '#/components/parameters/Sort_2' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string X-RateLimit-Remaining-second: description: 'The number of requests remaining for the organization in that second. ' schema: type: integer X-RateLimit-Remaining-minute: description: 'The number of requests remaining for the organization in that minute. ' schema: type: integer X-RateLimit-Limit-second: description: The number of requests available per second. schema: type: integer X-RateLimit-Limit-minute: description: The number of requests available per minute. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/PolicyMembersGetResponse' '400': $ref: '#/components/responses/Error400' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '429': $ref: '#/components/responses/Error429' '500': $ref: '#/components/responses/Error500' /api/1.5/policies/file-system-replica-links: get: tags: - Policies summary: Pure Storage Get Policy / FlashBlade File System Replica Link Pairs description: 'Retrieves pairs of policy references and their FlashBlade file system replica link members. ' parameters: - $ref: '#/components/parameters/Authorization_2' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token_2' - $ref: '#/components/parameters/Filter_2' - $ref: '#/components/parameters/Limit_2' - $ref: '#/components/parameters/Member_ids_2' - $ref: '#/components/parameters/Member_names_2' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Policy_ids_2' - $ref: '#/components/parameters/Policy_names_2' - $ref: '#/components/parameters/Sort_2' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string X-RateLimit-Remaining-second: description: 'The number of requests remaining for the organization in that second. ' schema: type: integer X-RateLimit-Remaining-minute: description: 'The number of requests remaining for the organization in that minute. ' schema: type: integer X-RateLimit-Limit-second: description: The number of requests available per second. schema: type: integer X-RateLimit-Limit-minute: description: The number of requests available per minute. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/PolicyMembersGetResponse' '400': $ref: '#/components/responses/Error400' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '429': $ref: '#/components/responses/Error429' '500': $ref: '#/components/responses/Error500' /api/1.5/policies/file-system-snapshots: get: tags: - Policies summary: Pure Storage Get Policy / FlashBlade File System Snapshot Pairs description: 'Retrieves pairs of policy references and their FlashBlade file system snapshot members. ' parameters: - $ref: '#/components/parameters/Authorization_2' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token_2' - $ref: '#/components/parameters/Filter_2' - $ref: '#/components/parameters/Limit_2' - $ref: '#/components/parameters/Member_ids_2' - $ref: '#/components/parameters/Member_names_2' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Policy_ids_2' - $ref: '#/components/parameters/Policy_names_2' - $ref: '#/components/parameters/Sort_2' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string X-RateLimit-Remaining-second: description: 'The number of requests remaining for the organization in that second. ' schema: type: integer X-RateLimit-Remaining-minute: description: 'The number of requests remaining for the organization in that minute. ' schema: type: integer X-RateLimit-Limit-second: description: The number of requests available per second. schema: type: integer X-RateLimit-Limit-minute: description: The number of requests available per minute. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/PolicyMembersGetResponse' '400': $ref: '#/components/responses/Error400' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '429': $ref: '#/components/responses/Error429' '500': $ref: '#/components/responses/Error500' /api/1.5/policies/members: get: tags: - Policies summary: Pure Storage Get Policy / Member Pairs description: 'Retrieves pairs of policy references and their members. ' parameters: - $ref: '#/components/parameters/Authorization_2' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token_2' - $ref: '#/components/parameters/Filter_2' - $ref: '#/components/parameters/Limit_2' - $ref: '#/components/parameters/Member_ids_2' - $ref: '#/components/parameters/Member_names_2' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Policy_ids_2' - $ref: '#/components/parameters/Policy_names_2' - $ref: '#/components/parameters/Sort_2' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string X-RateLimit-Remaining-second: description: 'The number of requests remaining for the organization in that second. ' schema: type: integer X-RateLimit-Remaining-minute: description: 'The number of requests remaining for the organization in that minute. ' schema: type: integer X-RateLimit-Limit-second: description: The number of requests available per second. schema: type: integer X-RateLimit-Limit-minute: description: The number of requests available per minute. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/PolicyMembersGetResponse' '400': $ref: '#/components/responses/Error400' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '429': $ref: '#/components/responses/Error429' '500': $ref: '#/components/responses/Error500' components: parameters: Fqnames: name: names in: query description: 'Performs the operation on the unique name specified. Enter multiple names in comma-separated format. The name is expected to be fully qualified, meaning if the object is contained in some context, the corresponding name would provide complete information about the containment hierarchy. For example, `name01,pod01::name01`. ' style: form explode: false schema: type: array items: type: string Offset_2: name: offset in: query description: 'The offset of the first resource to return from a collection. ' schema: type: integer format: int32 minimum: 0 Workload_ids: name: workload_ids in: query description: 'A comma-separated list of workload IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `workload_names` query parameter. ' style: form explode: false schema: type: array items: type: string Authorization_2: name: Authorization in: header description: 'Access token (in JWT format) required to use any API endpoint (except `/oauth2`) ' schema: type: string Ids: name: ids in: query description: "A comma-separated list of 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 Policy_names_2: name: policy_names in: query description: 'A comma-separated list of policy names. If there is not at least one resource that matches each `policy_name` element, an error is returned. Single quotes are required around all strings. ' style: form explode: false schema: type: array items: type: string x-quoted: true x-quoted: true Filter_2: name: filter in: query description: 'Exclude resources that don''t match the specified criteria. Single quotes are required around all strings inside the filters. ' schema: type: string 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 Policy_idsUnrestricted: name: policy_ids in: query description: 'Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in a comma-separated format. ' 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 Policy_ids: name: policy_ids in: query description: 'Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together. ' style: form explode: false schema: type: array items: type: string Continuation_token: name: continuation_token in: query description: 'A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters. ' schema: type: string XRequestId: name: X-Request-ID in: header description: 'Supplied by client during request or generated by server. ' schema: type: string Limit_2: name: limit in: query description: 'Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client''s page size request. If not specified, defaults to 1000. ' schema: type: integer format: int32 Limit: name: limit in: query description: 'Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. ' schema: type: integer format: int32 minimum: 0 example: 10 Policy_fqnames: name: policy_names in: query description: 'Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. The name is expected to be fully qualified, meaning if the object is contained in some context, the corresponding name would provide complete information about the containment hierarchy. For example, `policy01,pod01::policy01`. ' 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 Sort_2: name: sort in: query description: 'Sort the response by the specified fields (in descending order if ''-'' is appended to the field name). If you provide a sort you will not get a continuation token in the response. ' style: form explode: false schema: type: array items: pattern: ^[a-z]+(_[a-z]+)*-? type: string Ids_2: name: ids in: query description: 'A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings. ' style: form explode: false schema: type: array items: type: string x-quoted: true x-quoted: true Server_fqnames: name: server_names in: query description: 'Server names providing the context for the operation. Names are expected to be fully qualified, meaning if the object is contained in some context, the corresponding name would provide complete information about the containment hierarchy. For example, `server01,server02`. ' style: form explode: false schema: type: array items: type: string Member_names_2: name: member_names in: query description: 'A comma-separated list of member names. If there is not at least one resource that matches each `member_name` element, an error is returned. Single quotes are required around all strings. ' style: form explode: false schema: type: array items: type: string x-quoted: true x-quoted: true Names_required: name: names in: query description: 'Performs the operation on the unique name specified. For example, `name01`. Enter multiple names in comma-separated format. ' required: true style: form explode: false schema: type: array items: type: string Policy_ids_2: name: policy_ids in: query description: 'A comma-separated list of policy IDs. If there is not at least one resource that matches each `policy_id` element, an error is returned. Single quotes are required around all strings. ' style: form explode: false schema: type: array items: type: string x-quoted: true x-quoted: true Filter: 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 Ignore_usage: name: ignore_usage in: query description: 'Flag used to override checks for quota management operations. If set to `true`, directory usage is not checked against the `quota_limits` that are set. If set to `false`, the actual logical bytes in use are prevented from exceeding the limits set on the directory. Client operations might be impacted. If the limit exceeds the quota, the client operation is not allowed. If not specified, defaults to `false`. ' schema: type: boolean Policy_names: name: policy_names in: query description: 'Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`. ' 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 Continuation_token_2: name: continuation_token in: query description: 'An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings. ' schema: type: string x-quoted: true x-quoted: true 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 Source_names: name: source_names in: query description: 'Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, `name01,name02`. ' style: form explode: false schema: type: array items: type: string Source_ids: name: source_ids in: query description: 'Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format. ' style: form explode: false schema: type: array items: type: string Exclude_rules: name: exclude_rules in: query description: 'If true, the rules field in each policy will be null. If false, each returned policy will include its list of rules in the response. If not specified, defaults to `false`. ' 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 Member_ids_2: name: member_ids in: query description: 'A comma-separated list of member IDs. If there is not at least one resource that matches each `member_id` element, an error is returned. Single quotes are required around all strings. ' style: form explode: false schema: type: array items: type: string x-quoted: true x-quoted: true Workload_names: name: workload_names in: query description: 'A comma-separated list of workload names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `workload_ids` query parameter. ' style: form explode: false schema: type: array items: type: string Ignore_usageUserGroupQuota: name: ignore_usage in: query description: 'Flag used to override checks for user-group-quota management operations. If set to `true`, user/group usage is not checked against the `quota_limits` of user-group-quota rules. If set to `false`, the impact of the user-group-quota operation is checked against the user/group usage in the managed directory and its ancestors and the operation is not allowed if the user/group usage would exceed any enforced user-group-quota limits. If not specified, defaults to `false`. ' schema: type: boolean Member_idsUnrestricted: name: member_ids in: query description: 'Performs the operation on the unique member IDs specified. Enter multiple member IDs in a comma-separated format. ' style: form explode: false schema: type: array items: type: string Member_types: name: member_types in: query description: 'Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include `directories`. Enter multiple member types in comma-separated format. For example, `type01,type02`. ' style: form explode: false schema: type: array items: type: string Names_2: name: names in: query description: 'A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings. ' style: form explode: false schema: type: array items: type: string x-quoted: true x-quoted: true Names: name: names in: query description: 'Performs the operation on the unique names specified. Enter multiple names in comma-separated format. For example, `name01,name02`. If there is not at least one resource that matches each of the elements of `names`, then an error is returned, except when creating new resources. ' style: form explode: false schema: type: array items: type: string Context_names_get: name: context_names in: query description: 'Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet or the name of the fleet itself. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided `context`. Enter multiple names in comma-separated format. For example, `name01,name02`. ' style: form explode: false schema: type: array items: type: string Server_ids: name: server_ids in: query description: 'A comma-separated list of server 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 schemas: PolicyRuleAlertWatcherPost: type: object properties: rules: description: A list of alert-watcher policy rules to create. type: array items: $ref: '#/components/schemas/_policyrulealertwatcherpostRules' _timeAware: type: object properties: _as_of: description: The freshness of the data (timestamp in millis since epoch). type: integer format: int64 readOnly: true example: 1502729489760 PolicyPasswordResponse: type: object properties: items: description: 'Returns a list of all items after filtering. If applicable, the values are displayed for each name. ' type: array items: $ref: '#/components/schemas/PolicyPassword' ErrorNoContext: type: object properties: message: type: string example: Something was wrong PolicyManagementAccessPost: allOf: - $ref: '#/components/schemas/PolicyPost' - type: object properties: aggregation_strategy: description: 'When set to `least-common-permissions`, any users to whom this policy applies can receive no access rights exceeding those defined in this policy''s capability and resource. When this is set to `all-permissions`, any users to whom this policy applies are capable of receiving additional access rights from other policies that apply to them. If not specified, defaults to `all-permissions`. ' type: string rules: description: 'List the rules that defines the scoped roles. ' type: array items: $ref: '#/components/schemas/_policyrulemanagementaccessRules' PolicyLockableResponse: 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/PolicyLockable' PolicyResponse_2: type: object properties: items: type: array items: $ref: '#/components/schemas/Policy_2' PolicyQuota: allOf: - $ref: '#/components/schemas/_policy_base' - type: object properties: destroyed: description: 'Returns a value of `true` if the policy has been destroyed and is pending eradication. The `time_remaining` value displays the amount of time left until the destroyed policy is permanently eradicated. Once the `time_remaining` period has elapsed, the policy is permanently eradicated and can no longer be recovered. ' type: boolean enabled: description: 'Returns a value of `true` if the policy is enabled. ' type: boolean pod: description: 'A reference to the pod. ' title: Reference allOf: - $ref: '#/components/schemas/_reference' time_remaining: description: 'The amount of time left, measured in milliseconds, until the destroyed policy is permanently eradicated. ' type: integer format: int64 readOnly: true workload: $ref: '#/components/schemas/_workloadConfigurationFixedReference' _policyruleusergroupquotapostRules: type: object properties: enforced: description: 'If set to `true`, the quota is enforced and an out-of-space warning is issued if logical space usage exceeds the specified limit. If set to `false`, the quota is not enforced and alerts and/or notifications are issued when logical space usage exceeds the limit value. If not specified, defaults to `false`. ' type: boolean notifications: description: 'Targets to notify when usage approaches or exceeds the quota limit. Valid non-empty values are `account` or `none`. The `account` value specifies that the user or group owning the usage will be notified, `none` specifies that notifications are not sent. If not specified, we assume `none`. ' type: array items: type: string quota_limit: description: 'Logical space limit of the quota (in bytes) assigned by the rule. This value cannot be negative. ' title: Policy_rule_user_group_quota_limit_type allOf: - $ref: '#/components/schemas/_policy_rule_user_group_quota_limit_type' quota_type: description: 'Specifies the type of quota rule. Valid values are `user-default`, `user`, `user-group-member`, `group-default` and `group`. Every user-group-quota rule requires a mandatory rule type. ' type: string subject: description: 'The subject for which the rule applies. Rules of quota type `user`, `user-group-member`, `group` require a non-empty subject, while rules of quota type `user-default` and `group-default` do not have a subject. The subject identifies the accounts for which the quota rule applies. ' title: PolicyruleusergroupquotaSubject allOf: - $ref: '#/components/schemas/_policyruleusergroupquotaSubject' PolicyRuleQuota: allOf: - $ref: '#/components/schemas/_context' - type: object properties: destroyed: description: 'Returns a value of `true` if the pod containing the quota policy rule has been destroyed and is pending eradication. The `time_remaining` value displays the amount of time left until the destroyed policy is permanently eradicated. Once the `time_remaining` period has elapsed, the quota policy rule is permanently eradicated and can no longer be recovered. ' type: boolean enforced: description: 'Defines whether the quota rule is enforced or unenforced. If the quota rule is enforced and logical space usage exceeds the quota limit, any modification operations that result in a need for more space are blocked. If the quota rule is unenforced and logical space usage exceeds the quota limit, notification emails are sent to targets that are specified using the `notification` parameter. No client operations are blocked when an unenforced limit is exceeded. If set to `true`, the limit is enforced. If set to `false`, notification targets are informed when the usage exceeds 80 percent of the limit. ' type: boolean readOnly: true name: description: 'Name of this rule. The name is automatically generated by the system. ' type: string readOnly: true notifications: description: 'Targets to notify when usage approaches the quota limit. The list of notification targets is a comma-separated string. Valid values are `user`, and `group`. If not specified, notification targets are not assigned for the rule. ' type: string readOnly: true policy: description: The policy to which this rule belongs. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' quota_limit: description: 'Logical space limit of the quota assigned by the rule, measured in bytes. This value cannot be set to 0. ' type: integer format: int64 readOnly: true time_remaining: description: 'The amount of time left, in milliseconds, until the destroyed quota policy rule is permanently eradicated. ' type: integer format: int64 readOnly: true PolicySmbPost: allOf: - $ref: '#/components/schemas/PolicyPost' - type: object properties: access_based_enumeration_enabled: description: 'If set to `true`, enables access based enumeration on the policy. When access based enumeration is enabled on a policy, files and folders within exports that are attached to the policy will be hidden from users who do not have permission to view them. If not specified, defaults to `false`. ' type: boolean continuous_availability_enabled: description: 'Returns a value of `true` if continuous availability is enabled on the policy. When continuous availability is enabled on a policy, file shares are accessible during otherwise disruptive scenarios such as temporary network outages, controller upgrades or failovers. If not specified, defaults to `false`. ' type: boolean policy_mapping: $ref: '#/components/schemas/_policynfspostPolicyMapping' PolicyRuleAlertWatcherPatch: type: object properties: rules: description: 'Updates an alert-watcher rule in a policy. Only one update object will be accepted. ' type: array maxItems: 1 items: $ref: '#/components/schemas/_policyrulealertwatcherpatchRules' PolicyLockableEradicationConfig: description: The configuration of the eradication feature. type: object properties: manual_eradication: description: 'Manual eradication status of snapshot policies. If manual_eradication is `disabled`, you cannot delete snapshot policies. Values include `disabled` and `enabled`. ' type: string readOnly: true example: enabled x-readOnly: true _policy_rule: description: A rule that can be added to a policy. type: object properties: at: description: 'Time of day to take the snapshot, in milliseconds since 00:00 in the specified `time_zone`. Only valid if `every` is set as whole days. ' type: integer format: int64 example: 32400000 every: description: How often to take snapshots, in milliseconds. type: integer format: int64 example: 86400000 keep_for: description: How long to keep snapshots, in milliseconds. type: integer format: int64 example: 86400000 time_zone: description: The time zone in which the `at` rule is applied. type: string example: America/Los_Angeles PolicyRuleNetworkAccessPost: type: object properties: rules: description: A list of network access policy rules to create. type: array items: $ref: '#/components/schemas/_policyrulenetworkaccesspostRules' _policyrulequotapatchRules: allOf: - type: object properties: enforced: description: 'The enforcement state of the quota rule. When set to `true`, the rule describes an enforced quota where an out-of-space warning is issued if logical space usage exceeds the limit. When set to `false`, the rule describes an unenforced quota where alerts or notifications are issued when usage exceeds the limit. ' type: boolean notifications: description: 'The entities to notify when usage approaches the quota limit, represented as a `comma-separated string`. Valid values include `user`, `group`, or both. Specifying `none` indicates that no targets should be notified. ' type: string - $ref: '#/components/schemas/_policy_rule_user_group_quota_limit_patch' PolicyManagementAccess: allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_context' - type: object properties: aggregation_strategy: description: 'When this is set to `least-common-permissions`, any users to whom this policy applies can receive no access rights exceeding those defined in this policy''s rules. When this is set to `all-permissions`, any users to whom this policy applies are capable of receiving additional access rights from other policies that apply to them. ' type: string enabled: description: 'Returns a value of `true` if the policy is enabled. ' type: boolean policy_type: description: 'The type of policy. Valid values include `management-access`, `autodir`, `nfs`, `smb`, `snapshot`, and `quota`. ' type: string readOnly: true rules: description: 'List the rules that defines the scoped roles. ' type: array items: $ref: '#/components/schemas/_policyrulemanagementaccessRules' PolicySmbGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicySmbResponse' - $ref: '#/components/schemas/_errorContextResponse' PolicyRuleAlertWatcher: allOf: - $ref: '#/components/schemas/_context' - type: object properties: alert_closure_notification: description: 'The configuration for sending notifications when an alert is closed. Valid values include `enable`, which triggers a notification upon alert closure, and `disable`, which suppresses it. ' type: string email: description: 'The email address that will receive the alert notification emails. ' type: string excluded_codes: description: 'An alert with one of these codes will not have emails sent to the recipient. Cannot be specified with `include_codes`. If specified while `include_codes` is already set, `include_codes` will be cleared. Use "" to clear. If both `exclude_codes` and `include_codes` are cleared, defaults to an empty list for `exclude_codes` and emails for all alert codes will be sent. ' type: array items: type: integer format: int32 example: 101 included_codes: description: 'An alert must have one of these codes in order for emails to be sent to the recipient. Cannot be specified with `exclude_codes`. If specified while `exclude_codes` is already set, `exclude_codes` will be cleared. Use "" to clear. If both `exclude_codes` and `include_codes` are cleared, defaults to an empty list for `exclude_codes` and emails for all alert codes will be sent. ' type: array items: type: integer format: int32 example: 101 minimum_notification_severity: description: 'The minimum severity that an alert must have in order for emails to be sent to the recipient. Possible values include `info`, `warning`, and `critical`. ' type: string name: description: 'Name of this rule. The name is automatically generated by the system. ' type: string readOnly: true policy: description: The policy to which this rule belongs. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' PolicyMemberCleanGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyMemberCleanResponse' - $ref: '#/components/schemas/_errorContextResponse' PolicyRuleNfsClientGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyRuleNfsClientResponse' - $ref: '#/components/schemas/_errorContextResponse' PolicyRuleSmbClientPost: type: object properties: rules: description: A list of SMB policy rules to create. type: array items: $ref: '#/components/schemas/_policyrulesmbclientpostRules' PolicyLockableGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyLockableResponse' - $ref: '#/components/schemas/_errorContextResponse' PolicyNfsPatch: allOf: - $ref: '#/components/schemas/PolicyPatch' - type: object properties: nfs_version: description: 'NFS protocol version allowed for the export to set for the policy. This operation updates all rules of the specified policy. Valid values are `nfsv3` and `nfsv4`. ' type: array items: type: string example: nfsv3 security: description: 'The security flavors to use for accessing files on this mount point. Values include `auth_sys`, `krb5`, `krb5i`, and `krb5p`. If the server does not support the requested flavor, the mount operation fails. This operation updates all rules of the specified policy. If `auth_sys`, the client is trusted to specify the identity of the user. If `krb5`, cryptographic proof of the identity of the user is provided in each RPC request. This provides strong verification of the identity of users accessing data on the server. Note that additional configuration besides adding this mount option is required to enable Kerberos security. If `krb5i`, integrity checking is added to krb5. This ensures the data has not been tampered with. If `krb5p`, integrity checking and encryption is added to `krb5`. This is the most secure setting, but it also involves the most performance overhead. ' type: array items: type: string example: auth_sys user_mapping_enabled: description: 'If set to `true`, FlashArray queries the joined AD/OpenLDAP server to find the user corresponding to the incoming UID. If set to `false`, users are defined by UID/GID pair. ' type: boolean PolicySmbResponse: 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/PolicySmb' PolicyManagementAccessResponse: 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/PolicyManagementAccess' PolicyRuleSnapshotPatch: type: object properties: rules: description: 'A list of snapshot policy rules to modify. ' type: array items: $ref: '#/components/schemas/_policyrulesnapshotpatchRules' PolicyRuleObjectStoreAccess: allOf: - $ref: '#/components/schemas/_builtInResourceNoId' - $ref: '#/components/schemas/_policyRuleObjectStoreAccessBase' PolicyMemberCleanResponse: 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/PolicyMemberClean' _builtInAsOf: description: 'A built-in resource. Many are singletons predefined by Purity (e.g., support settings). Some correspond to a piece of software, like an app, or hardware, like a controller. Others are created by the system in response to some event (e.g., alerts, audit records). Typically, a user can''t create, delete or rename a built-in resource. A few can be created or deleted, but not renamed because the names are meaningful to Purity (e.g., VIFs). ' allOf: - $ref: '#/components/schemas/_timeAware' - type: object properties: id: description: A non-modifiable, globally unique ID chosen by the system. type: string readOnly: true example: 01c2889a-4124-49ff-8cbd-c33405ede123 name: description: A non-modifiable, locally unique name chosen by the system. type: string readOnly: true example: example_name PolicyMembersGetResponse: allOf: - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/PolicyMembersResponse' _policyrulealertwatcherpostRules: type: object properties: alert_closure_notification: description: 'The setting that determines whether to send a notification upon alert closure. Valid values include `enable` and `disable`. ' type: string email: description: 'The email address that will receive the alert notification emails. ' type: string excluded_codes: description: 'An alert with one of these codes will not have emails sent to the recipient. Cannot be specified with `include_codes`. If specified while `include_codes` is already set, `include_codes` will be cleared. Use "" to clear. If both `exclude_codes` and `include_codes` are cleared, defaults to an empty list for `exclude_codes`. ' type: array items: type: integer format: int32 example: 101 included_codes: description: 'An alert must have one of these codes in order for emails to be sent to the recipient. Cannot be specified with `exclude_codes`. If specified while `exclude_codes` is already set, `exclude_codes` will be cleared. Use "" to clear. If both `exclude_codes` and `include_codes` are cleared, defaults to an empty list for `exclude_codes`. ' type: array items: type: integer format: int32 example: 101 minimum_notification_severity: description: 'The minimum severity that an alert must have in order for emails to be sent to the recipient. Possible values include `info`, `warning`, and `critical`. If not specified, defaults to `info`. ' type: string _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 PolicyMembersResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/PolicyMember_2' PolicyMember: allOf: - $ref: '#/components/schemas/_policy_member_base' - type: object properties: destroyed: description: 'Returns a value of `true` if the member is destroyed. ' type: boolean readOnly: true enabled: description: 'Returns a value of `true` if the policy is enabled. ' type: boolean readOnly: true time_remaining: description: 'The amount of time left, in milliseconds, until the destroyed policy member is permanently eradicated. ' type: integer format: int64 readOnly: true PolicyRuleQuotaResponse: 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/PolicyRuleQuota' PolicyAuditFilePatch: allOf: - $ref: '#/components/schemas/PolicyPatch' - type: object properties: log_targets: description: 'A list of targets to which audit logs will be sent. This list, if sent, overrides existing target list. ' type: array items: $ref: '#/components/schemas/_referenceNoIdWithType' PolicyRuleUserGroupQuotaResponse: 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/PolicyRuleUserGroupQuota' _referenceNoId: type: object properties: name: description: 'The resource name, such as volume name, pod name, snapshot name, and so on. ' type: string ObjectStoreAccessPolicyRuleResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/PolicyRuleObjectStoreAccess' _newName: type: object properties: name: description: The new name for the resource. type: string _errorErrors: type: object properties: context: type: string example: Error with ... message: type: string example: Something was wrong PolicyAuditFileGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyAuditFileResponse' - $ref: '#/components/schemas/_errorContextResponse' _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 _arrays: type: object properties: arrays: description: 'The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays. ' type: array readOnly: true items: $ref: '#/components/schemas/_fixedReferenceFqdn' x-readOnly: true _policyrulenfsclientpostRules: type: object properties: access: description: 'Specifies access control for the export. Valid values include `root-squash`, `all-squash`, and `no-root-squash`. The value `root-squash` prevents client users and groups with root privilege from mapping their root privilege to a file system. All users with UID 0 will have their UID mapped to `anonuid`. All users with GID 0 will have their GID mapped to `anongid`. The value `all-squash` maps all UIDs (including root) to `anonuid` and all GIDs (including root) to `anongid`. The value `no-root-squash` allows users and groups to access the file system with their UIDs and GIDs. If not specified, the default value is `root-squash`. ' type: string anongid: description: 'Any user whose GID is affected by an `access` of `root_squash` or `all_squash` will have their GID mapped to `anongid`. The default `anongid` is null, which means 65534. Use "" to clear. This value is ignored when user mapping is enabled. ' type: string example: '65530' anonuid: description: 'Any user whose UID is affected by an `access` of `root_squash` or `all_squash` will have their UID mapped to `anonuid`. The default `anonuid` is null, which means 65534. Use "" to clear. ' type: string example: '65530' client: description: 'Specifies which clients are given access. Valid values include `IP`, `IP mask`, or `hostname`. The default is `*` if not specified. ' type: string nfs_version: description: 'NFS protocol version allowed for the export. Valid values are `nfsv3` and `nfsv4`. If not specified, defaults to `nfsv3`. ' type: array items: type: string example: nfsv3 permission: description: 'Specifies which read-write client access permissions are allowed for the export. Values include `rw` and `ro`. The default value is `rw` if not specified. ' type: string security: description: 'The security flavors to use for accessing files on this mount point. Values include `auth_sys`, `krb5`, `krb5i`, and `krb5p`. If the server does not support the requested flavor, the mount operation fails. This operation updates all rules of the specified policy. If `auth_sys`, the client is trusted to specify the identity of the user. If `krb5`, cryptographic proof of the identity of the user is provided in each RPC request. This provides strong verification of the identity of users accessing data on the server. Note that additional configuration besides adding this mount option is required to enable Kerberos security. If `krb5i`, integrity checking is added to krb5. This ensures the data has not been tampered with. If `krb5p`, integrity checking and encryption is added to krb5. This is the most secure setting, but it also involves the most performance overhead. ' type: array items: type: string example: auth_sys PolicyPasswordGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyPasswordResponse' - $ref: '#/components/schemas/_errorContextResponse' PolicyRuleSmbClient: allOf: - $ref: '#/components/schemas/_context' - type: object properties: anonymous_access_allowed: description: 'Specifies whether access to information is allowed for anonymous users. Returns a value of `false` if not specified. ' type: boolean readOnly: true client: description: 'Specifies which clients are given access to the export. Accepted notation includes IP, IP mask, or hostname. The default is `*` if not specified. ' type: string readOnly: true destroyed: description: 'Returns a value of `true` if the pod containing the SMB policy rule has been destroyed and is pending eradication. The `time_remaining` value displays the amount of time left until the destroyed policy is permanently eradicated. Once the `time_remaining` period has elapsed, the SMB policy rule is permanently eradicated and can no longer be recovered. ' type: boolean name: description: 'Name of this rule. The name is automatically generated by the system. ' type: string readOnly: true policy: description: The policy to which this rule belongs. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' smb_encryption_required: description: 'Specifies whether the remote client is required to use SMB encryption. If not specified, defaults to `false`. ' type: boolean readOnly: true time_remaining: description: 'The amount of time left, in milliseconds, until the destroyed SMB policy rule is permanently eradicated. ' type: integer format: int64 readOnly: true PolicyGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyResponse' - $ref: '#/components/schemas/_errorContextResponse' PolicyGetResponse_2: allOf: - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/PolicyResponse_2' _arraysBuiltIn: description: 'A built-in resource that exists on one or multiple arrays. ' allOf: - $ref: '#/components/schemas/_builtInAsOf' - $ref: '#/components/schemas/_arrays' PolicyMember_2: description: An association between a policy and a member. allOf: - $ref: '#/components/schemas/_timeAware' - type: object properties: member: $ref: '#/components/schemas/_fixedReference_2' policy: $ref: '#/components/schemas/_fixedReference_2' _policyrulenetworkaccesspostRules: type: object properties: client: description: 'The clients that are permitted or denied access to the interface. Valid notations include a single `IP address`, a `subnet` in `CIDR` notation, or all clients, specified as `*`. The default value is `*` if the property is not specified. ' type: string example: 1.2.3.4 effect: description: 'The setting that determines whether the specified client is permitted or denied access to the specified interfaces. Valid values include `allow` and `deny`. The default value is `allow` if the property is not specified. ' type: string index: description: 'The position of the rule within the policy, which determines the numerical order in which rules are evaluated. ' type: integer format: int32 interfaces: description: 'The specific product interfaces to which the rule applies. Valid interface values include `management-ssh`, `management-rest-api`, `management-rest-api-v1`, `management-rest-api-v2`, `management-web-ui`, and `snmp`. ' type: array items: type: string PolicyAuditFilePost: allOf: - $ref: '#/components/schemas/PolicyPost' - type: object properties: log_targets: description: 'A list of targets to which audit logs will be sent. ' type: array items: $ref: '#/components/schemas/_referenceNoIdWithType' PolicyRuleSnapshotPost: type: object properties: rules: description: A list of snapshot policy rules to create. type: array items: $ref: '#/components/schemas/_policyrulesnapshotpostRules' _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 _policyruleusergroupquotaSubject: type: object properties: id: description: 'The subject User Identifier (UID) or Group Identifier (GID). Exactly one of `name`, `id`, `sid` is required. ' type: integer format: int64 name: description: 'The subject name. Retrieves all accounts matching this name. The name can have a `@domain` suffix to reduce ambiguity. Exactly one of `name`, `id`, or `sid` is required. ' type: string sid: description: 'The subject Security Identifier (SID), which uniquely identifies a user or group. Exactly one of `name`, `id`, or `sid` is required. ' type: string PolicyQuotaGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyQuotaResponse' - $ref: '#/components/schemas/_errorContextResponse' PolicyRuleNetworkAccessResponse: 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/PolicyRuleNetworkAccess' PolicyRuleAlertWatcherGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyRuleAlertWatcherResponse' - $ref: '#/components/schemas/_errorContextResponse' _policy_member_base: allOf: - $ref: '#/components/schemas/_context' - type: object properties: member: description: The reference to the resource targeted by the policy. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' policy: description: The reference to the policy. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' _serverReference: description: 'An object that is server-aware and can be associated to a server. ' type: object properties: server: description: 'Reference to the server the object belongs to. When the value is empty or set to `null` it means the object lives outside of a server scope. ' readOnly: true title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' _policyRuleObjectStoreAccessBase: allOf: - $ref: '#/components/schemas/_context' - type: object description: 'The object store access policy rule defining the actions that can be performed on specific resources. The rule is part of a policy that grants permissions to an object store user. ' properties: actions: description: 'The list of actions granted by this rule. Each included action may restrict other properties of the rule. ' type: array items: type: string example: - '*' - s3:CreateBucket - s3:PutObject effect: description: 'Effect of this rule. When `allow`, the rule allows the given actions to be performed on the given resources, subject to the given conditions. When `deny`, the rule disallows performing the given actions on the given resources, subject to the given condition. This takes precedence over any matching `allow` rules. Valid values include `allow` and `deny`. ' type: string readOnly: true example: allow policy: description: The policy to which this rule belongs. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' resources: description: 'The list of resources which this rule applies to. Each resource can include a bucket component, optionally followed by an object component. The choice of which components a resource can include is dictated by which actions are included in the rule. For further details, see the Object Store Access Policy Actions section of the User Guide. ' type: array items: type: string example: - '*' - mybucket - mybucket* - mybucket*/myobject* _referenceNoIdWithType: allOf: - $ref: '#/components/schemas/_referenceNoId' - type: object properties: resource_type: description: 'Type of the object (full name of the endpoint). Valid values include `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 PolicyMemberResponse: 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/PolicyMember' PolicyMemberGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyMemberResponse' - $ref: '#/components/schemas/_errorContextResponse' TestResultWithResourceGetResponse: allOf: - $ref: '#/components/schemas/TotalItemCountResponse' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: type: array items: $ref: '#/components/schemas/TestResultWithResource' _policyrulesnapshotpatchRules: type: object properties: at: description: 'Specifies the number of milliseconds since midnight at which to take a snapshot. The `at` value can only be set to an hour and must be between 0 and 82800000, inclusive. The `at` value can only be set on the rule with the smallest `every` value. The `at` value cannot be set if the `every` value is not measured in days. The `at` value can only be set for at most one rule in the same policy. ' type: integer format: int64 every: description: 'Specifies the interval between snapshots, in milliseconds. The `every` value for all rules must be multiples of one another. The `every` value must be unique for each rule in the same policy. The `every` value must be between 5 minutes and 1 year. ' type: integer format: int64 keep_for: description: 'Specifies the period that snapshots are retained before they are eradicated, in milliseconds. The `keep_for` value cannot be less than the `every` value of the rule. The `keep_for` value must be unique for each rule in the same policy. The `keep_for` value must be at least 5 minutes. The `keep_for` value cannot be less than the `keep_for` value of any rule in the same policy with a smaller `every` value. ' type: integer format: int64 PolicyAuditFile: allOf: - $ref: '#/components/schemas/Policy' - $ref: '#/components/schemas/_context' - type: object properties: log_targets: description: 'A list of targets to which audit logs will be sent. ' type: array items: $ref: '#/components/schemas/_referenceNoIdWithType' _fixedReferenceFqdn: allOf: - $ref: '#/components/schemas/_fixedReference_2' - type: object properties: fqdn: description: 'The fully qualified domain name of the appliance when `resource_type` is `arrays`, `null` otherwise. ' type: string readOnly: true example: example_name.dc1.example.com _limit_unset_value: type: string minLength: 0 maxLength: 0 PolicyRuleQuotaGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyRuleQuotaResponse' - $ref: '#/components/schemas/_errorContextResponse' PolicyQuotaPatch: allOf: - $ref: '#/components/schemas/_newName' - type: object properties: enabled: description: If set to `true`, the policy is enabled. If set to `false`, the policy is disabled. type: boolean PolicyRuleQuotaPost: type: object properties: rules: description: A list of quota policy rules to create. type: array items: $ref: '#/components/schemas/_policyrulequotapostRules' _fixedReference_2: type: object properties: id: description: The opaque and unique id of this resource. type: string readOnly: true example: 2a989a09-c851-4d52-9ec6-ab728b1c04db name: description: The name of this resource. type: string readOnly: true example: example_name resource_type: description: 'The type of this resource represented by the name of its REST endpoint. For example, "arrays", "network-interfaces", and "metrics". The value may be `null` if the resource is not represented. ' type: string readOnly: true example: example_resource_type x-readOnly: true _policy_rule_user_group_quota_limit_patch: type: object properties: quota_limit: title: PolicyRuleUserGroupQuotaLimitPatch description: 'The logical space limit of the quota, measured in `bytes`, assigned by the rule. The value cannot be `negative`. Specifying an empty string `""` unsets the quota limit. ' oneOf: - $ref: '#/components/schemas/_policy_rule_user_group_quota_limit_type' - $ref: '#/components/schemas/_limit_unset_value' _builtInResourceNoId: 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, file systems, file system snapshots, volume snapshot). ' type: object properties: name: description: 'A locally unique, system-generated name. The name cannot be modified. ' type: string readOnly: true PolicyMemberExportResponse: 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/PolicyMemberExport' 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 ObjectStoreAccessPolicy: allOf: - $ref: '#/components/schemas/_policy_base' - type: object description: 'The object store access policy defines the rules that govern access to object storage resources. It specifies which actions are allowed or denied for users or groups on specific object store resources. ' properties: description: description: 'The description of the policy, optionally specified when the policy is created. The description cannot be modified for an existing policy. ' type: string readOnly: true example: The permissions to use all APIs supported by FlashArray Object Store, including all S3 APIs. rules: type: array items: $ref: '#/components/schemas/PolicyRuleObjectStoreAccess' _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' PolicyRuleQuotaPatch: type: object properties: rules: description: 'Updates rules in a policy and accepts a single-rule update object. The list can contain only one item that will update all the specified rules. ' type: array maxItems: 1 items: $ref: '#/components/schemas/_policyrulequotapatchRules' _policyruleusergroupquotapatchRules: allOf: - type: object properties: enforced: description: 'The enforcement policy for the quota. When set to `true`, the quota is enforced and an out-of-space warning is issued if `logical space` usage exceeds the limit. When set to `false`, the quota is not enforced, and only alerts or notifications are issued upon exceeding the limit. The default value is `false` if the property is not specified. ' type: boolean notifications: description: 'The entities to notify when usage approaches or exceeds the quota limit. Valid non-empty values include `account`, which notifies the `user` or `group` owning the usage, or `none`, which specifies that no notifications are sent. The default value is `none` if the property is not specified. ' type: array items: type: string - $ref: '#/components/schemas/_policy_rule_user_group_quota_limit_patch' PolicyRuleNfsClient: allOf: - $ref: '#/components/schemas/_context' - type: object properties: access: description: 'Specifies access control for the export. Valid values are `root-squash`, `all-squash`, and `no-root-squash`. `root-squash` prevents client users and groups with root privilege from mapping their root privilege to a file system. All users with UID 0 will have their UID mapped to anonuid. All users with GID 0 will have their GID mapped to anongid. `all-squash` maps all UIDs (including root) to anonuid and all GIDs (including root) to anongid. `no-root-squash` allows users and groups to access the file system with their UIDs and GIDs. The default is `root-squash` if not specified. ' type: string readOnly: true anongid: description: 'Any user whose GID is affected by an `access` of `root_squash` or `all_squash` will have their GID mapped to `anongid`. The default `anongid` is null, which means 65534. Use "" to clear. This value is ignored when user mapping is enabled - see User Guide for more details. ' type: string readOnly: true example: '65530' anonuid: description: 'Any user whose UID is affected by an `access` of `root_squash` or `all_squash` will have their UID mapped to `anonuid`. The default `anonuid` is null, which means 65534. Use "" to clear. ' type: string readOnly: true example: '65530' client: description: 'Specifies the clients that will be permitted to access the export. Accepted notation includes IP, IP mask, or hostname. The default is `*` if not specified. ' type: string readOnly: true destroyed: description: 'Returns a value of `true` if the pod containing the NFS policy rule has been destroyed and is pending eradication. The `time_remaining` value displays the amount of time left until the destroyed policy is permanently eradicated. Once the `time_remaining` period has elapsed, the NFS policy rule is permanently eradicated and can no longer be recovered. ' type: boolean name: description: 'Name of this rule. The name is automatically generated by the system. ' type: string readOnly: true nfs_version: description: 'The NFS protocol version allowed for the export. Valid values are `nfsv3` and `nfsv4`. ' type: array items: type: string example: nfsv3 permission: description: 'Specifies which read-write client access permissions are allowed for the export. Valid values are `rw` and `ro`. The default is `rw` if not specified. ' type: string readOnly: true policy: description: The policy to which this rule belongs. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' security: description: 'The security flavors to use for accessing files on this mount point. Values include `auth_sys`, `krb5`, `krb5i`, and `krb5p`. If the server does not support the requested flavor, the mount operation fails. This operation updates all rules of the specified policy. If `auth_sys`, the client is trusted to specify the identity of the user. If `krb5`, cryptographic proof of the identity of the user is provided in each RPC request. This provides strong verification of the identity of users accessing data on the server. Note that additional configuration besides adding this mount option is required to enable Kerberos security. If `krb5i`, integrity checking is added to krb5. This ensures the data has not been tampered with. If `krb5p`, integrity checking and encryption is added to krb5. This is the most secure setting, but it also involves the most performance overhead. ' type: array items: type: string example: auth_sys time_remaining: description: 'The amount of time left, in milliseconds, until the destroyed NFS policy rule is permanently eradicated. ' type: integer format: int64 readOnly: true PolicyMemberExport: allOf: - $ref: '#/components/schemas/_context' - $ref: '#/components/schemas/PolicyMember' - $ref: '#/components/schemas/ExportPolicyAttachmentMixin' - $ref: '#/components/schemas/_serverReference' Error: type: object properties: errors: description: The list of errors encountered. type: array items: $ref: '#/components/schemas/_errorErrors' ExportPolicyAttachmentMixin: type: object properties: enabled: description: 'Returns a value of `true` if and only if the export policy that manages this export is enabled AND this export is enabled. ' type: boolean readOnly: true export_name: description: 'The export name for accessing this export. ' type: string status: description: 'Explains why `enabled` is `false`, or whether there is a name conflict with another export. Valid values include `policy_disabled`, `export_disabled`, and `name_conflict`. ' type: string readOnly: true PolicySmbPatch: allOf: - $ref: '#/components/schemas/PolicyPatch' - type: object properties: access_based_enumeration_enabled: description: 'If set to `true`, enables access based enumeration on the policy. When access based enumeration is enabled on a policy, files and folders within exports that are attached to the policy will be hidden from users who do not have permission to view them. ' type: boolean continuous_availability_enabled: description: 'If set to `true`, enables continuous availability on the policy. When continuous availability is enabled on a policy, file shares are accessible during otherwise disruptive scenarios such as temporary network outages, controller upgrades or failovers. ' type: boolean TestResult: type: object properties: component_address: description: Address of the component running the test. type: string example: 10.230.94.21 component_name: description: Name of the component running the test. type: string example: CT0 description: description: What the test is doing. type: string example: Testing phonehome connectivity destination: description: The URI of the target server being tested. type: string example: ra.cloud-support.purestorage.com enabled: description: 'Whether the object being tested is enabled or not. Returns a value of `true` if the the service is enabled. Returns a value of `false` if the service is disabled. ' type: boolean example: true result_details: description: Additional information about the test result. type: string example: Timeout connecting to phonehome endpoint success: description: 'Whether the object being tested passed the test or not. Returns a value of `true` if the specified test has succeeded. Returns a value of `false` if the specified test has failed. ' type: boolean test_type: description: 'Displays the type of test being performed. The returned values are determined by the `resource` being tested and its configuration. Values include `array-admin-group-searching`, `binding`, `connecting`, `phonehome`, `phonehome-ping`, `remote-assist`, `rootdse-searching`, `read-only-group-searching`, `storage-admin-group-searching`, and `validate-ntp-configuration`. ' type: string example: phonehome _reference: type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified. ' type: string name: description: 'The resource name, such as volume name, pod name, snapshot name, and so on. ' type: string x-aliases: - _referenceWithoutType _policyrulealertwatcherpatchRules: type: object properties: alert_closure_notification: description: 'The setting that determines whether to send a notification upon alert closure. Valid values include `enable` and `disable`. ' type: string email: description: 'The email address that will receive the alert notification emails. ' type: string excluded_codes: description: 'An alert with one of these codes will not have emails sent to the recipient. Cannot be specified with `include_codes`. If specified while `include_codes` is already set, `include_codes` will be cleared. Use "" to clear. If both `exclude_codes` and `include_codes` are cleared, defaults to an empty list for `exclude_codes`. ' type: array items: type: integer format: int32 example: 101 included_codes: description: 'An alert must have one of these codes in order for emails to be sent to the recipient. Cannot be specified with `exclude_codes`. If specified while `exclude_codes` is already set, `exclude_codes` will be cleared. Use "" to clear. If both `exclude_codes` and `include_codes` are cleared, defaults to an empty list for `exclude_codes`. ' type: array items: type: integer format: int32 example: 101 minimum_notification_severity: description: 'The minimum severity that an alert must have in order for emails to be sent to the recipient. Possible values include `info`, `warning`, and `critical`. ' type: string PolicyRuleSmbClientResponse: 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/PolicyRuleSmbClient' _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 PolicyRuleUserGroupQuotaPatch: type: object properties: rules: description: 'Updates the rules in a policy and accepts a single-rule update object. The list can contain only one item that will update all the specified rules. ' type: array maxItems: 1 items: $ref: '#/components/schemas/_policyruleusergroupquotapatchRules' _policy_base: allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_context' - type: object properties: policy_type: description: 'The type of policy. Values include `autodir`, `network-access`, `nfs`, `smb`, `snapshot`, `quota`, and `object-store-access`. ' type: string readOnly: true PolicyMemberObjectStoreAccessGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyMemberObjectStoreAccessResponse' - $ref: '#/components/schemas/_errorContextResponse' _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 PolicyRuleNetworkAccessGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyRuleNetworkAccessResponse' - $ref: '#/components/schemas/_errorContextResponse' PolicyRuleUserGroupQuotaGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyRuleUserGroupQuotaResponse' - $ref: '#/components/schemas/_errorContextResponse' PolicyQuotaResponse: 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/PolicyQuota' _policyrulequotapostRules: type: object properties: enforced: description: 'If set to `true`, this rule describes an enforced quota. An out-of-space warning is issued if logical space usage exceeds the limit value described in this rule. If set to `false`, this rule describes an unenforced quota. Alerts and/or notifications are issued when logical space usage exceeds the limit value described in this rule. If not specified, defaults to `false`. ' type: boolean notifications: description: 'Targets to notify when usage approaches the quota limit. The list of notification targets is a comma-separated string. Valid values are one or more of `user` and `group`. To notify no targets, use `none`. If not specified, defaults to `none`. ' type: string quota_limit: description: 'Logical space limit of the quota (in bytes) assigned by the rule. This value cannot be set to 0. ' title: Policy_rule_user_group_quota_limit_type allOf: - $ref: '#/components/schemas/_policy_rule_user_group_quota_limit_type' PolicyNfs: allOf: - $ref: '#/components/schemas/_context' - $ref: '#/components/schemas/Policy' - type: object properties: nfs_version: description: 'NFS protocol version allowed for the export. If NFS version is allowed for all rules of the policy it is cascaded exactly as: `nfsv3`, `nfsv4`. If the NFS version is supported partially by the rules of the policy it will be cascaded as: `nfsv3-partial`, `nfsv4-partial`. If the NFS version is not supported by any rules or there are no rules of the policy then it will not be in the result array. If there are no rules in the policy the array will be empty. If there are two rules, one supporting `nfsv3` and the other supporting `nfsv3` and `nfsv4` then the array would contain `nfsv3` and `nfsv4-partial`. ' type: array items: type: string example: nfsv3-partial policy_mapping: description: 'Specifies the mapping of this policy across a pod replica link. If this policy is not inside a pod of a pod replica link, mapping is `null`. ' title: PolicyNfsPolicyMapping allOf: - $ref: '#/components/schemas/PolicyNfsPolicyMapping' security: description: 'The security flavors to use for accessing files on this mount point. Values include `auth_sys`, `auth_sys-partial`, `krb5`, `krb5-partial`, `krb5i`, and `krb5p`. If the server does not support the requested flavor, the mount operation fails. If `auth_sys`, the client is trusted to specify the identity of the user. If `krb5`, cryptographic proof of the identity of the user is provided in each RPC request. Note that additional configuration besides adding this mount option is required in order to enable Kerberos security. If `krb5i`, integrity checking is added to krb5, to ensure the data has not been tampered with. If `krb5p`, integrity checking and encryption are added to `krb5`. This is the most secure setting, but it also involves the most performance overhead. If security option is allowed for all rules of the policy, it is cascaded exactly. Examples: `auth_sys`, `krb5`. If the security option is supported partially by the rules of the policy, it will be cascaded with the `-partial` suffix. Examples include: `auth_sys-partial`, `krb5-partial`. If the security option is not supported by any rules or there are no rules of the policy, then it will not be in the result array. If there are no rules in the policy the array of values will be empty. If there are two rules, one supporting auth_sys and the other supporting auth_sys and krb5 the array of values would contain `auth_sys` and `krb5-partial`. ' type: array items: type: string example: auth_sys-partial user_mapping_enabled: description: 'Returns `true` if user mapping is enabled on the policy. If `true`, FlashArray queries the joined AD/OpenLDAP server to find the user corresponding to the incoming UID. If `false`, users are defined by UID/GID pair. ' type: boolean workload: $ref: '#/components/schemas/_workloadConfigurationFixedReference' PolicyRuleSmbClientGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyRuleSmbClientResponse' - $ref: '#/components/schemas/_errorContextResponse' PolicyManagementAccessGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyManagementAccessResponse' - $ref: '#/components/schemas/_errorContextResponse' PolicyRuleUserGroupQuotaPost: type: object properties: rules: description: 'A list of user-group-quota policy rules to create. ' type: array items: $ref: '#/components/schemas/_policyruleusergroupquotapostRules' PolicyAuditFileResponse: 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/PolicyAuditFile' PolicyMemberPost: type: object properties: members: description: 'A list of resources to which the policy may be applied. ' type: array items: $ref: '#/components/schemas/_policymemberpostMembers' PolicyLockablePatch: allOf: - $ref: '#/components/schemas/PolicyPatch' - type: object properties: retention_lock: description: 'The valid values are `ratcheted` and `unlocked`. The default value for a newly created policy is `unlocked`. Set `retention_lock` to `ratcheted` to enable SafeMode restrictions on the policy. Contact Pure Technical Services to change `retention_lock` to `unlocked`. ' type: string example: unlocked PolicyResponse: 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/Policy' _policyrulesmbclientpostRules: type: object properties: anonymous_access_allowed: description: 'Specifies whether access to information is allowed for anonymous users. If not specified, defaults to `false`. ' type: boolean client: description: 'Specifies which clients are given access. Accepted notation, IP, IP mask, or hostname. The default is `*` if not specified. ' type: string smb_encryption_required: description: 'Specifies whether the remote client is required to use SMB encryption. If not specified, defaults to `false`. ' 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' PolicyNfsPolicyMapping: type: object properties: mapping: description: 'The mapping of this policy. Valid values are `connected` and `disconnected`. ' type: string remote_policy: description: 'The policy on the remote pod of the pod replica link for this policy mapping. ' type: string _policyrulemanagementaccessRules: type: object properties: role: description: 'Role defines a set of permissions applicable in a scope. `viewer` grants users the ability to read a resource. `support` grants the ability to perform general support-related actions, as well as read resources. `storage` grants access to all storage operations on a resource. `admin` grants access to all operations. ' title: ReferenceNoId allOf: - $ref: '#/components/schemas/_referenceNoId' scope: description: 'Reference to the resource (e.g. arrays, realms) which specifies the scope that the role applies. The `id` or `name` parameter is required, but they cannot be set together. Also, `resource_type` must be set. ' title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' PolicyRuleNfsClientPost: type: object properties: rules: description: A list of NFS policy rules to create. type: array items: $ref: '#/components/schemas/_policyrulenfsclientpostRules' PolicyManagementAccessPatch: allOf: - $ref: '#/components/schemas/_newName' - type: object properties: aggregation_strategy: description: 'When this is set to `least-common-permissions`, any users to whom this policy applies can receive no access rights exceeding those defined in this policy''s capability and resource. When this is set to `all-permissions`, any users to whom this policy applies are capable of receiving additional access rights from other policies that apply to them. ' type: string enabled: description: 'Sets whether the policy is enabled and grants the permissions specified. ' type: boolean rules: description: 'List the rules that defines the scoped roles. ' type: array items: $ref: '#/components/schemas/_policyrulemanagementaccessRules' PolicyRuleUserGroupQuotaSubject: type: object properties: id: description: 'The subject User Identifier (UID) or Group Identifier (GID). ' type: integer format: int64 readOnly: true name: description: 'The subject name. The name can have a `@domain` suffix. ' type: string readOnly: true sid: description: 'The subject SID, which uniquely identifies a user or group. ' type: string readOnly: true PageInfo_2: type: object properties: continuation_token: description: 'Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified). ' type: string example: MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My total_item_count: description: Total number of items after applying filter params. type: integer format: int32 example: 1 PolicyLockable: allOf: - $ref: '#/components/schemas/Policy' - type: object properties: eradication_config: $ref: '#/components/schemas/PolicyLockableEradicationConfig' retention_lock: description: 'The valid values are `ratcheted` and `unlocked`. The default value for a newly created policy is `unlocked`. Set `retention_lock` to `ratcheted` to enable SafeMode restrictions on the policy. Contact Pure Technical Services to change `retention_lock` to `unlocked`. ' type: string example: unlocked workload: $ref: '#/components/schemas/_workloadConfigurationFixedReference' PolicyMemberExportGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyMemberExportResponse' - $ref: '#/components/schemas/_errorContextResponse' PolicyRuleSnapshotGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyRuleSnapshotResponse' - $ref: '#/components/schemas/_errorContextResponse' ObjectStoreAccessPolicyResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/ObjectStoreAccessPolicy' _policyrulenfsclientpatchRules: type: object properties: access: description: 'Specifies access control for the export. Values include `root-squash`, `all-squash`, and `no-root-squash`. The `root-squash` value prevents client users and groups with root privilege from mapping their root privilege to a file system. All users with UID `0` will have their UID mapped to `anonuid`. All users with GID `0` will have their GID mapped to `anongid`. The `all-squash` value maps all UIDs (including root) to `anonuid` and all GIDs (including root) to `anongid`. The `no-root-squash` value allows users and groups to access the file system with their UIDs and GIDs. ' type: string anongid: description: 'Any user whose GID is affected by an `access` of `root_squash` or `all_squash` will have their GID mapped to `anongid`. If not specified, defaults to `65534`. Set to `""` to clear. This value is ignored when user mapping is enabled. ' type: string example: '65530' anonuid: description: 'Any user whose UID is affected by an `access` of `root_squash` or `all_squash` will have their UID mapped to `anonuid`. The default `anonuid` is null, which means 65534. Use "" to clear. ' type: string example: '65530' client: description: 'Specifies which clients are given access. Valid values include `IP`, `IP mask`, or `hostname`. The default is `*` if not specified. ' type: string nfs_version: description: 'The NFS protocol version allowed for the export. Values include `nfsv3` and `nfsv4`. ' type: array items: type: string example: nfsv3 permission: description: 'Specifies which read-write client access permissions are allowed for the export. Values include `rw` and `ro`. ' type: string security: description: 'The security flavors to use for accessing files on this mount point. Values include `auth_sys`, `krb5`, `krb5i`, and `krb5p`. If the server does not support the requested flavor, the mount operation fails. This operation updates all rules of the specified policy. If `auth_sys`, the client is trusted to specify the identity of the user. If `krb5`, cryptographic proof of the identity of the user is provided in each RPC request. This provides strong verification of the identity of users accessing data on the server. Note that additional configuration besides adding this mount option is required to enable Kerberos security. If `krb5i`, integrity checking is added to krb5. This ensures the data has not been tampered with. If `krb5p`, integrity checking and encryption is added to krb5. This is the most secure setting, but it also involves the most performance overhead. ' type: array items: type: string example: auth_sys Policy_2: allOf: - $ref: '#/components/schemas/_arraysBuiltIn' - description: 'A set of rules that can be applied to resources. ' type: object properties: enabled: description: Returns `true` if this policy is enabled. type: boolean example: true rules: type: array items: $ref: '#/components/schemas/_policy_rule' ObjectStoreAccessPolicyGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - $ref: '#/components/schemas/ObjectStoreAccessPolicyResponse' PolicyRuleNfsClientPatch: type: object properties: rules: description: 'Updates the rules in the NFS policy. The operation accepts a single-rule update object. The list must contain exactly one item that updates all specified rules. ' type: array maxItems: 1 items: $ref: '#/components/schemas/_policyrulenfsclientpatchRules' PolicyRuleNfsClientResponse: 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/PolicyRuleNfsClient' PolicyRuleUserGroupQuota: allOf: - $ref: '#/components/schemas/_context' - type: object properties: destroyed: description: 'Returns a value of `true` if the pod containing the user-group-quota policy rule has been destroyed and is pending eradication. The `time_remaining` value displays the amount of time left until the destroyed policy is permanently eradicated. Once the `time_remaining` period has elapsed, the user-group-quota policy rule is permanently eradicated and can no longer be recovered. ' type: boolean enforced: description: 'Specifies whether the user-group-quota rule is enforced or unenforced. If the user-group-quota rule is enforced and user/group space usage exceeds the quota limit, any modification operations that result in a need for more space are blocked. If the quota rule is unenforced and logical space usage exceeds the quota limit, notification emails are sent to targets that are specified using the `notification` parameter. No client operations are blocked when an unenforced limit is exceeded. If set to `true`, the limit is enforced. If set to `false`, the quota limit is enforced. ' type: boolean readOnly: true name: description: 'Name of the rule. The name is automatically generated by the system. ' type: string readOnly: true notifications: description: 'Specifies the targets to notify when usage approaches or exceeds the quota limit. `empty` specifies that no targets will be notified. The `account` value specifies that the user or group owning the usage will be notified. ' type: array items: type: string policy: description: 'The policy to which this rule belongs. ' title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' quota_limit: description: 'Logical space limit of the quota assigned by the rule, measured in bytes. The value cannot be negative. ' type: integer format: int64 readOnly: true quota_type: description: 'Specifies the type of quota rule. Valid values are `user-default`, `user`, `user-group-member`, `group-default` and `group`. Every user-group-quota rule has a rule type, and this field is always populated. ' type: string readOnly: true subject: description: 'The rule subject, when required. Rules of type `user`, `user-group-member` and `group` require a subject, specifying the user or group the rule is applicable to. ' title: PolicyRuleUserGroupQuotaSubject allOf: - $ref: '#/components/schemas/PolicyRuleUserGroupQuotaSubject' time_remaining: description: 'The amount of time left, in milliseconds, until the destroyed user-group-quota policy rule is permanently eradicated. ' type: integer format: int64 readOnly: true PolicyRuleSnapshotResponse: 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/PolicyRuleSnapshot' PolicyPassword: allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_context' - type: object properties: enabled: description: 'Returns a value of `true` if the policy is enabled. ' type: boolean enforce_dictionary_check: description: 'If `true`, test password against dictionary of known leaked passwords. Only applies to passwords longer than 6 characters. ' type: boolean example: true enforce_username_check: description: 'If `true`, the username cannot be a substring of the password. It only applies to usernames of 3 characters and longer. ' type: boolean example: true lockout_duration: description: 'The lockout duration, in milliseconds, if a user is locked out after reaching the maximum number of login attempts. Ranges from 1 second to 90 days. ' type: integer format: int64 minimum: 1000 maximum: 7776000000 example: 3600000 max_login_attempts: description: 'Maximum number of failed login attempts allowed before the user is locked out. ' type: integer format: int32 minimum: 1 maximum: 100 example: 10 max_password_age: description: 'The maximum age of password before password change is required. Ranges from 1 day to 99999 days, with 0 meaning password expiration is disabled. ' type: integer format: int64 minimum: 0 maximum: 8639913600000 example: 86400000 min_character_groups: description: 'The minimum number of character groups ([a-z], [A-Z], [0-9], other) required to be present in a password. ' type: integer format: int32 minimum: 0 maximum: 4 example: 3 min_characters_per_group: description: 'The minimum number of characters per group to count the group as present. Maximum is limited by the minimum password length divided by the number of character groups (e.g. min_password_length = 9, min_character_groups = 4, then maximum is 2). ' type: integer format: int32 minimum: 1 example: 1 min_password_age: description: 'The minimum age, in milliseconds, of password before password change is allowed. Ranges from 0 ms to 7 days ' type: integer format: int64 minimum: 0 maximum: 604800000 example: 86400000 min_password_length: description: 'Minimum password length. If not specified, defaults to 1. ' type: integer format: int32 minimum: 1 maximum: 100 example: 1 password_history: description: 'The number of passwords tracked to prevent reuse of passwords. ' type: integer format: int32 minimum: 0 maximum: 64 example: 5 policy_type: description: 'The type of policy. Valid values include `autodir`, `nfs`, `password`, `smb`, `snapshot`, and `quota`. ' type: string readOnly: true _policyrulesnapshotpostRules: type: object properties: at: description: 'Specifies the number of milliseconds since midnight at which to take a snapshot. The `at` value can only be set to an hour and must be between 0 and 82800000, inclusive. The `at` value can only be set on the rule with the smallest `every` value. The `at` value cannot be set if the `every` value is not measured in days. The `at` value can only be set for at most one rule in the same policy. ' type: integer format: int64 client_name: description: 'The snapshot client name. A full snapshot name is constructed in the form of `DIR.CLIENT_NAME.SUFFIX` where `DIR` is the managed directory name, `CLIENT_NAME` is the snapshot client name, and `SUFFIX` is the snapshot suffix. The client-visible snapshot name is `CLIENT_NAME.SUFFIX`. ' type: string every: description: 'Specifies the interval between snapshots, in milliseconds. The `every` value for all rules must be multiples of one another. The `every` value must be unique for each rule in the same policy. The `every` value must be between 5 minutes and 1 year. ' type: integer format: int64 keep_for: description: 'Specifies the period that snapshots are retained before they are eradicated, in milliseconds. The `keep_for` value cannot be less than the `every` value of the rule. The `keep_for` value must be unique for each rule in the same policy. The `keep_for` value must be between 5 minutes and 5 years. The `keep_for` value cannot be less than the `keep_for` value of any rule in the same policy with a smaller `every` value. ' type: integer format: int64 suffix: description: 'The snapshot suffix name. A full snapshot name is constructed in the form of `DIR.CLIENT_NAME.SUFFIX` where `DIR` is the managed directory name, `CLIENT_NAME` is the snapshot client name, and `SUFFIX` is the snapshot suffix. The client-visible snapshot name is `CLIENT_NAME.SUFFIX`. The `suffix` value can only be set for one rule in the same policy. The `suffix` value can only be set on a rule with the same `keep_for` value and `every` value. The `suffix` value can only be set on the rule with the largest `keep_for` value. If not specified, defaults to a monotonically increasing number generated by the system. ' type: string PolicyMemberClean: allOf: - $ref: '#/components/schemas/_context' - type: object properties: member: description: 'Reference to the resource that the policy is applied to. ' title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' policy: description: 'Reference to the policy. ' title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' TestResultWithResource: allOf: - $ref: '#/components/schemas/TestResult' - $ref: '#/components/schemas/_context' - type: object properties: resource: description: A reference to the object being tested. title: FixedReferenceNoId allOf: - $ref: '#/components/schemas/_fixedReferenceNoId' PolicyNfsPost: allOf: - $ref: '#/components/schemas/PolicyPost' - type: object properties: policy_mapping: $ref: '#/components/schemas/_policynfspostPolicyMapping' user_mapping_enabled: description: 'If set to `true`, FlashArray queries the joined AD/OpenLDAP server to find the user corresponding to the incoming UID. If set to `false`, users are defined by UID/GID pair. If not specified, defaults to `true`. ' type: boolean _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 PolicyRuleNetworkAccess: allOf: - $ref: '#/components/schemas/_context' - $ref: '#/components/schemas/_policyrulenetworkaccesspatchRules' - type: object properties: name: description: 'The `name` of the rule. This value is uniquely and automatically generated by the system to identify the resource. ' type: string readOnly: true policy: description: The reference to the `policy` to which this `rule` belongs. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' _policymemberexportpostMembers: type: object properties: export_enabled: description: 'If set to `true`, the export is enabled. If not specified, defaults to `true`. ' type: boolean example: false export_name: description: 'The name of the export to create when applying the export policy to the directory. Export names must be unique within the same protocol. ' type: string member: description: 'Reference to the directory to which the export policy may be applied. The `id` or `name` parameter is required, but they cannot be set together. If the `name` parameter is set, `resource_type` must also be set. ' title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' server: description: 'Server to which the export policy is attached to. ' title: Reference allOf: - $ref: '#/components/schemas/_reference' PolicyNfsResponse: 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/PolicyNfs' ObjectStoreAccessPolicyRuleGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - $ref: '#/components/schemas/ObjectStoreAccessPolicyRuleResponse' PolicyRuleAlertWatcherResponse: 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/PolicyRuleAlertWatcher' _policyrulenetworkaccesspatchRules: type: object properties: client: description: 'The clients that are permitted or denied access to the interface. Valid notations include a single `IP address`, a `subnet` in `CIDR` notation, or all clients, specified as `*`. ' type: string example: 1.2.3.4 effect: description: 'The setting that determines whether the specified client is permitted or denied access to the specified interfaces. Valid values include `allow` and `deny`. ' type: string index: description: 'The position of the rule within the policy, which determines the order in which rules are evaluated.. ' type: integer format: int32 interfaces: description: 'The specific product interfaces to which the rule applies. Valid interface values include `management-ssh`, `management-rest-api`, `management-rest-api-v1`, `management-rest-api-v2`, `management-web-ui`, and `snmp`. ' type: array items: type: string PolicyPatch: allOf: - $ref: '#/components/schemas/_newName' - type: object properties: enabled: description: If set to `true`, enables the policy. If set to `false`, disables the policy. type: boolean PolicySmb: allOf: - $ref: '#/components/schemas/_context' - $ref: '#/components/schemas/Policy' - type: object properties: access_based_enumeration_enabled: description: 'Returns a value of `true` if access based enumeration is enabled on the policy. When access based enumeration is enabled on a policy, files and folders within exports that are attached to the policy will be hidden from users who do not have permission to view them. ' type: boolean continuous_availability_enabled: description: 'Returns a value of `true` if continuous availability is enabled on the policy. When continuous availability is enabled on a policy, file shares are accessible during otherwise disruptive scenarios such as temporary network outages, controller upgrades or failovers. ' type: boolean policy_mapping: description: 'Specifies the mapping of this policy across a pod replica link. If this policy is not inside a pod of a pod replica link, mapping is `null`. ' title: PolicyNfsPolicyMapping allOf: - $ref: '#/components/schemas/PolicyNfsPolicyMapping' workload: $ref: '#/components/schemas/_workloadConfigurationFixedReference' _policymemberpostMembers: type: object properties: member: description: 'Reference to the resource to which the policy may be applied. The `id` or `name` parameter is required, but they cannot be set together. If the `name` parameter is set, `resource_type` must also be set. ' title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' _policy_rule_user_group_quota_limit_type: type: integer format: int64 Policy: allOf: - $ref: '#/components/schemas/_policy_base' - type: object properties: destroyed: description: 'Returns a value of `true` if the policy has been destroyed and is pending eradication. The `time_remaining` value displays the amount of time left until the destroyed policy is permanently eradicated. Once the `time_remaining` period has elapsed, the policy is permanently eradicated and can no longer be recovered. ' type: boolean enabled: description: 'Returns a value of `true` if the policy is enabled. ' type: boolean pod: description: 'A reference to the pod. ' title: Reference allOf: - $ref: '#/components/schemas/_reference' time_remaining: description: 'The amount of time left, measured in milliseconds, until the destroyed policy is permanently eradicated. ' type: integer format: int64 readOnly: true PolicyRuleNetworkAccessPatch: type: object properties: rules: description: A list of network access policy rules to modify. type: array items: $ref: '#/components/schemas/_policyrulenetworkaccesspatchRules' PolicyPost: type: object properties: enabled: description: If set to `true`, enables the policy. If set to `false`, disables the policy. type: boolean _policynfspostPolicyMapping: description: 'If set specifies the initial mapping of the policy upon its creation across a pod replica link. Policy being created must be in a source pod of a replica-link. ' type: object properties: mapping: description: 'The mapping of this policy. Valid values are `connected` and `disconnected`. ' type: string TotalItemCountResponse: type: object properties: 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 PolicyNfsGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyNfsResponse' - $ref: '#/components/schemas/_errorContextResponse' PolicyMemberObjectStoreAccessResponse: type: object properties: items: description: A list of members for policies. type: array items: $ref: '#/components/schemas/_policy_member_base' _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 PolicyMemberExportPost: type: object properties: members: description: 'A list of directories to which the export policy may be applied. ' type: array items: $ref: '#/components/schemas/_policymemberexportpostMembers' PolicyRuleSnapshot: allOf: - $ref: '#/components/schemas/_context' - type: object properties: at: description: 'Specifies the number of milliseconds since midnight at which to take a snapshot. The `at` value can only be set to an hour and must be between 0 and 82800000, inclusive. The `at` value can only be set on the rule with the smallest `every` value. The `at` value cannot be set if the `every` value is not measured in days. The `at` value can only be set for at most one rule in the same policy. ' type: integer format: int64 readOnly: true client_name: description: 'The snapshot client name. A full snapshot name is constructed in the form of `DIR.CLIENT_NAME.SUFFIX` where `DIR` is the managed directory name, `CLIENT_NAME` is the snapshot client name, and `SUFFIX` is the snapshot suffix. The client visible snapshot name is `CLIENT_NAME.SUFFIX`. ' type: string readOnly: true destroyed: description: 'Returns a value of `true` if the pod containing the snapshot policy rule has been destroyed and is pending eradication. The `time_remaining` value displays the amount of time left until the destroyed policy is permanently eradicated. Once the `time_remaining` period has elapsed, the snapshot policy rule is permanently eradicated and can no longer be recovered. ' type: boolean every: description: 'Specifies the interval between snapshots, in milliseconds. The `every` value for all rules must be multiples of one another. The `every` value must be unique for each rule in the same policy. The `every` value must be between 5 minutes and 1 year. ' type: integer format: int64 readOnly: true keep_for: description: 'Specifies the period that snapshots are retained before they are eradicated, in milliseconds. The `keep_for` value cannot be less than the `every` value of the rule. The `keep_for` value must be unique for each rule in the same policy. The `keep_for` value must be between 5 minutes and 5 years. The `keep_for` value cannot be less than the `keep_for` value of any rule in the same policy with a smaller `every` value. ' type: integer format: int64 readOnly: true name: description: 'Name of this rule. The name is automatically generated by the system. ' type: string readOnly: true policy: description: The policy to which this rule belongs. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' suffix: description: 'The snapshot suffix name. A full snapshot name is constructed in the form of `DIR.CLIENT_NAME.SUFFIX` where `DIR` is the managed directory name, `CLIENT_NAME` is the snapshot client name, and `SUFFIX` is the snapshot suffix. The client-visible snapshot name is `CLIENT_NAME.SUFFIX`. The `suffix` value can only be set for one rule in the same policy. The `suffix` value can only be set on a rule with the same `keep_for` value and `every` value. The `suffix` value can only be set on the rule with the largest `keep_for` value. If not specified, defaults to a monotonically increasing number generated by the system. ' type: string readOnly: true time_remaining: description: 'The amount of time left, in milliseconds, until the destroyed snapshot policy rule is permanently eradicated. ' type: integer format: int64 readOnly: true responses: Error403: description: FORBIDDEN headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: object content: application/json: schema: $ref: '#/components/schemas/ErrorNoContext' Error400: description: BAD REQUEST headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: object X-RateLimit-Remaining-minute: description: 'The number of requests remaining for the organization in that minute. ' schema: type: object X-RateLimit-Remaining-second: description: 'The number of requests remaining for the organization in that second. ' schema: type: object X-RateLimit-Limit-minute: description: The number of requests available per minute. schema: type: object X-RateLimit-Limit-second: description: The number of requests available per second. schema: type: object content: application/json: schema: $ref: '#/components/schemas/Error' Error429: description: TOO MANY REQUESTS headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: object X-RateLimit-Remaining-minute: description: 'The number of requests remaining for the organization in that minute. ' schema: type: object X-RateLimit-Remaining-second: description: 'The number of requests remaining for the organization in that second. ' schema: type: object X-RateLimit-Limit-minute: description: The number of requests available per minute. schema: type: object X-RateLimit-Limit-second: description: The number of requests available per second. schema: type: object content: application/json: schema: $ref: '#/components/schemas/ErrorNoContext' Error500: description: INTERNAL SERVER ERROR headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: object X-RateLimit-Remaining-minute: description: 'The number of requests remaining for the organization in that minute. ' schema: type: object X-RateLimit-Remaining-second: description: 'The number of requests remaining for the organization in that second. ' schema: type: object X-RateLimit-Limit-minute: description: The number of requests available per minute. schema: type: object X-RateLimit-Limit-second: description: The number of requests available per second. schema: type: object content: application/json: schema: $ref: '#/components/schemas/Error' Error404: description: NOT FOUND headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: object X-RateLimit-Remaining-minute: description: 'The number of requests remaining for the organization in that minute. ' schema: type: object X-RateLimit-Remaining-second: description: 'The number of requests remaining for the organization in that second. ' schema: type: object X-RateLimit-Limit-minute: description: The number of requests available per minute. schema: type: object X-RateLimit-Limit-second: description: The number of requests available per second. schema: type: object content: application/json: schema: $ref: '#/components/schemas/Error'