openapi: 3.0.1 info: title: FlashArray REST API version: "2.52" servers: - url: / tags: - name: Authorization description: | Pure Storage uses the OAuth 2.0 Token Exchange authorization grant and JSON Web Tokens (JWTs) to authenticate to the Pure Storage REST API. Before you can exchange the ID token for an access token, create and enable the API client to generate the `key_id`, `id`, and `issuer` values. These values will be used as JWT claims for the `subject_token` parameter. - name: Active Directory 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. - name: Administrators description: | The FlashArray has a single default administrative account named pureuser. The administrator can add, delete, and modify administrators on the array. Administrators are assigned management access policies to give different levels of permissions. - name: Alerts description: | Alerts indicate significant events that occur on an array, including whenever a component degrades or the capacity threshold of the component is reached. - name: Alert Watchers description: | Alert watchers receive email notifications when alerts occur on an array. - name: API Clients description: | An API client represents an identity type. API clients are created on the array. To create an API client, register and then enable it on the array. After the API client has been created, the user name (`sub`) and identity tokens (`kid` and `aud` tokens) that are issued by the API client are used as claims for the JSON Web Token that you create to authenticate into the REST API. - name: Apps description: | Apps that extend array functionality can be integrated into the Purity//FA operating system. - name: Arrays description: | Array features provide the ability to configure settings that affect the operation of the array as a whole and monitor array I/O performance. - name: Array Connections description: | Manages connections between arrays. - name: Audits description: | Audit trail records describe administrative actions performed by a user to modify the configuration of an array. - name: Buckets description: Manages the creation, attributes, and deletion of buckets on the array. - name: Certificates description: | Purity//FA creates a self-signed certificate and private key when you start the system for the first time. You can use the default certificate, change the certificate attributes, create a new self-signed certificate, or import an SSL certificate signed by a certificate authority. - name: Certificate Groups description: | Certificate groups, also known as certificate bundles, are collections of digital certificates. Each certificate can belong to one or more groups in order to serve different purposes. - name: Connections description: | A connection gives hosts access to volumes on the array. - name: Container Default Protections description: | Default protection is a list of protection groups that are applied to newly created volumes. Volumes can opt out of the default protection at creation. The pod's `default_protections` defaults to the array's `default_protections` at pod creation. Default protection can be configured on the array and the pod. - name: Controllers description: | Controller data includes the name, mode, FlashArray model, Purity//FA software version, and status of each controller in the array. - name: Directories description: | Important file system directories should be set up as managed directories. Managed directories can have policies attached to them. Managed directories differ from standard directories in that they provide space reporting and metrics. - name: Directory Exports description: | Managed directory exports are created by adding NFS or SMB export policies to managed directories. - name: Directory Quotas description: | Directory quotas provide the ability to set capacity limits on managed directories. - name: Directory Services description: | Manages directory service configurations for integration with LDAP servers (e.g. Active Directory and OpenLDAP) in order to support various array services. - name: Directory Snapshots description: | Directory snapshots are created manually or by adding snapshot policies to managed directories. Each snapshot policy can be re-used for multiple directories. - name: DNS description: | DNS attributes include the domain suffix, static name servers, mode (static or DHCP), and search domain. The configured attributes can be listed. - name: Drives description: | Drive data includes the name, type, status, capacity, protocol and other information for all flash, NVRAM, and cache modules in an array. - name: File Systems description: | A FlashArray can contain up to 24 separate file systems, each with a number of directories that can be exported via supported protocols. Clients, using Active Directory or LDAP, can connect and access these exports using SMB or NFS. - name: Fleets description: | A fleet is a collection of Arrays. - name: Hardware description: | Operational status is reported by most of the hardware components in an array, including the chassis, controller, and storage shelf. - name: Host Groups description: | Host groups implement consistent connections between a set of hosts and one or more volumes. Connections are consistent in the sense that all hosts associated with a host group address a volume connected to the group by the same LUN. Host groups are typically used to provide a common view of storage volumes to the hosts in a clustered application. - name: Hosts description: | Hosts organize the storage network addresses (iSCSI Qualified Names, NVMe qualified names, or Fibre Channel world wide names) of client computers to identify the host's intiators. Hosts also control communications between clients and volumes. After a volume has been created, establish a host-volume connection so that the host can read data from and write data to the volume. - name: KMIP description: | The Key Management Interoperability Protocol (KMIP) server is used in combination with the Pure Storage Rapid Data Locking (RDL) feature and EncryptReduce feature to further secure the encrypted data on a FlashArray. - name: Lifecycle Rules description: A life cycle rule helps manage the number of copies of a specific bucket. A lifecycle rule can be applied to a bucket with a rule indicating the retention time before it is to be deleted. - name: Log Targets description: | Log Targets to be used to send management or data audit logs. - name: Maintenance Windows description: | During a maintenance window, alerts are suppressed that are related to connections, paths, ports, and other resources that are down during maintenance. - name: Network Interfaces description: | Manages the interfaces and the network connection attributes of the array. - name: Object Store Access Keys description: Manages object store access keys. A maximum of two sets of keys can be created for each object store user. A set of keys consists of an access key ID and Secret Access Key. - name: Object Store Accounts description: Manages object store accounts. Accounts contain buckets and users. Accounts must be created before an object store user or buckets can be created. - name: Object Store Users description: Manages the object store users attributes. Each user is assigned to an object store account and given an access key. - name: Object Store Virtual Hosts description: Manages virtual host-style addressing for S3 requests to read or write an object within a bucket on the array. - name: Offloads description: | The offload feature enables system administrators to replicate point-in-time volume snapshots from the array to an external storage system for long-term retention. Each offload target represents an external storage system, such as an Azure Blob container, NFS device, or S3 bucket, to where Purity//FA volume snapshots can be replicated. - name: Presets description: | Presets are reusable templates that provision resources. - name: Pods description: | Synchronous replication is managed through pods. A pod representing a collection of protection groups and volumes is created on one array and stretched to another array, resulting in fully synchronized writes between the two arrays. A pod can contain a mix of volumes, and protection groups with member volumes. Writes to the pod coming into either array are immediately synchronized and seen on both arrays. - name: Pod Replica Links description: | Pod replica links are created by associating a source pod with a demoted pod, making the demoted pod the target pod of the source pod. The direction of the replica link is from the promoted source pod to the demoted target pod. Replica links can be created in either direction between the same two FlashArrays. The target pod of a replica link cannot be on the same FlashArray as the source pod. - 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. - name: Ports description: | The ports on a FlashArray are assigned iSCSI Qualified Names (IQNs), NVMe Qualified Names (NQNs), and Fibre Channel World Wide Names (WWNs). - name: Protection Groups description: | A protection group defines a set of volumes, hosts, or host groups (called members) that are protected together through snapshots with point-in-time consistency across the member volumes. The members within the protection group have common data protection requirements and the same snapshot, replication, and retention schedules. - name: Protection Group Snapshots description: | Protection group snapshots capture the content of all volumes on the source array for the specified protection group at a single point in time. - name: Realms description: "A realm is an administrative domain, a data container, and a namespace for pods, hosts, and host groups." - name: Realm Connections description: | Realm connections enable replication services between different realms in a connected array cluster. - name: Remote Arrays description: | Remote arrays provide the ability to list and manage all the remote arrays known to an array. - name: Remote Pods description: | A remote pod represents a pod that is on a connected array but not stretched to this array. - name: Remote Protection Groups description: | A remote protection group represents a protection group that resides on an offload target with the source side of the remote protection group being another array that is connected to the local array. The local array can only see the remote protection groups of other arrays if the two arrays are connected. - name: Remote Protection Group Snapshots description: | A remote protection group snapshot represents a protection group snapshot that resides on an offload target with the source side of the remote protection group snapshot being another array that is connected to the local array. The local array can only see the remote protection group snapshots of other arrays if the two arrays are connected. - name: Remote Realms description: | A remote realm represents a realm that is on a connected array but not stretched to this array. - name: Remote Volume Snapshots description: | A remote volume snapshot represents a volume snapshot that resides on an offload target with the source side of the remote volume snapshot being another array that is connected to the local array. The local array can only see the remote volume snapshots of other arrays if the two arrays are connected. - name: SAML2 SSO description: | SAML2 SSO allows customers to configure settings of SAML2 service provider and identity provider. It provides a multi-factor authentication (MFA) mechanism for customers to log in to FlashArray. - name: Sessions description: | Manages Purity//FA login and user session data. - name: SMI-S description: | Manages the Pure Storage Storage Management Initiative Specification (SMI-S). - name: SMTP description: | Manages Simple Mail Transfer Protocol (SMTP) settings. SMTP allows the array to send email notifications and alerts to recipients. - name: SNMP Agents description: | Manages connections to Simple Network Management Protocol (SNMP) agents. - name: SNMP Managers description: | Manages connections to Simple Network Management Protocol (SNMP) managers. - name: Software description: | Software to be installed on the array. - name: Subnets description: | Manages the subnets and VLANs used to organize the network interfaces. - name: Subscriptions description: | Provides information about subscription offerings. - name: Subscription Assets description: | Provides information about subscription assets. - name: Support description: | Enables Support to fix bugs and help customers solve problems. Support tools include proxy, phonehome, and remote assist. - name: Syslog description: | Copied to Log Targets/Syslog for more organized way to handle all log targets. Both endpoints are identical. We encourage our users to use Log Targets/Syslog. - name: User Group Quotas description: | User Group quotas provide the ability to set capacity limits for users and groups in managed directories. - name: Vchost Connections description: | A vchost connection is between a protocol endpoint and vchost. In the context of vchost-connection, the vchost represents a vCenter, and the protocol endpoint is used to represent a storage container. Creating a vchost connection gives the vCenter access to the storage container. If `all_vchosts` is set to `true`, the container will be accessible to all vchosts. - name: Volumes description: | A volume represents a container that manages the storage space on the array. After a volume has been created, host-volume connections must be established so that the host can read data from and write data to the volume. Volume data should be protected using asynchronous replication to a remote array, synchronous replication between remote arrays, and replication to external storage systems. - name: Volume Groups description: | Volume groups organize volumes into logical groupings. If virtual volumes are configured, each volume group on the FlashArray array represents its associated virtual machine, and inside each of those volumes groups are the FlashArray volumes that are assigned to the virtual machine. Volume groups that are associated with virtual machines have names that begin with `vvol-` and end with the virtual machine name. - name: Volume Snapshots description: | Volume snapshots are immutable, point-in-time images of the contents of one or more volumes. There are two types of volume snapshots: volume snapshots and protection group volume snapshots. A volume snapshot is a snapshot that captures the contents of a single volume. A protection group volume snapshot is a volume snapshot that is created from a group of volumes that are part of the same protection group. All of the volume snapshots created from a protection group snapshot are point-in-time consistent with each other. - name: Workloads description: | Workloads organize storage resources (such as volumes) and their related configuration and policy objects into logical groupings. Workloads can be deployed from workload presets. paths: /oauth2/1.0/token: post: tags: - Authorization summary: Pure Storage Get Access Token description: | Exchanges an ID Token for an OAuth 2.0 access token. parameters: - name: X-Request-ID in: header description: | Supplied by client during request or generated by server. schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - grant_type - subject_token - subject_token_type type: object properties: grant_type: $ref: '#/components/schemas/OauthGrantType' subject_token: $ref: '#/components/schemas/OauthSubjectToken' subject_token_type: $ref: '#/components/schemas/OauthSubjectTokenType' required: true responses: "200": $ref: '#/components/responses/OauthToken200' "400": $ref: '#/components/responses/OauthToken400' "401": $ref: '#/components/responses/OauthToken401' security: [] /api/api_version: get: tags: - Authorization summary: Pure Storage List Available API Versions description: | Returns a list of available API versions. No authentication is required to access this endpoint. parameters: - $ref: '#/components/parameters/XRequestId' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Api_versionResponse' security: [] /api/2.52/login: post: tags: - Authorization summary: Pure Storage Create a User Session description: | Creates a user session and returns a session token, using either the user's API token or their username and password. `api-token` is passed in a header, with the request body empty. Otherwise `username` and `password` are passed in the request body, without an `api-token` header. Storing user passwords client-side is not recommended. The username-password authentication option should only be used as necessary for initial retrieval of an API token, which should be securely stored and used for all subsequent logins. parameters: - name: api-token in: header description: | API token for a user. schema: type: string example: 0f2e2884-9486-c6c2-438c-f50418f2aac3 - $ref: '#/components/parameters/XRequestId' requestBody: content: application/json: schema: $ref: '#/components/schemas/LoginPost' required: false x-codegen-request-body-name: login responses: "200": description: OK headers: x-auth-token: description: Session token for a user. schema: type: string example: 3be3d489-55c6-4643-90ac-a476dbc98812 content: application/json: schema: $ref: '#/components/schemas/UsernameResponse' x-codegen-request-body-name: login /api/2.52/logout: post: tags: - Authorization summary: Pure Storage POST Logout (Placeholder) description: | Invalidate a session token. parameters: - name: x-auth-token in: header description: Session token for a user. schema: type: string example: 3be3d489-55c6-4643-90ac-a476dbc98812 - $ref: '#/components/parameters/XRequestId' responses: "200": description: OK content: {} /api/2.52/active-directory: get: tags: - Active Directory summary: Pure Storage List Active Directory Accounts description: | Displays configured Active Directory accounts. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Fqnames' - $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/ActiveDirectoryGetResponse' post: tags: - Active Directory summary: Pure Storage Create Active Directory Account description: | Creates one or more Active Directory accounts. The `user` and `password` provided are used to join the array to the specified `domain`. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Join_existing_acct_ad' - $ref: '#/components/parameters/Fqnames_required' requestBody: content: application/json: schema: $ref: '#/components/schemas/ActiveDirectoryPost' required: true x-codegen-request-body-name: active-directory responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ActiveDirectoryResponse' x-codegen-request-body-name: active-directory delete: tags: - Active Directory summary: Pure Storage Delete Active Directory Account description: | Deletes one or more specified Active Directory accounts. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Local_only_ad' - $ref: '#/components/parameters/Fqnames_required' responses: "200": description: OK content: {} patch: tags: - Active Directory summary: Pure Storage Modify Active Directory Account description: | Modifies specified Active Directory account. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Fqnames_required' requestBody: content: application/json: schema: $ref: '#/components/schemas/ActiveDirectoryPatch' required: true x-codegen-request-body-name: active-directory responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ActiveDirectoryResponse' x-codegen-request-body-name: active-directory /api/2.52/active-directory/test: get: tags: - Active Directory summary: Pure Storage GET Active-directory/test description: > The diagnostic process that executes a series of validation tests on one or more `Active Directory` `accounts`. Each individual test verifies a specific aspect of the `configuration`, such as connectivity, authentication permissions, and service principal integrity, to ensure the environment is functioning properly. 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_required' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK headers: X-Request-ID: description: The identifier or attribute provided by the `client` during the initial `request` or automatically generated by the `server` if not specified. schema: type: string content: application/json: schema: $ref: '#/components/schemas/TestResultWithResourceAndErrorContextPartialResourceResponse' "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 or displayed. content: application/json: schema: $ref: '#/components/schemas/TestResultWithResourceAndErrorContextPartialResourceResponse' /api/2.52/admins: get: tags: - Administrators summary: Pure Storage List Administrators description: |+ Displays a list of administrators. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Expose_api_token' - $ref: '#/components/parameters/Expose_public_key' - $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/AdminGetResponse' post: tags: - Administrators summary: Pure Storage Create an Administrator description: |+ Creates an administrator. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/AdminPost' required: true x-codegen-request-body-name: admin responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AdminResponse' x-codegen-request-body-name: admin delete: tags: - Administrators summary: Pure Storage Delete an Administrator description: |+ Deletes the specified administrator. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' responses: "200": description: OK content: {} patch: tags: - Administrators summary: Pure Storage Modify an Administrator description: |+ Modifies properties for the specified administrator. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/AdminPatch' required: true x-codegen-request-body-name: admin responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AdminResponse' x-codegen-request-body-name: admin /api/2.52/admins/policies/management-access: get: tags: - Administrators summary: Pure Storage List Management Access Policies Attached to Administrators description: |+ Displays a list of management access policies that are attached to administrators. 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/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/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: - Administrators summary: Pure Storage Create a Membership Between an Administrator with One or More Management Access Policies. description: |+ Creates a membership between an administrator with one or more management access policies. One of `member_ids` or `member_names` parameter 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' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyAssignmentPost' required: true x-codegen-request-body-name: policies responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberCleanResponse' x-codegen-request-body-name: policies delete: tags: - Administrators summary: Pure Storage Delete a Membership Between an Administrator and One or More Management Access Policies description: |+ Deletes a membership between an administrator with one or more management access policies. One of `policy_ids` or `policy_names` is required, and one of `member_ids` or `member_names` 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/Policy_ids' - $ref: '#/components/parameters/Policy_names' responses: "200": description: OK content: {} /api/2.52/admins/api-tokens: get: tags: - Administrators summary: Pure Storage List API Tokens description: Displays API tokens for the specified administrators. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Expose_api_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/AdminApiTokenGetResponse' post: tags: - Administrators summary: Pure Storage Create API Tokens description: Creates API tokens for the specified administrators. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Timeout' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AdminApiTokenResponse' delete: tags: - Administrators summary: Pure Storage Delete API Tokens description: Deletes the API tokens of the specified administrators. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' responses: "200": description: OK content: {} /api/2.52/admins/cache: get: tags: - Administrators summary: Pure Storage List Administrator Cache Entries description: |+ Displays entries in the administrator cache. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/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/AdminCacheGetResponse' put: tags: - Administrators summary: Pure Storage Update or Refresh Entries in the Administrator Cache description: |+ Updates entries in the cache for administrators who currently do not have a cache entry, otherwise refreshes the existing entry. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AdminCacheResponse' delete: tags: - Administrators summary: Pure Storage Delete Cache Entries description: |+ Deletes all entries from the administrator cache. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Remove_all_entries' responses: "200": description: OK content: {} /api/2.52/admins/settings: get: tags: - Administrators summary: Pure Storage List Administrator Settings description: |+ Displays the global administrator settings for the array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AdminSettingsGetResponse' patch: tags: - Administrators summary: Pure Storage Modify Administrator Settings description: |+ Modifies the global administrator settings for the array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' requestBody: content: application/json: schema: $ref: '#/components/schemas/AdminSettings' required: true x-codegen-request-body-name: admin-settings responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AdminSettingsResponse' x-codegen-request-body-name: admin-settings /api/2.52/alerts: get: tags: - Alerts summary: Pure Storage List Alerts description: Displays a list of alerts. 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/Flagged' - $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/AlertGetResponse' "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/AlertGetResponse' patch: tags: - Alerts summary: Pure Storage Modify Flagged State description: Modifies one or more alerts and display updated information about these alerts. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/Alert' required: true x-codegen-request-body-name: alert responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AlertResponse' x-codegen-request-body-name: alert /api/2.52/alerts/events: get: tags: - Alerts summary: Pure Storage List Alert Events description: Displays a list of alert events. 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/Flagged' - $ref: '#/components/parameters/IdsSemiRequired' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/NamesSemiRequired' - $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/AlertEventGetResponse' "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/AlertEventGetResponse' /api/2.52/alerts/rules: get: tags: - Alerts summary: Pure Storage List Custom Alert Rules description: | Displays a list of custom alert rules. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Alert_rules_code_list' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AlertRulesGetResponse' "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/AlertRulesGetResponse' post: tags: - Alerts summary: Pure Storage Create a Custom Alert Rule description: | Creates an alert rule with a custom value. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Alert_rules_code' - $ref: '#/components/parameters/Alert_rules_parameter' requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertRules' required: true x-codegen-request-body-name: alert-rule responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AlertRulesResponse' x-codegen-request-body-name: alert-rule delete: tags: - Alerts summary: Pure Storage Delete a Custom Alert Rule description: | Deletes a custom alert rule. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Alert_rules_code' - $ref: '#/components/parameters/Alert_rules_parameter' responses: "200": description: OK content: {} patch: tags: - Alerts summary: Pure Storage Modify a Custom Alert Rule description: | Modifies a custom alert rule to a new value. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Alert_rules_code' - $ref: '#/components/parameters/Alert_rules_parameter' requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertRules' required: true x-codegen-request-body-name: alert-rule responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AlertRulesResponse' x-codegen-request-body-name: alert-rule /api/2.52/alerts/rules/catalog: get: tags: - Alerts summary: Pure Storage List Available Customizable Alert Codes description: | Displays a list of available customizable alert codes. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Alert_rules_code_list' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AlertRulesCatalogGetResponse' "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/AlertRulesCatalogGetResponse' /api/2.52/alert-watchers: get: tags: - Alert Watchers summary: Pure Storage List Alert Watchers description: Displays alert watcher email addressess and indicates whether they are `enabled`. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/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/AlertWatcherGetResponse' post: tags: - Alert Watchers summary: Pure Storage Create Alert Watcher description: "Creates one or more alert watcher email addresses, adding them to the list of alert watchers." parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names_required' requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertWatcherPost' required: false x-codegen-request-body-name: alert-watcher responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AlertWatcherResponse' x-codegen-request-body-name: alert-watcher delete: tags: - Alert Watchers summary: Pure Storage Delete Alert Watcher description: Delete alert watcher email address from the list of alert watchers. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names_required' responses: "200": description: OK content: {} patch: tags: - Alert Watchers summary: Pure Storage Modify Alert Watcher description: Modify alert watcher email address by enabling or disabling it. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names_required' requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertWatcherPatch' required: true x-codegen-request-body-name: alert-watcher responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AlertWatcherResponse' x-codegen-request-body-name: alert-watcher /api/2.52/alert-watchers/test: get: tags: - Alert Watchers summary: Pure Storage List Alert Watcher Test description: Displays alert watcher 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/api-clients: get: tags: - API Clients summary: Pure Storage List API Clients description: |+ Displays a list of API clients. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $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/ApiClientGetResponse' post: tags: - API Clients summary: Pure Storage Create an API Client description: | Creates an API client. Newly created API clients are disabled by default. Enable an API client through the `PATCH` method. The `names`, `issuer`, and `public_key` parameters are required. The `access_policies` or `max_role` parameter is required, but they cannot be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/ApiClientPost' required: true x-codegen-request-body-name: API clients responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ApiClientResponse' x-codegen-request-body-name: API clients delete: tags: - API Clients summary: Pure Storage Delete an API Client description: |+ Deletes an API client. 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/Ids' - $ref: '#/components/parameters/Names' responses: "200": description: OK content: {} patch: tags: - API Clients summary: Pure Storage Manage an API Client description: | Enables or disables an API client. 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/Ids' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/ApiClientPatch' required: true x-codegen-request-body-name: API clients responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ApiClientResponse' x-codegen-request-body-name: API clients /api/2.52/apps: get: tags: - Apps summary: Pure Storage List Apps description: Displays a list of installed apps. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/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/AppGetResponse' patch: tags: - Apps summary: Pure Storage Modify App description: | Modifies an installed app or modifies Virtual Network Computing (VNC) access for apps that are being patched. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names_required' requestBody: content: application/json: schema: $ref: '#/components/schemas/App' required: true x-codegen-request-body-name: app responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AppResponse' x-codegen-request-body-name: app /api/2.52/apps/nodes: get: tags: - Apps summary: Pure Storage List App Nodes description: Displays a list of installed apps and their nodes. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/App_names' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AppNodeGetResponse' /api/2.52/arrays: get: tags: - Arrays summary: Pure Storage List Arrays description: | Displays general array properties including the array name, login banner, idle timeout for management sessions, and NTP servers. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ArrayGetResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/ArrayGetResponse' delete: tags: - Arrays summary: Pure Storage Delete an Array description: | Deletes an array. For physical appliances, deleting an array restores the hardware to factory settings. This entails deleting all data, metadata, configuration, and logs. The array returns to the state it was in prior to any configuration changes being made. If the hardware is reused, it must be as a different array with a new ID. For virtual appliances, deleting an array puts it into an unusable state. Virtual resources (e.g., virtual machines) can later be freed, which deletes any remaining data, metadata, configuration, and logs. Prior to factory reset, an array must be manually prepared (e.g., all volumes and snapshots must be eradicated) and a factory reset token must be created. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Eradicate_all_data' - $ref: '#/components/parameters/Factory_reset_token' responses: "200": description: OK content: {} patch: tags: - Arrays summary: Pure Storage Modify an Array description: | Modifies general array properties such as the array name, login banner, idle timeout for management sessions, and NTP servers. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/Arrays' required: true x-codegen-request-body-name: array responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ArrayResponse' x-codegen-request-body-name: array /api/2.52/arrays/cache: get: tags: - Arrays summary: Pure Storage DIMM Cache Status description: The status of the DIMM cache. parameters: - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/History_start_time' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/CacheGetResponse' /api/2.52/arrays/cloud-config: get: tags: - Arrays summary: Pure Storage List CBS Array Configuration Status description: | Displays the configuration status of the CBS array, including the progress of the configuration upgrade. Requests for non-CBS arrays will receive an error response. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/CloudConfigGetResponse' patch: tags: - Arrays summary: Pure Storage Modify CBS Array Configuration description: | Modifies the configuration of the CBS array. This should trigger a backend process that will upgrade the CBS array configuration. The array can be upgraded only to models defined by the supported configurations endpoint. When an existing array upgrade request is in progress, any new request to upgrade the array will receive an error response. For non-CBS arrays, this feature is not supported and requests will receive an error response. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' requestBody: description: The requested configuration of the CBS array hardware. content: application/json: schema: $ref: '#/components/schemas/CloudConfigPatch' required: true x-codegen-request-body-name: config responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/CloudConfigPatchResponse' x-codegen-request-body-name: config /api/2.52/arrays/cloud-config/supported-configs: get: tags: - Arrays summary: Pure Storage List CBS Array Supported Upgrade Target Configs description: | Displays the list of supported configurations to which the CBS array can be upgraded. Requests for non-CBS arrays will receive an error response. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/CloudConfigSupportedConfigsGetResponse' /api/2.52/arrays/cloud-capacity: get: tags: - Arrays summary: Pure Storage List CBS Array Capacity Status description: | Displays the capacity status of the CBS array including the progress of the capacity update. Requests for non-CBS arrays will receive an error response. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/CloudCapacityGetResponse' patch: tags: - Arrays summary: Pure Storage Modify CBS Array Capacity description: | Modifies the raw capacity of the CBS array. This should trigger a backend process that will update the CBS array capacity. The array capacity can be updated only to values defined by the capacity steps endpoint. When an existing capacity update request is in progress, any new request to update of the capacity will receive an error response. For non-CBS arrays, this feature is not supported and requests will receive an error response. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' requestBody: description: The requested capacity of the CBS array. content: application/json: schema: $ref: '#/components/schemas/CloudCapacityStatus' required: true x-codegen-request-body-name: capacity responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/CloudCapacityPatchResponse' x-codegen-request-body-name: capacity /api/2.52/arrays/cloud-capacity/supported-steps: get: tags: - Arrays summary: Pure Storage List CBS Array Capacity Steps description: | Displays the list of supported raw capacity sizes in bytes the CBS array can be upgraded to. Requests for non-CBS arrays will receive an error response. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/CloudCapacityStepsGetResponse' /api/2.52/arrays/cloud-provider-tags: get: tags: - Arrays summary: Pure Storage List User Tags on the Cloud. description: Displays the list of user tags on deployed cloud resources of a CBS array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/CloudProviderTagGetResponse' delete: tags: - Arrays summary: Pure Storage Delete User Tags from the Cloud. description: Deletes user tags from deployed cloud resources of a CBS array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Keys' responses: "200": description: OK content: {} /api/2.52/arrays/cloud-provider-tags/batch: put: tags: - Arrays summary: Pure Storage Update User Tags on the Cloud. description: Updates users tags to deployed cloud resources of a CBS array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' requestBody: description: "A list of tags to be created or, if already existing, updated." content: application/json: schema: maxItems: 50 minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/CloudProviderTag' required: true x-codegen-request-body-name: tag responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/CloudProviderTagResponse' x-codegen-request-body-name: tag /api/2.52/arrays/erasures: get: tags: - Arrays summary: Pure Storage List Factory Reset Details description: | Displays a list of factory reset processes. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ArrayErasureGetResponse' post: tags: - Arrays summary: Pure Storage Create a Process for Factory Reset description: |+ Creates the initiation of the factory reset process parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Eradicate_all_data_required' - $ref: '#/components/parameters/Preserve_configuration_data_required' - $ref: '#/components/parameters/Skip_phonehome_check' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ArrayErasureResponse' delete: tags: - Arrays summary: Pure Storage Delete Factory Reset description: |+ Deletes the factory reset process when it is `failed`. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' responses: "200": description: OK content: {} patch: tags: - Arrays summary: Pure Storage Update Factory Reset description: |+ Modifies the factory reset process to finalize. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Delete_sanitization_certificate_required' - $ref: '#/components/parameters/Eradicate_all_data_required' - $ref: '#/components/parameters/Finalize_array_erasure_required' - $ref: '#/components/parameters/Reinstall_image_required' requestBody: content: application/json: schema: $ref: '#/components/schemas/ArrayErasurePatch' required: false x-codegen-request-body-name: erasure_patch responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ArrayErasureResponse' x-codegen-request-body-name: erasure_patch /api/2.52/arrays/eula: get: tags: - Arrays summary: Pure Storage List End User Agreement and Signature description: Displays the End User Agreement and signature. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/EulaGetResponse' patch: tags: - Arrays summary: Pure Storage Modify Signature on the End User Agreement description: Modifies the signature on the End User Agreement. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' requestBody: content: application/json: schema: $ref: '#/components/schemas/Eula' required: false x-codegen-request-body-name: eula responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/EulaResponse' x-codegen-request-body-name: eula /api/2.52/arrays/factory-reset-token: get: tags: - Arrays summary: Pure Storage List Factory Reset Tokens description: Displays a list of tokens used to perform a factory reset on the array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ArrayFactoryResetTokenGetResponse' post: tags: - Arrays summary: Pure Storage Create a Factory Reset Token description: |+ Creates a token that can be used to perform a factory reset on the array. Factory reset tokens can only be created after the array has been prepared for reset (e.g., all volumes and snapshots must first be eradicated). After a token has been created, operations that would take the array out of the prepared state are disabled (e.g., creating volumes) until all tokens have been deleted. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ArrayFactoryResetTokenResponse' delete: tags: - Arrays summary: Pure Storage Delete a Factory Reset Token description: Deletes an existing token that could be used to perform a factory reset on the array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' responses: "200": description: OK content: {} /api/2.52/arrays/ntp-test: get: tags: - Arrays summary: Pure Storage List NTP Test Results description: Displays test results for configured NTP servers. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TestResultGetResponse' /api/2.52/arrays/performance: get: tags: - Arrays summary: Pure Storage List Array Front-end Performance Data description: |+ Displays real-time and historical front-end performance data at the array level including latency, bandwidth, IOPS, average I/O size, and queue depth. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Perf_protocol_type' - $ref: '#/components/parameters/Perf_protocol_group' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ArrayPerformanceGetResponse' /api/2.52/arrays/performance/by-link: get: tags: - Arrays summary: Pure Storage List Array Front-end IO Performance Data by Link description: |+ Displays real-time and historical front-end performance data at the array level including latency, bandwidth, IOPS, average I/O size, and queue depth. Group output is shown by link. A link represents a set of arrays that an I/O operation depends on. For local-only I/Os, this is a local array. For mirrored I/Os, this is a set of synchronous replication peer arrays. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ArrayPerformanceByLinkGetResponse' /api/2.52/arrays/space: get: tags: - Arrays summary: Pure Storage List Array Space Information description: |+ Displays real-time and historical array space information including unique volume and snapshot space, shared space, data reduction, provisioned capacity, usable capacity, and parity. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ArraySpaceGetResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/ArraySpaceGetResponse' /api/2.52/arrays/tags: get: tags: - Arrays summary: Pure Storage List Tags description: | Displays the list of tags on array objects. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Namespaces' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TagGetResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/TagGetResponse' delete: tags: - Arrays summary: Pure Storage Delete Tags description: | Deletes specified tags on array objects. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Keys' - $ref: '#/components/parameters/Namespaces' responses: "200": description: OK content: {} /api/2.52/arrays/tags/batch: put: tags: - Arrays summary: Pure Storage Update Tags description: | Updates tags. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' requestBody: description: "A list of tags to be created or, if they already exist, updated." content: application/json: schema: maxItems: 30 minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/NonCopyableTag' required: true x-codegen-request-body-name: tag responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TagResponse' x-codegen-request-body-name: tag /api/2.52/array-connections: get: tags: - Array Connections summary: Pure Storage List the Connected Arrays description: | Displays a list of connected arrays. 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/Remote_ids' - $ref: '#/components/parameters/Remote_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ArrayConnectionGetResponse' "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/ArrayConnectionGetResponse' post: tags: - Array Connections summary: Pure Storage Create an Array Connection description: | Creates a connection between this array and the specified array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/ArrayConnectionPost' required: true x-codegen-request-body-name: array-connection responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ArrayConnectionResponse' x-codegen-request-body-name: array-connection delete: tags: - Array Connections summary: Pure Storage Delete an Array Connection description: | Deletes the connection between this array and the specified array. 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: - Array Connections summary: Pure Storage Modify an Array Connection description: | Modifies attributes for an array connection. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Refresh' - $ref: '#/components/parameters/Renew_encryption_key' requestBody: content: application/json: schema: $ref: '#/components/schemas/ArrayConnectionPatch' required: false x-codegen-request-body-name: array-connection responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ArrayConnectionResponse' x-codegen-request-body-name: array-connection /api/2.52/array-connections/connection-key: get: tags: - Array Connections summary: Pure Storage List Connection Key description: Displays the connection key for the array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Encrypted' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ArrayConnectionKeyGetResponse' /api/2.52/array-connections/path: get: tags: - Array Connections summary: Pure Storage List Connection Path description: | Displays the connection path from the array to which the connection was made. 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/Remote_ids' - $ref: '#/components/parameters/Remote_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ArrayConnectionPathGetResponse' "207": description: | Indicates partial success. Some resources were returned, but errors may have prevented other resources from being returned. content: application/json: schema: $ref: '#/components/schemas/ArrayConnectionPathGetResponse' /api/2.52/audits: get: tags: - Audits summary: Pure Storage List Audits description: Displays a list of audits. 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/AuditGetResponse' "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/AuditGetResponse' /api/2.52/buckets: get: tags: - Buckets summary: Pure Storage GET Buckets description: List object store bucket attributes such as creation time and space usage. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/BucketGetResponse' "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/BucketGetResponse' post: tags: - Buckets summary: Pure Storage POST Buckets description: Create a new object store bucket. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names_required' requestBody: content: application/json: schema: $ref: '#/components/schemas/_bucketPostBase' required: true x-codegen-request-body-name: bucket 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/BucketResponse' x-codegen-request-body-name: bucket delete: tags: - Buckets summary: Pure Storage DELETE Buckets description: Delete object store buckets. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' responses: "200": description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: {} patch: tags: - Buckets summary: Pure Storage PATCH Buckets description: Modify object store bucket attributes such as destroyed and versioning. parameters: - $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/_bucketPatchBase' required: true x-codegen-request-body-name: bucket 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/BucketResponse' x-codegen-request-body-name: bucket /api/2.52/buckets/space: get: tags: - Buckets summary: Pure Storage List Bucket Space Information description: |+ The monitoring interface or dataset that provides `physical storage` `consumption` data for each individual `bucket`. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceBucketSpaceGetResponse' "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/ResourceBucketSpaceGetResponse' /api/2.52/buckets/performance: get: x-pure-block-remote-execution: true tags: - Buckets summary: Pure Storage List Bucket Performance Data description: | The monitoring interface that provides real-time and historical performance data, including `latency` and average `I/O` sizes. These metrics are available for each individual `bucket` and as an aggregate total for all buckets across the entire `array`. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/BucketPerformanceGetResponse' /api/2.52/certificates: get: tags: - Certificates summary: Pure Storage List Certificate Attributes description: | Displays certificate attributes. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $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/CertificateGetResponse' post: tags: - Certificates summary: Pure Storage Create Certificate description: | Creates a certificate object and specifies the valid time period and organization details of the certificate. A certificate can be imported or manually configured. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/CertificatePost' required: true x-codegen-request-body-name: certificate responses: "200": description: Returns the newly created certificate object. content: application/json: schema: $ref: '#/components/schemas/CertificateResponse' x-codegen-request-body-name: certificate delete: tags: - Certificates summary: Pure Storage Delete Certificate description: | Deletes a specific certificate object. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' responses: "200": description: OK content: {} patch: tags: - Certificates summary: Pure Storage Modify Certificates description: | Modifies certificate attributes. Modifying self-signed certificate attributes replaces the existing certificate with a new one, generated by Purity//FA, using the specified attributes. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Generate_new_key' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/CertificatePost' required: true x-codegen-request-body-name: certificate responses: "200": description: Returns the newly updated certificate object. content: application/json: schema: $ref: '#/components/schemas/CertificateResponse' x-codegen-request-body-name: certificate /api/2.52/certificates/certificate-groups: get: tags: - Certificates summary: Pure Storage List Certificates and Certificate-groups description: | Lists membership associations between groups and certificates. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Certificate_group_ids' - $ref: '#/components/parameters/Certificate_group_names' - $ref: '#/components/parameters/Certificate_ids' - $ref: '#/components/parameters/Certificate_names' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/CertificateCertificateGroupGetResponse' post: tags: - Certificates summary: Pure Storage Create Certificates Orcertificate-groups description: | Creates one or more certificates to one or more certificate groups. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Certificate_group_ids' - $ref: '#/components/parameters/Certificate_group_names' - $ref: '#/components/parameters/Certificate_ids' - $ref: '#/components/parameters/Certificate_names' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/CertificateCertificateGroupResponse' delete: tags: - Certificates summary: Pure Storage Deletes Certificates/certificate-groups description: | Deletes one or more certificates from one or more certificate groups. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Certificate_group_ids' - $ref: '#/components/parameters/Certificate_group_names' - $ref: '#/components/parameters/Certificate_ids' - $ref: '#/components/parameters/Certificate_names' responses: "200": description: OK content: {} /api/2.52/certificates/uses: get: tags: - Certificates summary: Pure Storage List Certificates Uses description: | Displays the usage and associations of certificates. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $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/CertificateUseGetResponse' /api/2.52/certificate-groups: get: tags: - Certificate Groups summary: Pure Storage List Certificate-groups description: | Display all array certificate groups. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $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/CertificateGroupGetResponse' post: tags: - Certificate Groups summary: Pure Storage Create Certificate-groups description: | Creates one or more certificate groups on the array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/CertificateGroupResponse' delete: tags: - Certificate Groups summary: Pure Storage Delete Certificate-groups description: | Deletes one or more certificate groups from the array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' responses: "200": description: OK content: {} /api/2.52/certificate-groups/certificates: get: tags: - Certificate Groups summary: Pure Storage List Certificate-groups and Certificates description: | Lists membership associations between groups and certificates on the array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Certificate_group_ids' - $ref: '#/components/parameters/Certificate_group_names' - $ref: '#/components/parameters/Certificate_ids' - $ref: '#/components/parameters/Certificate_names' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/CertificateGroupCertificateGetResponse' post: tags: - Certificate Groups summary: Pure Storage Create Certificate-groups/certificates description: | Creates one or more certificates to one or more certificate groups on the array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Certificate_group_ids' - $ref: '#/components/parameters/Certificate_group_names' - $ref: '#/components/parameters/Certificate_ids' - $ref: '#/components/parameters/Certificate_names' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/CertificateGroupCertificateResponse' delete: tags: - Certificate Groups summary: Pure Storage Delete Certificate-groups or Certificates description: | Deletes one or more certificate groups. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Certificate_group_ids' - $ref: '#/components/parameters/Certificate_group_names' - $ref: '#/components/parameters/Certificate_ids' - $ref: '#/components/parameters/Certificate_names' responses: "200": description: OK content: {} /api/2.52/certificate-groups/uses: get: tags: - Certificate Groups summary: Pure Storage List Certificate-groups/uses description: | Lists how certificate groups are being used and by what. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $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/CertificateGroupUseGetResponse' /api/2.52/certificates/certificate-signing-requests: post: tags: - Certificates summary: Pure Storage Create Certificate-signing-requests description: | Creates a certificate signing request using a specified certificate and parameters. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' requestBody: content: application/json: schema: $ref: '#/components/schemas/CertificateSigningRequestPost' required: true x-codegen-request-body-name: certificate responses: "200": description: Returns the newly created certificate object. content: application/json: schema: $ref: '#/components/schemas/CertificateSigningRequestResponse' x-codegen-request-body-name: certificate /api/2.52/connections: get: tags: - Connections summary: Pure Storage List Volume Connections description: |+ Displays a list of connections between a volume and its hosts and host groups, as well as the logical unit numbers (LUNs) or NVMe Namespace IDs (NSIDs) used by the associated hosts to address these volumes. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Host_group_names' - $ref: '#/components/parameters/Host_names' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Protocol_endpoint_ids' - $ref: '#/components/parameters/Protocol_endpoint_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Volume_ids' - $ref: '#/components/parameters/Volume_names' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ConnectionGetResponse' "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/ConnectionGetResponse' post: tags: - Connections summary: Pure Storage Create a Connection Between a Volume and Host or Host Group description: |+ Creates a connection between a volume and a host or host group. One of `volume_names` or `volume_ids` and one of `host_names` or `host_group_names` query parameters are required. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Host_group_names' - $ref: '#/components/parameters/Host_names' - $ref: '#/components/parameters/Volume_ids' - $ref: '#/components/parameters/Volume_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/ConnectionPost' required: false x-codegen-request-body-name: connection responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ConnectionResponse' x-codegen-request-body-name: connection delete: tags: - Connections summary: Pure Storage Delete a Connection Between a Volume and its Host or Host Group description: | Deletes the connection between a volume and its associated host or host group. One of `volume_names` or `volume_ids` and one of `host_names` or `host_group_names` query parameters are required. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Host_group_names' - $ref: '#/components/parameters/Host_names' - $ref: '#/components/parameters/Volume_ids' - $ref: '#/components/parameters/Volume_names' responses: "200": description: OK content: {} /api/2.52/container-default-protections: get: tags: - Container Default Protections summary: Pure Storage List Container Default Protections description: | Displays a list of containers with its default protections. 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/Container_ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Container_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/ContainerDefaultProtectionGetResponse' "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/ContainerDefaultProtectionGetResponse' patch: tags: - Container Default Protections summary: Pure Storage Modify a Container's Default Protections description: | Modifies a container's default protections. To modify, set `default_protections` to the new list. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Container_ids' - $ref: '#/components/parameters/Container_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/ContainerDefaultProtection' required: true x-codegen-request-body-name: container-default-protection responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ContainerDefaultProtectionResponse' x-codegen-request-body-name: container-default-protection /api/2.52/controllers: get: tags: - Controllers summary: Pure Storage List Controller Information and Status description: "Displays the name, mode, FlashArray model, Purity//FA software version, and status of each controller in the array." parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/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/ControllerGetResponse' /api/2.52/directories: get: tags: - Directories summary: Pure Storage List Directories description: | Displays a list of directories, including those pending eradication. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/File_system_ids' - $ref: '#/components/parameters/File_system_names' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' - $ref: '#/components/parameters/Workload_ids' - $ref: '#/components/parameters/Workload_names' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/DirectoryGetResponse' "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/DirectoryGetResponse' post: tags: - Directories summary: Pure Storage Create or Copy Directory description: | Creates a managed directory at the specified path. The managed directory name must consist of a file system name prefix and a managed directory name suffix (separated with ':'). The suffix must be between 1 and 63 characters (alphanumeric and '-') in length and begin and end with a letter or number. The suffix must include at least one letter or '-'. Set `names` to create a managed directory with the specified full managed directory name, or set `file_system_names` or `file_system_ids` in the query parameters and `suffix` in the body parameters to create a managed directory in the specified file system with the specified suffix. These two options are exclusive. The `add_to_policy_names` and `add_to_policy_ids` query parameters specify a list of policy names or ids, respectively, that will be applied to the newly created managed directory. These parameters are mutually exclusive. The `with_default_protection` query parameter specifies whether to use the container default protection configuration for the managed directory. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Add_to_policy_ids_directory' - $ref: '#/components/parameters/Add_to_policy_names_directory' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/File_system_ids' - $ref: '#/components/parameters/File_system_names' - $ref: '#/components/parameters/Ignore_usage' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/With_default_protection_policy_directory' requestBody: content: application/json: schema: $ref: '#/components/schemas/DirectoryPost' required: true x-codegen-request-body-name: directory responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/DirectoryResponse' x-codegen-request-body-name: directory delete: tags: - Directories summary: Pure Storage Delete Managed Directories description: | Deletes one or more managed directories. To be deleted, a managed directory must be empty and not attached to any enabled export policies. Deleted managed directories cannot be recovered. The `ids` or `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/Ids' - $ref: '#/components/parameters/Names' responses: "200": description: OK content: {} patch: tags: - Directories summary: Pure Storage Modify a Managed Directory description: |+ Modifies a managed directory. To rename a managed directory, set `name` to the new name. The `ids` or `names` parameter is required, but cannot be set together. The `name` or `directory_name` parameter is required. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/DirectoryPatch' required: true x-codegen-request-body-name: directory responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/DirectoryResponse' x-codegen-request-body-name: directory /api/2.52/directories/groups: get: tags: - Directories summary: Pure Storage List Group with Content in Directories description: | Displays a list of groups, that have content in specific directories. 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/File_system_ids' - $ref: '#/components/parameters/File_system_names' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Group_quota_gids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Group_sids' - $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/DirectoriesGroupsGetResponse' "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/DirectoriesGroupsGetResponse' /api/2.52/directories/locks/nlm-reclamations: post: tags: - Directories summary: Pure Storage Create NLM Reclamation description: | Creates an NLM reclamation, which is a system-wide operation that affects all clients, so only one may be in progress at a time. Attempting to initiate reclamation while one is in progress will result in an error. When NLM reclamation is initiated, all NLM locks are deleted and client applications are notified that they can reacquire their locks within a grace period. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/DirectoryLockNlmReclamationResponse' /api/2.52/directories/performance: get: tags: - Directories summary: Pure Storage List Directory Performance Data description: |+ Displays real-time and historical performance data, real-time latency data, and average I/O sizes for each directory and as a total of all directories across the entire array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Perf_protocol_type' - $ref: '#/components/parameters/Perf_protocol_group' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/DirectoryPerformanceGetResponse' "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/DirectoryPerformanceGetResponse' /api/2.52/directories/policies: get: tags: - Directories summary: Pure Storage List Policies description: Displays a list of policies that are attached to directories. 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/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/directories/policies/audit-file: get: tags: - Directories summary: Pure Storage List Audit Policies Attached to a Directory description: |+ Displays a list of audit policies that are attached to directories. 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/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: - Directories summary: Pure Storage Create a Membership Between a Directory and One or More Audit Policies description: |+ Creates a membership between a directory and one or more audit policies. Either 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' requestBody: content: application/json: schema: $ref: '#/components/schemas/DirectoryPolicyPost' required: true x-codegen-request-body-name: policies responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberResponse' x-codegen-request-body-name: policies delete: tags: - Directories summary: Pure Storage Delete a Membership Between a Directory and One or More Audit Policies description: |+ Deletes a membership between a directory and one or more audit policies. Either the `policy_ids` or `policy_names` parameter is required, but they cannot be set together. Either 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/Policy_ids' - $ref: '#/components/parameters/Policy_names' responses: "200": description: OK content: {} /api/2.52/directories/policies/autodir: get: tags: - Directories summary: Pure Storage List Auto Managed Directory Policies Attached to a Directory description: |+ Displays a list of auto managed directory policies that are attached to directories. 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/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: - Directories summary: Pure Storage Create a Membership Between a Directory with One or More Auto Managed Directory Policies description: |+ Creates a membership between a directory with one or more auto managed directory policies. 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' requestBody: content: application/json: schema: $ref: '#/components/schemas/DirectoryPolicyPost' required: true x-codegen-request-body-name: policies responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberResponse' x-codegen-request-body-name: policies delete: tags: - Directories summary: Pure Storage Delete a Membership Between a Directory and One or More Auto Managed Directory Policies description: |+ Deletes a membership between a directory with one or more auto managed directory policies. 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/Policy_ids' - $ref: '#/components/parameters/Policy_names' responses: "200": description: OK content: {} /api/2.52/directories/policies/nfs: get: tags: - Directories summary: Pure Storage List NFS Policies Attached to a Directory description: |+ Displays a list of NFS policies that are attached to directories. 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/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: - Directories summary: Pure Storage Create a Membership Between a Directory and One or More NFS Policies description: |+ Creates a membership between a directory and one or more NFS policies. 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' requestBody: content: application/json: schema: $ref: '#/components/schemas/DirectoryPolicyExportPost' required: true x-codegen-request-body-name: policies responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberExportResponse' x-codegen-request-body-name: policies delete: tags: - Directories summary: Pure Storage Delete a Membership Between a Directory and One or More NFS Policies description: |+ Deletes a membership between a directory and one or more NFS policies. 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/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/directories/policies/quota: get: tags: - Directories summary: Pure Storage List Quota Policies Attached to a Directory description: Displays a list of quota policies that are attached to directories. 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/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: - Directories summary: Pure Storage Create a Membership Between a Directory and One or More Quota Policies description: |+ Creates a membership between a directory and one or more quota policies. 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_usage' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/DirectoryPolicyPost' required: true x-codegen-request-body-name: policies responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberResponse' x-codegen-request-body-name: policies delete: tags: - Directories summary: Pure Storage Delete a Membership Between a Directory and One or More Quota Policies description: |+ Deletes a membership between a directory and one or more quota policies. 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/Policy_ids' - $ref: '#/components/parameters/Policy_names' responses: "200": description: OK content: {} /api/2.52/directories/policies/smb: get: tags: - Directories summary: Pure Storage List SMB Policies Attached to a Directory description: Displays a list of SMB policies that are attached to directories. 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/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: - Directories summary: Pure Storage Create a Membership Between a Directory and One or More SMB Policies description: |+ Creates a membership between a directory and one or more SMB policies. 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' requestBody: content: application/json: schema: $ref: '#/components/schemas/DirectoryPolicyExportPost' required: true x-codegen-request-body-name: policies responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberExportResponse' x-codegen-request-body-name: policies delete: tags: - Directories summary: Pure Storage Delete a Membership Between a Directory and One or More SMB Policies description: |+ Deletes a membership between a directory and one or more SMB policies. 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/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/directories/policies/snapshot: get: tags: - Directories summary: Pure Storage List Snapshot Policies Attached to a Directory description: Displays a list of snapshot policies that are attached to directories. 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/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: - Directories summary: Pure Storage Create a Membership Between a Directory with One or More Snapshot Policies description: |+ Creates a membership between a directory with one or more snapshot policies. 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' requestBody: content: application/json: schema: $ref: '#/components/schemas/DirectoryPolicyPost' required: true x-codegen-request-body-name: policies responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberResponse' x-codegen-request-body-name: policies delete: tags: - Directories summary: Pure Storage Delete a Membership Between a Directory and One or More Snapshot Policies description: |+ Deletes a membership between a directory and one or more snapshot policies. 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/Policy_ids' - $ref: '#/components/parameters/Policy_names' responses: "200": description: OK content: {} /api/2.52/directories/policies/user-group-quota: get: tags: - Directories summary: Pure Storage List User-group-quota Policies Attached to a Directory description: | Displays a list of user-group-quota policies that are attached to directories. 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/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: - Directories summary: Pure Storage Create a Membership Between a Directory and One or More User-group-quota Policies description: |+ Creates a membership between a directory and one or more user-group-quota policies. 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' requestBody: content: application/json: schema: $ref: '#/components/schemas/DirectoryPolicyPost' required: true x-codegen-request-body-name: policies responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberResponse' x-codegen-request-body-name: policies delete: tags: - Directories summary: Pure Storage Delete a Membership Between a Directory and One or More User-group-quota Policies description: |+ Deletes a membership between a directory and one or more user-group-quota policies. 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/Policy_ids' - $ref: '#/components/parameters/Policy_names' responses: "200": description: OK content: {} /api/2.52/directories/space: get: tags: - Directories summary: Pure Storage List Directory Space Information description: |+ Displays physical storage consumption data for each directory. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceDirectorySpaceGetResponse' "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/ResourceDirectorySpaceGetResponse' /api/2.52/directories/users: get: tags: - Directories summary: Pure Storage List Users with Content in Directories description: | Displays a list of users that have content in specific directories. 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/File_system_ids' - $ref: '#/components/parameters/File_system_names' - $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/User_quota_uids' - $ref: '#/components/parameters/User_names' - $ref: '#/components/parameters/User_sids' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/DirectoriesUsersGetResponse' "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/DirectoriesUsersGetResponse' /api/2.52/directory-exports: get: tags: - Directory Exports summary: Pure Storage List Directory Exports description: |+ Displays a list of directory exports. 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/Directory_ids' - $ref: '#/components/parameters/Directory_fqnames' - $ref: '#/components/parameters/Export_names' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Directory_export_fqnames' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_fqnames' - $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/DirectoryExportGetResponse' "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/DirectoryExportGetResponse' post: tags: - Directory Exports summary: Pure Storage Create Directory Exports description: | Creates an export of a managed directory. The `directory_ids` or `directory_names` parameter is required, but cannot be set together. The `policy_ids` or `policy_names` parameter is required, but cannot be set together. When server reference is not provided, the `_array_server` is set as effective default. The API provides two options for identifying an export object. One option is to reference it by its fully qualified export name, or alternatively, by a combination of parameters—specifically, the `server` and `export_name`. All identifying parameters must always be provided, either explicitly or as part of the fully qualified name. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Directory_ids' - $ref: '#/components/parameters/Directory_fqnames' - $ref: '#/components/parameters/Directory_export_fqnames' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_fqnames' requestBody: content: application/json: schema: $ref: '#/components/schemas/DirectoryExportPost' required: true x-codegen-request-body-name: exports responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/DirectoryExportResponse' x-codegen-request-body-name: exports delete: tags: - Directory Exports summary: Pure Storage Delete Directory Exports description: |+ Deletes one or more directory exports. If any of the `export_names` is not unique across the system, `policy_ids` or `policy_names` must be specified to determine the exports. When server reference is not provided, the `_array_server` is set as effective default. The API provides two options for identifying an export object. One option is to reference it by its fully qualified export name, or alternatively, by a combination of parameters-specifically, the `server_names` (or `server_ids`) and `export_names`. All identifying parameters must always be provided, either explicitly or as part of the fully qualified name. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Directory_ids' - $ref: '#/components/parameters/Directory_fqnames' - $ref: '#/components/parameters/Export_names' - $ref: '#/components/parameters/Directory_export_fqnames' - $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: {} patch: tags: - Directory Exports summary: Pure Storage Modify Directory Exports description: |+ Modifies a directory export. Used for manually renaming, enabling, and disabling directory exports. To rename a directory export, set 'export_name' to the new name. When server reference is not provided, the `_array_server` is set as effective default. The API provides two options for identifying an export object. One option is to reference it by its fully qualified export name, or alternatively, by a combination of parameters—specifically, the `server` and `export_name`. All identifying parameters must always be provided, either explicitly or as part of the fully qualified name. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Directory_ids' - $ref: '#/components/parameters/Directory_fqnames' - $ref: '#/components/parameters/Export_names' - $ref: '#/components/parameters/Directory_export_fqnames' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_fqnames' - $ref: '#/components/parameters/Server_ids' - $ref: '#/components/parameters/Server_fqnames' requestBody: content: application/json: schema: $ref: '#/components/schemas/DirectoryExportPatch' required: true x-codegen-request-body-name: export responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/DirectoryExportResponse' x-codegen-request-body-name: export /api/2.52/directory-group-quotas: get: tags: - User Group Quotas summary: Pure Storage List Group Quotas. description: | Displays a list of groups and the group quota rules that affect their usage limits. 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/Directory_ids' - $ref: '#/components/parameters/Directory_names' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Group_quota_gids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Group_sids' - $ref: '#/components/parameters/Limit' - $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/DirectoryGroupQuotasGetResponse' "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/DirectoryGroupQuotasGetResponse' /api/2.52/directory-quotas: get: tags: - Directory Quotas summary: Pure Storage List Directories with Attached Quota Policies description: Displays a list of directories and the quota policies attached to them. Directories with multiple policies are listed repeatedly (once per policy). The directories without a policy attached are not listed. 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/Directory_ids' - $ref: '#/components/parameters/Directory_names' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $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/DirectoryQuotasGetResponse' "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/DirectoryQuotasGetResponse' /api/2.52/directory-services: get: tags: - Directory Services summary: Pure Storage List Directory Services Configuration description: | Displays the directory services configuration settings for manageability. 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/Fqnames' - $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/DirectoryServiceGetResponse' "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/DirectoryServiceGetResponse' post: tags: - Directory Services summary: Pure Storage Create Directory Services Configuration description: | Creates directory services configuration. All directory services configuration created using this resource will have `services` set to `data`. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Fqnames_required' requestBody: content: application/json: schema: $ref: '#/components/schemas/DirectoryServicePost' required: true x-codegen-request-body-name: directory-service responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/DirectoryServiceResponse' x-codegen-request-body-name: directory-service delete: tags: - Directory Services summary: Pure Storage Delete Directory Services Configuration description: |+ Deletes directory services configuration. Directory service configuration must not be referenced by any server nor enabled to be deleted. The built-in "management" directory service cannot be deleted. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Fqnames' responses: "200": description: OK content: {} patch: tags: - Directory Services summary: Pure Storage Modify Directory Services Configuration description: | Modifies the directory service configuration. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Fqnames' - $ref: '#/components/parameters/To_member_ids' - $ref: '#/components/parameters/To_member_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/DirectoryServicePatch' required: true x-codegen-request-body-name: directory-service responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/DirectoryServiceResponse' x-codegen-request-body-name: directory-service /api/2.52/directory-services/roles: get: tags: - Directory Services summary: Pure Storage List Group to Management Access Policy Mappings description: | Displays access control settings for remote groups. 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/Group_mapping_names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Role_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/DirectoryServiceRoleGetResponse' "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/DirectoryServiceRoleGetResponse' post: tags: - Directory Services summary: Pure Storage Create a Group in Management Access Policy Mappings description: | Creates one or more groups in management access policy mappings. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_mapping_names_required' requestBody: content: application/json: schema: $ref: '#/components/schemas/DirectoryServiceRolePost' required: true x-codegen-request-body-name: directory-service-roles responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/DirectoryServiceRoleResponse' x-codegen-request-body-name: directory-service-roles delete: tags: - Directory Services summary: Pure Storage Delete Group to Management Access Policy Mappings description: | Deletes one or more group to management access policy mappings. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_mapping_names_required' responses: "200": description: OK content: {} patch: tags: - Directory Services summary: Pure Storage Modify Group to Management Access Policy Mappings description: | Modifies properties of one or more group to management access policy mappings. Modifying management access policies is done at `/directory-services/roles/policies/management-access` instead. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_mapping_names_required' - $ref: '#/components/parameters/Role_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/DirectoryServiceRole' required: true x-codegen-request-body-name: directory-service-roles responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/DirectoryServiceRoleResponse' x-codegen-request-body-name: directory-service-roles /api/2.52/directory-services/roles/policies/management-access: get: tags: - Directory Services summary: Pure Storage List Management Access Policies Attached to a Group to Management Access Policy Mapping description: |+ Displays a list of management access policies that are attached to a group to management access policy mappings. 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/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/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: - Directory Services summary: Pure Storage Create a Membership Between a Group to Management Access Policy Mapping with One or More Management Access Policies description: |+ Creates a membership between a group to management access policy mapping with one or more management access policies. One of `member_ids` or `member_names` parameter 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' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyAssignmentPost' required: true x-codegen-request-body-name: policies responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberCleanResponse' x-codegen-request-body-name: policies delete: tags: - Directory Services summary: Pure Storage Delete a Membership Between a Group to Management Access Policy Mapping and One or More Management Access Policies description: |+ Deletes a membership between a group to management access policy mapping with one or more management access policies. One of `policy_ids` or `policy_names` is required, and one of `member_ids` or `member_names` 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/Policy_ids' - $ref: '#/components/parameters/Policy_names' responses: "200": description: OK content: {} /api/2.52/directory-services/test: get: tags: - Directory Services summary: Pure Storage GET Directory-service/test description: The diagnostic utility that verifies the status and configuration of the `directory services` on the `array`. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names_required' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Server_fqnames' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TestGetResultWithResourceErrorContextMultiserverAwareResponse' "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/TestGetResultWithResourceErrorContextMultiserverAwareResponse' patch: tags: - Directory Services summary: Pure Storage PATCH Directory-service/test description: The diagnostic utility that verifies the status of the configured `directory services` on the `array`. This process supports the optional provision of `configuration` modifications, allowing for validation of proposed changes in a test environment without affecting the current active settings. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names_required' - $ref: '#/components/parameters/Server_fqnames' requestBody: description: | The optional `directory service` `configuration` used to temporarily overwrite specific attributes of existing `objects` during diagnostic testing. These modifications are applied only within the scope of the test and do not persist or alter the current active system settings. content: application/json: schema: $ref: '#/components/schemas/DirectoryServicePatch' required: false x-codegen-request-body-name: directory-service responses: "200": description: OK headers: X-Request-ID: description: The identifier or attribute provided by the `client` during the initial `request` or automatically generated by the `server` if not specified. schema: type: string content: application/json: schema: $ref: '#/components/schemas/TestPatchResultWithResourceMultiserverAwareResponse' x-codegen-request-body-name: directory-service /api/2.52/directory-services/local/directory-services: get: tags: - Directory Services summary: Pure Storage List Local Directory Services description: | Displays a list of local directory services. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $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' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/LocalDirectoryServiceGetResponse' post: tags: - Directory Services summary: Pure Storage Create Local Directory Service description: | Creates a local directory service. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Fqnames_required' requestBody: content: application/json: schema: $ref: '#/components/schemas/LocalDirectoryServicePost' required: false x-codegen-request-body-name: local-directory responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/LocalDirectoryServiceResponse' x-codegen-request-body-name: local-directory delete: tags: - Directory Services summary: Pure Storage Delete Local Directory Services description: | Deletes local directory services. Local directory service can't be deleted when referenced by any server. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Fqnames' responses: "200": description: OK content: {} patch: tags: - Directory Services summary: Pure Storage Modify Local Directory Service description: | Modifies local directory services. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Fqnames' - $ref: '#/components/parameters/To_member_ids' - $ref: '#/components/parameters/To_member_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/LocalDirectoryService' required: true x-codegen-request-body-name: local-directory responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/LocalDirectoryServiceResponse' x-codegen-request-body-name: local-directory /api/2.52/directory-services/local/groups: get: tags: - Directory Services summary: Pure Storage List Local Groups description: | Displays a list of local groups. 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/Gids' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sids' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/LocalGroupGetResponse' "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/LocalGroupGetResponse' post: tags: - Directory Services summary: Pure Storage Create Local Group description: | Creates a local group. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Local_directory_service_ids' - $ref: '#/components/parameters/Local_directory_service_names' - $ref: '#/components/parameters/Names_required' requestBody: content: application/json: schema: $ref: '#/components/schemas/LocalGroupPost' required: false x-codegen-request-body-name: local-group responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/LocalGroupResponse' x-codegen-request-body-name: local-group delete: tags: - Directory Services summary: Pure Storage Delete Local Groups description: | Deletes one or more local groups. The `gids`, `names`, or `sids` 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/Gids' - $ref: '#/components/parameters/Local_directory_service_ids' - $ref: '#/components/parameters/Local_directory_service_names' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Sids' responses: "200": description: OK content: {} patch: tags: - Directory Services summary: Pure Storage Modify Local Groups description: |+ Modifies local groups. The `gids`, `names`, or `sids` 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/Gids' - $ref: '#/components/parameters/Local_directory_service_ids' - $ref: '#/components/parameters/Local_directory_service_names' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Sids' requestBody: content: application/json: schema: $ref: '#/components/schemas/LocalGroupPatch' required: true x-codegen-request-body-name: local-group responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/LocalGroupResponse' x-codegen-request-body-name: local-group /api/2.52/directory-services/local/groups/members: get: tags: - Directory Services summary: Pure Storage List Local Group Memberships description: | Displays a list of local group memberships. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Group_gids' - $ref: '#/components/parameters/Local_group_names' - $ref: '#/components/parameters/Group_sids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Local_member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_sids' - $ref: '#/components/parameters/Member_types' - $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/LocalMembershipGetResponse' "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/LocalMembershipGetResponse' post: tags: - Directory Services summary: Pure Storage Create Local Group Membership description: | Creates a local group membership with a group. The `group_names`, `group_sids`, or `group_gids` 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/Group_gids' - $ref: '#/components/parameters/Local_group_names' - $ref: '#/components/parameters/Group_sids' - $ref: '#/components/parameters/Local_directory_service_ids' - $ref: '#/components/parameters/Local_directory_service_names' requestBody: description: | The `member_names`, `member_sids`, or `member_gids` parameter is required, but cannot be set together. content: application/json: schema: $ref: '#/components/schemas/LocalGroupMembershipPost' required: true x-codegen-request-body-name: local-membership responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/LocalMembershipResponse' x-codegen-request-body-name: local-membership delete: tags: - Directory Services summary: Pure Storage Delete Local Group Membership description: |+ Deletes one or more local group memberships. The `group_names`, `group_sids`, or `group_gids` parameter is required, but cannot be set together. The `member_names`, `member_sids`, or `member_gids` 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/Group_gids' - $ref: '#/components/parameters/Local_group_names' - $ref: '#/components/parameters/Group_sids' - $ref: '#/components/parameters/Local_directory_service_ids' - $ref: '#/components/parameters/Local_directory_service_names' - $ref: '#/components/parameters/Local_member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_sids' - $ref: '#/components/parameters/Member_types' responses: "200": description: OK content: {} /api/2.52/directory-services/local/users: get: tags: - Directory Services summary: Pure Storage List Local Users description: | Displays a list of local users. 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/Sids' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Uids' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/LocalUserGetResponse' "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/LocalUserGetResponse' post: tags: - Directory Services summary: Pure Storage Create Local User description: | Creates a local user. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Local_directory_service_ids' - $ref: '#/components/parameters/Local_directory_service_names' - $ref: '#/components/parameters/Names_required' requestBody: content: application/json: schema: $ref: '#/components/schemas/LocalUserPost' required: false x-codegen-request-body-name: local-user responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/LocalUserResponse' x-codegen-request-body-name: local-user delete: tags: - Directory Services summary: Pure Storage Delete Local Users description: | Deletes one or more local users. The `uids`, `names`, or `sids` 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/Local_directory_service_ids' - $ref: '#/components/parameters/Local_directory_service_names' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Sids' - $ref: '#/components/parameters/Uids' responses: "200": description: OK content: {} patch: tags: - Directory Services summary: Pure Storage Modify Local User description: | Modifies a local user. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/KeepSessionsOpen' - $ref: '#/components/parameters/Local_directory_service_ids' - $ref: '#/components/parameters/Local_directory_service_names' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Sids' - $ref: '#/components/parameters/Uids' requestBody: content: application/json: schema: $ref: '#/components/schemas/LocalUserPatch' required: true x-codegen-request-body-name: local-user responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/LocalUserResponse' x-codegen-request-body-name: local-user /api/2.52/directory-services/local/users/members: get: tags: - Directory Services summary: Pure Storage List Local User Memberships description: | Displays a list of local user memberships. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Group_gids' - $ref: '#/components/parameters/Local_group_names' - $ref: '#/components/parameters/Group_sids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Local_member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_sids' - $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/LocalMembershipGetResponse' "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/LocalMembershipGetResponse' post: tags: - Directory Services summary: Pure Storage Create Local User Membership description: | Creates a local user membership with a group. The `member_names` or `member_sids` or `member_ids` 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/Local_directory_service_ids' - $ref: '#/components/parameters/Local_directory_service_names' - $ref: '#/components/parameters/Local_member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_sids' requestBody: description: | The `group_names`, `group_sids`, or `group_gids` parameter is required, but cannot be set together. content: application/json: schema: $ref: '#/components/schemas/LocalUserMembershipPost' required: true x-codegen-request-body-name: local-membership responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/LocalMembershipResponse' x-codegen-request-body-name: local-membership delete: tags: - Directory Services summary: Pure Storage Delete Local User Membership description: | Deletes one or more local user memberships. The `member_names`, `member_sids`, or `member_ids` 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/Group_gids' - $ref: '#/components/parameters/Local_group_names' - $ref: '#/components/parameters/Group_sids' - $ref: '#/components/parameters/Local_directory_service_ids' - $ref: '#/components/parameters/Local_directory_service_names' - $ref: '#/components/parameters/Local_member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_sids' - $ref: '#/components/parameters/Member_types' responses: "200": description: OK content: {} /api/2.52/directory-snapshots: get: tags: - Directory Snapshots summary: Pure Storage List Directory Snapshots description: |+ Displays a list of directory snapshots, including those pending eradication. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Source_ids' - $ref: '#/components/parameters/Source_names' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/DirectorySnapshotGetResponse' "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/DirectorySnapshotGetResponse' post: tags: - Directory Snapshots summary: Pure Storage Create Directory Snapshot description: |+ Creates a snapshot of the contents of a directory. The `source_ids` or `source_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/Source_ids' - $ref: '#/components/parameters/Source_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/DirectorySnapshotPost' required: true x-codegen-request-body-name: directory-snapshot responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/DirectorySnapshotResponse' x-codegen-request-body-name: directory-snapshot delete: tags: - Directory Snapshots summary: Pure Storage Delete Directory Snapshot description: |+ Deletes a directory snapshot that has been destroyed and is pending eradication. Eradicated directory snapshots cannot be recovered. Directory snapshots are destroyed by using the PATCH method. The `ids` or `names` parameter is required, but they cannot be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' responses: "200": description: OK content: {} patch: tags: - Directory Snapshots summary: Pure Storage Modify Directory Snapshot description: |+ Modifies a directory snapshot. You can destroy, recover, or update the policy or time remaining of a directory snapshot. To destroy a directory snapshot, set `destroyed=true`. To recover a directory snapshot that has been destroyed and is pending eradication, set `destroyed=false`. To rename a directory snapshot, 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/DirectorySnapshotPatch' required: true x-codegen-request-body-name: directory-snapshot responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/DirectorySnapshotResponse' x-codegen-request-body-name: directory-snapshot /api/2.52/directory-user-quotas: get: tags: - User Group Quotas summary: Pure Storage List User Quotas. description: | Displays a list of users and the user quota rules that affect their usage limits. 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/Directory_ids' - $ref: '#/components/parameters/Directory_names' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/User_quota_uids' - $ref: '#/components/parameters/User_names' - $ref: '#/components/parameters/User_sids' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/DirectoryUserQuotasGetResponse' "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/DirectoryUserQuotasGetResponse' /api/2.52/dns: get: tags: - DNS summary: Pure Storage List DNS Parameters description: | Displays the current DNS configurations and their parameters including domain suffix, the list of DNS name server IP addresses, and the list of services that DNS parameters apply to. 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/Fqnames' - $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/DnsGetResponse' "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/DnsGetResponse' post: tags: - DNS summary: Pure Storage Create DNS Configuration description: | Creates new DNS configuration with parameters including the domain suffix, the list of DNS name server IP addresses, and the list of services that DNS parameters apply to. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Fqnames' requestBody: content: application/json: schema: $ref: '#/components/schemas/DnsPost' required: true x-codegen-request-body-name: dns responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/DnsResponse' x-codegen-request-body-name: dns delete: tags: - DNS summary: Pure Storage Delete DNS Configuration description: | Deletes DNS configuration identified by configuration name. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Fqnames' responses: "200": description: OK content: {} patch: tags: - DNS summary: Pure Storage Modify DNS Parameters description: | Modifies the DNS parameters of an array, including the domain suffix, the list of DNS name server IP addresses, and the list of services that DNS parameters apply to. If there is no DNS configuration beforehand new DNS configuration with 'default' name is created. If more than one DNS configuration exists, `name` has to be specified to identify the DNS configuration to be modified. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Fqnames' requestBody: content: application/json: schema: $ref: '#/components/schemas/DnsPatch' required: true x-codegen-request-body-name: dns responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/DnsResponse' x-codegen-request-body-name: dns /api/2.52/drives: get: tags: - Drives summary: "Pure Storage List Flash, NVRAM, and Cache Modules" description: "Displays a list of flash, NVRAM, and cache modules that are installed in the array along with their attributes and status." parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/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/DriveGetResponse' patch: tags: - Drives summary: Pure Storage Modify Flash and NVRAM Modules description: Modifies flash and NVRAM modules that have been added or connected but not yet admitted to the array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Admit' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/DriveResponse' /api/2.52/file-systems: get: tags: - File Systems summary: Pure Storage List File Systems description: | Displays a list of file systems, including those pending eradication. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Workload_ids' - $ref: '#/components/parameters/Workload_names' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/FileSystemGetResponse' "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/FileSystemGetResponse' post: tags: - File Systems summary: Pure Storage Create File System description: | Creates one or more file systems. The `add_to_policy_names` and `add_to_policy_ids` query parameters specify a list of policy names or ids, respectively, that will be applied to the root directory of the newly created file system. These parameters are mutually exclusive. The `with_default_protection` query parameter specifies whether to use the container default protection configuration for the root directory of the file system. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Add_to_policy_ids_file_system' - $ref: '#/components/parameters/Add_to_policy_names_file_system' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/With_default_protection_policy_file_system' requestBody: content: application/json: schema: $ref: '#/components/schemas/FileSystemPost' x-codegen-request-body-name: file-system responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/FileSystemResponse' delete: tags: - File Systems summary: Pure Storage Delete File System description: | Deletes a file system that has been destroyed and is pending eradication. Eradicated file systems cannot be recovered. File systems are destroyed using the PATCH method. 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: - File Systems summary: Pure Storage Modify a File System description: | Modifies a file system. You can rename, destroy, move, or recover a file system. To rename a file system, set `name` to the new name. To destroy a file system, set `destroyed=true`. To move a file system, set 'pod' to the destination pod reference. To recover a file system that has been destroyed and is pending eradication, set `destroyed=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/FileSystemPatch' required: true x-codegen-request-body-name: file-system responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/FileSystemResponse' x-codegen-request-body-name: file-system /api/2.52/files: post: tags: - Files summary: Pure Storage Create a File Copy description: | Creates a file copy from one path to another path. The `directory_ids`, `directory_names` or `paths` value must be specified. If the `directory_ids` or `directory_names` value is not specified, the file is copied to the source directory specified in the body params. The `paths` value refers to the path of the target file relative to the target directory. If `paths` value is not specified, the file will be copied to the relative path specified in `source_path` under the target directory. The `source_path` value refers to the path of the source file relative to the source directory. To overwrite an existing file, set the `overwrite` flag to `true`. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Directory_ids' - $ref: '#/components/parameters/Directory_names' - $ref: '#/components/parameters/Overwrite' - $ref: '#/components/parameters/Paths' requestBody: content: application/json: schema: $ref: '#/components/schemas/FilePost' required: true x-codegen-request-body-name: source-file responses: "200": description: OK content: {} x-codegen-request-body-name: source-file /api/2.52/fleets: get: tags: - Fleets summary: Pure Storage List Fleets description: |+ Displays information about the fleets known to the array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names_single' - $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/FleetGetResponse' post: tags: - Fleets summary: Pure Storage Create a Fleet description: |+ Creates a fleet and adds the current array as its first member. Additional arrays can be added to the fleet with `POST /fleets/members`. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names_single' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/FleetResponse' delete: tags: - Fleets summary: Pure Storage Delete a Fleet description: |+ Deletes a fleet, permanently. A fleet can only be deleted if the current array is the only array in the fleet. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Ids_single' - $ref: '#/components/parameters/Names_single' responses: "200": description: OK content: {} patch: tags: - Fleets summary: Pure Storage Modify a Fleet description: |+ Modifies a fleet, changing its name by passing the old name in `name` query parameter, and the new name in the `name` parameter in the request body. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Ids_single' - $ref: '#/components/parameters/Names_single' requestBody: content: application/json: schema: $ref: '#/components/schemas/FleetPatch' required: true x-codegen-request-body-name: fleet responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/FleetResponse' x-codegen-request-body-name: fleet /api/2.52/fleets/fleet-key: get: tags: - Fleets summary: Pure Storage Get Fleet Key Information description: |+ Displays the time remaining on the fleet key. Note, fleet key itself is not displayed, since that is only available at time of fleet key creation. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/FleetKeyGetResponse' post: tags: - Fleets summary: Pure Storage Create a Fleet Key description: |+ Creates a fleet key allowing an array to be added to a fleet. This is the only time the fleet key is displayed, it cannot be retrieved subsequently. Note, creation of a subsequent key invalidates all keys created earlier. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/FleetKeyResponse' /api/2.52/fleets/members: get: tags: - Fleets summary: Pure Storage List Fleet Members description: |+ Displays the members in the current fleet. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Fleet_ids' - $ref: '#/components/parameters/Fleet_names' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/FleetMemberGetResponse' post: tags: - Fleets summary: Pure Storage Add Members to a Fleet description: |+ Adds arrays to an existing fleet. This API needs to be run from the array that's joining the fleet. To add the current array to the fleet, specify its own array `id` or `name`, as well as the `fleet key` generated on any array already in the fleet. `resource_type` is `remote-arrays`. The array's `ID` and `name` can be retrieved with a call to `GET /arrays` on the array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Fleet_ids' - $ref: '#/components/parameters/Fleet_names' requestBody: description: | Info about the members being added to fleet. content: application/json: schema: $ref: '#/components/schemas/FleetMemberPost' required: false x-codegen-request-body-name: members responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/FleetMemberResponse' x-codegen-request-body-name: members delete: tags: - Fleets summary: Pure Storage Delete Fleet Members description: |+ Deletes the specified array(s) from the fleet. Note that this will only succeed if the array(s) to be removed are not making use of any fleet resources. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Unreachable' responses: "200": description: OK content: {} /api/2.52/hardware: get: tags: - Hardware summary: Pure Storage List Hardware Component Information description: Displays a list of hardware slots and bays and status of installed components. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $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/HardwareGetResponse' patch: tags: - Hardware summary: Pure Storage Modify Visual Identification description: "Modifies the visual identification of a specified hardware component, and causing the ID LED to turn on or off." parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/HardwarePatch' required: true x-codegen-request-body-name: hardware responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/HardwareResponse' x-codegen-request-body-name: hardware /api/2.52/host-groups: get: tags: - Host Groups summary: Pure Storage List Host Groups description: |+ Displays a list of host groups. 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/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/HostGroupGetResponse' "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/HostGroupGetResponse' post: tags: - Host Groups summary: Pure Storage Create a Host Group and Upsert Tags description: |+ Creates a host group in which the `names` query parameter is required. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/HostGroupPost' required: false x-codegen-request-body-name: host-group responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/HostGroupResponse' x-codegen-request-body-name: host-group delete: tags: - Host Groups summary: Pure Storage Delete a Host Group description: |+ Deletes a host group in which the `names` query parameter is required. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' responses: "200": description: OK content: {} patch: tags: - Host Groups summary: Pure Storage Modify a Host Group description: |+ Modifies a host group in which the `names` query parameter is required. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/From_member_ids' - $ref: '#/components/parameters/From_member_names' - $ref: '#/components/parameters/Modify_resource_access_on_move' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/To_member_ids' - $ref: '#/components/parameters/To_member_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/HostGroupPatch' required: true x-codegen-request-body-name: host-group responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/HostGroupResponse' x-codegen-request-body-name: host-group /api/2.52/host-groups/hosts: get: tags: - Host Groups summary: Pure Storage List Host Groups That Are Associated with Hosts description: |+ Displays a list of host groups that are associated with hosts. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/MemberNoIdAllGetResponse' "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/MemberNoIdAllGetResponse' post: tags: - Host Groups summary: Pure Storage Create a Membership to a Host Group description: | Create a membership between a host and a host group. Adding a membership to a host group automatically connects the host to all volumes associated with the group. Multiple hosts can be belong to a host group, but a host can only belong to one host group. Hosts can be added to host groups at any time. The `group_names` and `member_names` parameters are required and must be set together, and only one host group can be specified at a time. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Member_names' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/MemberNoIdAllResponse' delete: tags: - Host Groups summary: Pure Storage Delete a Membership from a Host Group description: | Deletes a membership from a host group. Removing a membership from a host group automatically disconnects the host from all volumes associated with the group. Hosts can be removed from host groups at any time. The `group_names` and `member_names` parameters are required and must be set together, and only one host group can be specified at a time. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Member_names' responses: "200": description: OK content: {} /api/2.52/host-groups/performance: get: tags: - Host Groups summary: Pure Storage List Host Group Performance Data description: |+ Displays real-time and historical performance data, real-time latency data, and average I/O sizes of all host groups, displayed both by host group and by total size across all host groups. This data represents volumes that are connected to the host groups on the local array and stretched volumes connected to the host groups on arrays that are connected by synchronous replication. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourcePerformanceNoIdGetResponse' "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/ResourcePerformanceNoIdGetResponse' /api/2.52/host-groups/performance/by-array: get: tags: - Host Groups summary: Pure Storage List Host Group Performance Data by Array description: |+ Displays real-time and historical performance data, real-time latency data, and average I/O size data. The data is displayed by total size across all host groups on each array and by individual host group on each array. The displayed data represents the volumes that are connected to a host group on the current array and the volumes that are connected to a host group on any remote arrays that are visible to the current array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourcePerformanceNoIdByArrayGetResponse' "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/ResourcePerformanceNoIdByArrayGetResponse' /api/2.52/host-groups/protection-groups: get: tags: - Host Groups summary: Pure Storage List Host Groups That Are Members of Protection Groups description: | Displays a list of host group members that belong to one or more protection groups. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/MemberNoIdMemberGetResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/MemberNoIdMemberGetResponse' post: tags: - Host Groups summary: Pure Storage Create a Host Group description: | Creates a host group member and assigns to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. The `group_names` parameter represents the name of the protection group, and the `member_names` parameter represents the name of the host group. The `group_names` and `member_names` parameters are required and must be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Member_names' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/MemberNoIdMemberResponse' delete: tags: - Host Groups summary: Pure Storage Delete a Host Group from a Protection Group description: | Deletes a host group member from a protection group. After the member has been removed, it is no longer protected by the group. Any protection group snapshots that were taken before the member was removed are not affected. Removing a member from a protection group does not delete the member from the array or realm, and the member can be added back to the protection group at any time. The `group_names` parameter represents the name of the protection group, and the `member_names` parameter represents the name of the host group. The `group_names` and `member_names` parameters are required and must be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Member_names' responses: "200": description: OK content: {} /api/2.52/host-groups/qos: get: tags: - Host Groups summary: Pure Storage List Host Group QoS Config description: | Displays real-time and historical QoS config data for each host group. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/HostGroupQosGetResponse' "207": description: | Indicates partial success. Some resources were returned, but errors may have prevented other resources from being returned. content: application/json: schema: $ref: '#/components/schemas/HostGroupQosGetResponse' /api/2.52/host-groups/space: get: tags: - Host Groups summary: Pure Storage List Host Group Space Information description: | Displays provisioned size and physical storage consumption data for each host group. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/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/ResourceSpaceNoIdGetResponse' "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/ResourceSpaceNoIdGetResponse' /api/2.52/host-groups/tags: get: tags: - Host Groups summary: Pure Storage List Tags description: | Displays the list of tags on host group objects. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Namespaces' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Resource_destroyed' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TagGetResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/TagGetResponse' delete: tags: - Host Groups summary: Pure Storage Delete Tags description: | Deletes specified tags on host group objects. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Keys' - $ref: '#/components/parameters/Namespaces' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' responses: "200": description: OK content: {} /api/2.52/host-groups/tags/batch: put: tags: - Host Groups summary: Pure Storage Update Tags description: | Updates tags. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' requestBody: description: "A list of tags to be created or, if one already exists, updated." content: application/json: schema: maxItems: 30 minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/NonCopyableTagBatch' required: true x-codegen-request-body-name: tag responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TagResponse' x-codegen-request-body-name: tag /api/2.52/hosts: get: tags: - Hosts summary: Pure Storage List Hosts description: |+ Displays a list of hosts. 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/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/HostGetResponse' "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/HostGetResponse' post: tags: - Hosts summary: Pure Storage Create a Host and Upsert Tags description: |+ Creates a host for which the `names` query parameter is required. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/HostPost' required: true x-codegen-request-body-name: host responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/HostResponse' x-codegen-request-body-name: host delete: tags: - Hosts summary: Pure Storage Delete a Host description: |+ Deletes an existing host. All volumes that are connected to the host, either through private or shared connections, must be disconnected from the host before the host can be deleted. The `names` query parameter is required. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' responses: "200": description: OK content: {} patch: tags: - Hosts summary: Pure Storage Modify a Host description: |+ Modifies an existing host, including its storage network addresses, CHAP, host personality, and preferred arrays, or associate a host to a host group. The `names` query parameter is required. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/From_member_ids' - $ref: '#/components/parameters/From_member_names' - $ref: '#/components/parameters/Modify_resource_access_on_move' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/To_member_ids' - $ref: '#/components/parameters/To_member_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/HostPatch' required: true x-codegen-request-body-name: host responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/HostResponse' x-codegen-request-body-name: host /api/2.52/hosts/host-groups: get: tags: - Hosts summary: Pure Storage List Hosts That Are Associated with Host Groups description: |+ Displays a list of hosts that are associated with host groups. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/MemberNoIdAllGetResponse' "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/MemberNoIdAllGetResponse' post: tags: - Hosts summary: Pure Storage Create a Membership to a Host Group description: | Creates a membership to a host group. Creating a membership to a host group automatically connects the host to all volumes associated with the group. Multiple hosts can be belong to a host group, but a host can only belong to one host group. Hosts can be added to host groups at any time. The `group_names` and `member_names` parameters are required and must be set together, and only one host group can be specified at a time. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Member_names' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/MemberNoIdAllResponse' delete: tags: - Hosts summary: Pure Storage Delete a Membership from a Host Group description: | Deletes a membership from a host group. Deleting a membership from a host group automatically disconnects the host from all volumes associated with the group. Hosts can be deleted from host groups at any time. The `group_names` and `member_names` parameters are required and must be set together, and only one host group can be specified at a time. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Member_names' responses: "200": description: OK content: {} /api/2.52/hosts/performance: get: tags: - Hosts summary: Pure Storage List Host Performance Data description: |+ Displays real-time and historical performance data, real-time latency data, and average I/O sizes across all hosts, displayed by host and by total size across all hosts. This data represents volumes that are connected to the hosts on the local array and stretched volumes connected to the hosts on any arrays that are connected by synchronous replication. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourcePerformanceNoIdGetResponse' "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/ResourcePerformanceNoIdGetResponse' /api/2.52/hosts/performance/balance: get: tags: - Hosts summary: Pure Storage List Host Performance Balance description: | Displays the I/O balance statistics for host paths. 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/HostPerformanceBalanceGetResponse' "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/HostPerformanceBalanceGetResponse' /api/2.52/hosts/performance/by-array: get: tags: - Hosts summary: Pure Storage List Host Performance Data by Array description: |+ Displays real-time and historical performance data, real-time latency data, and average I/O size data. The data is displayed by total size across all hosts on each array and by individual host on each array. The displayed data represents the volumes that are connected to a host on the current array and the volumes that are connected to a host on any remote arrays that are visible to the current array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourcePerformanceNoIdByArrayGetResponse' "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/ResourcePerformanceNoIdByArrayGetResponse' /api/2.52/hosts/protection-groups: get: tags: - Hosts summary: Pure Storage List Hosts That Are Members of Protection Groups description: | Displays a list of host members that belong to one or more protection groups. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/MemberNoIdMemberGetResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/MemberNoIdMemberGetResponse' post: tags: - Hosts summary: Pure Storage Create a Host description: | Creates a host member and adds it to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. The `group_names` parameter represents the name of the protection group, and the `member_names` parameter represents the name of the host. The `group_names` and `member_names` parameters are required and must be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Member_names' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/MemberNoIdMemberResponse' delete: tags: - Hosts summary: Pure Storage Delete a Host from a Protection Group description: | Deletes a host member from a protection group. After the member has been removed, it is no longer protected by the group. Any protection group snapshots that were taken before the member was removed are not affected. Removing a member from a protection group does not delete the member from the array or realm, and the member can be added back to the protection group at any time. The `group_names` parameter represents the name of the protection group, and the `member_names` parameter represents the name of the host. The `group_names` and `member_names` parameters are required and must be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Member_names' responses: "200": description: OK content: {} /api/2.52/hosts/qos: get: tags: - Hosts summary: Pure Storage List Host QoS Config description: | Displays real-time and historical QoS config data for each host. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/HostQosGetResponse' "207": description: | Indicates partial success. Some resources were returned, but errors may have prevented other resources from being returned. content: application/json: schema: $ref: '#/components/schemas/HostQosGetResponse' /api/2.52/hosts/space: get: tags: - Hosts summary: Pure Storage List Host Space Information description: | Displays provisioned size and physical storage consumption data for each host. 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/ResourceSpaceNoIdGetResponse' "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/ResourceSpaceNoIdGetResponse' /api/2.52/hosts/tags: get: tags: - Hosts summary: Pure Storage List Tags description: | Displays the list of tags on host objects. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Namespaces' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Resource_destroyed' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TagGetResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/TagGetResponse' delete: tags: - Hosts summary: Pure Storage Delete Tags description: | Deletes specified tags on host objects. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Keys' - $ref: '#/components/parameters/Namespaces' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' responses: "200": description: OK content: {} /api/2.52/hosts/tags/batch: put: tags: - Hosts summary: Pure Storage Update Tags description: | Updates tags. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' requestBody: description: "A list of tags to be created or, if one already exists, updated." content: application/json: schema: maxItems: 30 minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/NonCopyableTagBatch' required: true x-codegen-request-body-name: tag responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TagResponse' x-codegen-request-body-name: tag /api/2.52/kmip: get: tags: - KMIP summary: Pure Storage List KMIP Server Objects description: | Displays the list of KMIP server objects. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/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/KmipGetResponse' post: tags: - KMIP summary: Pure Storage Create KMIP Server Object description: | Creates KMIP server objects. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/KmipPost' required: true x-codegen-request-body-name: kmip responses: "200": description: Returns the newly created KMIP server object. content: application/json: schema: $ref: '#/components/schemas/KmipResponse' x-codegen-request-body-name: kmip delete: tags: - KMIP summary: Pure Storage Delete KMIP Server Object description: Deletes KMIP server objects. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' responses: "200": description: OK content: {} patch: tags: - KMIP summary: Pure Storage Modify KMIP Attributes description: | Modifies one or more attributes of KMIP server objects. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/KmipPatch' required: true x-codegen-request-body-name: kmip responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/KmipResponse' x-codegen-request-body-name: kmip /api/2.52/kmip/test: get: tags: - KMIP summary: Pure Storage Lists KMIP Connection Tests description: Displays communication data between a FlashArray and KMIP server. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names_required' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/KmipTestResultGetResponse' /api/2.52/lifecycle-rules: get: tags: - Lifecycle Rules summary: Pure Storage GET Lifecycle-rules description: |+ Returns a list of lifecycle rules. When `names` is specified, list the individual rules. When `ids` is specified, `bucket_names` or `bucket_ids` is also required. When `bucket_names` or `bucket_ids` are specified without `ids`, if there are at most 10 buckets with lifecycle rules in the system, list all the rules for the bucket, else it returns an error. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Bucket_ids' - $ref: '#/components/parameters/Bucket_names' - $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 headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/LifecycleRuleGetResponse' "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/LifecycleRuleGetResponse' post: tags: - Lifecycle Rules summary: Pure Storage POST Lifecycle-rules description: |+ Creates a lifecycle rule. `bucket` and `keep_previous_version_for` are required. If `rule_id` is not specified, it will be automatically generated in the format "faRuleIdX". parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Confirm_date' - $ref: '#/components/parameters/Context_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/_lifecycleRulePostBase' required: true x-codegen-request-body-name: rule 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/LifecycleRuleResponse' x-codegen-request-body-name: rule delete: tags: - Lifecycle Rules summary: Pure Storage DELETE Lifecycle-rules description: |+ Deletes individual lifecycle rules by name or id, or deletes all rules for a bucket. If `ids` is specified, `bucket_names` or `bucket_ids` is also required. If `bucket_names` or `bucket_ids` are specified without `ids`, delete all the rules for the bucket. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Bucket_ids' - $ref: '#/components/parameters/Bucket_names' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' responses: "200": description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: {} patch: tags: - Lifecycle Rules summary: Pure Storage PATCH Lifecycle-rules description: |+ Modify an existing lifecycle rule by name or id. If `ids` is specified, `bucket_names` or `bucket_ids` is also required. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Bucket_ids' - $ref: '#/components/parameters/Bucket_names' - $ref: '#/components/parameters/Confirm_date' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/_lifecycleRulePatchBase' required: true x-codegen-request-body-name: lifecycle 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/LifecycleRuleResponse' x-codegen-request-body-name: lifecycle /api/2.52/log-targets: get: tags: - Log Targets summary: Pure Storage List Log Targets description: Displays a list of configured log targets. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/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/LogTargetsGetResponse' "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/LogTargetsGetResponse' /api/2.52/log-targets/file: get: tags: - Log Targets summary: Pure Storage List File Log Targets description: Displays a list of configured file log targets. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/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/LogTargetFileGetResponse' "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/LogTargetFileGetResponse' post: tags: - Log Targets summary: Pure Storage Create File Log Target description: | Creates a new file log target. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/LogTargetFile' required: true x-codegen-request-body-name: log-target-file responses: "200": description: Displays the newly configured file log target. content: application/json: schema: $ref: '#/components/schemas/LogTargetFileResponse' x-codegen-request-body-name: log-target-file delete: tags: - Log Targets summary: Pure Storage Delete File Log Target description: Deletes a configured file log target. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' responses: "200": description: OK content: {} patch: tags: - Log Targets summary: Pure Storage Modify File Log Target description: Modifies the URI of a configured file log target. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/LogTargetFile' required: true x-codegen-request-body-name: log-target-file responses: "200": description: Displays the newly updated file log target. content: application/json: schema: $ref: '#/components/schemas/LogTargetFileResponse' x-codegen-request-body-name: log-target-file /api/2.52/log-targets/syslog: get: tags: - Log Targets summary: Pure Storage List Syslog Servers description: | Displays a list of configured syslog servers. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/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/SyslogServerGetResponse' "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/SyslogServerGetResponse' post: tags: - Log Targets summary: Pure Storage Create Syslog Server description: | Creates a new syslog server. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/SyslogServer' required: true x-codegen-request-body-name: syslog-server responses: "200": description: Displays the newly configured syslog server. content: application/json: schema: $ref: '#/components/schemas/SyslogServerResponse' x-codegen-request-body-name: syslog-server delete: tags: - Log Targets summary: Pure Storage Delete Syslog Server description: | Deletes a configured syslog server and stop forwarding syslog messages. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' responses: "200": description: OK content: {} patch: tags: - Log Targets summary: Pure Storage Modify Syslog Server description: | Modifies the URI and services of a configured syslog server. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/SyslogServer' required: true x-codegen-request-body-name: syslog-server responses: "200": description: Displays the newly updated syslog server. content: application/json: schema: $ref: '#/components/schemas/SyslogServerResponse' x-codegen-request-body-name: syslog-server /api/2.52/log-targets/syslog/settings: get: tags: - Log Targets summary: Pure Storage List Syslog Settings description: | Displays syslog settings. Values include `continuation_token`, `items`, `more_items_remaining`, and `total_item_count`. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SyslogServerSettingsGetResponse' "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/SyslogServerSettingsGetResponse' patch: tags: - Log Targets summary: Pure Storage Modify Syslog Settings description: | Modifies syslog settings. Values include `continuation_token`, `items`, `more_items_remaining`, and `total_item_count`. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/SyslogServerSettings' required: true x-codegen-request-body-name: syslog-server-settings responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SyslogServerSettingsResponse' x-codegen-request-body-name: syslog-server-settings /api/2.52/log-targets/syslog/test: get: tags: - Log Targets summary: Pure Storage List Syslog Server Test Results description: "Displays syslog server test results, which indicate whether the syslog is working and configured correctly." parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/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/maintenance-windows: get: tags: - Maintenance Windows summary: Pure Storage List Maintenance Window Details description: "Displays maintenance window details, including start time, end time, and maintenance type." parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/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/MaintenanceWindowsGetResponse' post: tags: - Maintenance Windows summary: Pure Storage Create a Maintenance Window description: | Creates a maintenance window that suppresses alerts for a specified period of time. A maintenance window can be manually closed at any time. The `names` and `timeout` parameters are required. Set the `names` parameter to `environment`. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/MaintenanceWindowPost' required: true x-codegen-request-body-name: maintenance-window responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/MaintenanceWindowsResponse' x-codegen-request-body-name: maintenance-window delete: tags: - Maintenance Windows summary: Pure Storage Delete Maintenance Window description: | Deletes an open maintenance window before its scheduled end (`expire`) time. The `names` parameter is required and must be set to `environment`. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' responses: "200": description: OK content: {} /api/2.52/network-interfaces: get: tags: - Network Interfaces summary: Pure Storage List Network Interfaces description: Displays all network interfaces for all controllers on the array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/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/NetworkInterfaceGetResponse' "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/NetworkInterfaceGetResponse' post: tags: - Network Interfaces summary: Pure Storage Create Network Interface description: Creates a network interface on a controller on the array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/NetworkInterfacePost' required: true x-codegen-request-body-name: network responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/NetworkInterfaceResponse' x-codegen-request-body-name: network delete: tags: - Network Interfaces summary: Pure Storage Delete Network Interface description: Deletes a network interface on a controller. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' responses: "200": description: OK content: {} patch: tags: - Network Interfaces summary: Pure Storage Modify Network Interface description: Modifies a network interface on a controller. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/NetworkInterfacePatch' required: true x-codegen-request-body-name: network responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/NetworkInterfaceResponse' x-codegen-request-body-name: network /api/2.52/network-interfaces/neighbors: get: tags: - Network Interfaces summary: Pure Storage List Network Interface Neighbors description: Displays all neighbors for all network interfaces on the array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Local_port_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/NetworkInterfaceNeighborGetResponse' /api/2.52/network-interfaces/performance: get: tags: - Network Interfaces summary: Pure Storage List Network Performance Statistics description: | Displays network statistics, historical bandwidth, and error reporting for all specified network interfaces. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/NetworkInterfacePerformanceGetResponse' /api/2.52/network-interfaces/port-details: get: tags: - Network Interfaces summary: Pure Storage List SFP Port Details description: | Displays Ethernet and Fibre Channel SFP details. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $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/NetworkInterfacesPortDetailsGetResponse' /api/2.52/object-store-access-keys: get: tags: - Object Store Access Keys summary: Pure Storage GET Object-store-access-keys description: List object store access keys. 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/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/ObjectStoreAccessKeyGetResponse' "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/ObjectStoreAccessKeyGetResponse' post: tags: - Object Store Access Keys summary: Pure Storage POST Object-store-access-keys description: | The generation of object store access keys. This process produces a new `access key ID` and `secret key` for the specified user. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/_objectStoreAccessKeyPostBase' required: true x-codegen-request-body-name: object-store-access-key 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/ObjectStoreAccessKeyResponse' x-codegen-request-body-name: object-store-access-key delete: tags: - Object Store Access Keys summary: Pure Storage DELETE Object-store-access-keys description: Delete an object store access key. Once an access key has been deleted, it cannot be recovered. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names_required' responses: "200": description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: {} patch: tags: - Object Store Access Keys summary: Pure Storage PATCH Object-store-access-keys description: Enable or disable object store access keys. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names_required' requestBody: content: application/json: schema: $ref: '#/components/schemas/ObjectStoreAccessKey' required: true x-codegen-request-body-name: object-store-access-key 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/ObjectStoreAccessKeyResponse' x-codegen-request-body-name: object-store-access-key /api/2.52/object-store-accounts: get: tags: - Object Store Accounts summary: Pure Storage GET Object-store-accounts description: The list of object store accounts 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/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ObjectStoreAccountGetResponse' "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/ObjectStoreAccountGetResponse' post: tags: - Object Store Accounts summary: Pure Storage POST Object-store-accounts description: The creation of an object store account. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names_required' 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/ObjectStoreAccountResponse' x-codegen-request-body-name: object-store-account delete: tags: - Object Store Accounts summary: Pure Storage DELETE Object-store-accounts description: The deletion of an object store account. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' responses: "200": description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: {} /api/2.52/object-store-accounts/space: get: tags: - Object Store Accounts summary: Pure Storage List Object Store Account Space Information description: |+ The monitoring interface or dataset that provides `physical storage` `consumption` data for each `object store account`. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceObjectStoreAccountSpaceGetResponse' "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/ResourceObjectStoreAccountSpaceGetResponse' /api/2.52/object-store-users: get: tags: - Object Store Users summary: Pure Storage GET Object-store-users description: List object store users and their 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/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/ObjectStoreUserGetResponse' "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/ObjectStoreUserGetResponse' post: tags: - Object Store Users summary: Pure Storage POST Object-store-users description: Create object store users to administer object storage for an object store account. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names_required' 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/ObjectStoreUserResponse' delete: tags: - Object Store Users summary: Pure Storage DELETE Object-store-users description: Delete an object store user. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' responses: "200": description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: {} /api/2.52/object-store-users/policies/object-store-access: get: tags: - Object Store Users summary: Pure Storage GET Object-store-users/policies/object-store-access 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/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: - Object Store Users summary: Pure Storage POST Object-store-users/policies/object-store-access 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/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: - Object Store Users summary: Pure Storage DELETE Object-store-users/policies/object-store-access description: Revoke 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/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/object-store-virtual-hosts: get: tags: - Object Store Virtual Hosts summary: Pure Storage GET Object-store-virtual-hosts description: The list of object store virtual hosts. 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/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/ObjectStoreVirtualHostGetResponse' "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/ObjectStoreVirtualHostGetResponse' post: tags: - Object Store Virtual Hosts summary: Pure Storage POST Object-store-virtual-hosts description: | The creation of an object store virtual host. A maximum of `10` virtual hosts is supported. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names_required' 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/ObjectStoreVirtualHostResponse' delete: tags: - Object Store Virtual Hosts summary: Pure Storage DELETE Object-store-virtual-hosts description: The deletion of an object store virtual host. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' responses: "200": description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: {} /api/2.52/offloads: get: tags: - Offloads summary: Pure Storage List Offload Targets description: | Displays a list of offload targets that are connected to the array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Protocol' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/OffloadGetResponse' "207": description: | Indicates partial success. Some resources were returned, but errors may have prevented other resources from being returned. content: application/json: schema: $ref: '#/components/schemas/OffloadGetResponse' post: tags: - Offloads summary: Pure Storage Create Offload Target description: | Creates an offload target, connecting it to an array. Before you can connect to, manage, and replicate to an offload target, the Purity Run app must be installed. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Initialize' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/OffloadPost' required: true x-codegen-request-body-name: offload responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/OffloadResponse' x-codegen-request-body-name: offload delete: tags: - Offloads summary: Pure Storage Delete Offload Target description: | Deletes an offload target. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' responses: "200": description: OK content: {} patch: tags: - Offloads summary: Pure Storage Patch Offload Target description: | Modifies an existing offload target. Usage includes rotating the client secret. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/OffloadPatch' required: true x-codegen-request-body-name: offload responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/OffloadResponse' x-codegen-request-body-name: offload /api/2.52/pods: get: tags: - Pods summary: Pure Storage List Pods description: | Displays a list of pods that are stretched to this array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PodGetResponse' "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/PodGetResponse' post: tags: - Pods summary: Pure Storage Create a Pod description: | Creates a pod on the local array. Each pod must be given a unique name across the arrays to which they are stretched. A pod cannot be stretched to an array that already contains a pod with the same name. After a pod has been created, add volumes and protection groups, and then stretch the pod to another connected array or realm. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_throttle_operation' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PodPost' required: true x-codegen-request-body-name: pod responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PodResponse' x-codegen-request-body-name: pod delete: tags: - Pods summary: Pure Storage Delete a Pod description: | Deletes a pod that has been destroyed and is pending eradication. Eradicated pods cannot be recovered. Pods are destroyed using the PATCH method. The `ids` or `names` parameter is required, but they cannot be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Eradicate_contents' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' responses: "200": description: OK content: {} patch: tags: - Pods summary: Pure Storage Modify a Pod description: | Modifies pod details. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Abort_quiesce' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Destroy_contents' - $ref: '#/components/parameters/From_member_ids' - $ref: '#/components/parameters/From_member_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Move_with_host_group_names' - $ref: '#/components/parameters/Move_with_host_names' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Promote_from' - $ref: '#/components/parameters/Quiesce' - $ref: '#/components/parameters/Skip_quiesce' - $ref: '#/components/parameters/To_member_ids' - $ref: '#/components/parameters/To_member_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PodPatch' required: true x-codegen-request-body-name: pod responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PodResponse' x-codegen-request-body-name: pod /api/2.52/pods/arrays: get: tags: - Pods summary: Pure Storage List Pods and Their the Array Members description: | Displays a list of pods and the local and remote arrays over which the pods are stretched. Pods with realm members will not be returned. The optional `group_names` parameter represents the name of the pod. The optional `member_names` parameter represents the name of the array over which the pod is stretched. (Deprecated) Use pods/members instead.) parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/MemberGetResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/MemberGetResponse' post: tags: - Pods summary: Pure Storage Creates a Pod to Be Stretched to an Array description: | Creates a pod to be stretched to an array. When a pod is stretched to an array, the data in the arrays over which the pod is stretched is synchronously replicated. The `group_names` parameter represents the name of the pod to be stretched. The `member_names` parameter represents the name of the array over which the pod is to be stretched. The `group_names` and `member_names` parameters are required and must be set together. (Deprecated) Use pods/members instead. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/MemberResponse' delete: tags: - Pods summary: Pure Storage Delete a Pod That Was Stretched to an Array description: | Deletes a pod that was stretchd to an array, collapsing the pod to a single array. Unstretch a pod from an array when the volumes within the stretched pod no longer need to be synchronously replicated between the two arrays. After a pod has been unstretched, synchronous replication stops. A destroyed version of the pod with 'restretch' appended to the pod name is created on the array that no longer has the pod. The restretched pod represents a point-in-time snapshot of the pod, just before it was unstretched. The restretch pod enters an eradication pending period starting from the time that the pod was unstretched. A restretched pod can be cloned or destroyed, but it cannot be explicitly recovered. The `group_names` parameter represents the name of the pod to be unstretched. The `member_names` parameter represents the name of the array from which the pod is to be unstretched. The `group_names` and `member_names` parameters are required and must be set together. (Deprecated) Use pods/members instead. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/With_unknown' responses: "200": description: OK content: {} /api/2.52/pods/members: get: tags: - Pods summary: Pure Storage List Pods and Their Members description: | Displays a list of pods and the local and remote members over which the pods are stretched. Currently either array or realm is supported as member. 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/Offset' - $ref: '#/components/parameters/Pod_ids' - $ref: '#/components/parameters/Pod_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PodMemberGetResponse' "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/PodMemberGetResponse' post: tags: - Pods summary: Pure Storage Creates a Pod to Be Stretched to a Member description: | Creates a pod to be stretched to a member. When a pod is stretched to an array or a realm on another array, the data in the arrays or realms over which the pod is stretched is synchronously replicated. The `member_names` or `member_ids` parameter represents the array or realm over which the pod is to be stretched. Both pod and member must be specified by name or ID. 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/Pod_ids' - $ref: '#/components/parameters/Pod_names' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PodMemberResponse' delete: tags: - Pods summary: Pure Storage Delete a Member from a Pod description: | Deletes a stretched pod from an array or realm, collapsing the pod to a member array or realm. Unstretch a pod from an array or realm when the volumes within the stretched podno longer need to be synchronously replicated between the two members. After a pod has been unstretched, synchronous replication stops. A destroyed version of the pod with 'restretch' appended to the pod name is created on the member that no longer has the pod. The restretched pod represents a point-in-time snapshot of the pod, just before it was unstretched. The restretched pod enters an eradication pending period starting from the time that the pod was unstretched. A restretched pod can be cloned or destroyed, but it cannot be explicitly recovered. The `member_names` parameter represents the name of the array or realm from which the pod is to be unstretched. Both pod and member must be specified by name or ID. 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/Pod_ids' - $ref: '#/components/parameters/Pod_names' - $ref: '#/components/parameters/With_unknown' responses: "200": description: OK content: {} /api/2.52/pods/performance: get: tags: - Pods summary: Pure Storage List Pod Performance Data description: | Displays real-time and historical performance data, real-time latency data, and average I/O sizes across all pods, displayed both by pod and as a total across all pods. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Perf_protocol_type' - $ref: '#/components/parameters/Perf_protocol_group' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ContainerPerformanceGetResponse' "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/ContainerPerformanceGetResponse' /api/2.52/pods/performance/by-array: get: tags: - Pods summary: Pure Storage List Pod Performance Data by Array description: | Displays real-time and historical performance data, real-time latency data, and average I/O size data. The data is displayed as a total across all pods on the local array and by individual pod. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Perf_protocol_type' - $ref: '#/components/parameters/Perf_protocol_group' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PodPerformanceByArrayGetResponse' "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/PodPerformanceByArrayGetResponse' /api/2.52/pods/performance/replication: get: tags: - Pods summary: Pure Storage List Pod Replication Performance Data description: |+ Displays pod replication performance data. The data returned is the real-time and historical performance data for each replication type at the pod level. Values include `continuous`, `periodic`, `resync`, and `sync`. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Historical_total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PodPerformanceReplicationGetResponse' "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/PodPerformanceReplicationGetResponse' /api/2.52/pods/performance/replication/by-array: get: tags: - Pods summary: Pure Storage List Pod Replication Performance Data by Array description: |+ Displays pod replication performance data, organized by array. The data returned is the real-time and historical performance data for each replication type at the pod level. Values include `continuous`, `periodic`, `resync`, and `sync`. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PodPerformanceReplicationByArrayGetResponse' "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/PodPerformanceReplicationByArrayGetResponse' /api/2.52/pods/space: get: tags: - Pods summary: Pure Storage List Pod Space Information description: | Displays provisioned size and physical storage consumption data for each pod on the local array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourcePodSpaceGetResponse' "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/ResourcePodSpaceGetResponse' /api/2.52/pods/tags: get: tags: - Pods summary: Pure Storage List Tags description: Displays the list of tags. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Namespaces' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Resource_destroyed' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TagGetResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/TagGetResponse' delete: tags: - Pods summary: Pure Storage Delete Tags description: Deletes specified tags. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Keys' - $ref: '#/components/parameters/Namespaces_delete' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' responses: "200": description: OK content: {} /api/2.52/pods/tags/batch: put: tags: - Pods summary: Pure Storage Update Tags description: Updates tags for all specified objects. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' requestBody: description: "A list of tags to be created or, if already existing, updated." content: application/json: schema: maxItems: 30 minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/Tag' required: true x-codegen-request-body-name: tag responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TagResponse' x-codegen-request-body-name: tag /api/2.52/pods/test: post: tags: - Pods summary: Pure Storage Create an Attempt to Clone a Pod description: | Creates an attempt to clone a pod on the local array without actually cloning it to test whether the pod can be successfully cloned. This action does not suppport pod creation. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_throttle_operation' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PodPost' required: true x-codegen-request-body-name: pod responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TestResultWithResourceWithIdPostResponse' x-codegen-request-body-name: pod /api/2.52/pod-replica-links: get: tags: - Pod Replica Links summary: Pure Storage List Pod Replica Links description: Displays the list of pod replica links that are configured between arrays. 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/Local_pod_ids' - $ref: '#/components/parameters/Local_pod_names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Remote_array_or_realm_ids' - $ref: '#/components/parameters/Remote_array_or_realm_names' - $ref: '#/components/parameters/Remote_pod_ids' - $ref: '#/components/parameters/Remote_pod_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PodReplicaLinkGetResponse' "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/PodReplicaLinkGetResponse' post: tags: - Pod Replica Links summary: Pure Storage Create Pod Replica Links description: "Creates pod replica links between two arrays. The `local_pod_names` and `remote_pod_names` are required. Valid values are `replicating`, `baselining`, `paused`, `unhealthy`, `quiescing`, and `quiesced`. A status of `replicating` indicates that the source array is replicating to the target array. A status of `baselining` indicates that the the initial version of the dataset is being sent. During this phase, you cannot promote the target pod. In addition, changing the link direction might trigger the `baselining` status to recur. A status of `paused ` indicates that data transfer between objects has stopped. A status of `unhealthy` indicates that the link is currently unhealthy and customers must perform some health checks to determine the cause. A status of `quiescing` indicates that the source pod is not accepting new write requests but the most recent changes to the source have not arrived on the target. A status of `quiesced` indicates that the source pod has been demoted and all changes have been replicated to the target pod." parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Local_pod_ids' - $ref: '#/components/parameters/Local_pod_names' - $ref: '#/components/parameters/Remote_array_or_realm_ids' - $ref: '#/components/parameters/Remote_array_or_realm_names' - $ref: '#/components/parameters/Remote_pod_ids' - $ref: '#/components/parameters/Remote_pod_names' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PodReplicaLinkResponse' delete: tags: - Pod Replica Links summary: Pure Storage Delete Pod Replica Links description: "Deletes pod replica links. The `local_pod_names` and `remote_pod_names` are required. Valid values are `replicating`, `baselining`, `paused`, `unhealthy`, `quiescing`, and `quiesced`. A status of `replicating` indicates that the source array is replicating to the target array. A status of `baselining` indicates that the the initial version of the dataset is being sent. During this phase, you cannot promote the target pod. In addition, changing the link direction might trigger the `baselining` status to recur. A status of `paused ` indicates that data transfer between objects has stopped. A status of `unhealthy` indicates that the link is currently unhealthy and customers must perform some health checks to determine the cause. A status of `quiescing` indicates that the source pod is not accepting new write requests but the most recent changes to the source have not arrived on the target. A status of `quiesced` indicates that the source pod has been demoted and all changes have been replicated to the target pod." parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Local_pod_ids' - $ref: '#/components/parameters/Local_pod_names' - $ref: '#/components/parameters/Remote_pod_ids' - $ref: '#/components/parameters/Remote_pod_names' responses: "200": description: OK content: {} patch: tags: - Pod Replica Links summary: Pure Storage Modify Pod Replica Links description: "Modifies pod replica links. The `local_pod_names` and `remote_pod_names` are required. Valid values are `replicating`, `baselining`, `paused`, `unhealthy`, `quiescing`, and `quiesced`. A status of `replicating` indicates that the source array is replicating to the target array. A status of `baselining` indicates that the the initial version of the dataset is being sent. During this phase, you cannot promote the target pod. In addition, changing the link direction might trigger the `baselining` status to recur. A status of `paused ` indicates that data transfer between objects has stopped. A status of `unhealthy` indicates that the link is currently unhealthy and customers must perform some health checks to determine the cause. A status of `quiescing` indicates that the source pod is not accepting new write requests but the most recent changes to the source have not arrived on the target. A status of `quiesced` indicates that the source pod has been demoted and all changes have been replicated to the target pod." parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Local_pod_ids' - $ref: '#/components/parameters/Local_pod_names' - $ref: '#/components/parameters/Remote_array_or_realm_ids' - $ref: '#/components/parameters/Remote_array_or_realm_names' - $ref: '#/components/parameters/Remote_pod_ids' - $ref: '#/components/parameters/Remote_pod_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PodReplicaLinkPatch' required: true x-codegen-request-body-name: pod-replica-link responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PodReplicaLinkResponse' x-codegen-request-body-name: pod-replica-link /api/2.52/pod-replica-links/lag: get: tags: - Pod Replica Links summary: Pure Storage List Pod Replica Link Lag description: Displays the lag in milliseconds that the replication target is behind the source. This is the time difference between the current time and the recovery point. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Local_pod_ids' - $ref: '#/components/parameters/Local_pod_names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Remote_array_or_realm_ids' - $ref: '#/components/parameters/Remote_array_or_realm_names' - $ref: '#/components/parameters/Remote_pod_ids' - $ref: '#/components/parameters/Remote_pod_names' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PodReplicaLinkLagGetResponse' "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/PodReplicaLinkLagGetResponse' /api/2.52/pod-replica-links/performance/replication: get: tags: - Pod Replica Links summary: Pure Storage List Replica Link Performance Data description: | The monitoring interface or metric that provides the total number of `bytes` of `replication` data transmitted and received `per second`. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Local_pod_ids' - $ref: '#/components/parameters/Local_pod_names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Remote_array_or_realm_ids' - $ref: '#/components/parameters/Remote_array_or_realm_names' - $ref: '#/components/parameters/Remote_pod_ids' - $ref: '#/components/parameters/Remote_pod_names' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Historical_total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PodReplicaLinkPerformanceReplicationGetResponse' "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/PodReplicaLinkPerformanceReplicationGetResponse' /api/2.52/pod-replica-links/performance/replication/by-array: get: tags: - Pod Replica Links summary: Pure Storage List Replica Link Performance Data with Array Details description: | The monitoring interface that provides the total number of `bytes` of `replication` data transmitted and received `per second`. This data is organized by `array` and further categorized by the specific `replica link`, `source array`, and `target array` to provide granular visibility into network throughput. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Local_pod_ids' - $ref: '#/components/parameters/Local_pod_names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Remote_array_or_realm_ids' - $ref: '#/components/parameters/Remote_array_or_realm_names' - $ref: '#/components/parameters/Remote_pod_ids' - $ref: '#/components/parameters/Remote_pod_names' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Historical_total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PodReplicaLinkPerformanceReplicationArrayGetResponse' "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/PodReplicaLinkPerformanceReplicationArrayGetResponse' /api/2.52/pod-replica-links/mappings/policies: get: tags: - Pod Replica Links summary: Pure Storage List Policy Mappings description: | Displays a list of policy mappings. 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/Local_pod_ids' - $ref: '#/components/parameters/Local_pod_names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Pod_replica_link_ids' - $ref: '#/components/parameters/Remote_array_or_realm_ids' - $ref: '#/components/parameters/Remote_array_or_realm_names' - $ref: '#/components/parameters/Remote_pod_ids' - $ref: '#/components/parameters/Remote_pod_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PodReplicaLinkMappingPolicyGetResponse' "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/PodReplicaLinkMappingPolicyGetResponse' patch: tags: - Pod Replica Links summary: Pure Storage Modify Policy Mappings description: | Modifies policy mappings of a replica link. Valid `mapping` values are `connected` and `disconnected`. `connected` indicates that the source policy and its attachments will be mirrored on the target pod. `disconnected` indicates that the associated policy and its attachments are independent from any policy on the remote. This operation can only be performed on the target side of a pod replica link. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Local_pod_ids' - $ref: '#/components/parameters/Local_pod_names' - $ref: '#/components/parameters/Pod_replica_link_ids' - $ref: '#/components/parameters/Remote_array_or_realm_ids' - $ref: '#/components/parameters/Remote_array_or_realm_names' - $ref: '#/components/parameters/Remote_pod_ids' - $ref: '#/components/parameters/Remote_pod_names' - $ref: '#/components/parameters/Remote_policy_ids' - $ref: '#/components/parameters/Remote_policy_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/MappingPolicyPatch' required: true x-codegen-request-body-name: mapping responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PodReplicaLinkMappingPolicyResponse' x-codegen-request-body-name: mapping /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/2.52/ports: get: tags: - Ports summary: Pure Storage List Ports description: "Displays host name, iSCSI Qualified Names (IQNs), NVMe Qualified Names (NQNs), IPv4 address of the portal, Fibre Channel World Wide Names (WWNs), and failover ports, including those that were discovered by Purity//FA and those that have been manually assigned by system administrators." 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/PortGetResponse' "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/PortGetResponse' /api/2.52/ports/initiators: get: tags: - Ports summary: Pure Storage List Port Initiators description: "Displays host iSCSI Qualified Names (IQNs), NVMe Qualified Names (NQNs), and Fibre Channel World Wide Names (WWNs), including those that were discovered by Purity//FA and those that have been manually assigned by system administrators, along with the array ports (targets) on which they are eligible to communicate." 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/PortInitiatorsGetResponse' "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/PortInitiatorsGetResponse' /api/2.52/presets/workload: get: tags: - Presets summary: Pure Storage List Workload Presets description: | Displays a list of workload presets. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PresetWorkloadGetResponse' put: tags: - Presets summary: Pure Storage Update a Workload Preset description: | Updates a workload preset by replacing it with the new contents in `preset`. 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_single' - $ref: '#/components/parameters/Names_single' - $ref: '#/components/parameters/Preset_workload_skip_verify_deployable' requestBody: content: application/json: schema: $ref: '#/components/schemas/PresetWorkload' required: true x-codegen-request-body-name: preset responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PresetWorkloadResponse' x-codegen-request-body-name: preset post: tags: - Presets summary: Pure Storage Create a Workload Preset description: | Creates one workload preset. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names_single_required' - $ref: '#/components/parameters/Preset_workload_skip_verify_deployable' requestBody: content: application/json: schema: $ref: '#/components/schemas/PresetWorkloadPost' required: true x-codegen-request-body-name: preset responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PresetWorkloadResponse' x-codegen-request-body-name: preset delete: tags: - Presets summary: Pure Storage Delete a Workload Preset description: | Deletes a workload preset permanently. 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_single' - $ref: '#/components/parameters/Names_single' responses: "200": description: OK content: {} patch: tags: - Presets summary: Pure Storage Modify a Workload Preset description: | Modifies a workload preset by overriding the fields specified in `preset`. To rename a workload preset, set name to the new name. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids_single' - $ref: '#/components/parameters/Names_single' requestBody: content: application/json: schema: $ref: '#/components/schemas/PresetWorkloadPatch' required: true x-codegen-request-body-name: preset responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PresetWorkloadResponse' x-codegen-request-body-name: preset /api/2.52/protection-groups: get: tags: - Protection Groups summary: Pure Storage List Protection Groups description: | Displays a list of protection groups, including their associated source arrays or pods, replication targets, hosts, host groups, and volumes. The list includes protection groups that were created on the local array or realm to replicate snapshot data to other arrays, pods or offload targets, created on a remote array or pod and replicated asynchronously to this array or realm, or created inside a pod on a remote array or realm and stretched to the local array or realm. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupGetResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupGetResponse' post: tags: - Protection Groups summary: Pure Storage Create a Protection Group and Upsert Tags description: | Creates a protection group on the local array or realm for asynchronous replication. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Overwrite' - $ref: '#/components/parameters/Protection_group_source_ids' - $ref: '#/components/parameters/Protection_group_source_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupPost' required: false x-codegen-request-body-name: protection-group responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupResponse' x-codegen-request-body-name: protection-group delete: tags: - Protection Groups summary: Pure Storage Delete a Protection Group description: | Deletes a protection group that has been destroyed and is pending eradication. Eradicated protection groups cannot be recovered. Protection groups are destroyed through the `PATCH` method. The `names` parameter is required. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' responses: "200": description: OK content: {} patch: tags: - Protection Groups summary: Pure Storage Modify a Protection Group description: | Modifies the protection group schedules to generate and replicate snapshots to another array, pod or to an external storage system. Renames or destroys a protection group. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/ProtectionGroup' required: true x-codegen-request-body-name: protection-group responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupResponse' x-codegen-request-body-name: protection-group /api/2.52/protection-groups/hosts: get: tags: - Protection Groups summary: Pure Storage List Protection Groups with Host Members description: Displays a list of protection groups that have host members. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/MemberNoIdMemberGetResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/MemberNoIdMemberGetResponse' post: tags: - Protection Groups summary: Pure Storage Create an Action to Add a Host to a Protection Group description: |+ Creates an action to add a host member to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. The `group_names` parameter represents the name of the protection group, and the `member_names` parameter represents the name of the host. The `group_names` and `member_names` parameters are required and must be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Member_names' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/MemberNoIdMemberResponse' delete: tags: - Protection Groups summary: Pure Storage Delete a Host from a Protection Group description: | Deletes a host member from a protection group. After the member has been removed, it is no longer protected by the group. Any protection group snapshots that were taken before the member was removed will not be affected. Removing a member from a protection group does not delete the member from the array or realm, and the member can be added back to the protection group at any time. The `group_names` parameter represents the name of the protection group, and the `member_names` parameter represents the name of the host. The `group_names` and `member_names` parameters are required and must be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Member_names' responses: "200": description: OK content: {} /api/2.52/protection-groups/host-groups: get: tags: - Protection Groups summary: Pure Storage List Protection Groups with Host Group Members description: Displays a list of protection groups that have host group members. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/MemberNoIdMemberGetResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/MemberNoIdMemberGetResponse' post: tags: - Protection Groups summary: Pure Storage Creates an Action to Add a Host Group to a Protection Group description: | Creates an action to add a host group member to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. The `group_names` parameter represents the name of the protection group, and the `member_names` parameter represents the name of the host group. The `group_names` and `member_names` parameters are required and must be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Member_names' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/MemberNoIdMemberResponse' delete: tags: - Protection Groups summary: Pure Storage Delete a Host Group from a Protection Group description: | Deletes a host group member from a protection group. After the member has been removed, it is no longer protected by the group. Protection group snapshots taken before the member was removed will not be affected. Removing a member from a protection group does not delete the member from the array or realm, and the member can be added back to the protection group at any time. The `group_names` parameter represents the name of the protection group, and the `member_names` parameter represents the name of the host group. The `group_names` and `member_names` parameters are required and must be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Member_names' responses: "200": description: OK content: {} /api/2.52/protection-groups/performance/replication: get: tags: - Protection Groups summary: Pure Storage List Protection Group Replication Performance Data description: |+ Displays the total number of bytes of replication data transmitted and received per second. The data is grouped by protection group. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupPerformanceResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupPerformanceResponse' /api/2.52/protection-groups/performance/replication/by-array: get: tags: - Protection Groups summary: Pure Storage List Protection Group Replication Performance Data with Array Details description: | Displays the total number of bytes of replication data transmitted and received per second. The data is grouped by protection group and includes the names of the source array and targets for each protection group. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupPerformanceArrayResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupPerformanceArrayResponse' /api/2.52/protection-groups/space: get: tags: - Protection Groups summary: Pure Storage List Protection Group Space Information description: |+ Displays provisioned size and physical storage consumption data for each protection group. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceSpaceGetResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/ResourceSpaceGetResponse' /api/2.52/protection-groups/tags: get: tags: - Protection Groups summary: Pure Storage List Tags description: Displays the list of tags. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Namespaces' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Resource_destroyed' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TagGetResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/TagGetResponse' delete: tags: - Protection Groups summary: Pure Storage Delete Tags description: Deletes specified tags. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Keys' - $ref: '#/components/parameters/Namespaces_delete' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' responses: "200": description: OK content: {} /api/2.52/protection-groups/tags/batch: put: tags: - Protection Groups summary: Pure Storage Update Tags description: Updates tags for all specified objects. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' requestBody: description: "A list of tags to be created or, if one already exists, updated." content: application/json: schema: maxItems: 30 minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/TagBatch' required: true x-codegen-request-body-name: tag responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TagResponse' x-codegen-request-body-name: tag /api/2.52/protection-groups/targets: get: tags: - Protection Groups summary: Pure Storage List Protection Groups with Targets description: |+ Displays a list of protection groups that have target arrays, pods, or offload targets. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupTargetGetResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupTargetGetResponse' post: tags: - Protection Groups summary: Pure Storage Create an Action to Add a Target to a Protection Group description: |+ Creates an action to add an array, pod, or offload target to a protection group. The `group_names` parameter represents the name of the protection group. The `member_names` parameter represents the name of the array, pod, or offload target that is being added to the protection group. The `group_names` and `member_names` parameters are required and must be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupTargetResponse' delete: tags: - Protection Groups summary: Pure Storage Delete a Target from a Protection Group description: |+ Deletes an array, pod, or offload target from a protection group. The `group_names` parameter represents the name of the protection group. The `member_names` parameter represents the name of the array, pod, or offload target that is being removed from the protection group. The `group_names` and `member_names` parameters are required and must be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' responses: "200": description: OK content: {} patch: tags: - Protection Groups summary: Pure Storage Modify a Protection Group Target description: |+ Modifies the source array or pod to replicate protection group data to the target, or disallows the source array or pod from replicating protection group data to the target. The `allowed` parameter must be set from the target array or realm. The `group_names` parameter represents the name of the protection group. The `allowed` and `group_names` parameters are required and must be set together. Offload targets do not support the `allowed` parameter. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/TargetProtectionGroupPostPatch' required: true x-codegen-request-body-name: target responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupTargetResponse' x-codegen-request-body-name: target /api/2.52/protection-groups/volumes: get: tags: - Protection Groups summary: Pure Storage List Protection Groups with Volume Members description: | Displays a list of protection groups that have volume members. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Pgroup_group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Include_remote' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Member_destroyed' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupsVolumesGetResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupsVolumesGetResponse' post: tags: - Protection Groups summary: Pure Storage Create a Volume to Add it to a Protection Group description: | Creates a volume member and adds it to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. The `group_names` parameter represents the name of the protection group, and the `member_names` and `member_ids` parameters represent the names or IDs of the volume. The `group_names` parameter, and either the `member_names` or `member_ids` parameters are required and must be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupsVolumesResponse' delete: tags: - Protection Groups summary: Pure Storage Delete a Volume from a Protection Group description: | Deletes a volume member from a protection group. After the member has been deleted, it is no longer protected by the group. Any protection group snapshots that were taken before the member was deleted are not affected. Deleting a member from a protection group does not delete the member from the array or realm, and the member can be added back to the protection group at any time. The `group_names` parameter represents the name of the protection group, and the `member_names` and `member_ids` parameters represent the names or IDs of the volume. The `group_names` parameter, and either the `member_names` or `member_ids` parameters are required and must be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' responses: "200": description: OK content: {} /api/2.52/protection-group-snapshots: get: tags: - Protection Group Snapshots summary: Pure Storage List Protection Group Snapshots description: | Displays a list of protection group snapshots, including those pending eradication. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Source_ids' - $ref: '#/components/parameters/Source_names' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupSnapshotGetResponse' "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/ProtectionGroupSnapshotGetResponse' post: tags: - Protection Group Snapshots summary: Pure Storage Create a Protection Group Snapshot and Create Tags. description: | Creates a point-in-time snapshot of the contents of a protection group. The `source_ids` or `source_names` parameter is required, but they cannot be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_throttle_snapshot' - $ref: '#/components/parameters/Apply_retention' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/For_replication' - $ref: '#/components/parameters/Replicate' - $ref: '#/components/parameters/Replicate_now' - $ref: '#/components/parameters/Source_ids' - $ref: '#/components/parameters/Source_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupSnapshotPost' required: false x-codegen-request-body-name: protection-group-snapshot responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupSnapshotResponse' x-codegen-request-body-name: protection-group-snapshot delete: tags: - Protection Group Snapshots summary: Pure Storage Delete a Protection Group Snapshot description: | Deletes a protection group snapshot that has been destroyed and is pending eradication. Eradicating a protection group snapshot eradicates all of its protection group snapshots and cannot be recovered. Protection group snapshots are destroyed through the `PATCH` method. The `names` or `ids` 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: - Protection Group Snapshots summary: Pure Storage Modify a Protection Group Snapshot description: | Modifies a protection group snapshot so that it can be destroyed. To destroy a volume, set `destroyed=true`. To recover a volume that has been destroyed and is pending eradication, set `destroyed=false`. The `names` or `ids` 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/ProtectionGroupSnapshotPatch' required: true x-codegen-request-body-name: protection-group-snapshot responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupSnapshotResponse' x-codegen-request-body-name: protection-group-snapshot /api/2.52/protection-group-snapshots/replica: post: tags: - Protection Group Snapshots summary: Pure Storage Create an Action to Send Protection Group Snapshots description: |+ Creates an action to send protection group snapshots to protection pgroup targets. When the `on` option is used, only specified targets will recieve the protection group snapshots. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Convert_source_to_baseline' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/On_as_target' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupSnapshotReplicaResponse' /api/2.52/protection-group-snapshots/tags: get: tags: - Protection Group Snapshots summary: Pure Storage List Tags description: | Displays the list of tags. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Namespaces' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Resource_destroyed' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TagGetResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/TagGetResponse' delete: tags: - Protection Group Snapshots summary: Pure Storage Delete Tags description: | Deletes specified tags. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Keys' - $ref: '#/components/parameters/Namespaces_delete' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' responses: "200": description: OK content: {} /api/2.52/protection-group-snapshots/tags/batch: put: tags: - Protection Group Snapshots summary: Pure Storage Update Tags description: | Updates or creates tags for all specified objects. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' requestBody: description: "A list of tags to be created or, if already existing, updated." content: application/json: schema: maxItems: 30 minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/TagBatch' required: true x-codegen-request-body-name: tag responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TagResponse' x-codegen-request-body-name: tag /api/2.52/protection-group-snapshots/test: post: tags: - Protection Group Snapshots summary: Pure Storage Create an Attempt to Take Protection Group Snapshot description: | Creates an attempt to take the protection group snapshot, without actually taking it, to test if the snapshot can be successfully taken. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_throttle_snapshot' - $ref: '#/components/parameters/Apply_retention' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/For_replication' - $ref: '#/components/parameters/Replicate' - $ref: '#/components/parameters/Replicate_now' - $ref: '#/components/parameters/Source_ids' - $ref: '#/components/parameters/Source_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupSnapshotPost' required: false x-codegen-request-body-name: protection-group-snapshot responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TestResultWithResourceWithIdPostResponse' x-codegen-request-body-name: protection-group-snapshot /api/2.52/protection-group-snapshots/transfer: get: tags: - Protection Group Snapshots summary: Pure Storage List Protection Group Snapshots with Transfer Statistics description: | Displays a list of protection group snapshots and corresponding transfer statistics. 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/Source_ids' - $ref: '#/components/parameters/Source_names' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupSnapshotTransferGetResponse' "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/ProtectionGroupSnapshotTransferGetResponse' /api/2.52/realms: get: tags: - Realms summary: Pure Storage List Realms description: | Displays a list of realms. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/RealmGetResponse' "207": description: | Indicates partial success. Some resources were returned, but errors may have prevented other resources from being returned. content: application/json: schema: $ref: '#/components/schemas/RealmGetResponse' post: tags: - Realms summary: Pure Storage Create Realms description: | Creates realms on the local array. Each realm must be given a name that is unique across the connected arrays. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names_required' requestBody: content: application/json: schema: $ref: '#/components/schemas/RealmPost' required: false x-codegen-request-body-name: realm responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/RealmResponse' x-codegen-request-body-name: realm delete: tags: - Realms summary: Pure Storage Delete Realms description: | Deletes realms that have been destroyed and are pending eradication. Eradicated realms cannot be recovered. Realms are destroyed using the PATCH method. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Eradicate_contents' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' responses: "200": description: OK content: {} patch: tags: - Realms summary: Pure Storage Modify Realms description: | Modifies realm details. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Destroy_contents' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Container_ignore_usage' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/RealmPatch' required: true x-codegen-request-body-name: realm responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/RealmResponse' x-codegen-request-body-name: realm /api/2.52/realms/performance: get: tags: - Realms summary: Pure Storage List Realm Performance Data description: | Displays real-time and historical performance data, real-time latency data, and average I/O sizes across all realms, displayed both by realm and as a total across all realms. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ContainerPerformanceGetResponse' "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/ContainerPerformanceGetResponse' /api/2.52/realms/qos: get: tags: - Realms summary: Pure Storage List Realm QoS Config description: | Displays real-time and historical QoS configuration data for each realm. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/RealmQosGetResponse' "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/RealmQosGetResponse' /api/2.52/realms/space: get: tags: - Realms summary: Pure Storage List Realm Space Information description: | Displays provisioned size and storage consumption data for each realm on the local array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/RealmSpaceGetResponse' /api/2.52/realms/tags: get: tags: - Realms summary: Pure Storage List Tags description: | Displays the list of tags. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Namespaces' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Resource_destroyed' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TagGetResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/TagGetResponse' delete: tags: - Realms summary: Pure Storage Delete Tags description: | Deletes specified tags. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Keys' - $ref: '#/components/parameters/Namespaces_delete' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' responses: "200": description: OK content: {} /api/2.52/realms/tags/batch: put: tags: - Realms summary: Pure Storage Update Tags description: | Updates or creates tags for all specified objects. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' requestBody: description: "A list of tags to be created or, if already existing, updated." content: application/json: schema: maxItems: 30 minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/NonCopyableTag' required: true x-codegen-request-body-name: tag responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TagResponse' x-codegen-request-body-name: tag /api/2.52/remote-arrays: get: tags: - Remote Arrays summary: Pure Storage List Remote Arrays description: |+ Dispalys arrays in the current fleet, as well as arrays that the current array has existing replication connections to. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - name: current_fleet_only in: query description: | If current_fleet_only is specified, then results will only show arrays from the same fleet to which the current array is a member of. schema: type: boolean - $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/RemoteArraysResponse' /api/2.52/remote-pods: get: tags: - Remote Pods summary: Pure Storage List Remote Pods description: | Displays a list of pods that that are on connected arrays or realms but not stretched to this array or realm. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/On_' - $ref: '#/components/parameters/On_ids' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/RemotePodsResponse' "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/RemotePodsResponse' /api/2.52/remote-pods/tags: get: tags: - Remote Pods summary: Pure Storage List Tags description: | Displays the list of tags. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Namespaces' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/On_' - $ref: '#/components/parameters/On_ids' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/RemotePodTagGetResponse' "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/RemotePodTagGetResponse' /api/2.52/remote-protection-groups: get: tags: - Remote Protection Groups summary: Pure Storage List Remote Protection Groups description: | Returns a list of remote protection groups. 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/On_' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/RemoteProtectionGroupGetResponse' "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/RemoteProtectionGroupGetResponse' delete: tags: - Remote Protection Groups summary: Pure Storage Delete a Remote Protection Group description: | Deletes a remote protection group that has been destroyed and is pending eradication. Eradicated remote protection groups cannot be recovered. Remote protection groups are destroyed through the `PATCH` method. The `on` parameter represents the name of the offload target. The `ids` or `names` parameter and the `on` parameter are required and must be used together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/OnSingle' responses: "200": description: OK content: {} patch: tags: - Remote Protection Groups summary: Pure Storage Modify a Remote Protection Group description: | Modifies the snapshot retention schedule of a remote protection group. Also destroys a remote protection group from the offload target. Before the remote protection group can be destroyed, the offload target must first be removed from the protection group via the source array. The `on` parameter represents the name of the offload target. The `ids` or `names` parameter and the `on` parameter are required and must be used together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/OnSingle' requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoteProtectionGroup' required: true x-codegen-request-body-name: remote-protection-group responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/RemoteProtectionGroupResponse' x-codegen-request-body-name: remote-protection-group /api/2.52/remote-protection-group-snapshots: get: tags: - Remote Protection Group Snapshots summary: Pure Storage List Remote Protection Group Snapshots description: | Displays a list of remote protection group snapshots. 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/On_' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Source_ids' - $ref: '#/components/parameters/Source_names' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/RemoteProtectionGroupSnapshotGetResponse' "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/RemoteProtectionGroupSnapshotGetResponse' post: tags: - Remote Protection Group Snapshots summary: Pure Storage Create Remote Protection Group Snapshot and Tags description: | Creates remote protection group snapshots. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_throttle_snapshot' - $ref: '#/components/parameters/Apply_retention' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Convert_source_to_baseline' - $ref: '#/components/parameters/For_replication' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/OnSingle' - $ref: '#/components/parameters/Replicate' - $ref: '#/components/parameters/Replicate_now' - $ref: '#/components/parameters/Source_ids' - $ref: '#/components/parameters/Source_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoteProtectionGroupSnapshotPost' required: false x-codegen-request-body-name: remote-protection-group-snapshot responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/RemoteProtectionGroupSnapshotResponse' x-codegen-request-body-name: remote-protection-group-snapshot delete: tags: - Remote Protection Group Snapshots summary: Pure Storage Delete a Remote Protection Group Snapshot description: | Deletes a remote protection group snapshot that has been destroyed and is pending eradication. Eradicated remote protection group snapshots cannot be recovered. Remote protection group snapshots are destroyed using the `PATCH` method. The `names` parameter represents the name of the protection group snapshot. The `on` parameter represents the name of the offload target. The `names` and `on` parameters are required and must be used together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/OnSingle' responses: "200": description: OK content: {} patch: tags: - Remote Protection Group Snapshots summary: Pure Storage Modify a Remote Protection Group Snapshot description: | Modifies a remote protection group snapshot, removing it from the offload target and destroying the snapshot. The `on` parameter represents the name of the offload target. The `ids` or `names` parameter and the `on` parameter are required and must be used together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/OnSingle' requestBody: content: application/json: schema: $ref: '#/components/schemas/_destroyedPatchPost' required: true x-codegen-request-body-name: remote-protection-group-snapshot responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/RemoteProtectionGroupSnapshotResponse' x-codegen-request-body-name: remote-protection-group-snapshot /api/2.52/remote-protection-group-snapshots/transfer: get: tags: - Remote Protection Group Snapshots summary: Pure Storage List Remote Protection Groups with Transfer Statistics description: | Displays a list of remote protection groups and their transfer statistics. 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/On_' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Source_ids' - $ref: '#/components/parameters/Source_names' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/RemoteProtectionGroupSnapshotTransferGetResponse' "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/RemoteProtectionGroupSnapshotTransferGetResponse' /api/2.52/remote-protection-group-snapshots/test: post: tags: - Remote Protection Group Snapshots summary: Pure Storage Create an Attempt to Take Remote Protection Group Snapshot description: | Creates an attempt to take a remote protection group snapshot without actually taking it, to test if the snapshot can be successfully taken. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_throttle_snapshot' - $ref: '#/components/parameters/Apply_retention' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Convert_source_to_baseline' - $ref: '#/components/parameters/For_replication' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/OnSingle' - $ref: '#/components/parameters/Replicate' - $ref: '#/components/parameters/Replicate_now' - $ref: '#/components/parameters/Source_ids' - $ref: '#/components/parameters/Source_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoteProtectionGroupSnapshotPost' required: false x-codegen-request-body-name: remote-protection-group-snapshot responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TestResultWithResourceWithIdPostResponse' x-codegen-request-body-name: remote-protection-group-snapshot /api/2.52/remote-realms: get: tags: - Remote Realms summary: Pure Storage List Remote Realms description: | Displays a list of realms that are on connected arrays. 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/On_' - $ref: '#/components/parameters/On_ids' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RemoteRealmsResponse' "207": description: | Indicates partial success. Some resources were returned, but errors may have prevented other resources from being returned. content: application/json: schema: $ref: '#/components/schemas/RemoteRealmsResponse' /api/2.52/remote-realms/tags: get: tags: - Remote Realms summary: Pure Storage List Tags description: Displays the list of tags. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Namespaces' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/On_' - $ref: '#/components/parameters/On_ids' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/RemoteRealmTagGetResponse' "207": description: Indicates partial success. Some resources were returned, but errors may have prevented other resources from being returned. content: application/json: schema: $ref: '#/components/schemas/RemoteRealmTagGetResponse' /api/2.52/remote-volume-snapshots: get: tags: - Remote Volume Snapshots summary: Pure Storage List Remote Volume Snapshots description: Displays a list of remote volume snapshots. 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/On_' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Source_ids' - $ref: '#/components/parameters/Source_names' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/RemoteVolumeSnapshotGetResponse' "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/RemoteVolumeSnapshotGetResponse' post: tags: - Remote Volume Snapshots summary: Pure Storage Create a Volume Snapshot on a Connected Remote Target or Offload Target description: Creates a volume snapshot on the specified connected remote target or offload target. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/OnSingle' - $ref: '#/components/parameters/Source_ids' - $ref: '#/components/parameters/Source_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoteVolumeSnapshotPost' required: true x-codegen-request-body-name: remote-volume-snapshot responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/RemoteVolumeSnapshotResponse' x-codegen-request-body-name: remote-volume-snapshot delete: tags: - Remote Volume Snapshots summary: Pure Storage Delete a Remote Volume Snapshot description: | Deletes a remote volume snapshot that has been destroyed and is pending eradication. Eradicated remote volume snapshots cannot be recovered. Remote volume snapshots are destroyed through the `PATCH` method. The `names` parameter represents the name of the volume snapshot. The `on` parameter represents the name of the offload target. The `names` and `on` parameters are required and must be used together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/OnSingle' - $ref: '#/components/parameters/Replication_snapshot' responses: "200": description: OK content: {} patch: tags: - Remote Volume Snapshots summary: Pure Storage Modify a Remote Volume Snapshot description: | Modifies a remote volume snapshot by destroying or recovering it from the offload target. The `on` parameter represents the name of the offload target. The `names` parameter and the `on` parameter are required and must be used together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/OnSingle' - $ref: '#/components/parameters/Replication_snapshot' requestBody: content: application/json: schema: $ref: '#/components/schemas/_destroyedPatchPost' required: true x-codegen-request-body-name: remote-volume-snapshot responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/RemoteVolumeSnapshotResponse' x-codegen-request-body-name: remote-volume-snapshot /api/2.52/remote-volume-snapshots/transfer: get: tags: - Remote Volume Snapshots summary: Pure Storage List Remote Volume Snapshots with Transfer Statistics description: | Displays a list of remote volume snapshots and their transfer statistics. 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/On_' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Source_ids' - $ref: '#/components/parameters/Source_names' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/RemoteVolumeSnapshotTransferGetResponse' "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/RemoteVolumeSnapshotTransferGetResponse' /api/2.52/realm-connections: get: tags: - Realm Connections summary: Pure Storage List Realm Connections. description: |+ Displays a list of configured realm connections. 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_without_names' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Local_realm_ids' - $ref: '#/components/parameters/Local_realm_names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Remote_realm_ids' - $ref: '#/components/parameters/Remote_realm_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RealmConnectionsGetResponse' "207": description: | Indicates partial success. Some resources were returned, but errors may have prevented other resources from being returned. content: application/json: schema: $ref: '#/components/schemas/RealmConnectionsGetResponse' post: tags: - Realm Connections summary: Pure Storage Create Realm Connection. description: | Creates a new connection between two realms. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Local_realm_ids' - $ref: '#/components/parameters/Local_realm_names' - $ref: '#/components/parameters/Remote_realm_ids' - $ref: '#/components/parameters/Remote_realm_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/RealmConnectionWithKey' required: true x-codegen-request-body-name: connection responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RealmConnectionsResponse' x-codegen-request-body-name: connection delete: tags: - Realm Connections summary: Pure Storage Delete Realm Connections. description: | Deletes connections between realms. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids_without_names' - $ref: '#/components/parameters/Local_realm_ids' - $ref: '#/components/parameters/Local_realm_names' - $ref: '#/components/parameters/Remote_realm_ids' - $ref: '#/components/parameters/Remote_realm_names' responses: '200': description: OK content: {} patch: tags: - Realm Connections summary: Pure Storage Modify Realm Connections. description: | Modifies the connection type between realms. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids_without_names' - $ref: '#/components/parameters/Local_realm_ids' - $ref: '#/components/parameters/Local_realm_names' - $ref: '#/components/parameters/Remote_realm_ids' - $ref: '#/components/parameters/Remote_realm_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/RealmConnectionWithKey' required: true x-codegen-request-body-name: connection responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RealmConnectionsResponse' x-codegen-request-body-name: connection /api/2.52/realm-connections/connection-keys: get: tags: - Realm Connections summary: Pure Storage Get Realm Connection Key Information description: |+ Displays information about existing realm connection keys. Secret keys are not displayed, as they are only available at the time of key creation. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Realm_ids' - $ref: '#/components/parameters/Realm_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RealmConnectionKeyGetResponse' post: tags: - Realm Connections summary: Pure Storage Create Realm Connection Key description: |+ Creates a new one-time connection key to allow establishing a connection to the specified realm. The key is valid until a successful connection is established or its expiration time is reached. Note that this is the only time the connection key is displayed; it cannot be retrieved subsequently. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Realm_ids' - $ref: '#/components/parameters/Realm_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/RealmConnectionKeyPost' required: true x-codegen-request-body-name: connection_key responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RealmConnectionKeyPostResponse' x-codegen-request-body-name: connection_key delete: tags: - Realm Connections summary: Pure Storage Delete Realm Connection Keys description: |+ Deletes all connection keys for a given realm. Note that every realm connection key is a one-time key and is deleted automatically upon a successful connection or once it expires. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Realm_ids' - $ref: '#/components/parameters/Realm_names' responses: '200': description: OK content: {} /api/2.52/resource-accesses: get: tags: - Resource Accesses summary: Pure Storage List Resource Access Configurations description: |+ Displays a list of configured resource accesses. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids_without_names' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceAccessesGetResponse' delete: tags: - Resource Accesses summary: Pure Storage Delete a Resource Access Configuration description: |+ Deletes a resource access object. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Ids_without_names' responses: "200": description: OK content: {} /api/2.52/resource-accesses/batch: post: tags: - Resource Accesses summary: Pure Storage Create a Resource Access Configuration description: | Creates resource access objects. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ResourceAccess' required: true x-codegen-request-body-name: items responses: "200": description: Ok content: application/json: schema: $ref: '#/components/schemas/ResourceAccessesResponse' x-codegen-request-body-name: items /api/2.52/resource-accesses/status: get: tags: - Resource Accesses summary: Pure Storage List Status of Resource Accesses as Specified by Resource Access Configuration description: |+ Displays a list of effective resource accesses. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceAccessesStatusGetResponse' /api/2.52/servers: get: tags: - Servers summary: Pure Storage List Servers description: | Displays a list of servers. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $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/Fqnames' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ServerGetResponse' post: tags: - Servers summary: Pure Storage Create Server description: | Creates a server on the local array. The server must be given a unique name. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Create_local_directory_service' - $ref: '#/components/parameters/Fqnames' requestBody: content: application/json: schema: $ref: '#/components/schemas/ServerPost' required: false x-codegen-request-body-name: server responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ServerResponse' x-codegen-request-body-name: server delete: tags: - Servers summary: Pure Storage Delete Server description: | Deletes a server. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Cascade_delete' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Fqnames' responses: "200": description: OK content: {} patch: tags: - Servers summary: Pure Storage Modify Server description: | Modifies server details. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Fqnames' requestBody: content: application/json: schema: $ref: '#/components/schemas/ServerPatch' required: true x-codegen-request-body-name: server responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ServerResponse' x-codegen-request-body-name: server /api/2.52/sessions: get: tags: - Sessions summary: Pure Storage List Session Data description: "Displays session data for user login events performed in the Purity//FA GUI, CLI, and REST API." parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $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/SessionGetResponse' /api/2.52/smi-s: get: tags: - SMI-S summary: Pure Storage List SMI-S Settings description: | Displays the SMI-S settings, including whether SLP and WBEM-HTTPS are enabled. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SmisGetResponse' patch: tags: - SMI-S summary: Pure Storage Modify SLP and SMI-S description: | Modifies the Service Location Protocol (SLP) and the SMI-S provider, enabling or disabling them. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' requestBody: content: application/json: schema: $ref: '#/components/schemas/Smis' required: true x-codegen-request-body-name: smi-s responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SmisResponse' x-codegen-request-body-name: smi-s /api/2.52/smtp-servers: get: tags: - SMTP summary: Pure Storage List SMTP Server Attributes description: "Displays SMTP server attributes. Values include `user_name`, `password`, `relay_host`, `sender_domain`, `sender_username`, `subject_prefix`, `body_prefix`, `encryption_mode`, and `name`." parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SmtpServerGetResponse' patch: tags: - SMTP summary: Pure Storage Modify SMTP Server Attributes description: "Modifies SMTP server attributes. Values include `user_name`, `password`, `relay_host`, `sender_domain`, `sender_username`, `subject_prefix`, `body_prefix`, `encryption_mode`, and `name`." parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' requestBody: content: application/json: schema: $ref: '#/components/schemas/SmtpServer' required: true x-codegen-request-body-name: smtp responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SmtpServerResponse' x-codegen-request-body-name: smtp /api/2.52/snmp-agents: get: tags: - SNMP Agents summary: Pure Storage List SNMP Agent description: Displays the SNMP agent name and protocol attributes. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SnmpAgentGetResponse' patch: tags: - SNMP Agents summary: Pure Storage Modify SNMP Agent description: Modifies the name or the protocol attributes of the SNMP agent. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' requestBody: content: application/json: schema: $ref: '#/components/schemas/SnmpAgentPatch' required: true x-codegen-request-body-name: snmp-agent responses: "200": description: Returns the newly updated SNMP agent object. content: application/json: schema: $ref: '#/components/schemas/SnmpAgentResponse' x-codegen-request-body-name: snmp-agent /api/2.52/snmp-agents/mib: get: tags: - SNMP Agents summary: Pure Storage List SNMP Agent MIB Text description: Displays the SNMP MIB text. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SnmpAgentMibGetResponse' /api/2.52/snmp-managers: get: tags: - SNMP Managers summary: Pure Storage List SNMP Managers description: Displays designated SNMP managers and their communication and security attributes. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/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/SnmpManagerGetResponse' post: tags: - SNMP Managers summary: Pure Storage Create SNMP Manager description: | Creates a Purity SNMP manager object that identifies a host (SNMP manager) and specifies the protocol attributes for communicating with it. Once a manager object is created, the transmission of SNMP traps is immediately enabled. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/SnmpManagerPost' required: true x-codegen-request-body-name: snmp-manager responses: "200": description: Returns the newly created snmp manager object. content: application/json: schema: $ref: '#/components/schemas/SnmpManagerResponse' x-codegen-request-body-name: snmp-manager delete: tags: - SNMP Managers summary: Pure Storage Delete SNMP Manager description: | Deletes the SNMP manager object and stops communication with specified managers. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' responses: "200": description: OK content: {} patch: tags: - SNMP Managers summary: Pure Storage Modify SNMP Manager description: Modifies the name or the protocol attributes of the specified SNMP manager. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/SnmpManagerPatch' required: true x-codegen-request-body-name: snmp-manager responses: "200": description: Returns the newly updated snmp manager object. content: application/json: schema: $ref: '#/components/schemas/SnmpManagerResponse' x-codegen-request-body-name: snmp-manager /api/2.52/snmp-managers/test: get: tags: - SNMP Managers summary: Pure Storage List SNMP Manager Test Results description: Displays SNMP manager test results (traps or informs). 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/software: get: tags: - Software summary: Pure Storage List Software Packages description: | Displays a list of available software packages. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $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/Versions' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SoftwareGetResponse' post: tags: - Software summary: Pure Storage Create a Software Package description: | Creates a software package download. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' requestBody: content: application/json: schema: $ref: '#/components/schemas/SoftwarePost' required: true x-codegen-request-body-name: software responses: "200": description: | The software package download was initiated. The download will start soon. content: application/json: schema: $ref: '#/components/schemas/SoftwareResponse' x-codegen-request-body-name: software delete: tags: - Software summary: Pure Storage Delete a Software Package description: | Deletes a software package specified by software name and version. A software package being used for an installation can be deleted if the installation is `downloading`, `downloaded`, `aborted`, or `finished`. If the software package is currently `downloading`, the download will be cancelled. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Software_versions' responses: "200": description: OK content: {} /api/2.52/software-bundle: get: tags: - Software summary: Pure Storage List Software-bundle description: | Displays a list of software bundles. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SoftwareBundleGetResponse' post: tags: - Software summary: Pure Storage Create Software-bundle description: | Creates and initiates a software bundle download. parameters: - $ref: '#/components/parameters/XRequestId' requestBody: content: application/json: schema: $ref: '#/components/schemas/SoftwareBundlePost' required: true x-codegen-request-body-name: source responses: "200": description: | The software bundle has started downloading successfully. content: application/json: schema: $ref: '#/components/schemas/SoftwareBundleResponse' x-codegen-request-body-name: source /api/2.52/software-check: get: tags: - Software summary: Pure Storage List Software Check Tasks description: Displays a list of software check tasks. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Software_names' - $ref: '#/components/parameters/Software_versions' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SoftwareChecksGetResponse' post: tags: - Software summary: Pure Storage Create a Software Check Task description: | Creates a software check task. If there are no previously queued or running software check tasks, the new task immediately starts. Otherwise, it is queued and starts once all previously queued or running software check tasks finish. To create a task, use a software name and version. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Software_names' - $ref: '#/components/parameters/Software_versions' responses: "200": description: | The software check record was created successfully. content: application/json: schema: $ref: '#/components/schemas/SoftwareChecksResponse' delete: tags: - Software summary: Pure Storage Delete a Software Check Task description: | Deletes a software check task specified by software name and version. The check task must be queued. If the check task is running or passed/failed then the task cannot be deleted. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Software_names' - $ref: '#/components/parameters/Software_versions' responses: "200": description: OK content: {} /api/2.52/software-installations: get: tags: - Software summary: Pure Storage List Software Upgrades description: |+ Displays a list of software upgrades, including currently running and past upgrades. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $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/Software_ids' - $ref: '#/components/parameters/Software_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SoftwareInstallationsGetResponse' post: tags: - Software summary: Pure Storage Create a Software Upgrade description: | Creates and initiates a software upgrade. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Software_idsRequired' requestBody: content: application/json: schema: $ref: '#/components/schemas/SoftwareInstallationPost' required: true x-codegen-request-body-name: software-installations responses: "200": description: | The software upgrade record was created successfully. content: application/json: schema: $ref: '#/components/schemas/SoftwareInstallationsResponse' x-codegen-request-body-name: software-installations patch: tags: - Software summary: Pure Storage Modify Software Upgrade description: |+ Modifies a software upgrade by continuing, retrying, or aborting it. All `override_checks` are updated before the command is issued if `add_override_checks` is present. The `override_checks` parameter is valid when `command` is set to `continue` or `retry`. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Software_installation_command_required' - $ref: '#/components/parameters/Software_installation_current_step_idRequired' requestBody: content: application/json: schema: $ref: '#/components/schemas/SoftwareInstallationPatch' required: false x-codegen-request-body-name: software-installations responses: "200": description: | The `command` was issued and/or `override_checks` was updated. content: application/json: schema: $ref: '#/components/schemas/SoftwareInstallationsResponse' x-codegen-request-body-name: software-installations /api/2.52/software-installation-steps: get: tags: - Software summary: Pure Storage List Software Upgrade Steps description: Displays a list of currently running and completed software upgrade steps. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $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/Software_installation_ids' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SoftwareInstallationStepsGetResponse' /api/2.52/software-patches: get: tags: - Software summary: Pure Storage List Software Patches description: | Displays a list of software patches. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $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/SoftwarePatchesGetResponse' post: tags: - Software summary: Pure Storage Create a Software Patch description: | Creates software patch download and installation. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - name: allow_ha_reduction in: query description: |+ If Software Patch has ha_reduction_required set to true, `allow_ha_reduction` must be set to `true` for Software Patch installation. schema: type: boolean - name: name in: query description: Name of software patch to install required: true schema: type: string responses: "200": description: | The software patch download was initiated. The download and installation will start soon. content: application/json: schema: $ref: '#/components/schemas/SoftwarePatchesResponse' /api/2.52/software-patches/catalog: get: tags: - Software summary: Pure Storage List Available Software Patches description: | Displays a list of available software patches. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SoftwarePatchesGetResponse' /api/2.52/software-versions: get: tags: - Software summary: Pure Storage List Software Versions description: |+ Displays a list of software versions. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SoftwareVersionsGetResponse' /api/2.52/sso/saml2/idps: get: tags: - SAML2 SSO summary: Pure Storage List SAML2 SSO Configurations description: | Displays the SAML2 SSO service provider and identity provider configuration settings in the array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $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/Saml2SsoGetResponse' post: tags: - SAML2 SSO summary: Pure Storage Create SAML2 SSO Configurations description: | Creates SAML2 SSO configurations. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names_required' requestBody: content: application/json: schema: $ref: '#/components/schemas/Saml2SsoPost' required: true x-codegen-request-body-name: idp responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Saml2SsoResponse' x-codegen-request-body-name: idp delete: tags: - SAML2 SSO summary: Pure Storage Delete SAML2 SSO Configurations description: | Deletes SAML2 SSO configurations. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' responses: "200": description: OK content: {} patch: tags: - SAML2 SSO summary: Pure Storage Modify SAML2 SSO Configurations description: | Modifies one or more attributes of SAML2 SSO configurations. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/Saml2SsoPatch' required: true x-codegen-request-body-name: idp responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Saml2SsoResponse' x-codegen-request-body-name: idp /api/2.52/sso/saml2/idps/test: get: tags: - SAML2 SSO summary: Pure Storage List Existing SAML2 SSO Configurations description: | Displays the existing SAML2 SSO configurations in the array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/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/TestResultWithResourceResponse' patch: tags: - SAML2 SSO summary: Pure Storage Modify Provided SAML2 SSO Configurations description: | Modifies the provided SAML2 SSO configurations. If the configurations with the specified `ids` or `names` exist, the provided configurations will overwrite the existing configurations, but will not be persisted in the array. 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/Saml2SsoPost' required: true x-codegen-request-body-name: idp responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TestResultWithResourcePatchResponse' x-codegen-request-body-name: idp /api/2.52/subnets: get: tags: - Subnets summary: Pure Storage List Subnets description: Displays a list of subnets with statuses and attributes. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/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/SubnetGetResponse' post: tags: - Subnets summary: Pure Storage Create Subnet description: Creates a subnet with the specified parameters. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names_required' requestBody: content: application/json: schema: $ref: '#/components/schemas/SubnetPost' required: true x-codegen-request-body-name: subnet responses: "200": description: Displays the newly created subnet. content: application/json: schema: $ref: '#/components/schemas/SubnetResponse' x-codegen-request-body-name: subnet delete: tags: - Subnets summary: Pure Storage Delete Subnet description: | Deletes subnets. A subnet can only be deleted if it has no interfaces. Interfaces must be removed by using the `network-interfaces` endpoint. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' responses: "200": description: OK content: {} patch: tags: - Subnets summary: Pure Storage Modify Subnet description: Modifies one or more specified subnet properties. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/SubnetPatch' required: true x-codegen-request-body-name: subnet responses: "200": description: Displays the updated subnet. content: application/json: schema: $ref: '#/components/schemas/SubnetResponse' x-codegen-request-body-name: subnet /api/2.52/subscriptions: get: tags: - Subscriptions summary: Pure Storage List Subscriptions description: |+ Displays information about subscriptions. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SubscriptionGetResponse' /api/2.52/subscription-assets: get: tags: - Subscription Assets summary: Pure Storage List Subscription Assets description: |+ Displays information about subscription assets. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $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/SubscriptionAssetGetResponse' /api/2.52/support: get: tags: - Support summary: Pure Storage List Connection Paths description: | Displays connection paths between the current array and each connected array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SupportGetResponse' patch: tags: - Support summary: Pure Storage Create Connection Path description: | Creates a connection path from the array to another array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' requestBody: content: application/json: schema: $ref: '#/components/schemas/SupportPatch' required: true x-codegen-request-body-name: support responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SupportResponse' x-codegen-request-body-name: support /api/2.52/support/remote-assist-sessions: get: tags: - Support summary: Pure Storage List Remote Assist Session description: | Displays settings for remote assist sessions. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SupportRemoteAssistSessionsGetResponse' patch: tags: - Support summary: Pure Storage Modify Remote Assist Session description: | Modifies settings for remote assist sessions. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' requestBody: content: application/json: schema: $ref: '#/components/schemas/SupportRemoteAssistSessionsPatch' required: true x-codegen-request-body-name: support responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SupportRemoteAssistSessionsResponse' x-codegen-request-body-name: support /api/2.52/support/remote-assist-sessions/settings: get: tags: - Support summary: Pure Storage List Remote Assist Session Global Settings description: | Displays global settings for remote assist sessions. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SupportRemoteAssistSessionsSettingsGetResponse' patch: tags: - Support summary: Pure Storage Update Remote Assist Session Global Settings description: | Updates global settings for remote assist sessions. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' requestBody: content: application/json: schema: $ref: '#/components/schemas/SupportRemoteAssistSessionsSettings' required: true x-codegen-request-body-name: support responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SupportRemoteAssistSessionsSettingsResponse' x-codegen-request-body-name: support /api/2.52/support/system-manifest: get: tags: - Support summary: Pure Storage List the System Manifest description: The creation and return of the system manifest as a `JSON` object. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SupportSystemManifestResponse' /api/2.52/support/test: get: tags: - Support summary: Pure Storage List Pure Storage Support Connection Data description: Displays information about whether the array can connect to Pure Storage Support by establishing a secure shell or secure HTTP connection and verifies that messages can be exchanged. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Test_type' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TestResultGetResponse' /api/2.52/support-diagnostics/details: get: tags: - Support summary: Pure Storage List Diagnostics Details description: | Displays the diagnostics tests details. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SupportDiagnosticsDetailsGetResponse' /api/2.52/support-diagnostics/settings: get: tags: - Support summary: Pure Storage List Diagnostics Tools Version and Last Updated Date description: | Displays diagnostics tools version and last updated date. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SupportDiagnosticsGetResponse' patch: tags: - Support summary: Pure Storage Update Diagnostics Tools description: | Update diagnostics tools from downloaded bundle. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/PurityDefault' responses: "200": description: | The diagnostics tools were updated successfully. content: application/json: schema: $ref: '#/components/schemas/SupportDiagnosticsResponse' /api/2.52/syslog-servers: get: tags: - Syslog summary: Pure Storage List Syslog Servers description: | Displays a list of configured syslog servers. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/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/SyslogServerGetResponse' "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/SyslogServerGetResponse' post: tags: - Syslog summary: Pure Storage Create Syslog Server description: | Creates a new syslog server. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/SyslogServer' required: true x-codegen-request-body-name: syslog-server responses: "200": description: Displays the newly configured syslog server. content: application/json: schema: $ref: '#/components/schemas/SyslogServerResponse' x-codegen-request-body-name: syslog-server delete: tags: - Syslog summary: Pure Storage Delete Syslog Server description: | Deletes a configured syslog server and stops forwarding syslog messages. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' responses: "200": description: OK content: {} patch: tags: - Syslog summary: Pure Storage Modify Syslog Server description: | Modifies the URI and services of a configured syslog server. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/SyslogServer' required: true x-codegen-request-body-name: syslog-server responses: "200": description: Displays the newly updated syslog server. content: application/json: schema: $ref: '#/components/schemas/SyslogServerResponse' x-codegen-request-body-name: syslog-server /api/2.52/syslog-servers/settings: get: tags: - Syslog summary: Pure Storage List Syslog Settings description: "Displays syslog settings. Values include `continuation_token`, `items`, `more_items_remaining`, and `total_item_count`." parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SyslogServerSettingsGetResponse' "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/SyslogServerSettingsGetResponse' patch: tags: - Syslog summary: Pure Storage Modify Syslog Settings description: "Modifies syslog settings. Values include `continuation_token`, `items`, `more_items_remaining`, and `total_item_count`." parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/SyslogServerSettings' required: true x-codegen-request-body-name: syslog-server-settings responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SyslogServerSettingsResponse' x-codegen-request-body-name: syslog-server-settings /api/2.52/syslog-servers/test: get: tags: - Syslog summary: Pure Storage List Syslog Server Test Results description: "Displays syslog server test results, which indicate whether the syslog is working and configured correctly." parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/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/vchosts: get: tags: - Vchosts summary: Pure Storage List Vchosts description: |+ Displays a list of vchosts. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $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/VchostGetResponse' post: tags: - Vchosts summary: Pure Storage Create a Vchost description: |+ Creates a vchost. The `names` query parameter is required. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/VchostPost' required: true x-codegen-request-body-name: vchost responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VchostResponse' x-codegen-request-body-name: vchost delete: tags: - Vchosts summary: Pure Storage Delete a Vchost description: |+ Deletes an existing vchost. The `names` or `ids` query parameter is required. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' responses: "200": description: OK content: {} patch: tags: - Vchosts summary: Pure Storage Modify a Vchost description: |+ Modifies an existing vchost. The `names` or `ids` query parameter is required. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/VchostPatch' required: true x-codegen-request-body-name: vchost responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VchostResponse' x-codegen-request-body-name: vchost /api/2.52/vchosts/certificates: get: tags: - Vchosts summary: Pure Storage List Vchost Certificates description: |+ Displays certificates that are attached to configured vchosts on at least one endpoint. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Certificate_names' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Vchost_ids' - $ref: '#/components/parameters/Vchost_names' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VchostCertificateGetResponse' post: tags: - Vchosts summary: Pure Storage Create a Vchost Certificate description: |+ Creates an association between a certificate and vchost on one or more endpoints. The `vchost_names` or `vchost_ids` query parameter is required. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Vchost_ids' - $ref: '#/components/parameters/Vchost_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/VchostCertificatePost' required: true x-codegen-request-body-name: certificate responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VchostCertificateResponse' x-codegen-request-body-name: certificate delete: tags: - Vchosts summary: Pure Storage Delete a Vchost Certificate description: |+ Deletes an existing vchost certificate. The `ids` query parameter alone, or the `certificate_names` query parameter together with one of `vchost_names` or `vchost_ids`, is required. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Certificate_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Vchost_ids' - $ref: '#/components/parameters/Vchost_names' responses: "200": description: OK content: {} patch: tags: - Vchosts summary: Pure Storage Modify a Vchost Certificate description: |+ Modifies an existing vchost certificate. The `ids` query parameter alone, or the `certificate_names` query parameter together with one of `vchost_names` or `vchost_ids`, is required. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Certificate_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Vchost_ids' - $ref: '#/components/parameters/Vchost_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/VchostCertificatePatch' required: true x-codegen-request-body-name: certificate responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VchostCertificateResponse' x-codegen-request-body-name: certificate /api/2.52/vchosts/endpoints: get: tags: - Vchosts summary: Pure Storage List Vchost Endpoints description: |+ Displays a list of vchost endpoints with their associated vchosts and certificates. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Endpoints' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Vchost_ids' - $ref: '#/components/parameters/Vchost_names' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VchostEndpointGetResponse' post: tags: - Vchosts summary: Pure Storage Create a Vchost Endpoint description: |+ Creates a vchost endpoint. Either the `vchost_names` or `vchost_ids` query parameter is required. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Vchost_ids' - $ref: '#/components/parameters/Vchost_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/VchostEndpointPost' required: true x-codegen-request-body-name: endpoint responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VchostEndpointResponse' x-codegen-request-body-name: endpoint delete: tags: - Vchosts summary: Pure Storage Delete a Vchost Endpoint description: |+ Deletes an existing vchost endpoint The `ids` query parameter alone, or the `endpoints` query parameter together with one of `vchost_names` or `vchost_ids`, is required. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Endpoints' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Vchost_ids' - $ref: '#/components/parameters/Vchost_names' responses: "200": description: OK content: {} patch: tags: - Vchosts summary: Pure Storage Modify a Vchost Endpoint description: |+ Modifies an existing vchost endpoint. The `ids` query parameter alone, or the `endpoints` query parameter together with one of `vchost_names` or `vchost_ids`, is required. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Endpoints' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Vchost_ids' - $ref: '#/components/parameters/Vchost_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/VchostEndpointPatch' required: true x-codegen-request-body-name: endpoint responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VchostEndpointResponse' x-codegen-request-body-name: endpoint /api/2.52/vchost-connections: get: tags: - Vchost Connections summary: Pure Storage List the Vchost-connections Between Protocol Endpoint and Vchost. description: |+ Displays a list of vchost-connections between the protocol endpoint and vchost. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/All_vchosts' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Protocol_endpoint_ids_for_vchost_connections' - $ref: '#/components/parameters/Protocol_endpoint_names_for_vchost_connections' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Vchost_ids_for_vchost_connections' - $ref: '#/components/parameters/Vchost_names_for_vchost_connections' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VchostConnectionGetResponse' post: tags: - Vchost Connections summary: Pure Storage Create a Vchost-connection Between Protocol Endpoint and Vchost. description: | Creates a vchost-connection between protocol endpoint and vchost. Each vchost is associated with a vCenter. Each protocol endpoint is associated with a storage container. A vchost-connection makes the storage container accessible to the vCenter when the vCenter attempts to mount the container. One of `protocol_endpoint_names` or `protocol_endpoint_ids` query parameters and one of `vchost_names` or `vchost_ids` query parameters are required. But if `all_vchosts` is set to `true`, `vchost_names` and `vchost_ids` should not be specified. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/All_vchosts' - $ref: '#/components/parameters/Allow_stretched_multi_vchost' - $ref: '#/components/parameters/Protocol_endpoint_ids_for_vchost_connections' - $ref: '#/components/parameters/Protocol_endpoint_names_for_vchost_connections' - $ref: '#/components/parameters/Vchost_ids_for_vchost_connections' - $ref: '#/components/parameters/Vchost_names_for_vchost_connections' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VchostConnectionResponse' delete: tags: - Vchost Connections summary: Pure Storage Delete the Vchost-connection Between a Protocol Endpoint and its Vchost description: |+ Deletes the vchost-connection between a protocol endpoint and its vchost. The storage container represented by the protocol endpoint will no longer be visible to the vCenter represented by the vchost. One of the `protocol_endpoint_names` or `protocol_endpoint_ids` query parameters, and one of the `vchost_names` or `vchost_ids` query parameters are required. But if `all_vchosts` is set to `true`, `vchost_names` and `vchost_ids` should not be specified. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/All_vchosts' - $ref: '#/components/parameters/Protocol_endpoint_ids_for_vchost_connections' - $ref: '#/components/parameters/Protocol_endpoint_names_for_vchost_connections' - $ref: '#/components/parameters/Vchost_ids_for_vchost_connections' - $ref: '#/components/parameters/Vchost_names_for_vchost_connections' responses: "200": description: OK content: {} /api/2.52/virtual-machines: get: tags: - Virtual Machines summary: Pure Storage List Virtual Machines description: |+ Displays a list of virtual machines, including those pending eradication. If `vm_type` is `vvol`, the `recovery_context` in the response will represent the most recent snapshot of the config vVol. This must be used as the `source` in the `PATCH` method when recovering a virtual machine from the destroyed state. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' - name: vm_ids in: query description: | Performs the operation on the unique virtual machine IDs specified. Enter multiple virtual machine IDs in a comma-separated format. style: form explode: false schema: type: array items: type: string - name: vm_type in: query description: | The type of virtual machine. The only valid value is `vvol`. schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VirtualMachineGetResponse' post: tags: - Virtual Machines summary: Pure Storage Create a Virtual Machine description: |+ Creates one or more virtual machines from a protection group snapshot. If the virtual machine is of type `vvol`, the `source` property of the request body must be a `recovery_context` value retrieved from the `GET /virtual-machine-snapshots` endpoint. If `overwrite` is specified, an existing virtual machine will have its volumes overwritten by the snapshot. Otherwise, a new virtual machine will be created from the snapshot. If creating the new virtual machine will cause a conflict with an existing virtual machine, the operation will fail. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Overwrite' requestBody: content: application/json: schema: $ref: '#/components/schemas/VirtualMachinePost' required: true x-codegen-request-body-name: virtual-machine responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VirtualMachineResponse' x-codegen-request-body-name: virtual-machine patch: tags: - Virtual Machines summary: Pure Storage Update a Virtual Machine description: |+ Updates a virtual machine, recovering it from the destroyed state. If the virtual machine is of type `vvol`, the `source` property of the request body must be a `recovery_context` value retrieved from the `GET /virtual-machines` endpoint. If recovering the virtual machine will cause a conflict with an existing virtual machine, the operation will fail. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' requestBody: content: application/json: schema: $ref: '#/components/schemas/VirtualMachinePost' required: true x-codegen-request-body-name: virtual-machine responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VirtualMachineResponse' x-codegen-request-body-name: virtual-machine /api/2.52/virtual-machine-volume-snapshots: get: tags: - Virtual Machines summary: Pure Storage List Virtual Machine Volume Snapshots description: |+ Displays a list of virtual machine volume snapshots, including those pending eradication. If `vm_type` is `vvol`, the `recover_context` in the response will represent a protection group snapshot containing the virtual machine volume. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' - name: vm_ids in: query description: | Performs the operation on the unique virtual machine IDs specified. Enter multiple resource IDs in a comma-separated format. required: true style: form explode: false schema: type: array items: type: string - name: vm_type in: query description: | The type of virtual machine. The only valid value is `vvol`. schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VirtualMachineVolumeSnapshotResponse' /api/2.52/virtual-machine-snapshots: get: tags: - Virtual Machines summary: Pure Storage List Virtual Machine Snapshots description: |+ Displays a list of virtual machine snapshots, including those pending eradication. If `vm_type` is `vvol`, the `recovery_context` in the response will represent a protection group snapshot containing the virtual machine. This must be used as the `source` in the `POST /virtual-machine` method when recovering or overwriting a virtual machine from a snapshot. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' - name: vm_ids in: query description: | Performs the operation on the unique virtual machine IDs specified. Enter multiple resource IDs in a comma-separated format. style: form explode: false schema: type: array items: type: string - name: vm_type in: query description: | The type of virtual machine. The only valid value is `vvol`. schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VirtualMachineGetResponse' /api/2.52/volumes: get: tags: - Volumes summary: Pure Storage List Volumes description: |+ Displays a list of volumes, including those pending eradication. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VolumeGetResponse' "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/VolumeGetResponse' post: tags: - Volumes summary: Pure Storage Create or Copy a Volume and Upsert Tags description: |+ Creates one or more virtual storage volumes of the specified size. If `provisioned` is not specified, the size of the new volume defaults to 1 MB. The `names` query parameter is required. The `add_to_protection_group_names` query parameter specifies a list of protection group names that will compose the initial protection for the volume. The `with_default_protection` query parameter specifies whether to use the container default protection configuration for the volume. The `add_to_protection_group_names` and `with_default_protection` query parameters cannot be provided when `overwrite` is `true`. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Add_to_protection_group_ids' - $ref: '#/components/parameters/Add_to_protection_group_names' - $ref: '#/components/parameters/Allow_throttle_operation' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Overwrite' - $ref: '#/components/parameters/With_default_protection' requestBody: content: application/json: schema: $ref: '#/components/schemas/VolumePost' required: true x-codegen-request-body-name: volume responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VolumeResponse' x-codegen-request-body-name: volume delete: tags: - Volumes summary: Pure Storage Delete a Volume description: |+ Deletes a volume that has been destroyed and is pending eradication. Eradicated volumes cannot be recovered. Volumes are destroyed using the `PATCH` method. The `ids` or `names` parameter is required, but they cannot be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' responses: "200": description: OK content: {} patch: tags: - Volumes summary: Pure Storage Modify a Volume description: |+ Modifies a volume by renaming, destroying, or resizing it. To rename a volume, set `name` to the new name. To destroy a volume, set `destroyed=true`. To recover a volume that has been destroyed and is pending eradication, set `destroyed=false`. Set the bandwidth and IOPS limits of a volume through the respective `bandwidth_limit` and `iops_limit` parameter. This moves the volume into a pod or volume group through the respective `pod` or `volume_group` parameter. 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/Add_to_protection_group_ids' - $ref: '#/components/parameters/Add_to_protection_group_names' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Remove_from_protection_group_ids' - $ref: '#/components/parameters/Remove_from_protection_group_names' - $ref: '#/components/parameters/Truncate' requestBody: content: application/json: schema: $ref: '#/components/schemas/VolumePatch' required: true x-codegen-request-body-name: volume responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VolumeResponse' x-codegen-request-body-name: volume /api/2.52/volumes/batch: post: tags: - Volumes summary: Pure Storage Create or Copy Volumes and Upsert Tags description: | Creates or copies a list of virtual storage volumes. Volumes of different sizes, vgroups, and tag upsertions can be copied this way. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_throttle_operation' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Overwrite' - $ref: '#/components/parameters/With_default_protection' requestBody: description: | A list of volumes to be created or copied. content: application/json: schema: type: array items: $ref: '#/components/schemas/VolumeBatchPost' required: true x-codegen-request-body-name: volume responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VolumesBatchResponse' x-codegen-request-body-name: volume /api/2.52/volumes/diff: get: tags: - Volumes summary: Pure Storage List Volume Diffs description: Displays block differences for the specified volumes. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Base_id' - $ref: '#/components/parameters/Base_name' - $ref: '#/components/parameters/Block_size' - $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/Next_allocated_block_hint' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Segment_length' - $ref: '#/components/parameters/Segment_offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VolumesDiffGetResponse' "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/VolumesDiffGetResponse' /api/2.52/volumes/batch/test: post: tags: - Volumes summary: Pure Storage Create an Attempt to Copy Volumes and Upsert Tags description: |+ Creates an attempt to copy virtual storage volumes of different sizes in different vgroups and also upserts tags, without actually creating them, to test if they can be successfully created. Only available for creating volumes via a copy, not direct volume creation. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_throttle_operation' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Overwrite' - $ref: '#/components/parameters/With_default_protection' requestBody: description: | A list of volumes to be copied. content: application/json: schema: type: array items: $ref: '#/components/schemas/VolumeBatchPost' required: true x-codegen-request-body-name: volume responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TestResultWithResourceWithIdPostResponse' x-codegen-request-body-name: volume /api/2.52/volumes/performance: get: tags: - Volumes summary: Pure Storage List Volume Performance Data description: |+ Displays real-time and historical performance data, real-time latency data, and average I/O sizes for each volume and and as a total of all volumes across the entire array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourcePerformanceGetResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/ResourcePerformanceGetResponse' /api/2.52/volumes/performance/by-array: get: tags: - Volumes summary: Pure Storage List Volume Performance Data by Array description: |+ Displays real-time and historical performance data, real-time latency data, and average I/O size data. The data returned is for each volume on the current array and for each volume on any remote arrays that are visible to the current array. The data is grouped by individual volumes and as a total across all volumes on each array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourcePerformanceByArrayGetResponse' "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/ResourcePerformanceByArrayGetResponse' /api/2.52/volumes/protection-groups: get: tags: - Volumes summary: Pure Storage List Volumes That Are Members of Protection Groups description: | Displays a list of volume members that belong to one or more protection groups. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Member_destroyed' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupsVolumesGetResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupsVolumesGetResponse' post: tags: - Volumes summary: Pure Storage Create a Volume and Add it to a Protection Group description: | Creates a volume member and adds it to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. The `group_names` parameter represents the name of the protection group, and the `member_names` and `member_ids` parameters represent the names or IDs of the volume. The `group_names` and only one of `member_names` or `member_ids` parameters are required and must be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ProtectionGroupsVolumesResponse' delete: tags: - Volumes summary: Pure Storage Delete a Volume from a Protection Group description: | Deletes a volume member from a protection group. After the member has been deleted, it is no longer protected by the group. Any protection group snapshots that were taken before the member was deleted are not affected. Deleting a member from a protection group does not delete the member from the array or realm, and the member can be added back to the protection group at any time. The `group_names` parameter represents the name of the protection group, and the `member_names` and `member_ids` parameters represent the names or IDs of the volume. The `group_names` and only one of `member_names` or `member_ids` parameters are required and must be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' responses: "200": description: OK content: {} /api/2.52/volumes/qos: get: tags: - Volumes summary: Pure Storage List Volume QoS Config description: | Displays real-time and historical QoS configuration data for each volume. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VolumeQosGetResponse' "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/VolumeQosGetResponse' /api/2.52/volumes/space: get: tags: - Volumes summary: Pure Storage List Volume Space Information description: |+ Displays the provisioned size and physical storage consumption data for each volume. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VolumeSpaceGetResponse' "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/VolumeSpaceGetResponse' /api/2.52/volumes/tags: get: tags: - Volumes summary: Pure Storage List Tags description: Displays the list of tags. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Namespaces' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Resource_destroyed' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TagGetResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/TagGetResponse' delete: tags: - Volumes summary: Pure Storage Delete Tags description: Deletes specified tags. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Keys' - $ref: '#/components/parameters/Namespaces_delete' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' responses: "200": description: OK content: {} /api/2.52/volumes/tags/batch: put: tags: - Volumes summary: Pure Storage Update Tags description: | Updates tags. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' requestBody: description: "A list of tags to be created or, if one already exists, updated." content: application/json: schema: maxItems: 30 minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/TagBatch' required: true x-codegen-request-body-name: tag responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TagResponse' x-codegen-request-body-name: tag /api/2.52/volumes/test: post: tags: - Volumes summary: Pure Storage Create a Dry Run Attempt to Copy a Volume description: | Creates a dry run attempt to see if copying a volume would succeed. No virtual volumes are actually copied or created in this process. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Add_to_protection_group_ids' - $ref: '#/components/parameters/Add_to_protection_group_names' - $ref: '#/components/parameters/Allow_throttle_operation' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Overwrite' - $ref: '#/components/parameters/With_default_protection' requestBody: content: application/json: schema: $ref: '#/components/schemas/VolumePost' required: true x-codegen-request-body-name: volume responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TestResultWithResourceWithIdPostResponse' x-codegen-request-body-name: volume /api/2.52/volumes/volume-groups: get: tags: - Volumes summary: Pure Storage List Volumes That Are in Volume Groups description: |+ Displays a list of volumes that are in a volume group. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/MemberGetResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/MemberGetResponse' /api/2.52/volume-groups: get: tags: - Volume Groups summary: Pure Storage List Volume Groups description: | Displays a list of volume groups, including those pending eradication. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VolumeGroupGetResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/VolumeGroupGetResponse' post: tags: - Volume Groups summary: Pure Storage Create a Volume Group and Upsert Tags. description: | Creates a volume group. The volume group itself does not contain any meaningful content; instead, it acts as a container that is used to organize volumes. Once a volume group has been created, volumes can be created inside the volume group or moved into and out of the volume group. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/VolumeGroupPost' required: true x-codegen-request-body-name: volume-group responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VolumeGroupResponse' x-codegen-request-body-name: volume-group delete: tags: - Volume Groups summary: Pure Storage Delete a Volume Group description: | Deletes a volume group that has been destroyed and is pending eradication. Eradicated volume groups cannot be recovered. Volume groups are destroyed through the PATCH method. The `ids` or `names` parameter is required, but they cannot be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Eradicate_contents' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' responses: "200": description: OK content: {} patch: tags: - Volume Groups summary: Pure Storage Modify a Volume Group description: | Modifies a volume group. You can rename, destroy, recover, or set QoS limits for a volume group. To rename a volume group, set `name` to the new name. To destroy a volume group, set `destroyed=true`. To recover a volume group that has been destroyed and is pending eradication, set `destroyed=false`. Sets the bandwidth and IOPS limits of a volume group through the respective `bandwidth_limit` and `iops_limit` parameter. The `ids` or `names` parameter is required, but they cannot be set together. Sets the priority adjustment for a volume group using the `priority_adjustment_operator` and `priority_adjustment_value` fields. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Destroy_contents' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/VolumeGroupPatch' required: true x-codegen-request-body-name: volume-group responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VolumeGroupResponse' x-codegen-request-body-name: volume-group /api/2.52/volume-groups/performance: get: tags: - Volume Groups summary: Pure Storage List Volume Group Performance Data description: | Displays real-time and historical performance data, real-time latency data, and average I/O sizes for each volume group and and as a total of all volume groups across the entire array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourcePerformanceGetResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/ResourcePerformanceGetResponse' /api/2.52/volume-groups/qos: get: tags: - Volume Groups summary: Pure Storage List Volume Group QoS Config description: | Displays real-time and historical QoS configuration data for each volume group. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VolumeGroupQosGetResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/VolumeGroupQosGetResponse' /api/2.52/volume-groups/space: get: tags: - Volume Groups summary: Pure Storage List Volume Group Space Information description: | Displays the provisioned size and physical storage consumption data for each volume group. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceSpaceGetResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/ResourceSpaceGetResponse' /api/2.52/volume-groups/volumes: get: tags: - Volume Groups summary: Pure Storage List Volume Groups with Volumes description: Displays a list of volume groups that contain volumes. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Group_ids' - $ref: '#/components/parameters/Group_names' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/MemberGetResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/MemberGetResponse' /api/2.52/volume-groups/tags: get: tags: - Volume Groups summary: Pure Storage List Tags description: Displays the list of tags. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Namespaces' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Resource_destroyed' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TagGetResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/TagGetResponse' delete: tags: - Volume Groups summary: Pure Storage Delete Tags description: Deletes specified tags. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Keys' - $ref: '#/components/parameters/Namespaces_delete' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' responses: "200": description: OK content: {} /api/2.52/volume-groups/tags/batch: put: tags: - Volume Groups summary: Pure Storage Update Tags description: Updates tags for all specified objects. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' requestBody: description: "A list of tags to be created or, if one already exists, updated." content: application/json: schema: maxItems: 30 minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/TagBatch' required: true x-codegen-request-body-name: tag responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TagResponse' x-codegen-request-body-name: tag /api/2.52/volume-snapshots: get: tags: - Volume Snapshots summary: Pure Storage List Volume Snapshots description: |+ Displays a list of volume snapshots, including those pending eradication. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Source_ids' - $ref: '#/components/parameters/Source_names' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VolumeSnapshotGetResponse' "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/VolumeSnapshotGetResponse' post: tags: - Volume Snapshots summary: Pure Storage Create a Volume Snapshot and Tags description: |+ Creates a point-in-time snapshot of the contents of a volume. The `source_ids` or `source_names` parameter is required, but they cannot be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_throttle_snapshot' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/OnSingle' - $ref: '#/components/parameters/Source_ids' - $ref: '#/components/parameters/Source_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/VolumeSnapshotPost' required: true x-codegen-request-body-name: volume-snapshot responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VolumeSnapshotResponse' x-codegen-request-body-name: volume-snapshot delete: tags: - Volume Snapshots summary: Pure Storage Delete a Volume Snapshot description: |+ Deletes a volume snapshot that has been destroyed and is pending eradication. Eradicated volume snapshots cannot be recovered. Volume snapshots are destroyed by using the `PATCH` method. The `ids` or `names` parameter is required, but they cannot be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Replication_snapshot' responses: "200": description: OK content: {} patch: tags: - Volume Snapshots summary: Pure Storage Modify a Volume Snapshot description: |+ Modifies a volume snapshot by renaming, destroying, or recovering it. To rename the suffix of a volume snapshot, set `name` to the new suffix name. To recover a volume snapshot that has been destroyed and is pending eradication, set `destroyed=true`. 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' - $ref: '#/components/parameters/Replication_snapshot' requestBody: content: application/json: schema: $ref: '#/components/schemas/VolumeSnapshotPatch' required: true x-codegen-request-body-name: volume-snapshot responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VolumeSnapshotResponse' x-codegen-request-body-name: volume-snapshot /api/2.52/volume-snapshots/batch: post: tags: - Volume Snapshots summary: Pure Storage Create Volume Snapshots and Create Tags. description: |+ Creates point-in-time snapshots of the contents of volumes. The destroyed parameter, suffixes, and tags can be different for each snapshot. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_throttle_snapshot' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/OnSingle' requestBody: description: | The list of volume snapshots to be created. content: application/json: schema: type: array items: $ref: '#/components/schemas/VolumeSnapshotBatchPost' required: true x-codegen-request-body-name: volume-snapshot responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VolumeSnapshotBatchResponse' x-codegen-request-body-name: volume-snapshot /api/2.52/volume-snapshots/transfer: get: tags: - Volume Snapshots summary: Pure Storage List Volume Snapshots with Transfer Statistics description: |+ Displays a list of volume snapshots and their transfer statistics. 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/Source_ids' - $ref: '#/components/parameters/Source_names' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VolumeSnapshotTransferGetResponse' "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/VolumeSnapshotTransferGetResponse' /api/2.52/volume-snapshots/tags: get: tags: - Volume Snapshots summary: Pure Storage List Tags description: Displays the list of tags. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Namespaces' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Resource_destroyed' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TagGetResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/TagGetResponse' delete: tags: - Volume Snapshots summary: Pure Storage Delete Tags description: Deletes specified tags. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Keys' - $ref: '#/components/parameters/Namespaces_delete' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' responses: "200": description: OK content: {} /api/2.52/volume-snapshots/tags/batch: put: tags: - Volume Snapshots summary: Pure Storage Update Tags description: | Updates tags. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' requestBody: description: A list of tags to be created or modified. content: application/json: schema: maxItems: 30 minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/TagBatch' required: true x-codegen-request-body-name: tag responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TagResponse' x-codegen-request-body-name: tag /api/2.52/volume-snapshots/test: post: tags: - Volume Snapshots summary: Pure Storage Create the Volume Snapshot Path description: | Creates the volume snapshot path without actually taking a volume snapshot. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_throttle_snapshot' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/OnSingle' - $ref: '#/components/parameters/Source_ids' - $ref: '#/components/parameters/Source_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/VolumeSnapshotPost' required: true x-codegen-request-body-name: volume-snapshot responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TestResultWithResourcePostResponse' x-codegen-request-body-name: volume-snapshot /api/2.52/workloads: get: tags: - Workloads summary: Pure Storage List Workloads description: | Displays a list of workloads. 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/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/WorkloadGetResponse' "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/WorkloadGetResponse' post: tags: - Workloads summary: Pure Storage Create a Workload description: | Creates one workload. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names_single_required' - $ref: '#/components/parameters/Preset_ids' - $ref: '#/components/parameters/Preset_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkloadPost' required: true x-codegen-request-body-name: workload responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/WorkloadResponse' x-codegen-request-body-name: workload delete: tags: - Workloads summary: Pure Storage Delete a Workload description: | Deletes a workload that has been destroyed and is pending eradication. Eradicated workloads cannot be recovered. Workloads are destroyed using the `PATCH` method. The `ids` or `names` parameter is required, but they cannot be set together. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids_single' - $ref: '#/components/parameters/Names_single' responses: "200": description: OK content: {} patch: tags: - Workloads summary: Pure Storage Modify a Workload description: | Modifies a workload by renaming or destroying it. To rename a workload, set `name` to the new name. To destroy a workload, set `destroyed=true`. To recover a workload that has been destroyed and is pending eradication, set `destroyed=false`. 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_single' - $ref: '#/components/parameters/Names_single' requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkloadPatch' required: true x-codegen-request-body-name: workload responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/WorkloadResponse' x-codegen-request-body-name: workload /api/2.52/workloads/placement-recommendations: get: tags: - Workloads summary: Pure Storage List Workload Placement Recommendations description: Displays a list of placement recommendations for workloads. 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/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/WorkloadPlacementRecommendationGetResponse' "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/WorkloadPlacementRecommendationGetResponse' post: tags: - Workloads summary: Pure Storage Create a Request for a Workload Placement Recommendation. description: | Creates a recommendation for the placement of the specified workload. The computation might take a few minutes. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Placement_names' - name: preset_ids in: query description: | Creates the workload placement recommendations using the presets specified by ids. Only one preset can be specified. One of the `preset_ids` or `preset_names` parameters are required, but they cannot be set together. style: form explode: false schema: type: array items: type: string - name: preset_names in: query description: | Creates the workload placement recommendations using the presets specified by names. Only one preset can be specified. One of the `preset_ids` or `preset_names` parameters are required, but they cannot be set together. style: form explode: false schema: type: array items: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkloadPlacementRecommendation' required: true x-codegen-request-body-name: inputs responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/WorkloadPlacementRecommendationResponse' x-codegen-request-body-name: inputs /api/2.52/workloads/tags: get: tags: - Workloads summary: Pure Storage List Tags description: Displays the list of tags. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Namespaces' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TagGetResponse' "207": description: | Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. content: application/json: schema: $ref: '#/components/schemas/TagGetResponse' delete: tags: - Workloads summary: Pure Storage Delete Tags description: Deletes specified tags. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Keys' - $ref: '#/components/parameters/Namespaces_delete' - $ref: '#/components/parameters/Resource_ids_single' - $ref: '#/components/parameters/Resource_names_single' responses: "200": description: OK content: {} /api/2.52/workloads/tags/batch: put: tags: - Workloads summary: Pure Storage Update Tags description: Updates or creates tags for all specified objects. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Resource_ids_single' - $ref: '#/components/parameters/Resource_names_single' requestBody: description: "A list of tags to be created or, if they already exist, updated." content: application/json: schema: maxItems: 30 minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/TagBatch' required: true x-codegen-request-body-name: tag responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/TagResponse' x-codegen-request-body-name: tag components: schemas: OauthGrantType: type: string description: | The method by which the access token will be obtained. The Pure Storage REST API supports the OAuth 2.0 "token exchange" grant type, which indicates that a token exchange is being performed. Set `grant_type` to `urn:ietf:params:oauth:grant-type:token-exchange`. default: urn:ietf:params:oauth:grant-type:token-exchange OauthSubjectToken: type: string description: |+ An encoded security ID Token representing the identity of the party on behalf of whom the request is being made. The token must be issued by a trusted identity provider which must be either a registered application in Pure1 or an enabled API client on the array. The token must be a JSON Web Token and must contain the following claims: > | JWT claim | Location | API Client Field | Description | Required By | > |-|-|-|-|-| > | kid | Header | key_id | Key ID of the API client that issues the identity token. | FlashArray and FlashBlade only. | > | aud | Payload | id | Client ID of the API client that issues the identity token. | FlashArray and FlashBlade only. | > | sub | Payload | | Login name of the array user for whom the token should be issued. This must be a valid user in the system. | FlashArray and FlashBlade only. | > | iss | Payload | issuer | Application ID for the Pure1 or API client's trusted identity issuer on the array. | All products. | > | iat | Payload | | Timestamp of when the identity token was issued. Measured in milliseconds since the UNIX epoch. | All products. | > | exp | Payload | | Timestamp of when the identity token will expire. Measured in milliseconds since the UNIX epoch. | All products. | Each token must also be signed with the private key that is paired with the API client's public key. OauthSubjectTokenType: type: string description: | An identifier that indicates the type of security token specifed in the `subject_token` parameter. The Pure Storage REST API supports the JSON Web Token (JWT) as the means for requesting the access token. Set `subject_token_type` to `urn:ietf:params:oauth:token-type:jwt`. default: urn:ietf:params:oauth:token-type:jwt Api_versionResponse: type: object properties: version: $ref: '#/components/schemas/_api_versions' LoginPost: type: object properties: password: description: | The user password that is used as an alternative to an api-token. type: string username: description: | The username used to log in as an alternative to an api-token. type: string UsernameResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Username' ActiveDirectoryPost: type: object properties: computer_name: description: | The name of the computer account to be created in the Active Directory domain. If not specified, defaults to the name of the Active Directory configuration. type: string example: FLASHARRAY01 directory_servers: description: | A list of directory servers used for lookups related to user authorization. Servers must be specified in FQDN format. All specified servers must be registered to the domain appropriately in the configured DNS of the array and are only communicated with over the secure LDAP (LDAPS) protocol. If not specified, servers are resolved for the domain in DNS. type: array items: type: string example: ldap.my-corporation.com domain: description: The Active Directory domain to join. type: string example: my-corporation.com join_ou: description: | The distinguished name of the organizational unit in which the computer account should be created when joining the domain. The `DC=...` components of the distinguished name can be optionally omitted. If not specified, defaults to `CN=Computers`. type: string example: "OU=Dev,OU=Sweden,DC=purestorage,DC=com" kerberos_servers: description: | A list of key distribution servers to use for Kerberos protocol. Servers must be specified in FQDN format. All specified servers must be registered to the domain appropriately in the configured DNS of the array. If not specified, servers are resolved for the domain in DNS. type: array items: type: string example: kdc.my-corporation.com password: description: | The login password of the user with privileges to create the computer account in the domain. This is not persisted on the array. type: string example: password sources: description: | List of network interfaces used for egress. For directory services at the array level, this list can be empty. If the list is empty, the system will use VIFs with the "ds" service (or if none, the "management" service) for egress. type: array items: $ref: '#/components/schemas/_reference' tls: description: | TLS mode for communication with domain controllers. Valid values are `required` and `optional`. `required` forces TLS communication with a domain controller. `optional` allows the use of non-TLS communication, TLS will still be preferred, if available. If not specified, defaults to `required`. type: string example: required user: description: | The login name of the user with privileges to create the computer account in the domain. This is not persisted on the array. type: string example: Administrator ActiveDirectoryPatch: type: object properties: sources: description: | List of network interfaces used for egress. For directory services at the array level, the list can be empty. If the list is empty, the system will use VIFs with the "ds" service (or if none, the "management" service) for egress. type: array items: $ref: '#/components/schemas/_reference' tls: description: | TLS mode for communication with domain controllers. Valid values are `required` and `optional`. `required` forces TLS communication with domain controller. `optional` allows the use of non-TLS communication, TLS will still be preferred, if available. If not specified, defaults to `required`. type: string example: "required" ActiveDirectoryGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/ActiveDirectoryResponse' ActiveDirectoryResponse: type: object properties: items: description: | A list of Active Directory computer account configuration objects. type: array items: $ref: '#/components/schemas/ActiveDirectory' TestResultWithResourceAndErrorContextPartialResourceResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: type: array items: $ref: '#/components/schemas/TestResultWithResource' AdminPost: type: object properties: management_access_policies: description: | List of management access policies to associate with the administrator. Policies can be specified by the `name` or `ID` parameter, but they cannot be set together. type: array items: $ref: '#/components/schemas/_referenceWithType' password: description: | Password associated with the account. type: string role: $ref: '#/components/schemas/_adminRole' AdminPatch: allOf: - $ref: '#/components/schemas/Admin' - type: object properties: old_password: description: | The current password. type: string AdminGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/AdminResponse' AdminResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Admin' PolicyAssignmentPost: type: object properties: policies: description: | A list of policies to apply to the resource. One of `id` or `name` is required in each `policy`. type: array items: $ref: '#/components/schemas/PolicyAssignmentPostPolicy' PolicyMemberCleanGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyMemberCleanResponse' - $ref: '#/components/schemas/_errorContextResponse' 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' AdminApiTokenGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/AdminApiTokenResponse' AdminApiTokenResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/AdminApiToken' AdminCacheGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/AdminCacheResponse' AdminCacheResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/AdminCache' AdminSettings: description: Global settings for administrative accounts. type: object properties: 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: 20 example: 10 min_password_length: description: | Minimum password length. If not specified, defaults to 1. type: integer format: int32 example: 1 required_authentication_methods: $ref: '#/components/schemas/_adminSettingsRequiredAuthenticationMethods' single_sign_on_enabled: description: | If `true`, then single sign-on is enabled for the array. type: boolean example: true AdminSettingsGetResponse: allOf: - $ref: '#/components/schemas/AdminSettingsResponse' - type: object properties: 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 AdminSettingsResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/AdminSettings' Alert: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_context' - description: Alert generated by the array when an event occurs. type: object properties: action: description: The action of the alert. type: string readOnly: true actual: description: Actual condition at the time the alert is created. type: string readOnly: true example: 95% category: description: | The category of the alert. Valid values include `array`, `hardware` and `software`. type: string readOnly: true example: array closed: description: The time the alert was closed in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true example: 1578440492342 code: description: The code number of the alert. type: integer format: int64 readOnly: true example: 7 component_name: description: The name of the component that generated the alert. type: string readOnly: true example: vm-tom component_type: description: The type of component that generated the alert. type: string readOnly: true example: storage created: description: The time the alert was created in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true example: 1576275532434 description: description: A short description of the alert. type: string readOnly: true example: boot drive overutilization duration: description: The duration of the alert. type: integer format: int64 readOnly: true expected: description: Expected state or threshold under normal conditions. type: string readOnly: true example: 90% flagged: description: | If set to `true`, the message is flagged. Important messages can can be flagged and listed separately. type: boolean example: true issue: description: Information about the alert cause. type: string readOnly: true example: boot drive overutilization knowledge_base_url: description: The URL of the relevant knowledge base page. type: string readOnly: true example: https://support.purestorage.com/?cid=Alert_0007 notified: description: | The time the most recent alert notification was sent in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true example: 1578440491109 severity: description: | The severity level of the alert. Valid values include `info`, `warning`, `critical`, and `hidden`. type: string readOnly: true example: critical state: description: | The current state of the alert. Valid values include `open`, `closing`, and `closed`. type: string readOnly: true example: open summary: description: A summary of the alert. type: string readOnly: true example: boot drive overutilization updated: description: The time the alert was last updated in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true example: 1578440491109 AlertGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/AlertResponse' - $ref: '#/components/schemas/_errorContextResponse' AlertResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Alert' AlertEventGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/AlertEventResponse' - $ref: '#/components/schemas/_errorContextResponse' AlertRules: allOf: - $ref: '#/components/schemas/_context' - description: | Custom rules for alerts. type: object properties: code: description: | The alert code that the rule applies to. Available alert codes for customization can be found in the alert rules catalog. type: integer format: int32 readOnly: true example: 25 parameter: description: | The parameter of the custom alert rule to modify. Values include `info` and `warning`. Available parameter values can be found in the alert rules catalog. type: string readOnly: true example: info value: description: | The value to use for the custom alert rule. Valid values for an alert code and parameter combination can be found in the alert rules catalog. type: string example: "85" AlertRulesGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/AlertRulesResponse' - $ref: '#/components/schemas/_errorContextResponse' AlertRulesResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/AlertRules' AlertRulesCatalogGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/AlertRulesCatalogResponse' - $ref: '#/components/schemas/_errorContextResponse' AlertWatcherPost: type: object properties: enabled: description: | If set to `true`, email notifications will be sent to this watcher for alerts. If set to `false`, email notifications are disabled. If not specified, defaults to `true`. type: boolean AlertWatcherPatch: type: object properties: enabled: description: | If set to `true`, email notifications will be sent to this watcher for alerts. If set to `false`, email notifications are disabled. type: boolean AlertWatcherGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/AlertWatcherResponse' AlertWatcherResponse: type: object properties: items: description: A list of alert watcher objects. type: array items: $ref: '#/components/schemas/AlertWatcher' TestResultWithResourceGetResponse: allOf: - $ref: '#/components/schemas/TotalItemCountResponse' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: type: array items: $ref: '#/components/schemas/TestResultWithResource' ApiClientPost: type: object properties: access_policies: description: | The access policies allowed for ID Tokens issued by this API client. The bearer of an access token will be authorized to perform actions within the intersection of these policies and those of the array user specified as the JWT `sub` (subject) claim. type: array items: $ref: '#/components/schemas/_referenceWithType' access_token_ttl_in_ms: description: | The TTL (Time To Live) length of time for the exchanged access token. Measured in milliseconds. If not specified, defaults to `86400000`. type: integer format: int64 example: 15000 x-minimum: 1000 x-maximum: 86400000 issuer: description: | The name of the identity provider that will be issuing ID Tokens for this API client. The `iss` claim in the JWT issued must match this string. If not specified, defaults to the API client name. type: string example: https://purestorage.idp.okta.com max_role: description: | Deprecated. The maximum Admin Access Policy (previously 'role') allowed for ID Tokens issued by this API client. The bearer of an access token will be authorized to perform actions within the intersection of this policy and that of the array user specified as the JWT `sub` (subject) claim. `max_role` is deprecated in favor of `access_policies`, but remains for backwards compatibility. If `max_role` is the name of a valid legacy role, it will be interpreted as the corresponding access policy of the same name. Otherwise, it's invalid. type: string example: storage_admin public_key: description: | The API client's PEM formatted (Base64 encoded) RSA public key. Include the `-----BEGIN PUBLIC KEY-----` and `-----END PUBLIC KEY-----` lines. type: string example: | -----BEGIN PUBLIC KEY----- MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEArSe6chh1JzME9svOKjU0 eKTm8S23Ok3Vr2bWuPri/YHfLrlnRwWoCt+st0/BebKSJ+fQUWOaLlqpZQKpI8oR gJ9sWmwGibVG8cTuz7XMkskx9bsm/bjIenuB4W+s3g0BCsi9930mfdKgJgFzY69O nLh7d7hAFcmhSJa945PryQZpvJ/U4Ue5F4d+WXgEJ0SoSRaZ6bbeMPhcbMHTzTum 2ZrPBkK5cqPYitaso6BXeAlqNQPw4Kbu4Ugm0CTogrtImkwoonWDDP34XMOq+u7q sNTbJSvDKMTM1RPPrTWCaLiuZkdLVEVesZ9/8+XUMIgBTElwQJDCAQer03MJzqRr 1eCZGgLfDuYqwMG2MFaAX7kgqBwwyqRTd6MxaQxt2nkdfwiXSY71llzEQ23g3T+1 64zjwAL5f+dtu8PkGF7IdU2T8P2Qk9bG9pckwZHWYkBK77BAk5jbmSzsKGZgRb2R 1E+TWDKIaveFhQp251j/C5wkZwMXgjOzN+BOPo+OiLBGUl+jRybWA9f7Vq1MEdf6 SEdLiqYrXcZERkYBMieLXAfdtaztAIb96cUu+OKMSLDk+D0GHkUfm7lEbDK3ew1+ D6z+BnxDyH6oqZzz4lS2kPLBLsc+6pdTGuKLf0S9YuLiqJe659AdwU8+X/3KtwNd FVJSaxdFbWx0nj3hJqFkIO8CAwEAAQ== -----END PUBLIC KEY----- ApiClientPatch: type: object properties: enabled: description: | Returns a value of `true` if the API client is permitted to exchange ID tokens for access tokens. API clients are disabled by default. type: boolean example: true ApiClientGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/ApiClientResponse' ApiClientResponse: type: object properties: items: description: | Returns a list of all items after filtering. The values are displayed for each name, where meaningful. type: array items: $ref: '#/components/schemas/ApiClient' App: allOf: - $ref: '#/components/schemas/_builtInResourceNoId' - description: | An app that is installed on Purity to extend its functionality. The app is an add-on service that is integrated into the system to extend array functionality. type: object properties: description: description: | A description of the app. type: string readOnly: true example: Snapshot offload to NFS or Amazon S3 details: description: | Details of the status of the app. type: string readOnly: true example: Insufficient resources to operate enabled: description: | If set to `true`, the app is enabled. By default, apps are disabled. type: boolean status: description: | The status of the app. Values include `healthy` and `unhealthy`. For cluster apps, this represents the aggregate status of the app. The aggregate status is only `healthy` if all nodes are `healthy`; otherwise, it is `unhealthy`. type: string readOnly: true example: healthy version: description: | The app version. For cluster apps, this represents the node version if all nodes are of the same version. If the node versions differ, a value of `null` is returned. type: string readOnly: true example: 1.0.0 vnc_enabled: description: | If set to `true`, VNC access is enabled. By default, VNC access is disabled. type: boolean AppGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/AppResponse' AppResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/App' AppNodeGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/AppNodeResponse' Arrays: allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_context' - type: object properties: _as_of: description: | The time in milliseconds since UNIX epoch. type: integer format: int64 readOnly: true example: 1684403432765 banner: type: string example: Restricted area. Authorized personnel only. capacity: description: | The usable capacity in bytes. If the user does not have sufficient access, this field will return `null`. type: integer format: int64 readOnly: true example: 10995116277760 console_lock_enabled: description: | If `true`, console lock is enabled for the array. If the user does not have sufficient access, this field will return `null`. type: boolean example: false encryption: title: ArrayEncryption allOf: - $ref: '#/components/schemas/ArrayEncryption' eradication_config: $ref: '#/components/schemas/Eradication_config' idle_timeout: description: | The idle timeout in milliseconds. Valid values include `0` and any multiple of `60000` in the range of `300000` and `10800000`. Any other values are rounded down to the nearest multiple of `60000`. type: integer format: int32 example: 300000 network_access_policy: description: | The network access policy for the array. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' ntp_servers: description: | NTP Servers. If the user does not have sufficient access, this field will return `null`. type: array items: type: string example: time.acme.com ntp_symmetric_key: description: | The text of ntp symmetric authentication key. Supported formats include a hex-encoded string no longer than 64 characters, or an ASCII string no longer than 20 characters, excluding "#". Any configured key will be masked as "****" on return. If the user does not have sufficient access, this field will return `null`. type: string os: description: | Specifies the operating system. Valid values are `Purity`, `Purity//FA`, and `Purity//FB`. type: string readOnly: true example: Purity//FA parity: description: | A representation of data redundancy on the array. Data redundancy is rebuilt automatically by the system whenever parity is less than `1.0`. If the user does not have sufficient access, this field will return `null`. type: number format: float readOnly: true example: 0.99 scsi_timeout: description: | The SCSI timeout. If not specified, defaults to `60s`. If the user does not have sufficient access, this field will return `null`. type: integer format: int32 example: 60000 space: title: Space allOf: - $ref: '#/components/schemas/Space' time_zone: description: | The time zone of the array. type: string readOnly: true example: America/Los_Angeles version: type: string readOnly: true example: 5.0.0 ArrayGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/ArrayResponse' - $ref: '#/components/schemas/_errorContextResponse' ArrayResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Arrays' CacheGetResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Cache' description: Displays DIMM Cache status. CloudConfigPatch: type: object properties: automatic_capacity_upgrade: description: The requested configuration of the automatic capacity upgrade. title: CloudConfigAutomaticCapacityUpgradePatch allOf: - $ref: '#/components/schemas/CloudConfigAutomaticCapacityUpgradePatch' model: description: The requested model configuration of the CBS array. title: CloudConfigModelPatch allOf: - $ref: '#/components/schemas/CloudConfigModelPatch' CloudConfigGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - type: object properties: items: type: array items: $ref: '#/components/schemas/CloudConfig' CloudConfigPatchResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/CloudConfig' CloudConfigSupportedConfigsGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - type: object properties: items: type: array items: $ref: '#/components/schemas/CloudConfigSupported' CloudCapacityStatus: allOf: - $ref: '#/components/schemas/_builtIn' - type: object properties: current_capacity: description: | The current raw capacity of the CBS array in bytes. type: integer format: int64 readOnly: true example: 10995116277760 details: description: | Details about the capacity update. This field can contain error details when status is `failed` or progress information when status is `expanding`. For status `idle` the value is null. type: string readOnly: true requested_capacity: description: | The requested raw capacity of the CBS array in bytes. When the capacity update process finishes, it should be the same as `current_capacity`. type: integer format: int64 example: 10995116277760 status: description: | The status of the capacity update process. Can be one of `idle`, `failed`, `expanding`. type: string readOnly: true example: idle CloudCapacityGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/CloudCapacityPatchResponse' CloudCapacityPatchResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/CloudCapacityStatus' CloudCapacityStepsGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - type: object properties: items: type: array items: $ref: '#/components/schemas/CloudCapacityStep' CloudProviderTagGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/CloudProviderTagResponse' CloudProviderTag: type: object properties: details: description: | Details about the status of the tag if not healthy. type: string readOnly: true example: partially applied key: description: | Key of the tag. Supports UTF-8 Unicode characters. Please refer to the offical document from cloud providers for limitations. type: string example: environment value: description: | Value of the tag. Supports UTF-8 Unicode characters. Please refer to the offical document from cloud providers for limitations. type: string example: staging CloudProviderTagResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/CloudProviderTag' ArrayErasurePatch: type: object properties: image_source: description: | Source of the ISO image to download. Valid values include `auto` and URLs. `auto` means download the image from Pure1 cloud, and a URL means download the image from the specified URL. Default value is `auto`. type: string example: auto image_version: description: | Version of the image to download. `image_version` is optional, and the default value is the current running Purity version. If `image_source` is `auto`, the image with the specified version will be downloaded from Pure1 cloud. If `image_source` is a URL, `image_version` will be used to compare to the downloaded image version for the purpose of validation. type: string example: 6.6.6 ArrayErasureGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/ArrayErasureResponse' ArrayErasureResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/ArrayErasure' Eula: type: object properties: agreement: description: The End User Agreement text. type: string readOnly: true signature: $ref: '#/components/schemas/_eula_signature' EulaGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/EulaResponse' EulaResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Eula' ArrayFactoryResetTokenGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/ArrayFactoryResetTokenResponse' ArrayFactoryResetTokenResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/ArrayFactoryResetToken' TestResultGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/TestResultResponse' ArrayPerformanceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - type: object properties: items: type: array items: $ref: '#/components/schemas/ArrayPerformance' ArrayPerformanceByLinkGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/ArrayPerformanceByLinkResponse' ArraySpaceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: type: array items: $ref: '#/components/schemas/ArraySpace' TagGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/TagResponse' - $ref: '#/components/schemas/_errorContextResponse' NonCopyableTag: type: object properties: key: description: | Key of the tag. Supports up to 64 Unicode characters. type: string example: environment namespace: description: | Optional namespace of the tag. Namespace identifies the category of the tag. Omitting the namespace defaults to the namespace `default`. The `pure*` namespaces are reserved for plugins and integration partners. It is recommended that customers avoid using reserved namespaces. type: string example: default resource: $ref: '#/components/schemas/_fixedReference' value: description: | Value of the tag. Supports up to 256 Unicode characters. type: string example: staging TagResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Tag' ArrayConnectionPost: type: object properties: connection_key: description: | The connection key of the target array. type: string example: 6207d123-d123-0b5c-5fa1-95fabc5c7123 encryption: description: | If `encrypted`, all traffic over this array connection will be encrypted. If `unencrypted`, all traffic over this array connection will be unencrypted. Defaults to `unencrypted`. type: string example: encrypted management_address: description: | Management IP address of the target array. type: string example: 10.202.101.78 replication_addresses: description: | IP addresses and FQDNs of the target arrays. Configurable only when `replication_transport` is set to `ip`. If not configured, will be set to all the replication addresses available on the target array at the time of the POST. type: array items: type: string example: 10.202.101.70 replication_transport: description: | The protocol used to transport data between the local array and the remote array. Valid values are `ip` and `fc`. The default is `ip`. type: string example: ip type: description: | The type of replication. Valid values are `async-replication` and `sync-replication`. type: string example: async-replication ArrayConnectionPatch: allOf: - $ref: '#/components/schemas/_throttle_deprecated' - type: object properties: connection_key: description: | The connection key of the target array. It is required when `encryption` is changed, or when `type` is changed from `async-replication` to `sync-replication`. type: string example: 6207d123-d123-0b5c-5fa1-95fabc5c7123 encryption: description: | If `encrypted`, encryption will be enabled for all traffic over this array connection. If `unencrypted`, encryption will be disabled for all traffic over this array connection. `connection_key` must be specified when encryption is changed. If not specified, the current encryption option for the array connection will remain unchanged. type: string example: encrypted management_address: description: | Management IP address of the target array. type: string example: 10.202.101.78 replication_addresses: description: | IP addresses and FQDNs of the target arrays. Configurable only when `replication_transport` is set to `ip`. type: array items: type: string example: 10.202.101.70 throttle: $ref: '#/components/schemas/_throttle' type: description: | The type of replication. Valid values are `async-replication` and `sync-replication`. type: string ArrayConnectionGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/ArrayConnectionResponse' - $ref: '#/components/schemas/_errorContextResponse' ArrayConnectionResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/ArrayConnection' ArrayConnectionKeyGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - type: object properties: items: type: array items: $ref: '#/components/schemas/ArrayConnectionKey' ArrayConnectionPathGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/ArrayConnectionPathResponse' - $ref: '#/components/schemas/_errorContextResponse' AuditGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/AuditResponse' - $ref: '#/components/schemas/_errorContextResponse' _bucketPostBase: type: object properties: account: description: The name of the account for bucket creation. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' _bucketPatchBase: type: object properties: destroyed: description: | If set to `true`, the bucket is destroyed. If set to `false`, the bucket is recovered. type: boolean example: true versioning: description: | The versioning state for objects within the bucket. Valid values are `enabled` and `suspended`. type: string example: enabled BucketGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - $ref: '#/components/schemas/BucketResponse' - type: object properties: total: description: | If `total_only` query param is `true`, then this field will be a total of all records after filtering and no items will be returned. If `total_only` is `false`, then it will be a total of all records on this page. type: object items: $ref: '#/components/schemas/Bucket' BucketResponse: type: object properties: items: description: A list of bucket objects. type: array items: $ref: '#/components/schemas/Bucket' ResourceBucketSpaceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: | Displays a list of all items after filtering. If applicable, the values are displayed for each name. If `total_only=true`, the `items` list will be empty. type: array items: $ref: '#/components/schemas/ResourceBucketSpace' total: description: | The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. If applicable, the values are displayed for each field. type: array items: $ref: '#/components/schemas/ResourceBucketSpace' BucketPerformanceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - type: object properties: items: description: | Performance data. If `total_only=true`, the `items` list will be empty. type: array items: $ref: '#/components/schemas/BucketPerformance' total: description: | The aggregate value of all items after filtering. When it makes sense, the average value is displayed instead. The values are displayed for each field if meaningful. type: array items: $ref: '#/components/schemas/BucketPerformance' CertificatePost: allOf: - $ref: '#/components/schemas/_certificateBase' - type: object properties: days: description: | The number of days that the self-signed certificate is valid. Defaults to 3650. This field can only be specified when creating a new self-signed certificate. type: integer format: int32 example: 3650 key: description: | The text of the private key. This field can only be specified when importing a certificate and key pair. type: string passphrase: description: | The passphrase used to encrypt `key`. This field can only be specified when importing a certificate and key pair. type: string CertificateGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/CertificateResponse' CertificateResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Certificate' CertificateCertificateGroupGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/CertificateCertificateGroupResponse' CertificateCertificateGroupResponse: type: object properties: items: description: | A list of certificate and certificate group relationships. type: array items: $ref: '#/components/schemas/_memberWithType' CertificateUseGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - type: object properties: items: description: A list of certificate use objects. type: array items: $ref: '#/components/schemas/CertificateUse' CertificateGroupGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/CertificateGroupResponse' CertificateGroupResponse: type: object properties: items: description: | A list of certificate group objects. type: array items: $ref: '#/components/schemas/CertificateGroup' CertificateGroupCertificateGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/CertificateGroupCertificateResponse' CertificateGroupCertificateResponse: type: object properties: items: description: | A list of certificate and certificate group relationships. type: array items: $ref: '#/components/schemas/_memberWithType' CertificateGroupUseGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - type: object properties: items: description: A list of certificate group use objects. type: array items: $ref: '#/components/schemas/CertificateGroupUse' CertificateSigningRequestPost: description: SSL Certificate managed by Purity//FA. type: object properties: certificate: $ref: '#/components/schemas/_referenceNoId' common_name: description: The common name field listed in the certificate. type: string example: Pure Storage Inc. country: description: Two-letter country (ISO) code listed in the certificate. type: string example: CA email: description: The email field listed in the certificate. type: string example: tcrisp@veridiandynamics.com locality: description: The locality field listed in the certificate. type: string example: Toronto organization: description: The organization field listed in the certificate. type: string example: Veridian Dynamics organizational_unit: description: The organizational unit field listed in the certificate. type: string example: Research & Development state: description: The state/province field listed in the certificate. type: string example: Ontario subject_alternative_names: description: | The alternative names that are secured by this certificate. Alternative names include IP addresses, DNS names, or URIs. type: array items: type: string example: otherdnsname.mydomain.com CertificateSigningRequestResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/CertificateSigningRequest' ConnectionPost: type: object properties: lun: description: | The logical unit number (LUN) by which the specified hosts are to address the specified volume. If the LUN is not specified, the system automatically assigns a LUN to the connection. To automatically assign a LUN to a private connection, the system starts at LUN `1` and counts up to the maximum LUN `4095`, assigning the first available LUN to the connection. For shared connections, the system starts at LUN `254` and counts down to the minimum LUN `1`, assigning the first available LUN to the connection. If all LUNs in the `[1...254]` range are taken, the system starts at LUN `255` and counts up to the maximum LUN `4095`, assigning the first available LUN to the connection. Should not be used together with an NVMe host or host group. type: integer format: int32 minimum: 1 maximum: 4095 example: 7 protocol_endpoint: description: | A protocol endpoint (also known as a conglomerate volume) which acts as a proxy through which virtual volumes are created and then connected to VMware ESXi hosts or host groups. The protocol endpoint itself does not serve I/Os; instead, its job is to form connections between FlashArray volumes and ESXi hosts and host groups. title: Reference allOf: - $ref: '#/components/schemas/_reference' ConnectionGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/ConnectionResponse' - $ref: '#/components/schemas/_errorContextResponse' ConnectionResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Connection' ContainerDefaultProtection: allOf: - $ref: '#/components/schemas/_context' - type: object properties: default_protections: description: | The default protection that is applied to newly created volumes or managed directories. Pgroups and policies in the list will protect volumes and managed directories, respectively. Volumes and managed directories can opt out of the default protection at creation. The pod's `default_protections` defaults to the array's `default_protections` at pod creation. To clear the list of default protections, set to an empty list `[]`. type: array items: $ref: '#/components/schemas/_default_protection_reference' id: description: | The id of an administrative domain, a data container, and a namespace for volumes and protection groups. Values can be `pod id` or `null`. `Null` represents the local array id. type: string readOnly: true name: description: | The name of an administrative domain, a data container, and a namespace for volumes and protection groups. Values can be `pod name` or `null`. `null` represents the local array name. type: string readOnly: true type: description: | The type of an administrative domain, a data container, and a namespace for volumes and protection groups. Values can be `pod` or `null`. `null` represents the local array type. type: string readOnly: true ContainerDefaultProtectionGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/ContainerDefaultProtectionResponse' - $ref: '#/components/schemas/_errorContextResponse' ContainerDefaultProtectionResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/ContainerDefaultProtection' ControllerGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - type: object properties: items: type: array items: $ref: '#/components/schemas/Controller' DirectoryPost: type: object properties: directory_name: description: | The managed directory name without the file system name prefix. A full managed directory name is constructed in the form of `FILE_SYSTEM:DIR` where `FILE_SYSTEM` is the file system name and `DIR` is the value of this field. `directory_name` is required if `file_system_names` or `file_system_ids` is set. `directory_name` cannot be set if `names` is set. type: string path: description: | Path of the managed directory in the file system. type: string source: description: | A managed directory snapshot to be copied in order to create a new managed directory. If not specified, the newly created managed directory will be empty. title: Reference allOf: - $ref: '#/components/schemas/_reference' workload: $ref: '#/components/schemas/_workloadConfigurationReferencePost' DirectoryPatch: allOf: - $ref: '#/components/schemas/_newName' - type: object properties: directory_name: description: | The managed directory name without the file system name prefix. A full managed directory name is constructed in the form of `FILE_SYSTEM:DIR` where `FILE_SYSTEM` is the file system name and `DIR` is the value of this field. type: string workload: $ref: '#/components/schemas/_workloadConfigurationReferencePatch' DirectoryGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/DirectoryResponse' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: total: description: | The aggregate value of all items after filtering. When applicable, the average value is displayed instead. If applicable, the values are displayed for each field. type: array items: $ref: '#/components/schemas/Directory' DirectoryResponse: 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/Directory' DirectoriesGroupsGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/DirectoriesGroupsResponse' - $ref: '#/components/schemas/_errorContextResponse' DirectoryLockNlmReclamationResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/DirectoryLockNlmReclamation' DirectoryPerformanceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: | Performance data. If `total_only=true`, the `items` list will be empty. type: array items: $ref: '#/components/schemas/DirectoryPerformance' total: description: | The aggregate value of all items after filtering. When it makes sense, the average value is displayed instead. The values are displayed for each field if meaningful. type: array items: $ref: '#/components/schemas/DirectoryPerformance' PolicyMemberGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyMemberResponse' - $ref: '#/components/schemas/_errorContextResponse' DirectoryPolicyPost: type: object properties: policies: description: | A list of policies to apply to the resource. The `id` or `name` field in each `policy` parameter is required, but they cannot be set together. type: array items: $ref: '#/components/schemas/_directorypolicypostPolicies' 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' DirectoryPolicyExportPost: type: object properties: policies: description: | A list of export policies to apply to the directory. The `id` and `name` fields in each `policy` parameter are required, but cannot be set together. type: array items: $ref: '#/components/schemas/_directorypolicyexportpostPolicies' PolicyMemberExportGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyMemberExportResponse' - $ref: '#/components/schemas/_errorContextResponse' 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' ResourceDirectorySpaceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: | Displays a list of all items after filtering. If applicable, the values are displayed for each name. If `total_only=true`, the `items` list will be empty. type: array items: $ref: '#/components/schemas/ResourceDirectorySpace' total: description: | The aggregate value of all items after filtering. Where meaningful, the average value is displayed instead. If applicable, the values are displayed for each field. type: array items: $ref: '#/components/schemas/ResourceDirectorySpace' DirectoriesUsersGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/DirectoriesUsersResponse' - $ref: '#/components/schemas/_errorContextResponse' DirectoryExportPost: type: object properties: export_enabled: description: | Indicates whether the export is enabled. 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. Export names must be unique within the same protocol and server. type: string server: description: | Server to which the directory export is attached to. title: Reference allOf: - $ref: '#/components/schemas/_reference' DirectoryExportPatch: 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 new name of the export. Export names must be unique within the same protocol. type: string DirectoryExportGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/DirectoryExportResponse' - $ref: '#/components/schemas/_errorContextResponse' DirectoryExportResponse: 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/DirectoryExport' DirectoryGroupQuotasGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/DirectoryGroupQuotasResponse' - $ref: '#/components/schemas/_errorContextResponse' DirectoryQuotasGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/DirectoryQuotasResponse' - $ref: '#/components/schemas/_errorContextResponse' DirectoryServicePost: allOf: - $ref: '#/components/schemas/DirectoryServiceCommon' - type: object properties: sources: description: | List of network interfaces used for egress. For directory services at the array level, this list can be empty. If the list is empty, the system will use VIFs with the "ds" service (or if none, the "management" service) for egress. type: array items: $ref: '#/components/schemas/_reference' DirectoryServicePatch: allOf: - $ref: '#/components/schemas/_newFqname' - $ref: '#/components/schemas/DirectoryServiceCommon' - description: type: object properties: ca_certificate: description: | The certificate of the Certificate Authority (CA) that signed the directory servers' certificate(s), which is used to validate the authenticity of the configured servers. Deprecated, please use ca_certificate_ref instead. Setting this field will result in ca_certificate_ref being updated to _legacy_ds_ca_certificate_. type: string ca_certificate_ref: description: | Reference (ID, name, and resource type) of the Certificate Authority (CA) that signed the certificates of the directory servers, which is used to validate the authenticity of the configured servers. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' check_peer: description: | Determines whether or not server authenticity is enforced when a certificate is provided. type: boolean example: false management: $ref: '#/components/schemas/_directoryServiceManagement' sources: description: | List of network interfaces used for egress. For directory services at the array level, this list can be empty. If the list is empty, the system will use VIFs with the "ds" service (or if none, the "management" service) for egress. type: array items: $ref: '#/components/schemas/_reference' DirectoryServiceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/DirectoryServiceResponse' - $ref: '#/components/schemas/_errorContextResponse' DirectoryServiceResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/DirectoryService' DirectoryServiceRolePost: type: object properties: group: description: | Group name that contains users with the abilities granted by the associated policies. type: string example: groupOfUsers group_base: description: | Specifies where the configured group is located in the directory tree. type: string example: "OU=PureGroups,OU=SANManagers" management_access_policies: description: | List of management access policies to associate with the group. type: array items: $ref: '#/components/schemas/_referenceWithType' role: description: | This field has been deprecated. Predecessor to management access policies. Can be set to the premade policy of the same name. Cannot be set with management_access_policies. title: ReferenceNoId allOf: - $ref: '#/components/schemas/_referenceNoId' DirectoryServiceRole: allOf: - $ref: '#/components/schemas/_fixedNameResourceNoId' - $ref: '#/components/schemas/_context' - type: object properties: group: description: | Group name that contains users with the abilities granted by the associated policies. type: string example: groupOfUsers group_base: description: | Specifies where the configured group is located in the directory tree. type: string example: "OU=PureGroups,OU=SANManagers" management_access_policies: description: | List of management access policies associated with the group. type: array readOnly: true items: $ref: '#/components/schemas/_fixedReferenceWithType' role: description: | This field has been deprecated. Predecessor to management access policies. title: ReferenceNoId allOf: - $ref: '#/components/schemas/_referenceNoId' DirectoryServiceRoleGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/DirectoryServiceRoleResponse' - $ref: '#/components/schemas/_errorContextResponse' DirectoryServiceRoleResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/DirectoryServiceRole' TestGetResultWithResourceErrorContextMultiserverAwareResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: type: array items: $ref: '#/components/schemas/TestResultWithNoIdResourceMultiserverAware' TestPatchResultWithResourceMultiserverAwareResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/TestResultWithNoIdResourceMultiserverAware' LocalDirectoryServicePost: description: | Configuration information for the local directory service. type: object properties: domain: description: | The name of the domain stored in this local directory service. All users and groups are going to be presented as being part of this domain name. When not set, it defaults to name of the Local Directory Service. For example, for object "mydomain" the domain name will be "mydomain" where domain name does not have any unique constraint (it can be the same for different local directory services within an array. type: string example: domain LocalDirectoryService: allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_serverReference' - $ref: '#/components/schemas/LocalDirectoryServicePost' LocalDirectoryServiceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/LocalDirectoryServiceResponse' LocalDirectoryServiceResponse: 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/LocalDirectoryService' LocalGroupPost: type: object properties: email: description: | Optional field to set the email address of the local group. type: string gid: description: | Optional field to set the GID of the local group. type: integer format: int32 LocalGroupPatch: allOf: - $ref: '#/components/schemas/_context' - type: object properties: built_in: description: | Returns a value of `true` if the local group is built in. Returns a value of `false` if the group has been created manually. type: boolean readOnly: true email: description: | The email address of the local group. type: string gid: description: | The POSIX user ID of this object (group ID). type: integer format: int32 name: description: | The local group name. type: string sid: description: | The SID (Security Identifier) of the local group. type: string readOnly: true LocalGroupGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/LocalGroupResponse' - $ref: '#/components/schemas/_errorContextResponse' LocalGroupResponse: 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/LocalGroup' LocalGroupMembershipPost: type: object properties: members: description: | A list of resources to be a member of the group. type: array items: $ref: '#/components/schemas/_localgroupmembershippostMembers' LocalMembershipGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/LocalMembershipResponse' - $ref: '#/components/schemas/_errorContextResponse' LocalMembershipResponse: 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/LocalMember' LocalUserPost: type: object properties: email: description: Optional field to set the email of the local user. type: string enabled: description: | If this field is `false`, the local user will be disabled on creation. Otherwise, the local user will be enabled and functional. type: boolean password: description: | The password of the local user. This field is only required if the `enabled` field is `true`. type: string primary_group: description: | Local group that would be assigned as the primary group of the local user. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' uid: description: Optional field to set the UID of the local user. type: integer format: int32 LocalUserPatch: type: object properties: email: description: Optional field to set the email of the local user. type: string enabled: description: | If this field is `false`, the local user will be disabled on creation. Otherwise, the local user will be enabled and functional from the beginning. type: boolean name: description: | The local user name. type: string password: description: | The password of the local user. This field is only required if the `enabled` field is true. type: string primary_group: description: | Local group that would be assigned as the primary group of the local user. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' uid: description: Optional field to set the UID of the local user. type: integer format: int32 LocalUserGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/LocalUserResponse' - $ref: '#/components/schemas/_errorContextResponse' LocalUserResponse: 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/LocalUser' LocalUserMembershipPost: type: object properties: groups: description: | A list of groups of which the user is a member. type: array items: $ref: '#/components/schemas/_localusermembershippostGroups' is_primary: description: Determines whether memberships are primary group memberships or not. type: boolean default: false DirectorySnapshotPost: type: object properties: client_name: description: | The client name portion of the client visible snapshot 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 value of this field, and `SUFFIX` is the suffix. The client visible snapshot name is `CLIENT_NAME.SUFFIX`. type: string keep_for: description: | The time to keep the snapshots for, in milliseconds. type: integer format: int64 suffix: description: | The suffix portion of the client visible snapshot 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 client name, and `SUFFIX` is the value of this field. The client visible snapshot name is `CLIENT_NAME.SUFFIX`. If not specified, defaults to a monotonically increasing number generated by the system. type: string DirectorySnapshotPatch: allOf: - $ref: '#/components/schemas/_destroyedPatchPost' - type: object properties: client_name: description: | The client name portion of the client-visible snapshot 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 value of this field, and `SUFFIX` is the suffix. The client-visible snapshot name is `CLIENT_NAME.SUFFIX`. The client name of a directory snapshot managed by a snapshot policy is not changeable. If the `name` and `client_name` parameters are both specified, `client_name` must match the client name portion of `name`. type: string keep_for: description: | The amount of time to keep the snapshots, in milliseconds. Can only be set on snapshots that are not managed by any snapshot policy. Set to `""` to clear the keep_for value. type: integer format: int64 name: description: | The new name of a directory snapshot. The name of a directory snapshot managed by a snapshot policy is not changeable. type: string policy: description: | The snapshot policy that manages this snapshot. Set to `name` or `id` to `""` to clear the policy. title: Reference allOf: - $ref: '#/components/schemas/_reference' suffix: description: | The suffix portion of the client-visible snapshot 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 client name, and `SUFFIX` is the value of this field. The client-visible snapshot name is `CLIENT_NAME.SUFFIX`. The suffix of a directory snapshot managed by a snapshot policy is not changeable. If the `name` and `suffix` parameters are both specified, `suffix` must match the suffix portion of `name`. type: string DirectorySnapshotGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/DirectorySnapshotResponse' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: total: description: | The aggregate value of all items after filtering. When applicable, the average value is displayed instead. If applicable, the values are displayed for each field. type: array items: $ref: '#/components/schemas/DirectorySnapshot' DirectorySnapshotResponse: 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/DirectorySnapshot' DirectoryUserQuotasGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/DirectoryUserQuotasResponse' - $ref: '#/components/schemas/_errorContextResponse' DnsPost: description: | Configuration information for the domain name servers. type: object properties: ca_certificate: description: | A reference to the `certificate` to use for validating nameservers with HTTPS connections. This property is mutually exclusive with `ca_certificate_group` property and may only be configured when nameservers begin with HTTPS. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' ca_certificate_group: description: | A reference to the `certificate group` to use for validating nameservers with HTTPS connections. This property is mutually exclusive with `ca_certificate` property and may only be configured when nameservers begin with HTTPS. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' domain: description: | The domain suffix to be appended by the appliance when performing DNS lookups. type: string example: example.com nameservers: description: | The list of DNS servers either in the form of IP addresses or HTTPS endpoints. Domain names in HTTPS endpoints are not supported. IP addresses must be used instead. If nameservers begin with `https://`, then DNS queries will be performed over HTTPS. Otherwise, unencrypted DNS queries will be performed. Using a combination of nameservers that begin with `https://` and that do not begin with `https://` is not supported. If servers are specified with `https://` one of `ca_certificate` and `ca_certificate_group` parameters must be set. type: array items: type: string example: - 192.168.0.125 services: description: | The list of services utilizing the DNS configuration. type: array items: type: string description: | Valid values include `management` and `file`. source: description: | The network interface used for communication with the DNS server. title: ReferenceNoId allOf: - $ref: '#/components/schemas/_referenceNoId' DnsPatch: allOf: - $ref: '#/components/schemas/_newName' - $ref: '#/components/schemas/DnsPost' DnsGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/DnsResponse' - $ref: '#/components/schemas/_errorContextResponse' DnsResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Dns' DriveGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/DriveResponse' DriveResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Drive' FileSystemPost: type: object properties: workload: $ref: '#/components/schemas/_workloadConfigurationReferencePost' FileSystemPatch: allOf: - $ref: '#/components/schemas/_destroyedPatchPost' - $ref: '#/components/schemas/_newName' - type: object properties: pod: description: The pod to move existing file systems into. title: Reference allOf: - $ref: '#/components/schemas/_reference' workload: $ref: '#/components/schemas/_workloadConfigurationReferencePatch' FileSystemGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/FileSystemResponse' - $ref: '#/components/schemas/_errorContextResponse' FileSystemResponse: 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/FileSystem' FilePost: type: object properties: source: description: | The source information of a file copy. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' source_path: description: | The source file path relative to the source directory. type: string FleetPatch: allOf: - $ref: '#/components/schemas/_newName' - type: object FleetGetResponse: allOf: - $ref: '#/components/schemas/FleetResponse' - $ref: '#/components/schemas/PageInfo' FleetResponse: 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/Fleet' FleetKeyGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/FleetKeyResponse' FleetKeyResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/FleetKey' FleetMemberPost: type: object properties: members: description: | Info about the members being added to fleet. type: array items: $ref: '#/components/schemas/_fleetmemberpostMembers' FleetMemberGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/FleetMemberResponse' FleetMemberResponse: 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/FleetMember' HardwarePatch: allOf: - $ref: '#/components/schemas/_builtInResourceNoId' - type: object properties: identify_enabled: description: | State of an LED used to visually identify the component. type: boolean example: true index: description: | Number that identifies the relative position of a hardware component within the array. type: integer format: int32 example: 1 HardwareGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/HardwareResponse' HardwareResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Hardware' HostGroupPost: type: object properties: qos: description: Sets QoS limits. title: ContainerQosCeilings allOf: - $ref: '#/components/schemas/_containerQosCeilings' tags: description: | The list of tags to be upserted with the object. type: array items: $ref: '#/components/schemas/NonCopyableTag' HostGroupPatch: allOf: - $ref: '#/components/schemas/_newName' - type: object properties: qos: description: Sets QoS limits. title: ContainerQosCeilings_patch allOf: - $ref: '#/components/schemas/_containerQosCeilings_patch' HostGroupGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/HostGroupResponse' - $ref: '#/components/schemas/_errorContextResponse' HostGroupResponse: 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/HostGroup' MemberNoIdAllGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/MemberNoIdAllResponse' - $ref: '#/components/schemas/_errorContextResponse' MemberNoIdAllResponse: type: object properties: items: description: | Displays a list of all items after filtering. The values are displayed for each name where meaningful. type: array items: $ref: '#/components/schemas/MemberNoIdAll' ResourcePerformanceNoIdGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: | Performance data. If `total_only=true`, the `items` list will be empty. type: array items: $ref: '#/components/schemas/ResourcePerformanceNoId' total: description: | The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each field where meaningful. type: array items: $ref: '#/components/schemas/ResourcePerformanceNoId' ResourcePerformanceNoIdByArrayGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: | Performance data, broken down by array. If `total_only=true`, the `items` list will be empty. type: array items: $ref: '#/components/schemas/ResourcePerformanceNoIdByArray' total: description: | The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each field where meaningful. type: array items: $ref: '#/components/schemas/ResourcePerformanceNoIdByArray' MemberNoIdMemberGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/MemberNoIdMemberResponse' - $ref: '#/components/schemas/_errorContextResponse' MemberNoIdMemberResponse: type: object properties: items: description: | Displays a list of all items after filtering. The values are displayed for each name, if meaningful. type: array items: $ref: '#/components/schemas/MemberNoIdMember' HostGroupQosGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: | Specifies the Quality of Service (QoS) configuration data. type: array items: $ref: '#/components/schemas/QosMetricsCeilings' ResourceSpaceNoIdGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: type: array items: $ref: '#/components/schemas/ResourceSpaceNoId' NonCopyableTagBatch: type: object properties: key: description: | Key of the tag. Supports up to 64 Unicode characters. type: string example: environment namespace: description: | Optional namespace of the tag. Namespace identifies the category of the tag. Omitting the namespace defaults to the namespace `default`. The `pure*` namespaces are reserved for plugins and integration partners. Avoid using reserved namespaces. type: string example: default resource: description: | A reference to the parent object. title: Reference allOf: - $ref: '#/components/schemas/_reference' value: description: | Value of the tag. Supports up to 256 Unicode characters. type: string example: staging HostPost: type: object properties: chap: $ref: '#/components/schemas/_chap' iqns: description: | The iSCSI qualified name (IQN) associated with the host. type: array items: type: string example: iqn.2010-06.com.purestorage:linux.393d930077be2977 nqns: description: The NVMe Qualified Name (NQN) associated with the host. type: array items: type: string example: nqn.2010-06.com.purestorage:flasharray.512f7bb185978505 nvme_stretch: description: | The configuration that determines host behavior with stretched volumes, applicable only to `NVMe` hosts. Valid values include `disallow`, `allow`, and `allow-only-with-fleet`. Host operating systems supporting `NVMe` `dispersed namespaces` typically use `allow`, while those without such support use `allow-only-with-fleet` within a fleet or `disallow` otherwise. Changing to or from the `allow-only-with-fleet` mode triggers a disconnect of all `NVMe` connections for the host. The default value is `disallow`. type: string personality: description: | Determines how the system tunes the array to ensure that it works optimally with the host. Set `personality` to the name of the host operating system or virtual memory system. Valid values are `aix`, `esxi`, `hitachi-vsp`, `hpux`, `oracle-vm-server`, `solaris`, `vms`, `nutanix-mgmt` and `nutanix-cluster`. If your system is not listed as one of the valid host personalities, do not set the option. By default, the personality is not set. type: string preferred_arrays: description: | For synchronous replication configurations, sets a host's preferred array to specify which array exposes active/optimized paths to that host. Enter multiple preferred arrays in comma-separated format. If a preferred array is set for a host, then the other arrays in the same pod will expose active/non-optimized paths to that host. If the host is in a host group, `preferred_arrays` cannot be set because host groups have their own preferred arrays. On a preferred array of a certain host, all the paths on all the ports (for both the primary and secondary controllers) are set up as A/O (active/optimized) paths, while on a non-preferred array, all the paths are A/N (Active/Non-optimized) paths. type: array items: $ref: '#/components/schemas/_reference' qos: description: Sets QoS limits. title: ContainerQosCeilings allOf: - $ref: '#/components/schemas/_containerQosCeilings' tags: description: | The list of tags to be upserted with the object. type: array items: $ref: '#/components/schemas/NonCopyableTag' vlan: description: | The VLAN ID that the host is associated with. If not set or set to `any`, the host can access any VLAN. If set to `untagged`, the host can only access untagged VLANs. If set to a number between `1` and `4094`, the host can only access the specified VLAN with that number. type: string example: "1" wwns: description: The Fibre Channel World Wide Name (WWN) associated with the host. type: array items: type: string example: 52:4A:93:70:4E:E5:68:00 HostPatch: allOf: - $ref: '#/components/schemas/_newName' - type: object properties: add_iqns: description: | Adds the specified iSCSI Qualified Names (IQNs) to those already associated with the specified host. type: array items: type: string description: IQNs to add. example: iqn.2010-06.com.purestorage:linux.393d930077be2977 add_nqns: description: | Adds the specified NVMe Qualified Names (NQNs) to those already associated with the specified host. type: array items: type: string description: NQNs to add. example: nqn.2010-06.com.purestorage:flasharray.512f7bb185978505 add_wwns: description: | Adds the specified Fibre Channel World Wide Names (WWNs) to those already associated with the specified host. type: array items: type: string description: WWNs to add. example: 52:4A:93:70:4E:E5:68:00 chap: $ref: '#/components/schemas/_chap' host_group: description: The host group to which the host should be associated. title: ReferenceNoId allOf: - $ref: '#/components/schemas/_referenceNoId' iqns: description: | The iSCSI qualified name (IQN) associated with the host. type: array items: type: string example: iqn.2010-06.com.purestorage:linux.393d930077be2977 nqns: description: The NVMe Qualified Name (NQN) associated with the host. type: array items: type: string example: nqn.2010-06.com.purestorage:flasharray.512f7bb185978505 nvme_stretch: description: | The configuration that determines host behavior with stretched volumes, applicable only to `NVMe` hosts. Valid values include `disallow`, `allow`, and `allow-only-with-fleet`. Host operating systems supporting `NVMe` `dispersed namespaces` typically use `allow`, while those without such support use `allow-only-with-fleet` within a fleet or `disallow` otherwise. Changing to or from the `allow-only-with-fleet` mode triggers a disconnect of all `NVMe` connections for the host. The default value is `disallow`. type: string personality: description: | Determines how the system tunes the array to ensure that it works optimally with the host. Set `personality` to the name of the host operating system or virtual memory system. Valid values are `aix`, `esxi`, `hitachi-vsp`, `hpux`, `oracle-vm-server`, `solaris`, `vms`, `nutanix-mgmt` and `nutanix-cluster`. If your system is not listed as one of the valid host personalities, do not set the option. By default, the personality is not set. type: string preferred_arrays: description: | For synchronous replication configurations, sets a host's preferred array to specify which array exposes active/optimized paths to that host. Enter multiple preferred arrays in comma-separated format. If a preferred array is set for a host, then the other arrays in the same pod will expose active/non-optimized paths to that host. If the host is in a host group, `preferred_arrays` cannot be set because host groups have their own preferred arrays. On a preferred array of a certain host, all the paths on all the ports (for both the primary and secondary controllers) are set up as A/O (active/optimized) paths, while on a non-preferred array, all the paths are A/N (Active/Non-optimized) paths. type: array items: $ref: '#/components/schemas/_reference' qos: description: Sets QoS limits. title: ContainerQosCeilings_patch allOf: - $ref: '#/components/schemas/_containerQosCeilings_patch' remove_iqns: description: | Disassociates the specified iSCSI Qualified Names (IQNs) from the specified host. type: array items: type: string description: IQNs to remove. example: iqn.2010-06.com.purestorage:linux.393d930077be2977 remove_nqns: description: | Disassociates the specified NVMe Qualified Names (NQNs) from the specified host. type: array items: type: string description: NQNs to remove. example: nqn.2010-06.com.purestorage:flasharray.512f7bb185978505 remove_wwns: description: | Disassociates the specified Fibre Channel World Wide Names (WWNs) from the specified host. type: array items: type: string description: WWNs to remove. example: 52:4A:93:70:4E:E5:68:00 vlan: description: | The VLAN ID that the host is associated with. If not set, there is no change in VLAN. If set to `any`, the host can access any VLAN. If set to `untagged`, the host can only access untagged VLANs. If set to a number between `1` and `4094`, the host can only access the specified VLAN with that number. type: string example: "1" wwns: description: The Fibre Channel World Wide Name (WWN) associated with the host. type: array items: type: string example: 52:4A:93:70:4E:E5:68:00 HostGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/HostResponse' - $ref: '#/components/schemas/_errorContextResponse' HostResponse: 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/Host' HostPerformanceBalanceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: | A list of entries indicating count and percentage of I/O operations across various data paths between the host and the array. type: array items: $ref: '#/components/schemas/HostPerformanceBalance' HostQosGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: | Specifies the Quality of Service (QoS) configuration data. type: array items: $ref: '#/components/schemas/QosMetricsCeilings' KmipPost: type: object properties: ca_certificate: description: The text of the CA certificate for the KMIP server. type: string maxLength: 3000 example: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----' certificate: description: | The certificate used to verify FlashArray authenticity to the KMIP servers. title: ReferenceNoId allOf: - $ref: '#/components/schemas/_referenceNoId' uris: description: List of URIs for the configured KMIP servers. type: array items: type: string example: - 1.1.1.1:8888 - 2.2.2.2:9999 KmipPatch: type: object properties: ca_certificate: description: The text of the CA certificate for the KMIP server. type: string maxLength: 3000 example: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----' certificate: description: | The certificate used to verify FlashArray authenticity to the KMIP servers. title: ReferenceNoId allOf: - $ref: '#/components/schemas/_referenceNoId' uris: description: List of URIs for the configured KMIP servers. type: array items: type: string example: - 1.1.1.1:8888 - 2.2.2.2:9999 KmipGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/KmipResponse' KmipResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Kmip' KmipTestResultGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - type: object properties: items: type: array items: $ref: '#/components/schemas/KmipTestResult' _lifecycleRulePostBase: allOf: - $ref: '#/components/schemas/_lifecycle_rule_config_base' - type: object properties: bucket: description: | The bucket targeted by the lifecycle rule. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' rule_id: description: | The identifier for the rule. It must be unique to the bucket. The maximum length is 255 characters. If not specified, an ID unique to the bucket is generated in the format `RuleId`, where `` increments starting at 1. type: string _lifecycleRulePatchBase: allOf: - $ref: '#/components/schemas/_lifecycle_rule_config_base' - type: object properties: enabled: description: | If set to `true`, this rule will be enabled. type: boolean LifecycleRuleGetResponse: allOf: - $ref: '#/components/schemas/_errorContextResponse' - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/LifecycleRuleResponse' LifecycleRuleResponse: type: object properties: items: description: A list of lifecycle rule objects. type: array items: $ref: '#/components/schemas/LifecycleRule' LogTargetsGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/LogTargetsResponse' - $ref: '#/components/schemas/_errorContextResponse' LogTargetFile: allOf: - $ref: '#/components/schemas/LogTarget' - description: A file log target type: object properties: directory: description: | Directory name to be used as log target. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' keep_for: description: | Specifies the period that audit logs are retained before they are deleted, in milliseconds. Default value is `null` which means size based retention does not apply. Use 0 to reset the value to `null`. At least one of the `keep_for` or `keep_size` parameters is required, and they can be set together. type: integer format: int64 minimum: 86400000 example: 86400000 keep_size: description: | Specifies the maximum size of audit logs to be retained. Measured in bytes. When exceeded, older logs will be deleted. Default value is `null` which means size-based retention does not apply. Use 0 to reset the value to `null`. type: integer format: int64 minimum: 1000000 example: 1000000 LogTargetFileGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/LogTargetFileResponse' - $ref: '#/components/schemas/_errorContextResponse' LogTargetFileResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/LogTargetFile' SyslogServer: allOf: - $ref: '#/components/schemas/LogTarget' - description: A syslog server type: object properties: services: description: | Valid values are `data-audit` and `management`. If not specified, defaults to `management`. type: array items: type: string uri: description: | The URI of the syslog server in the format `PROTOCOL://HOSTNAME:PORT`. type: string example: tcp://my.syslogserver.com SyslogServerGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/SyslogServerResponse' - $ref: '#/components/schemas/_errorContextResponse' SyslogServerResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/SyslogServer' SyslogServerSettings: description: Global settings for syslog servers. allOf: - $ref: '#/components/schemas/_context' - type: object properties: ca_certificate: description: | The certificate of the certificate authority (CA) that signed the directory servers' certificate(s), which is used to validate the authenticity of the configured servers. type: string logging_severity: description: | Returns the configured logging severity threshold for which events will be forwarded to the configured syslog servers. Default configuration is info level severity. Valid values are `debug`, `info`, and `notice`. type: string tls_audit_enabled: description: | Returns a value of `true` if messages that are necessary in order to audit TLS negotiations performed by the array are forwarded to the configured syslog servers. type: boolean SyslogServerSettingsGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/SyslogServerSettingsResponse' - $ref: '#/components/schemas/_errorContextResponse' SyslogServerSettingsResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/SyslogServerSettings' MaintenanceWindowPost: type: object properties: timeout: description: | The specified length of time that alerts are suppressed during a maintenance window, measured in milliseconds. The maintenance window timeout value must be between `60000` (1 minute) and `86400000` (24 hours). The value entered is rounded down to the nearest minute. The `names` and `timeout` parameters must be set together, and the `names` parameter must be set to `environment`. type: integer format: int32 example: 3600000 x-minimum: 0 x-maximum: 86400000 MaintenanceWindowsGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/MaintenanceWindowsResponse' MaintenanceWindowsResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/MaintenanceWindow' NetworkInterfacePost: allOf: - $ref: '#/components/schemas/_builtInResourceNoId' - type: object properties: attached_servers: description: | Applies only to Ethernet interfaces. The list of servers to be associated with the specified network interface for data ingress. At most one server can be specified for each interface. To attach the network interface to a server, the name or id of the desired server must be provided. If not specified and the interface is created at the array level, defaults to the _array_server instance. If not specified and the interface is created within a server, defaults to that server. To create a network interface that is not attached to any server, specify an empty list []. type: array maxItems: 1 items: $ref: '#/components/schemas/_reference' eth: $ref: '#/components/schemas/_networkinterfacepostEth' services: description: | The services provided by the specified network interface or Fibre Channel port. type: array items: type: string description: | Valid values include `iscsi`, `management`, `nvme-fc`, `nvme-roce`, `nvme-tcp`, `offload`, `replication` and `scsi-fc`. NetworkInterfacePatch: type: object properties: attached_servers: description: | Applicable only to Ethernet interfaces. List of servers to be associated with the specified network interface for data ingress. At most one server can be specified for each interface. To attach the network interface to a server, `name` or `id` the desired server must be provided. To detach a network interface from all servers, an empty list `[]` should be passed to the `attached_servers` field. type: array maxItems: 1 items: $ref: '#/components/schemas/_reference' enabled: description: | Returns a value of `true` if the specified network interface or Fibre Channel port is enabled. Returns a value of `false` if the specified network interface or Fibre Channel port is disabled. type: boolean eth: $ref: '#/components/schemas/_networkinterfacepatchEth' override_npiv_check: description: | N-Port ID Virtualization (NPIV) requires a balanced configuration of Fibre Channel ports configured for SCSI on both controllers. Enabling or Disabling a Fibre Channel port configured for SCSI might cause the NPIV status to change from enabled to disabled or vice versa. Set this option to proceed with enabling or disabling the port. type: boolean services: description: | The services provided by the specified network interface or Fibre Channel port. type: array items: type: string description: | Valid values include `iscsi`, `management`, `nvme-fc`, `nvme-roce`, `nvme-tcp`, `offload`, `replication`, and `scsi-fc`. NetworkInterfaceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/NetworkInterfaceResponse' - $ref: '#/components/schemas/_errorContextResponse' NetworkInterfaceResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/NetworkInterface' NetworkInterfaceNeighborGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/NetworkInterfaceNeighborResponse' NetworkInterfacePerformanceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - type: object properties: items: description: A list of performance objects. type: array items: $ref: '#/components/schemas/NetworkInterfacePerformance' total: description: | The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each field where meaningful. type: array items: $ref: '#/components/schemas/NetworkInterfacePerformance' NetworkInterfacesPortDetailsGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/NetworkInterfacesPortDetailsResponse' _objectStoreAccessKeyPostBase: type: object properties: user: description: The user associated with the access key. title: ReferenceWithFixedType allOf: - $ref: '#/components/schemas/_referenceWithFixedType' ObjectStoreAccessKey: allOf: - $ref: '#/components/schemas/_builtInResourceNoId' - $ref: '#/components/schemas/_objectStoreAccessKeyBase' ObjectStoreAccessKeyGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - $ref: '#/components/schemas/ObjectStoreAccessKeyResponse' ObjectStoreAccessKeyResponse: type: object properties: items: description: A list of object store access key objects. type: array items: $ref: '#/components/schemas/ObjectStoreAccessKey' ObjectStoreAccountGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - $ref: '#/components/schemas/ObjectStoreAccountResponse' - type: object properties: total: description: | If `total_only` query param is `true`, then this field will be a total of all records after filtering and no items will be returned. If `total_only` is `false`, then it will be a total of all records on this page. type: object items: $ref: '#/components/schemas/ObjectStoreAccount' ObjectStoreAccountResponse: type: object properties: items: description: A list of object store account objects. type: array items: $ref: '#/components/schemas/ObjectStoreAccount' ResourceObjectStoreAccountSpaceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: | Displays a list of all items after filtering. If applicable, the values are displayed for each name. If `total_only=true`, the `items` list will be empty. type: array items: $ref: '#/components/schemas/ResourceObjectStoreAccountSpace' total: description: | The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. If applicable, the values are displayed for each field. type: array items: $ref: '#/components/schemas/ResourceObjectStoreAccountSpace' ObjectStoreUserGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - $ref: '#/components/schemas/ObjectStoreUserResponse' ObjectStoreUserResponse: type: object properties: items: description: A list of object store user objects. type: array items: $ref: '#/components/schemas/ObjectStoreUser' PolicyMemberObjectStoreAccessGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyMemberObjectStoreAccessResponse' - $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' ObjectStoreVirtualHostGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/ObjectStoreVirtualHostResponse' - $ref: '#/components/schemas/_errorContextResponse' ObjectStoreVirtualHostResponse: type: object properties: items: description: A list of object store virtual host objects. type: array items: $ref: '#/components/schemas/ObjectStoreVirtualHost' OffloadPost: type: object properties: azure: description: | Microsoft Azure Blob storage settings. title: Offload_azure allOf: - $ref: '#/components/schemas/_offload_azure' google-cloud: description: | Google Cloud Storage settings. title: OffloadGoogleCloud allOf: - $ref: '#/components/schemas/_offloadGoogleCloud' nfs: description: |- NFS settings. Deprecated from version 6.6.0 onwards - Contact support for additional information. title: Offload_nfs allOf: - $ref: '#/components/schemas/_offload_nfs' s3: description: | S3 settings. title: Offload_s3 allOf: - $ref: '#/components/schemas/_offload_s3' OffloadPatch: type: object properties: azure: description: | Specifies the Microsoft Azure Blob patch settings. title: Offload_azure_patch allOf: - $ref: '#/components/schemas/_offload_azure_patch' OffloadGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/OffloadResponse' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: total: description: | The aggregate value of all items after filtering. Where meaningful, the average value is displayed instead. If applicable, the values are displayed for each field. type: array items: $ref: '#/components/schemas/Offload' OffloadResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Offload' PodPost: allOf: - $ref: '#/components/schemas/_builtIn' - description: | A pod is an administrative domain, a data container, and a namespace for volumes and protection groups. type: object properties: failover_preferences: description: | Determines which array or realm within a stretched pod should be given priority to stay online should the arrays or realms ever lose contact with each other. The current array, current realm, and any peer arrays or realms that are connected to the current array or realm for synchronous replication can be added to a pod for failover preference. meaning no arrays or realms have been configured for failover preference. Enter multiple arrays or realms in comma-separated format. To clear the list of failover preferences, set to an empty list []. type: array items: $ref: '#/components/schemas/_reference' quota_limit: description: | The logical quota limit of the pod, measured in bytes. Must be a multiple of 512. title: Quota_limit_type allOf: - $ref: '#/components/schemas/_quota_limit_type' source: description: The source pod from where data is cloned to create the new pod. title: Reference allOf: - $ref: '#/components/schemas/_reference' tags: description: | The list of tags to be upserted with the object. type: array items: $ref: '#/components/schemas/Tag' PodPatch: allOf: - $ref: '#/components/schemas/_resource' - description: | A pod is an administrative domain, a data container, and a namespace for volumes and protection groups. type: object properties: destroyed: description: | If set to `true`, the pod has been destroyed and is pending eradication. The `time_remaining` value displays the amount of time left until the destroyed pod is permanently eradicated. A pod can only be destroyed if it is empty, so before destroying a pod, ensure all volumes and protection groups inside the pod have been either moved out of the pod or destroyed. A stretched pod cannot be destroyed unless you unstretch it first. Before the `time_remaining` period has elapsed, the destroyed pod can be recovered by setting `destroyed=false`. Once the `time_remaining` period has elapsed, the pod is permanently eradicated and can no longer be recovered. type: boolean failover_preferences: description: | Determines which array within a stretched pod should be given priority to stay online should the arrays ever lose contact with each other. The current array and any peer arrays that are connected to the current array for synchronous replication can be added to a pod for failover preference. By default, `failover_preferences=null`, meaning no arrays have been configured for failover preference. Enter multiple arrays in comma-separated format. type: array items: $ref: '#/components/schemas/_reference' ignore_usage: description: | Set to `true` to set a `quota_limit` that is lower than the existing usage. This ensures that no new volumes can be created until the existing usage drops below the `quota_limit`. If not specified, defaults to `false`. type: boolean mediator: description: | Sets the URL of the mediator for this pod, replacing the URL of the current mediator. By default, the Pure1 Cloud Mediator (`purestorage`) serves as the mediator. type: string example: https://mediator.cloud-support.purestorage.com requested_promotion_state: description: | Patch `requested_promotion_state` to `demoted` to demote the pod so that it can be used as a link target for continuous replication between pods. Demoted pods do not accept write requests, and a destroyed version of the pod with `undo-demote` appended to the pod name is created on the array with the state of the pod when it was in the promoted state. Patch `requested_promotion_state` to `promoted` to start the process of promoting the pod. The `promotion_status` indicates when the pod has been successfully promoted. Promoted pods stop incorporating replicated data from the source pod and start accepting write requests. The replication process does not stop when the source pod continues replicating data to the pod. The space consumed by the unique replicated data is tracked by the `space.journal` field of the pod. type: string - $ref: '#/components/schemas/_quota_limit_patch' PodGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PodResponse' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: total: description: | The aggregate value of all items after filtering. When applicable, the average value is displayed instead. The values are displayed for each field, if meaningful. type: array items: $ref: '#/components/schemas/Pod' PodResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Pod' MemberGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/MemberResponse' - $ref: '#/components/schemas/_errorContextResponse' MemberResponse: type: object properties: items: description: | Displays a list of all items after filtering. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty. type: array items: $ref: '#/components/schemas/Member' PodMemberGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PodMemberResponse' - $ref: '#/components/schemas/_errorContextResponse' PodMemberResponse: type: object properties: items: description: | Displays a list of all items after filtering. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty. type: array items: $ref: '#/components/schemas/PodMember' ContainerPerformanceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: | Performance data. If `total_only=true`, the `items` list will be empty. type: array items: $ref: '#/components/schemas/ContainerPerformance' total: description: | The aggregate value of all items after filtering. When applicable, the average value is displayed instead. If applicable, the values are displayed for each field. type: array items: $ref: '#/components/schemas/ContainerPerformance' PodPerformanceByArrayGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: | Performance data, broken down by array. If `total_only=true`, the `items` list will be empty. type: array items: $ref: '#/components/schemas/PodPerformanceByArray' total: description: | The aggregate value of all items after filtering. When applicable, the average value is displayed instead. If applicable, the values are displayed for each field. type: array items: $ref: '#/components/schemas/PodPerformanceByArray' PodPerformanceReplicationGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PodPerformanceReplicationResponse' - $ref: '#/components/schemas/_errorContextResponse' PodPerformanceReplicationByArrayGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PodPerformanceReplicationByArrayResponse' - $ref: '#/components/schemas/_errorContextResponse' ResourcePodSpaceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: | Displays a list of all items after filtering. If applicable, the values are displayed for each name. If `total_only=true`, the `items` list will be empty. type: array items: $ref: '#/components/schemas/ResourcePodSpace' total: description: | The aggregate value of all items after filtering. When applicable, the average value is displayed instead. If applicable, the values are displayed for each field. type: array items: $ref: '#/components/schemas/ResourcePodSpace' Tag: allOf: - $ref: '#/components/schemas/_context' - type: object properties: copyable: description: | Specifies whether or not to include the tag when copying the parent resource. If set to `true`, the tag is included in resource copying. If set to `false`, the tag is not included. If not specified, defaults to `true`. type: boolean example: true key: description: | Key of the tag. Supports up to 64 Unicode characters. type: string example: environment namespace: description: | Optional namespace of the tag. Namespace identifies the category of the tag. Omitting the namespace defaults to the namespace `default`. The `pure*` namespaces are reserved for plugins and integration partners. It is recommended that customers avoid using reserved namespaces. type: string example: default resource: $ref: '#/components/schemas/_fixedReference' value: description: | Value of the tag. Supports up to 256 Unicode characters. type: string example: staging TestResultWithResourceWithIdPostResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/TestResultWithResourceWithId' PodReplicaLinkPatch: type: object properties: paused: description: | Returns a value of `true` if the replica link is to be created in a `paused` state. Returns a value of `false` if the replica link is to be created not in a `paused` state. If not specified, defaults to `false`. type: boolean PodReplicaLinkGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PodReplicaLinkResponse' - $ref: '#/components/schemas/_errorContextResponse' PodReplicaLinkResponse: type: object properties: items: description: A list of pod replica link objects. type: array items: $ref: '#/components/schemas/PodReplicaLink' PodReplicaLinkLagGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PodReplicaLinkLagResponse' - $ref: '#/components/schemas/_errorContextResponse' PodReplicaLinkPerformanceReplicationGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PodReplicaLinkPerformanceReplicationResponse' - $ref: '#/components/schemas/_errorContextResponse' PodReplicaLinkPerformanceReplicationArrayGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PodReplicaLinkPerformanceReplicationArrayResponse' - $ref: '#/components/schemas/_errorContextResponse' MappingPolicyPatch: type: object properties: mapping: description: | The mapping to set on this policy mapping. Valid values are `connected` and `disconnected`. type: string PodReplicaLinkMappingPolicyGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PodReplicaLinkMappingPolicyResponse' - $ref: '#/components/schemas/_errorContextResponse' PodReplicaLinkMappingPolicyResponse: type: object properties: items: description: | A list of policy mappings. type: array items: $ref: '#/components/schemas/MappingPolicy' PolicyGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyResponse' - $ref: '#/components/schemas/_errorContextResponse' 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' 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' PolicyManagementAccessGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyManagementAccessResponse' - $ref: '#/components/schemas/_errorContextResponse' 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' PolicyMemberPost: type: object properties: members: description: | A list of resources to which the policy may be applied. type: array items: $ref: '#/components/schemas/_policymemberpostMembers' PolicyPost: type: object properties: enabled: description: "If set to `true`, enables the policy. If set to `false`, disables the policy." type: boolean 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 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' PolicyRuleAlertWatcherPost: type: object properties: rules: description: A list of alert-watcher policy rules to create. type: array items: $ref: '#/components/schemas/_policyrulealertwatcherpostRules' 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' PolicyRuleAlertWatcherGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyRuleAlertWatcherResponse' - $ref: '#/components/schemas/_errorContextResponse' 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' 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' 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' PolicyAuditFileGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyAuditFileResponse' - $ref: '#/components/schemas/_errorContextResponse' 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' PolicyRuleNetworkAccessPost: type: object properties: rules: description: A list of network access policy rules to create. type: array items: $ref: '#/components/schemas/_policyrulenetworkaccesspostRules' PolicyRuleNetworkAccessPatch: type: object properties: rules: description: A list of network access policy rules to modify. type: array items: $ref: '#/components/schemas/_policyrulenetworkaccesspatchRules' PolicyRuleNetworkAccessGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyRuleNetworkAccessResponse' - $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' 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 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 PolicyNfsGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyNfsResponse' - $ref: '#/components/schemas/_errorContextResponse' 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' PolicyRuleNfsClientPost: type: object properties: rules: description: A list of NFS policy rules to create. type: array items: $ref: '#/components/schemas/_policyrulenfsclientpostRules' 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' PolicyRuleNfsClientGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyRuleNfsClientResponse' - $ref: '#/components/schemas/_errorContextResponse' 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' 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' ObjectStoreAccessPolicyGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - $ref: '#/components/schemas/ObjectStoreAccessPolicyResponse' ObjectStoreAccessPolicyRuleGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - $ref: '#/components/schemas/ObjectStoreAccessPolicyRuleResponse' 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 PolicyPasswordGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyPasswordResponse' - $ref: '#/components/schemas/_errorContextResponse' 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' 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 PolicyQuotaGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyQuotaResponse' - $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' PolicyRuleQuotaPost: type: object properties: rules: description: A list of quota policy rules to create. type: array items: $ref: '#/components/schemas/_policyrulequotapostRules' 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' PolicyRuleQuotaGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyRuleQuotaResponse' - $ref: '#/components/schemas/_errorContextResponse' 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' 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' 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 PolicySmbGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicySmbResponse' - $ref: '#/components/schemas/_errorContextResponse' 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' PolicyRuleSmbClientPost: type: object properties: rules: description: A list of SMB policy rules to create. type: array items: $ref: '#/components/schemas/_policyrulesmbclientpostRules' PolicyRuleSmbClientGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyRuleSmbClientResponse' - $ref: '#/components/schemas/_errorContextResponse' 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' 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 PolicyLockableGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyLockableResponse' - $ref: '#/components/schemas/_errorContextResponse' 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' PolicyRuleSnapshotPost: type: object properties: rules: description: A list of snapshot policy rules to create. type: array items: $ref: '#/components/schemas/_policyrulesnapshotpostRules' PolicyRuleSnapshotPatch: type: object properties: rules: description: | A list of snapshot policy rules to modify. type: array items: $ref: '#/components/schemas/_policyrulesnapshotpatchRules' PolicyRuleSnapshotGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyRuleSnapshotResponse' - $ref: '#/components/schemas/_errorContextResponse' 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' PolicyRuleUserGroupQuotaPost: type: object properties: rules: description: | A list of user-group-quota policy rules to create. type: array items: $ref: '#/components/schemas/_policyruleusergroupquotapostRules' 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' PolicyRuleUserGroupQuotaGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyRuleUserGroupQuotaResponse' - $ref: '#/components/schemas/_errorContextResponse' 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' PortGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: type: array items: $ref: '#/components/schemas/Port' PortInitiatorsGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: type: array items: $ref: '#/components/schemas/PortInitiator' PresetWorkload: allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_context' - $ref: '#/components/schemas/_presetWorkloadBase' PresetWorkloadPost: allOf: - $ref: '#/components/schemas/_presetWorkloadBase' - type: object PresetWorkloadPatch: allOf: - $ref: '#/components/schemas/_newName' - type: object PresetWorkloadGetResponse: allOf: - $ref: '#/components/schemas/PageInfoWithoutTotalItemCountResponse' - $ref: '#/components/schemas/PresetWorkloadResponse' - $ref: '#/components/schemas/_errorContextResponse' PresetWorkloadResponse: 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/PresetWorkload' ProtectionGroupPost: type: object properties: tags: description: | The list of tags to be upserted with the object. type: array items: $ref: '#/components/schemas/Tag' ProtectionGroup: allOf: - $ref: '#/components/schemas/_context' - $ref: '#/components/schemas/_resource' - description: | A protection group defines a set of either volumes, hosts, or host groups (called members) that are protected together through snapshots with point-in-time consistency across the member volumes. The members within the protection group have common data protection requirements and share the same snapshot, replication, and retention schedules. type: object properties: destroyed: description: | Has this protection group been destroyed? To destroy a protection group, patch to `true`. To recover a destroyed protection group, patch to `false`. If not specified, defaults to `false`. type: boolean eradication_config: $ref: '#/components/schemas/ProtectionGroupEradicationConfig' host_count: description: Number of hosts in this protection group. type: integer format: int64 readOnly: true example: 3 host_group_count: description: Number of host groups in this protection group. type: integer format: int64 readOnly: true example: 3 is_local: description: | If set to `true`, the protection group belongs to the local array. If set to `false`, the protection group belongs to the remote array. type: boolean readOnly: true pod: description: The pod in which the protection group resides. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' replication_schedule: description: The schedule settings for asynchronous replication. title: Replication_schedule allOf: - $ref: '#/components/schemas/_replication_schedule' retention_lock: description: | The valid values are `ratcheted` and `unlocked`. The default value for a newly created protection group is `unlocked`. Set `retention_lock` to `ratcheted` to enable SafeMode restrictions on the protection group. Contact Pure Technical Services to change `retention_lock` to `unlocked`. type: string example: unlocked snapshot_schedule: description: The schedule settings for protection group snapshots. title: Snapshot_schedule allOf: - $ref: '#/components/schemas/_snapshot_schedule' source: description: The array or pod on which the protection group was created. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' source_retention: description: | The retention policy for the source array of the protection group. title: RetentionPolicy allOf: - $ref: '#/components/schemas/_retentionPolicy' space: description: | Displays provisioned size and physical storage consumption data for each protection group. title: Space allOf: - $ref: '#/components/schemas/_space' target_count: description: The number of targets to where this protection group replicates. type: integer format: int64 readOnly: true example: 3 target_retention: description: | The retention policy for the target(s) of the protection group. title: RetentionPolicy allOf: - $ref: '#/components/schemas/_retentionPolicy' time_remaining: description: | The amount of time left until the destroyed protection group is permanently eradicated. Measured in milliseconds. Before the `time_remaining` period has elapsed, the destroyed protection group can be recovered by setting `destroyed=false`. type: integer format: int64 readOnly: true volume_count: description: The number of volumes in the protection group. type: integer format: int64 readOnly: true example: 3 workload: $ref: '#/components/schemas/_workloadConfigurationFixedReference' ProtectionGroupGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/ProtectionGroupResponse' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: total: description: | The aggregate value of all items after filtering. When applicable, the average value is displayed instead. If applicable, the values are displayed for each field. type: array items: $ref: '#/components/schemas/ProtectionGroup' ProtectionGroupResponse: type: object properties: items: description: | Displays a list of all items after filtering. If applicable, the values are displayed for each name. If `total_only=true`, the `items` list will be empty. type: array items: $ref: '#/components/schemas/ProtectionGroup' ProtectionGroupPerformanceResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: | A list of protection group performance objects. type: array items: $ref: '#/components/schemas/ProtectionGroupPerformance' ProtectionGroupPerformanceArrayResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: | Lists performance data, broken down by array. type: array items: $ref: '#/components/schemas/ProtectionGroupPerformanceArray' ResourceSpaceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: | Displays a list of all items after filtering. If applicable, the values are displayed for each name. If `total_only=true`, the `items` list will be empty. type: array items: $ref: '#/components/schemas/ResourceSpace' total: description: | The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. If applicable, the values are displayed for each field. type: array items: $ref: '#/components/schemas/ResourceSpace' TagBatch: type: object properties: copyable: description: | Specifies whether or not to include the tag when copying the parent resource. If set to `true`, the tag is included in resource copying. If set to `false`, the tag is not included. If not specified, defaults to `true`. type: boolean example: true key: description: | Key of the tag. Supports up to 64 Unicode characters. type: string example: environment namespace: description: | Optional namespace of the tag. Namespace identifies the category of the tag. Omitting the namespace defaults to the namespace `default`. The `pure*` namespaces are reserved for plugins and integration partners. It is recommended that customers avoid using reserved namespaces. type: string example: default resource: description: | A reference to the parent object. title: Reference allOf: - $ref: '#/components/schemas/_reference' value: description: | Value of the tag. Supports up to 256 Unicode characters. type: string example: staging TargetProtectionGroupPostPatch: type: object properties: allowed: description: | If set to `true`, the target array has allowed the source array to replicate protection group data to the target array. If set to `false`, the target array has not allowed the source array to replicate protection group data to the target. type: boolean example: true protection_group: $ref: '#/components/schemas/_fixedReference' target: $ref: '#/components/schemas/_fixedReferenceNoId' ProtectionGroupTargetGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/ProtectionGroupTargetResponse' - $ref: '#/components/schemas/_errorContextResponse' ProtectionGroupTargetResponse: type: object properties: items: description: | Displays a list of all items after filtering. If applicable, the values are displayed for each name. type: array items: $ref: '#/components/schemas/TargetProtectionGroup' ProtectionGroupsVolumesGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/ProtectionGroupsVolumesResponse' - $ref: '#/components/schemas/_errorContextResponse' ProtectionGroupsVolumesResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/ProtectionGroupsVolumes' ProtectionGroupSnapshotPost: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/ProtectionGroupSnapshot' - type: object properties: destroyed: type: boolean readOnly: true tags: description: | The list of tags to be upserted with the object. type: array items: $ref: '#/components/schemas/Tag' ProtectionGroupSnapshotPatch: allOf: - $ref: '#/components/schemas/ProtectionGroupSnapshot' - type: object properties: suffix: type: string readOnly: true ProtectionGroupSnapshotGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/ProtectionGroupSnapshotResponse' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: total: description: | The aggregate value of all items after filtering. If applicable, the average value is displayed instead. If applicable, the values are displayed for each field. type: array items: $ref: '#/components/schemas/ProtectionGroupSnapshot' ProtectionGroupSnapshotResponse: 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/ProtectionGroupSnapshot' ProtectionGroupSnapshotReplicaResponse: type: object properties: items: description: | Displays a list of all items after the operation. If applicable, the values are displayed for each name. type: array items: $ref: '#/components/schemas/ProtectionGroupSnapshotReplica' ProtectionGroupSnapshotTransferGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/ProtectionGroupSnapshotTransferResponse' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: total: description: | The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. If applicable, the values are displayed for each field. type: array items: $ref: '#/components/schemas/ProtectionGroupSnapshotTransfer' RealmPost: type: object properties: qos: description: Sets QoS limits. title: ContainerQos allOf: - $ref: '#/components/schemas/_containerQos' quota_limit: description: | The logical quota limit of the realm, measured in bytes. Must be a multiple of 512. title: Quota_limit_type allOf: - $ref: '#/components/schemas/_quota_limit_type' tags: description: | The list of tags to be upserted with the object. type: array items: $ref: '#/components/schemas/NonCopyableTag' RealmPatch: allOf: - $ref: '#/components/schemas/_newName' - type: object properties: destroyed: description: | If set to `true`, the realm will be destroyed and pending eradication. The `time_remaining` value displays the amount of time left until the destroyed realm is permanently eradicated. A realm can only be destroyed if it is empty or destroy_contents is set to true. Before the `time_remaining` period has elapsed, the destroyed realm can be recovered by setting `destroyed=false`. Once the `time_remaining` period has elapsed, the realm is permanently eradicated and can no longer be recovered. type: boolean qos: description: | Sets QoS limits. title: ContainerQos_patch allOf: - $ref: '#/components/schemas/_containerQos_patch' - $ref: '#/components/schemas/_quota_limit_patch' RealmGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/RealmResponse' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: total: description: | The aggregate value of all items after filtering. When applicable, the average value is displayed instead. The values are displayed for each field, if meaningful. type: array items: $ref: '#/components/schemas/Realm' RealmResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Realm' RealmQosGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: | QoS configuration data. type: array items: $ref: '#/components/schemas/QosMetrics' RealmSpaceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - type: object properties: items: description: | Displays a list of all items after filtering. If applicable, the values are displayed for each name. If `total_only=true`, the `items` list will be empty. type: array items: $ref: '#/components/schemas/ResourceRealmSpace' total: description: | The aggregate value of all items after filtering. When applicable, the average value is displayed instead. The values are displayed for each field, if meaningful. type: array items: $ref: '#/components/schemas/ResourceRealmSpace' RemoteArraysResponse: allOf: - $ref: '#/components/schemas/PageInfo' - type: object properties: items: description: | Returns a list of all items after filtering. The values are displayed for each name where meaningful. type: array items: $ref: '#/components/schemas/RemoteArray' RemotePodsResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: | Displays a list of all items after filtering. The values are displayed for each name where meaningful. type: array items: $ref: '#/components/schemas/RemotePod' RemotePodTagGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: type: array items: $ref: '#/components/schemas/StretchedTagPod' RemoteProtectionGroup: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_context' - description: | A remote protection group represents a protection group that is replicated to an offload target. type: object properties: destroyed: description: | Returns a value of `true` if the remote protection group has been destroyed and is pending eradication. The `time_remaining` value displays the amount of time left until the destroyed remote protection group is permanently eradicated. Before the `time_remaining` period has elapsed, the destroyed remote protection group can be recovered by setting `destroyed=false`. Once the `time_remaining` period has elapsed, the remote protection group is permanently eradicated and can no longer be recovered. type: boolean is_local: description: | If set to `true`, the location reference is to the local array. If set to `false`, the location reference is to a remote location, such as a remote array or offload target. type: boolean readOnly: true remote: description: | The offload target that the remote protection group is on. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' source: description: | The array where the remote protection group is replicated from. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' target_retention: description: The retention policy for the remote protection group. title: RetentionPolicy allOf: - $ref: '#/components/schemas/_retentionPolicy' time_remaining: description: | Milliseconds remaining until eradication, if remote protection group has been destroyed. type: integer format: int64 readOnly: true RemoteProtectionGroupGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/RemoteProtectionGroupResponse' - $ref: '#/components/schemas/_errorContextResponse' RemoteProtectionGroupResponse: type: object properties: items: description: | Displays a list of all items after filtering. The values are displayed for each name where meaningful. type: array items: $ref: '#/components/schemas/RemoteProtectionGroup' RemoteProtectionGroupSnapshotPost: allOf: - $ref: '#/components/schemas/RemoteProtectionGroupSnapshot' - type: object properties: destroyed: type: boolean readOnly: true suffix: description: | Specifies a name suffix for the snapshots created. The snapshot is created on the FlashArray specified by the `on` parameter. The `on` parameter cannot refer to an offload target. Snapshots with suffixes specified have names in the form `PGROUP.SUFFIX` instead of the default `PGROUP.NNN` form. The names of all snapshots created by a single command that specifies this option have the same suffix. type: string tags: description: | The list of tags to be upserted with the object. type: array items: $ref: '#/components/schemas/Tag' _destroyedPatchPost: type: object properties: destroyed: description: | If set to `true`, destroys a resource. Once set to `true`, the `time_remaining` value will display the amount of time left until the destroyed resource is permanently eradicated. Before the `time_remaining` period has elapsed, the destroyed resource can be recovered by setting `destroyed=false`. Once the `time_remaining` period has elapsed, the resource is permanently eradicated and can no longer be recovered. type: boolean RemoteProtectionGroupSnapshotGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/RemoteProtectionGroupSnapshotResponse' - $ref: '#/components/schemas/_errorContextResponse' RemoteProtectionGroupSnapshotResponse: 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/RemoteProtectionGroupSnapshot' RemoteProtectionGroupSnapshotTransferGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/RemoteProtectionGroupSnapshotTransferResponse' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: total: description: | The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. If applicable, the values are displayed for each field. type: array items: $ref: '#/components/schemas/RemoteProtectionGroupSnapshotTransfer' RemoteRealmsResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: | Displays a list of all items after filtering. The values are displayed for each name where meaningful. type: array items: $ref: '#/components/schemas/RemoteRealm' RemoteRealmTagGetResponse: allOf: - $ref: '#/components/schemas/_errorContextResponse' - $ref: '#/components/schemas/PageInfo' - type: object properties: items: type: array items: $ref: '#/components/schemas/StretchedTagRealm' RemoteVolumeSnapshotPost: type: object properties: suffix: description: | The suffix that is appended to the `source_name` value to generate the full volume snapshot name in the form `VOL.SUFFIX`. If the suffix is not specified, the system constructs the snapshot name in the form `VOL.NNN`, where `VOL` is the volume name, and `NNN` is a monotonically increasing number. type: string RemoteVolumeSnapshotGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/RemoteVolumeSnapshotResponse' - $ref: '#/components/schemas/_errorContextResponse' RemoteVolumeSnapshotResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/RemoteVolumeSnapshot' RemoteVolumeSnapshotTransferGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/RemoteVolumeSnapshotTransferResponse' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: total: description: | The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each field where meaningful. type: array items: $ref: '#/components/schemas/RemoteVolumeSnapshotTransfer' RealmConnectionWithKey: allOf: - $ref: '#/components/schemas/RealmConnection' - type: object properties: connection_key: description: | Specifies the unique string token used to create or update a realm connection to the remote realm associated with the key. On update, the key is required only when changing the connection type from async-replication to sync-replication. type: string RealmConnectionsGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - $ref: '#/components/schemas/RealmConnectionsResponse' RealmConnectionsResponse: type: object properties: items: description: A list of realm connection objects. type: array items: $ref: '#/components/schemas/RealmConnection' RealmConnectionKeyPost: type: object properties: type: description: | Specifies the type of realm connection that a key can create. Values include async-replication and sync-replication. A sync-replication key can also be used to create an async-replication connection. type: string RealmConnectionKeyGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - $ref: '#/components/schemas/RealmConnectionKeyResponse' RealmConnectionKeyPostResponse: type: object properties: items: description: A list of realm connection keys. type: array items: $ref: '#/components/schemas/RealmConnectionKey' ResourceAccessesGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/ResourceAccessesResponse' ResourceAccess: description: | A resource access captures configuration of sharing a resource to a scope. For example, resource access can specify that an array host is accessible from a realm. type: object properties: id: description: ID of a resource access object. type: string readOnly: true resource: description: Resource to which the scope has access. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' scope: description: Scope which has access to the resource. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' ResourceAccessesResponse: type: object properties: items: description: A list of resource access objects. type: array items: $ref: '#/components/schemas/ResourceAccess' ResourceAccessesStatusGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/ResourceAccessesStatusResponse' ServerPost: type: object properties: directory_services: description: | The directory service configuration to be used by this server. type: array maxItems: 1 items: $ref: '#/components/schemas/_reference' dns: description: | The DNS configuration to be used by this server. type: array maxItems: 1 items: $ref: '#/components/schemas/_reference' local_directory_service: description: | The Local Directory Service to be associated to the server. title: Reference allOf: - $ref: '#/components/schemas/_reference' ServerPatch: allOf: - $ref: '#/components/schemas/_newName' - $ref: '#/components/schemas/ServerPost' ServerGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/ServerResponse' - $ref: '#/components/schemas/_errorContextResponse' ServerResponse: type: object properties: items: description: | The aggregate value of all items after filtering. When applicable, the average value is displayed instead. The values are displayed for each field, if meaningful. type: array items: $ref: '#/components/schemas/Server' SessionGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - type: object properties: items: type: array items: $ref: '#/components/schemas/Session' Smis: type: object properties: slp_enabled: description: | If set to `true`, the Service Location Protocol (SLP) and its ports, TCP 427 and UDP 427, are enabled. type: boolean wbem_https_enabled: description: | If set to `true`, the SMI-S provider and its port, TCP 5989 is enabled. type: boolean SmisGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/SmisResponse' SmisResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Smis' SmtpServer: allOf: - $ref: '#/components/schemas/_builtInResourceNoId' - type: object properties: body_prefix: description: | Optional string added to the beginning of the email body when sending alert email messages. HTML tags are not allowed. type: string maxLength: 256 example: Classifaction is UNCLASSIFIED encryption_mode: description: | Enforces an encryption mode when sending alert email messages. Valid values are `starttls`. Use "" to clear. type: string example: starttls password: description: | Password for the relay host, if needed. type: string relay_host: description: | Relay server used as a forwarding point for email sent from the array. Can be set as a hostname, IPv4 address, or IPv6 address, with optional port numbers. The expected format for IPv4 is `ddd.ddd.ddd.ddd:PORT`. The expected format for IPv6 is `xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx` or, if a port number is specified, `[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx]:PORT`. type: string sender_domain: description: | Domain name appended to alert email messages. type: string sender_username: description: | The local-part of the email address used when sending alert email messages. type: string subject_prefix: description: | Optional string added to the beginning of the subject when sending alert email messages. HTML tags are not allowed. type: string maxLength: 64 example: DC:45 RM:23 RACK:12 user_name: description: | User name for the relay host, if needed. type: string SmtpServerGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/SmtpServerResponse' SmtpServerResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/SmtpServer' SnmpAgentPatch: allOf: - $ref: '#/components/schemas/_builtInResourceNoId' - type: object properties: engine_id: description: | The administration domain unique name of an SNMP agent. type: string maxLength: 32 readOnly: true example: 80009e2205d7c0bd31fef5b87f4f44da v2c: $ref: '#/components/schemas/_snmp_v2c' v3: $ref: '#/components/schemas/_snmp_v3_patch' version: description: | Version of the SNMP protocol to be used by Purity//FA in communications with the specified manager. Valid values are `v2c` and `v3`. type: string example: v3 SnmpAgentGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/SnmpAgentResponse' SnmpAgentResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/SnmpAgent' SnmpAgentMibGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/SnmpAgentMibResponse' SnmpManagerPost: type: object properties: host: description: | DNS hostname or IP address of a computer that hosts an SNMP manager to which Purity//FA is to send trap messages when it generates alerts. type: string example: snmp.purestorage.com notification: description: | The type of notification the agent will send. Valid values are `inform` and `trap`. type: string example: trap v2c: $ref: '#/components/schemas/_snmp_v2c' v3: $ref: '#/components/schemas/_snmp_v3_post' version: description: | Version of the SNMP protocol to be used by Purity//FA to communicate with the specified manager. Valid values are `v2c` and `v3`. type: string example: v3 SnmpManagerPatch: allOf: - $ref: '#/components/schemas/_resourceNoId' - type: object properties: host: description: | DNS hostname or IP address of a computer that hosts an SNMP manager to which Purity//FA is to send trap messages when it generates alerts. type: string example: snmp.purestorage.com notification: description: | The type of notification the agent will send. Valid values are `inform` and `trap`. type: string example: trap v2c: $ref: '#/components/schemas/_snmp_v2c' v3: $ref: '#/components/schemas/_snmp_v3_patch' version: description: | Version of the SNMP protocol to be used by Purity//FA to communicate with the specified manager. Valid values are `v2c` and `v3`. type: string example: v3 SnmpManagerGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/SnmpManagerResponse' SnmpManagerResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/SnmpManager' SoftwarePost: description: Software to be installed on the array. type: object properties: name: description: | The name of the software. type: string example: Purity//FA version: description: | The version of the software. type: string example: 5.2.3 SoftwareGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/SoftwareResponse' SoftwareResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Software' SoftwareBundlePost: description: The source of the software bundle. type: object properties: source: description: "The source of the software bundle. Accepts HTTP, HTTPS or FTP, and paths." type: string example: ftp://local/upgrade_bundle.sh SoftwareBundleGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/SoftwareBundleResponse' SoftwareBundleResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/SoftwareBundle' SoftwareChecksGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/SoftwareChecksResponse' SoftwareChecksResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/SoftwareCheck' SoftwareInstallationPost: description: Software upgrade attempt. type: object properties: mode: description: | Mode that the upgrade is in. Valid values are `check-only`, `interactive`, `semi-interactive`, and `one-click`. The `check_only` mode is deprecated. Use `/software-checks`. In this mode, the upgrade only runs pre-upgrade checks and returns. In `interactive` mode, the upgrade pauses at several points, at which users must enter certain commands to proceed. In `semi-interactive` mode, the upgrade pauses if there are any upgrade check failures and functions like `one-click` mode otherwise. In `one-click` mode, the upgrade proceeds automatically without pausing. type: string example: interactive override_checks: description: | A list of upgrade checks whose failures are overridden during the upgrade. If any optional `args` are provided, they are validated later when the corresponding check script runs. type: array items: $ref: '#/components/schemas/_override_check' upgrade_parameters: description: | A list of parameters to be sent to the upgrade process. These parameters can be used to change the behavior of the upgrade process in specific ways such as enabling or disabling features in the target version or changing the attributes of the appliance at upgrade time. When there is a need or option to set an upgrade parameter, Pure Storage will provide documentation for the specific parameter. If you have been provided documentation related to a specific upgrade parameter, follow the instructions in the documentation. Otherwise, do not set any upgrade parameters. type: array items: $ref: '#/components/schemas/_upgrade_parameters' SoftwareInstallationPatch: type: object properties: add_override_checks: description: | Adds the specified checks to the current list of override checks. type: array items: $ref: '#/components/schemas/_override_check' SoftwareInstallationsGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/SoftwareInstallationsResponse' SoftwareInstallationsResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/SoftwareInstallation' SoftwareInstallationStepsGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/SoftwareInstallationStepsResponse' SoftwarePatchesGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/SoftwarePatchesResponse' SoftwarePatchesResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/SoftwarePatch' SoftwareVersionsGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/SoftwareVersionsResponse' Saml2SsoPost: type: object properties: array_url: description: | The URL of the array. type: string example: https://myarray.mycompany.com idp: $ref: '#/components/schemas/_saml2SsoIdp' management: $ref: '#/components/schemas/_saml2SsoManagement' sp: description: | Properties specific to the service provider. title: Saml2SsoSpCredential allOf: - $ref: '#/components/schemas/_saml2SsoSpCredential' Saml2SsoPatch: allOf: - $ref: '#/components/schemas/Saml2SsoPost' - type: object properties: enabled: description: | If set to `true`, the SAML2 SSO configuration is enabled. type: boolean Saml2SsoGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/Saml2SsoResponse' Saml2SsoResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Saml2Sso' TestResultWithResourceResponse: allOf: - $ref: '#/components/schemas/PageInfo' - type: object properties: items: type: array items: $ref: '#/components/schemas/TestResultWithResource' TestResultWithResourcePatchResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/TestResultWithResource' SubnetPost: type: object properties: enabled: description: | Returns a value of `true` if subnet is enabled. Returns a value of `false` if subnet is disabled. If not specified, defaults to `true`. type: boolean gateway: description: | The IPv4 or IPv6 address of the gateway through which the specified subnet is to communicate with the network. type: string mtu: description: | Maximum message transfer unit (packet) size for the subnet in bytes. MTU setting cannot exceed the MTU of the corresponding physical interface. If not specified, defaults to `1500`. type: integer format: int32 minimum: 1280 maximum: 9216 prefix: description: | The IPv4 or IPv6 address to be associated with the specified subnet. type: string vlan: description: VLAN ID number. type: integer format: int32 SubnetPatch: allOf: - $ref: '#/components/schemas/_resourceNoId' - $ref: '#/components/schemas/SubnetPost' SubnetGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/SubnetResponse' SubnetResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Subnet' SubscriptionGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/SubscriptionResponse' SubscriptionAssetGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/SubscriptionAssetResponse' SupportPatch: type: object properties: phonehome_enabled: description: | The status of phonehome. If set to `true`, enable phonehome. If set to `false`, disable phonehome. type: boolean phonehome_excludes: description: | A list of of items to exclude form phonehome. Valid values include `application-insights`. type: array items: type: string example: application-insights proxy: description: | The value of the current proxy, which is used for connecting to cloud services such as phonehome, remote assist, etc. Specify the server name, including the scheme and proxy port number. type: string example: http://proxy.example.com:8080 remote_assist_active: description: | The status of a remote assist session. If set to `true`, enable the remote assist session. If set to `false`, disable the remote assist session. type: boolean remote_assist_duration: description: | Specifies the duration of the remote assist session in milliseconds. This parameter should only be provided when establishing a new session. This parameter determines the length of time the session will remain active after it is initiated. type: integer format: int64 example: 86400000 SupportGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/SupportResponse' SupportResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Support' SupportRemoteAssistSessionsPatch: type: object properties: access_level_override: description: | Overrides the default access level for the remote assist session only. Values include `restricted` and `elevated`. If not provided, the remote assist session will use the default_access_level setting. type: string active: description: | The status of a remote assist session. If set to `true`, enables the remote assist session. If set to `false`, disables the remote assist session. type: boolean duration: description: | Specifies the duration of the remote assist session in milliseconds. This parameter should only be provided when establishing a new session. This parameter determines the length of time the session will remain active after initiation. Defaults to 86400000 (24h) with a min of 14400000 (4h) and a max of 172800000 (48h). type: integer format: int64 example: 86400000 SupportRemoteAssistSessionsGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/SupportRemoteAssistSessionsResponse' SupportRemoteAssistSessionsResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/SupportRemoteAssistSessions' SupportRemoteAssistSessionsSettings: type: object properties: default_access_level: description: | The default access level that support will have when connecting to the array. Values include `restricted` and `elevated`. type: string SupportRemoteAssistSessionsSettingsGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/SupportRemoteAssistSessionsSettingsResponse' SupportRemoteAssistSessionsSettingsResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/SupportRemoteAssistSessionsSettings' SupportSystemManifestResponse: allOf: - $ref: '#/components/schemas/PageInfo' - type: object properties: items: type: array items: $ref: '#/components/schemas/SupportSystemManifest' SupportDiagnosticsDetailsGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/SupportDiagnosticsDetailsResponse' SupportDiagnosticsGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/SupportDiagnosticsResponse' SupportDiagnosticsResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/SupportDiagnosticsSettings' VchostPost: type: object properties: vcuuid: description: | The vCenter Server uuid of the vchost. type: string example: ddf43502-4e00-405e-b341-e87e7eaa13f6 VchostPatch: type: object properties: name: description: | The new name of the vchost. type: string example: vchost-b VchostGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/VchostResponse' VchostResponse: 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/Vchost' VchostCertificatePost: type: object properties: certificate: description: | The certificate to be presented by the vchost over the configured endpoints. title: ReferenceNoIdWithType allOf: - $ref: '#/components/schemas/_referenceNoIdWithType' endpoints: description: | The IPv4 or IPv6 addresses of the endpoints to configure for the vchost, over which the configured certificate will be presented. type: array items: type: string example: 1.2.3.4 VchostCertificatePatch: type: object properties: endpoints: description: | The IPv4 or IPv6 addresses of the endpoints to configure for the vchost, over which the configured certificate will be presented. type: array items: type: string example: 1.2.3.4 VchostCertificateGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/VchostCertificateResponse' VchostCertificateResponse: 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/VchostCertificate' VchostEndpointPost: type: object properties: certificates: description: | The certificate to be presented by the vchost over the configured endpoints. type: array items: $ref: '#/components/schemas/_referenceNoIdWithType' endpoint: description: | The IPv4 or IPv6 address of the endpoint. type: string example: 1.2.3.4 VchostEndpointPatch: type: object properties: certificates: description: | The certificate to be presented by the vchost over the configured endpoints. type: array items: $ref: '#/components/schemas/_referenceNoIdWithType' VchostEndpointGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/VchostEndpointResponse' VchostEndpointResponse: 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/VchostEndpoint' VchostConnectionGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/VchostConnectionResponse' VchostConnectionResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/VchostConnection' VirtualMachinePost: type: object properties: id: description: | The ID of the virtual machine to create or modify, as assigned by the external system. `id` is deprecated. Use `vm_id` instead. type: string source: description: | The recovery context for the virtual machine or virtual machine snapshot being modified. title: Reference allOf: - $ref: '#/components/schemas/_reference' vm_id: description: | The ID of the virtual machine to create or modify, as assigned by the external system. type: string vm_type: description: | The type of virtual machine. The only valid value is `vvol`. type: string example: vvol VirtualMachineGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - 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/VirtualMachine' VirtualMachineResponse: 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/VirtualMachine' VirtualMachineVolumeSnapshotResponse: allOf: - $ref: '#/components/schemas/PageInfo' - 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/VirtualMachineVolumeSnapshot' VolumePost: allOf: - $ref: '#/components/schemas/_volumePostBase' - type: object properties: workload: $ref: '#/components/schemas/_workloadConfigurationReferencePost' VolumePatch: allOf: - $ref: '#/components/schemas/_destroyedPatchPost' - $ref: '#/components/schemas/_newName' - type: object properties: pod: description: Moves the volume into the specified pod. title: Reference allOf: - $ref: '#/components/schemas/_reference' priority_adjustment: description: Adjusts volume priority. title: PriorityAdjustment allOf: - $ref: '#/components/schemas/_priorityAdjustment' protocol_endpoint: description: | Sets the properties that are specific to protocol endpoints. This can only be used in conjunction to `subtype=protocol_endpoint`. title: Protocol_endpoint allOf: - $ref: '#/components/schemas/_protocol_endpoint' provisioned: description: "Updates the virtual size of the volume, measured in bytes." type: integer format: int64 maximum: 4503599627370496 qos: description: Sets QoS limits. title: Qos_patch allOf: - $ref: '#/components/schemas/_qos_patch' requested_promotion_state: description: | Valid values are `promoted` and `demoted`. Patch `requested_promotion_state` to `demoted` to demote the volume so that the volume stops accepting write requests. Patch `requested_promotion_state` to `promoted` to promote the volume so that the volume starts accepting write requests. type: string volume_group: description: Adds the volume to the specified volume group. title: Reference allOf: - $ref: '#/components/schemas/_reference' workload: $ref: '#/components/schemas/_workloadConfigurationReferencePatch' VolumeGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/VolumeResponse' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: total: description: | The aggregate value of all items after filtering. If applicable, the average value is displayed instead. If applicable, the values are displayed for each field. type: array items: $ref: '#/components/schemas/Volume' VolumeResponse: type: object properties: items: description: | Displays a list of all items after filtering. If applicable, the values are displayed for each name. If `total_only=true`, the `items` list is empty. type: array items: $ref: '#/components/schemas/Volume' VolumeBatchPost: allOf: - $ref: '#/components/schemas/_volumePostBase' - type: object properties: add_to_protection_groups: description: | Specifies a list of protection groups that will compose the initial protection for the volume. type: array items: $ref: '#/components/schemas/_reference' name: description: | Specifies the name of the volume. type: string VolumesBatchResponse: type: object properties: items: description: | Displays a list of all items. If applicable, the values are displayed for each name. type: array items: $ref: '#/components/schemas/Volume' VolumesDiffGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/VolumesDiffResponse' - $ref: '#/components/schemas/_errorContextResponse' ResourcePerformanceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: | Performance data. If `total_only=true`, the `items` list will be empty. type: array items: $ref: '#/components/schemas/ResourcePerformance' total: description: | The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each field where meaningful. type: array items: $ref: '#/components/schemas/ResourcePerformance' ResourcePerformanceByArrayGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: | Performance data, broken down by array. If `total_only=true`, the `items` list will be empty. type: array items: $ref: '#/components/schemas/ResourcePerformanceByArray' total: description: | The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each field where meaningful. type: array items: $ref: '#/components/schemas/ResourcePerformanceByArray' VolumeQosGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: | QoS configuration data. type: array items: $ref: '#/components/schemas/QosMetricsCeilings' VolumeSpaceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: | Displays a list of all items after filtering. If applicable, the values are displayed for each name. If `total_only=true`, the `items` list will be empty. type: array items: $ref: '#/components/schemas/VolumeSpace' total: description: | The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. If applicable, the values are displayed for each field. type: array items: $ref: '#/components/schemas/VolumeSpace' VolumeGroupPost: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_resource' - description: | Volume groups organize FlashArray volumes into logical groupings. type: object properties: destroyed: description: | If set to `true`, destroys a volume group. If set to `false`, recovers a destroyed volume group. If not specified, defaults to `false`. type: boolean readOnly: true priority_adjustment: $ref: '#/components/schemas/_priorityAdjustment' qos: $ref: '#/components/schemas/_qos' space: title: Space allOf: - $ref: '#/components/schemas/_space' tags: description: | The list of tags to be upserted with the object. type: array items: $ref: '#/components/schemas/Tag' time_remaining: description: | The amount of time left until the destroyed volume group is permanently eradicated, measured in milliseconds. type: integer format: int64 readOnly: true volume_count: description: | The number of volumes in the volume group. type: integer format: int64 readOnly: true example: 3 VolumeGroupPatch: allOf: - $ref: '#/components/schemas/_resource' - description: | Volume groups organize FlashArray volumes into logical groupings. type: object properties: destroyed: description: | Returns a value of `true` if the volume group has been destroyed and is pending eradication. Before the `time_remaining` period has elapsed, the destroyed volume group can be recovered by setting `destroyed=false`. After the `time_remaining` period has elapsed, the volume group is permanently eradicated and cannot be recovered. type: boolean priority_adjustment: $ref: '#/components/schemas/_priorityAdjustment' qos: $ref: '#/components/schemas/_qos_patch' space: title: Space allOf: - $ref: '#/components/schemas/_space' VolumeGroupGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/VolumeGroupResponse' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: total: description: | The aggregate value of all items after filtering. Where meaningful, the average value is displayed instead. If applicable, the values are displayed for each field. type: array items: $ref: '#/components/schemas/VolumeGroup' VolumeGroupResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/VolumeGroup' VolumeGroupQosGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: | QoS configuration data. type: array items: $ref: '#/components/schemas/QosMetricsCeilings' VolumeSnapshotPost: allOf: - $ref: '#/components/schemas/_destroyedPatchPost' - type: object properties: suffix: description: | The suffix that is appended to the `source_name` value to generate the full volume snapshot name in the form `VOL.SUFFIX`. If the suffix is not specified, the system constructs the snapshot name in the form `VOL.NNN`, where `VOL` is the volume name, and `NNN` is a monotonically increasing number. type: string tags: description: | The list of tags to be upserted with the object. type: array items: $ref: '#/components/schemas/Tag' VolumeSnapshotPatch: allOf: - $ref: '#/components/schemas/_destroyedPatchPost' - $ref: '#/components/schemas/_newName' VolumeSnapshotGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/VolumeSnapshotResponse' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: total: description: | The aggregate value of all items after filtering. Where meaningful, the average value is displayed instead. If applicable, the values are displayed for each field. type: array items: $ref: '#/components/schemas/VolumeSnapshot' VolumeSnapshotResponse: type: object properties: items: description: | Displays a list of all items after filtering. If applicable, the values are displayed for each name. If `total_only=true`, the `items` list will be empty. type: array items: $ref: '#/components/schemas/VolumeSnapshot' VolumeSnapshotBatchPost: allOf: - $ref: '#/components/schemas/VolumeSnapshotPost' - type: object properties: source_id: description: | Specifies the Id of the source volume. type: string source_name: description: | Specifies the name of the source volume. type: string VolumeSnapshotBatchResponse: 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/VolumeSnapshot' VolumeSnapshotTransferGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/VolumeSnapshotTransferResponse' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: total: description: | The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each field where meaningful. type: array items: $ref: '#/components/schemas/VolumeSnapshotTransfer' TestResultWithResourcePostResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/TestResultWithResource' WorkloadPost: type: object properties: parameters: description: | The parameter values to pass to the preset when creating the workload. Value must be supplied for all parameters that do not have a default defined in the preset. type: array items: $ref: '#/components/schemas/_workloadParameter' WorkloadPatch: allOf: - $ref: '#/components/schemas/_destroyedPatchPost' - $ref: '#/components/schemas/_newName' WorkloadGetResponse: allOf: - $ref: '#/components/schemas/PageInfoWithoutTotalItemCountResponse' - $ref: '#/components/schemas/WorkloadResponse' - $ref: '#/components/schemas/_errorContextResponse' WorkloadResponse: 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/Workload' WorkloadPlacementRecommendation: allOf: - $ref: '#/components/schemas/_context' - description: | A workload placement recommendation. type: object properties: additional_constraints: $ref: '#/components/schemas/_workloadPlacementRecommendationAdditionalConstraints' created: description: | The time the recommendation was made, measured in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true expires: description: | The time when recommendation expires, measured in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true id: description: | A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource. type: string readOnly: true more_results_available: type: boolean readOnly: true name: description: | A globally unique, system-generated name. The name cannot be modified and cannot refer to another resource. type: string readOnly: true parameters: description: | The parameter values to pass to the preset when creating the recommendation. A value is required for all parameters that are not of the resource_reference type. Parameters of type resource_reference could be: set to a fixed value, or defined as a set of allowed values, or not set. If a resource_reference parameter is not set then allowed values will be taken from the preset definition. type: array items: $ref: '#/components/schemas/_workloadPlacementRecommendationParameter' placement_names: type: array readOnly: true items: type: string preset: title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' progress: description: | The percentage progress of the recommendation computation. The percentage is displayed as a decimal value, starting at 0.00 and ending at 1.00. type: number format: float readOnly: true example: 0.77 projection_months: description: | The number of months to compute the projections. If not specified, defaults to 1 month. type: integer format: int32 x-minimum: 1 x-maximum: 12 recommendation_engine: description: | This parameter defines which engine to use for recommendations. Possible values include `pure1`, `local`, and `best-available`. If not specified, defaults to `best-available` which may mix results of different engines, while `pure1` and `local` restrict the used engine. type: string results: description: | The results of the recommendation. type: array readOnly: true items: $ref: '#/components/schemas/_workloadPlacementRecommendationResult' results_limit: description: | The maximum number of results to return. If not specified, defaults to 10 results. type: integer format: int32 status: description: | The status of the recommendation. Possible values are `processing`, `completed`, and `failed`. type: string readOnly: true WorkloadPlacementRecommendationGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/WorkloadPlacementRecommendationResponse' WorkloadPlacementRecommendationResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/WorkloadPlacementRecommendation' _api_versions: description: A list of supported API versions. type: array items: type: string example: - "1.0" - "1.1" - "1.2" - "1.3" - "1.4" - "1.5" - "1.6" - "1.7" - "1.8" - "1.9" - "1.10" - "1.11" - "1.12" - "1.13" - "1.14" - "1.15" - "1.16" - "1.17" - "2.0" Username: type: object properties: username: description: The username of the user. type: string example: pureuser _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 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 ActiveDirectory: allOf: - $ref: '#/components/schemas/_builtInResourceNoId' - $ref: '#/components/schemas/_serverReference' - type: object properties: computer_name: description: | The name of the computer account in the Active Directory domain. type: string readOnly: true example: FLASHARRAY01 directory_servers: description: | A list of directory servers used for lookups related to user authorization. Servers must be specified in FQDN format. All specified servers must be registered to the domain appropriately in the configured DNS of the array and are only communicated with over the secure LDAP (LDAPS) protocol. If this field is `null`, the servers are resolved for the domain in DNS. type: array readOnly: true items: type: string example: ldap.my-corporation.com domain: description: The Active Directory domain joined. type: string readOnly: true example: my-corporation.com kerberos_servers: description: | A list of key distribution servers to use for Kerberos protocol. Servers must be specified in FQDN format. All specified servers must be registered to the domain appropriately in the configured DNS of the array. If this field is `null`, the servers are resolved for the domain in DNS. type: array readOnly: true items: type: string example: kdc.my-corporation.com sources: description: | List of network interfaces used for egress. For directory services at the array level, this list can be empty. If the list is empty, the system will use VIFs with the "ds" service (or if none, the "management" service) for egress. type: array items: $ref: '#/components/schemas/_referenceWithType' tls: description: | TLS mode for communication with domain controllers. Valid values are `required` and `optional`. `required` forces TLS communication with domain controller. `optional` allows the use of non-TLS communication, TLS will still be preferred, if available. If not specified, defaults to `required`. type: string example: required _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' 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' _adminRole: allOf: - $ref: '#/components/schemas/_referenceNoId' - description: | This field has been deprecated. Predecessor to management access policies. type: object _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 Admin: allOf: - $ref: '#/components/schemas/_fixedNameResourceNoId' - description: Administrator account. type: object properties: admin_type: description: | The type of administrative account. A value of `local-user` indicates the account is managed directly on the array, while `remote-user` indicates the account is provisioned by an external system such as `LDAP` or `SAML`. type: string readOnly: true example: local-user api_token: $ref: '#/components/schemas/_apiToken' authorization_model: description: | The source of the access policy mapping. A value of `static` indicates that policies are configured locally on the array, while a value of `dynamic` indicates that they are determined by an external system such as `LDAP` or an `IdP`. type: string example: static is_local: description: | Returns a value of `true` if the user is local to the machine. type: boolean readOnly: true example: true locked: description: | Returns a value of `true` if the user is currently locked out. otherwise `false`. Change to `false` to unlock a user. This field is only visible to `array_admin` roles. For all other users, the value is always `null`. type: boolean example: false lockout_remaining: description: | The remaining lockout period if the user is locked out, in milliseconds. This field is only visible to `array_admin` roles. For all other users, the value is always `null`. type: integer format: int64 readOnly: true management_access_policies: description: | List of management access policies associated with the administrator. type: array items: $ref: '#/components/schemas/_referenceWithType' password: description: | Password associated with the account. type: string public_key: description: | Public key for SSH access. Multiple public keys can be specified, separated by newlines. type: string role: $ref: '#/components/schemas/_adminRole' PolicyAssignmentPostPolicy: type: object properties: policy: description: | Reference to the policy to apply to the resource. title: Reference allOf: - $ref: '#/components/schemas/_reference' 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' AdminApiToken: allOf: - $ref: '#/components/schemas/_fixedNameResourceNoId' - description: Administrative account API token. type: object properties: api_token: $ref: '#/components/schemas/_apiToken' AdminCache: allOf: - $ref: '#/components/schemas/_fixedNameResourceNoId' - description: | A cache entry for the admin cache to quickly look up admin roles. type: object properties: authorization_model: description: | The source of the access policy mapping. A value of `static` indicates that policies are configured locally on the array, while a value of `dynamic` indicates that they are determined by an external system such as `LDAP` or an `IdP`. type: string example: static cached_at: description: | Time when the entry was added to the cache, in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true management_access_policies: description: | List of management access policies associated with the administrator. type: array readOnly: true items: $ref: '#/components/schemas/_fixedReferenceWithType' role: title: AdminRole allOf: - $ref: '#/components/schemas/_adminRole' _adminSettingsRequiredAuthenticationMethods: description: | Authentication methods that are required for the array on specific user interfaces. type: object properties: ssh: description: | List of authentication methods that are required for SSH. Possible values include `password`, `key`, and `default`. `securid-am` is a possible value, but it cannot be changed through PATCH. If not specified, defaults to `default`. Specify `password` and `key` authentication methods to set up local multi-factor authentication for SSH. type: array items: type: string description: | Authentication method required for SSH. example: - password - key web_ui: description: | List of authentication methods that are required for the web UI. Possible values include `password`, `webauthn`, and `default`. Other possible values include `saml2` and `securid-am` but these cannot be changed through PATCH. If not specified, defaults to `default`. Specify `password` and `webauthn` authentication methods to set up local multi-factor authentication for web UI. External multi-factor authentication is configured through SAML2 SSO endpoints. type: array items: type: string description: | Authentication method required for the web UI. example: - password - webauthn _builtIn: description: | A built-in resource. Many are singletons predefined by Purity (e.g., support settings). Some correspond to a piece of software, like an app, or hardware, like a controller. Others are created by the system in response to some event (e.g., alerts, audit records). Typically, a user can't create, delete or rename a built-in resource. A few can be created or deleted, but not renamed because the names are meaningful to Purity (e.g., VIFs). type: object properties: id: description: | A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource. type: string readOnly: true name: description: | A locally unique, system-generated name. The name cannot be modified. type: string readOnly: true _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' AlertEventResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/AlertEvent' AlertRulesCatalogResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/AlertRulesCatalog' AlertWatcher: allOf: - $ref: '#/components/schemas/_builtInResourceNoId' - type: object properties: enabled: description: | If set to `true`, email notifications will be sent to this watcher for alerts. If set to `false`, email notification is disabled. type: boolean 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 ApiClient: type: object properties: access_policies: description: | The access policies allowed for ID Tokens issued by this API client. The bearer of an access token will be authorized to perform actions within the intersection of these policies and those of the array user specified as the JWT `sub` (subject) claim. type: array readOnly: true items: $ref: '#/components/schemas/_fixedReferenceWithType' access_token_ttl_in_ms: description: | The requested TTL (Time To Live) length of time for the exchanged access token, measured in milliseconds. type: integer format: int64 readOnly: true example: 15000 x-minimum: 1000 x-maximum: 86400000 enabled: description: | If `true`, the API client is permitted to exchange ID Tokens for access tokens. API clients are disabled by default. type: boolean readOnly: true example: true id: description: | The unique identifier for the associated API client. The ID represents the JWT `aud` (audience) claim in ID Tokens issued for this API client. type: string readOnly: true example: 6207d123-d123-0b5c-5fa1-95fabc5c7123 issuer: description: | The name of the identity provider that will be issuing ID Tokens for this API client. This string represents the JWT `iss` (issuer) claim in ID Tokens issued for this API client. type: string readOnly: true example: https://purestorage.idp.okta.com key_id: description: | The unique identifier for the associated public key of this API client. This string must match the JWT `kid` (key ID) claim in ID Tokens issued for this API client. type: string readOnly: true example: 6207d123-d123-0b5c-5fa1-95fabc5c7123 max_role: description: | This field has been deprecated. The maximum Admin Access Policy (previously 'role') allowed for ID Tokens issued by this API client. The bearer of an access token will be authorized to perform actions within the intersection of this policy and that of the array user specified as the JWT `sub` (subject) claim. `max_role` is deprecated in favor of `access_policies`, but remains for backwards compatibility. If a client has exactly one access policy which corresponds to a valid legacy role of the same name, `max_role` will be the name of that policy. Otherwise, it will be null. type: string readOnly: true example: storage_admin name: description: | The API client name. type: string readOnly: true example: NightlyStatsAggregationScript public_key: description: | The API client's PEM formatted (Base64 encoded) RSA public key. type: string readOnly: true example: | -----BEGIN PUBLIC KEY----- MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEArSe6chh1JzME9svOKjU0 eKTm8S23Ok3Vr2bWuPri/YHfLrlnRwWoCt+st0/BebKSJ+fQUWOaLlqpZQKpI8oR gJ9sWmwGibVG8cTuz7XMkskx9bsm/bjIenuB4W+s3g0BCsi9930mfdKgJgFzY69O nLh7d7hAFcmhSJa945PryQZpvJ/U4Ue5F4d+WXgEJ0SoSRaZ6bbeMPhcbMHTzTum 2ZrPBkK5cqPYitaso6BXeAlqNQPw4Kbu4Ugm0CTogrtImkwoonWDDP34XMOq+u7q sNTbJSvDKMTM1RPPrTWCaLiuZkdLVEVesZ9/8+XUMIgBTElwQJDCAQer03MJzqRr 1eCZGgLfDuYqwMG2MFaAX7kgqBwwyqRTd6MxaQxt2nkdfwiXSY71llzEQ23g3T+1 64zjwAL5f+dtu8PkGF7IdU2T8P2Qk9bG9pckwZHWYkBK77BAk5jbmSzsKGZgRb2R 1E+TWDKIaveFhQp251j/C5wkZwMXgjOzN+BOPo+OiLBGUl+jRybWA9f7Vq1MEdf6 SEdLiqYrXcZERkYBMieLXAfdtaztAIb96cUu+OKMSLDk+D0GHkUfm7lEbDK3ew1+ D6z+BnxDyH6oqZzz4lS2kPLBLsc+6pdTGuKLf0S9YuLiqJe659AdwU8+X/3KtwNd FVJSaxdFbWx0nj3hJqFkIO8CAwEAAQ== -----END PUBLIC KEY----- x-readOnly: true _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 AppNodeResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/AppNode' _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 Eradication_config: description: The configuration of eradication feature. type: object properties: disabled_delay: description: | The eradication delay in milliseconds for destroyed objects that cannot be manually eradicated. Destroyed objects that cannot be manually eradicated will be automatically eradicated after the configured delay time passes. Valid values are `86400000` and any multiple of `86400000` in the range of `86400000` and `2592000000`. Any other values are rounded down to the nearest multiple of `86400000`. type: integer format: int64 example: 86400000 enabled_delay: description: | The eradication delay in milliseconds for destroyed objects that can be manually eradicated. Destroyed objects that can be manually eradicated will be automatically eradicated after the configured delay time passes. Valid values are `86400000` and any multiple of `86400000` in the range of `86400000` and `2592000000`. Any other values are rounded down to the nearest multiple of `86400000`. type: integer format: int64 example: 86400000 eradication_delay: description: | Eradication delay in milliseconds for all destroyed objects. Automatically eradicate destroyed objects after the configured delay time passes. Updating this field will update both `eradication_disabled_delay` and `eradication_enabled_delay` if both `eradication_disabled_delay` and `eradication_enabled_delay` have the same value. If `eradication_disabled_delay` and `eradication_enabled_delay` have different values, trying to configure `eradication_delay` will result in an error. This field has been deprecated and will be removed in a future REST version. Valid values are `86400000` and any multiple of `86400000` in the range of `86400000` and `2592000000`. Any other values are rounded down to the nearest multiple of `86400000`. type: integer format: int64 example: 86400000 manual_eradication: description: | Manual eradication status applied on the array level. If status is `all-disabled`, you cannot eradicate objects, files, and directories. If at least one local object has `manual_eradication` disabled, then the status will be `partially-disabled`. Values include `all-disabled`, `partially-disabled`, and `all-enabled`. If the user does not have sufficient access, this field will return `null`. type: string readOnly: true example: all-disabled ArrayEncryption: description: "If the user does not have sufficient access, all fields will return `null`." type: object properties: data_at_rest: title: ArrayencryptionDataAtRest allOf: - $ref: '#/components/schemas/_arrayencryptionDataAtRest' module_version: description: | The version of the Purity encryption module installed on the array. Security certifications are carried out on a per-version basis. On non-encrypt builds, an encryption module may be installed without being enabled. Values include `FA-1.0`, `FA-1.1`, `FA-1.2`, `FA-1.3`, and so on. type: string readOnly: true example: FA-1.3 x-readOnly: true Space: description: "If the user does not have sufficient access, all fields will return `null`." allOf: - $ref: '#/components/schemas/_space' - type: object properties: replication: description: | The sum of replication space consumed by all pods on this array. type: integer format: int64 minimum: 0 readOnly: true shared_effective: description: | This field has been deprecated. It will return `null`. Use the `shared` field in the future, as it contains the same information for Evergreen//One arrays. type: integer format: int64 minimum: 0 readOnly: true snapshots_effective: description: | This field has deprecated. It will return `null`. Use the `snapshots` field in the future, as it contains the same information for Evergreen//One arrays. type: integer format: int64 minimum: 0 readOnly: true total_effective: description: | This field has been deprecated. It will return `null`. PUse the `total_physical` field instead, as it contains the same information for Evergreen//One arrays. type: integer format: int64 minimum: 0 readOnly: true unique_effective: description: | This field has been deprecated. It will return `null`. Use the `unique` field in the future, as it contains the same information for Evergreen//One arrays. type: integer format: int64 minimum: 0 readOnly: true Cache: allOf: - $ref: '#/components/schemas/_builtIn' - description: The DIMM cache status. type: object readOnly: true properties: cache_type: description: The cache type. type: string example: DRAM space: $ref: '#/components/schemas/_cacheSpace' status: description: The cache status. type: string example: healthy CloudConfigAutomaticCapacityUpgradePatch: type: object properties: enabled: description: | Indicates if the automatic capacity upgrade is enabled. type: boolean example: true max_capacity: description: | The maximum capacity for the automatic upgrade in bytes. type: integer format: int64 example: 30786325577728 CloudConfigModelPatch: type: object properties: add_override_checks: description: | A list of upgrade checks to be overridden. type: array items: type: string example: - HostIOCheck - HostPathsCheck requested: description: | A supported model for the CBS array. type: string example: CBS-V20MP2R2 CloudConfig: type: object properties: automatic_capacity_upgrade: description: | Automatic capacity upgrade configuration of the CBS array. title: CloudConfigAutomaticCapacityUpgrade allOf: - $ref: '#/components/schemas/CloudConfigAutomaticCapacityUpgrade' id: description: | A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource. type: string example: 0f58952a-35e4-7457-b1dd-23454257a1f1 model: description: The model configuration of the CBS array. title: CloudConfigModel allOf: - $ref: '#/components/schemas/CloudConfigModel' name: description: | A locally unique, system-generated name. The name cannot be modified. type: string example: string CloudConfigSupported: type: object properties: supported_models: description: List of supported models for an upgrade. type: array items: type: string description: A supported model for the CBS array. example: CBS-V20MP2R2 CloudCapacityStep: type: object properties: supported_capacity: description: | A possible supported raw capacity of the CBS array in bytes. type: integer format: int64 example: 10995116277760 ArrayErasure: allOf: - $ref: '#/components/schemas/_resource' - description: | Status and detailed information of the factory reset process. type: object properties: details: description: | The detailed reason of the `status`. type: string image_download_progress: description: | The progress of the ISO image download, displayed in decimal format. type: number format: float example: 0.32 image_source: description: | Source of the ISO image to download. Valid values include `auto` and URLs. `auto` means download the image from Pure1 cloud, and a URL means download the image from the specified URL. type: string example: auto image_version: description: | Version of the image to download and install. type: string example: 6.6.6 sanitization_certificate: description: | The sanitization certificate of the factory reset, which complies with the standard described in NIST SP800-88R1 section 4.8. type: string status: description: | The status of the factory reset process. Valid values include `resetting`, `reset_failed`, `reimage_failed`, `waiting_for_finalize`, `downloading`, `downloaded`, and `download_failed`. A status of `resetting` indicates that the factory reset is running. A status of `reset_failed` indicates that the factory reset encountered a failure. A status of `reimage_failed` indicates that the factory reset failed to reimage the array. A status of `waiting_for_finalize` indicates that the factory reset has finished sanitizing drives, and is waiting to be finalized. A status of `downloading` indicates that the factory reset is downloading ISO image. A status of `downloaded` indicates that the factory reset completed ISO image download. A status of `download_failed` indicates that the factory reset failed to download ISO image. type: string example: resetting _eula_signature: type: object properties: accepted: description: Accepted time in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true example: 1577880000000 company: description: | The company of the person who accepted the End User Agreement. This field is deprecated and the response will be `null`. Modification to this field will be ignored. type: string example: Example Inc. name: description: | The name of the person who accepted the End User Agreement. This field is deprecated and the response will be `null`. Modification to this field will be ignored. type: string example: John Doe title: description: | The title of the person who accepted the End User Agreement. This field is deprecated and the response will be `null`. Modification to this field will be ignored. type: string example: Admin ArrayFactoryResetToken: allOf: - $ref: '#/components/schemas/_resource' - description: |+ A token that is required to perform a factory reset of the array. A factory reset of the array permanently eradicates all data and deletes all configurations, restoring the state of the array to the original manufacturer settings. type: object properties: token: description: | A random number required as input to perform a factory reset of the array. type: integer format: int64 readOnly: true example: 4671919 TestResultResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/TestResult' ArrayPerformance: allOf: - $ref: '#/components/schemas/_performance' - $ref: '#/components/schemas/_performance_others' - $ref: '#/components/schemas/_builtIn' - type: object properties: local_queue_usec_per_op: description: | Deprecated. The number displayed here may not be accurate and in later versions of the product this field will always display `null`. Instead, use `queue_usec_per_mirrored_write_op`, `queue_usec_per_read_op`, and `queue_usec_per_write_op` fields to measure IO queuing. type: integer format: int64 minimum: 0 readOnly: true queue_depth: description: | Deprecated. The number displayed here may not be accurate and in later versions of the product this field will always display `null`. Instead, use `queue_usec_per_mirrored_write_op`, `queue_usec_per_read_op`, and `queue_usec_per_write_op` fields to measure IO queuing. type: integer format: int64 minimum: 0 readOnly: true x-readOnly: true ArrayPerformanceByLinkResponse: type: object properties: items: description: | Array-level front-end I/O performance metrics grouped by link. A link represents a set of arrays that an I/O operation depends on. type: array items: $ref: '#/components/schemas/ArrayPerformanceByLink' ArraySpace: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_context' - type: object properties: capacity: description: | Currently entitled usable capacity. type: integer format: int64 readOnly: true example: 10995116277760 capacity_installed: description: | Usable capacity of the array if entitled to full capacity for all drives. type: integer format: int64 example: 46179488366592 parity: description: | A representation of data redundancy on the array. Data redundancy is rebuilt automatically by the system whenever parity is less than 1.0. type: number format: float readOnly: true example: 0.99 space: title: Space allOf: - $ref: '#/components/schemas/Space' time: type: integer format: int64 readOnly: true _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 _throttle_deprecated: type: object properties: default_limit: description: | Deprecated. Default maximum bandwidth threshold for outbound traffic in bytes. Once exceeded, bandwidth throttling occurs. type: integer format: int64 example: 1073741824 window: description: Deprecated. The time during which the `window_limit` threshold is in effect. title: Time_window allOf: - $ref: '#/components/schemas/_time_window' window_limit: description: | Deprecated. Maximum bandwidth threshold for outbound traffic during the specified `window_limit` time range in bytes. Once exceeded, bandwidth throttling occurs. type: integer format: int64 example: 2097152 _throttle: description: | The bandwidth throttling for an array connection. Configurable on PATCH only. type: object properties: default_limit: description: | Default maximum bandwidth threshold for outbound traffic in bytes. Once exceeded, bandwidth throttling occurs. type: integer format: int64 example: 1073741824 window: description: The time during which the `window_limit` threshold is in effect. title: Time_window allOf: - $ref: '#/components/schemas/_time_window' window_limit: description: | Maximum bandwidth threshold for outbound traffic during the specified `window_limit` time range in bytes. Once exceeded, bandwidth throttling occurs. type: integer format: int64 example: 2097152 ArrayConnection: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_context' - description: | Connection to a target array. The `name` and `id` values refer to the name and ID of the target array. type: object properties: encryption: description: | If `encrypted`, all traffic over this array connection will be encrypted. If `unencrypted`, all traffic over this array connection will be unencrypted. type: string example: encrypted encryption_mode: description: | Cryptographic protocol, trust model, and encryption algorithm information. Will be `null` if `encrypted` is `false`. type: string example: TLS-PSK-AES-256 management_address: description: | Management IP address or FQDN of the target array. type: string example: 10.202.101.78 os: description: | The operating system of the connected array. type: string readOnly: true remote: description: | The remote array. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' replication_addresses: description: | IP addresses of the target arrays when `replication_transport` is `ip`. WWNs of the target arrays when `replication_transport` is `fc`. type: array items: type: string example: 10.202.101.70 replication_transport: description: | The protocol used to transport data between the local array and the remote array. Valid values are `ip` and `fc`. The default value is `ip`. type: string example: ip status: description: | Status of the connection. Valid values include `connected`, `connecting`, `partially_connected`, and `unbalanced`. A status of `connected` indicates that arrays are communicating. A status of `connecting` indicates that the array is trying to establish a connection. A status of `partially_connected` indicates that some replication addresses are communicating but others are not. A status of `unbalanced` indicates that the arrays are communicating, but the set of paths is either not redundant or not symmetrical. type: string throttle: $ref: '#/components/schemas/_throttle' type: description: | The type of connection. Valid values include `async-replication`, `sync-replication`, and `fleet-management`. type: string version: description: The Purity version on the target array. type: string example: 5.0.0 ArrayConnectionKey: type: object properties: connection_key: description: | Connection-key used on another array to connect to this array. type: string readOnly: true example: 6207d123-d123-0b5c-5fa1-95fabc5c7123 ArrayConnectionPathResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/ArrayConnectionPath' AuditResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Audit' Bucket: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_bucketBase' - type: object description: | The bucket in the object store. A bucket is a container for objects. properties: space: description: The size and space consumption details. title: Space allOf: - $ref: '#/components/schemas/_space' ResourceBucketSpace: allOf: - $ref: '#/components/schemas/ResourceSpace' - type: object properties: account: $ref: '#/components/schemas/_fixedReferenceWithType' object_count: description: The count of objects within the bucket. type: integer format: int64 readOnly: true example: 42 BucketPerformance: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_bucketPerformanceBase' _certificateBase: description: SSL certificate managed by Purity. type: object properties: certificate: description: | The text of the certificate. type: string certificate_type: description: | The type of certificate. Values include `appliance` and `external`. Certificates of type `appliance` are used by the array to verify its identity to clients. Certificates of type `external` are used by the array to identify external servers to which it is configured to communicate. type: string readOnly: true common_name: description: | The common name field listed in the certificate. type: string example: Pure Storage Inc. country: description: | Two-letter country (ISO) code listed in the certificate. type: string example: CA email: description: | The email field listed in the certificate. type: string example: tcrisp@veridiandynamics.com intermediate_certificate: description: | The text of the intermediate certificate chains. type: string issued_by: description: | The party that issued the certificate. type: string readOnly: true example: "Symantec, Inc." issued_to: description: | The party to whom the certificate is issued. type: string readOnly: true example: "Pure Storage, Inc." key_algorithm: description: | The key algorithm used to generate the certificate. This field can only be specified when creating a new self-signed certificate. Defaults to rsa if not specified. Valid values when creating a new self-signed certificate only include `rsa`, `ec`, `ed448` and `ed25519`. type: string example: rsa key_size: description: | The size (in bits) of the private key for the certificate. Default is 2048 bits for `rsa` key_algorithm, 256 for `ec` and `ed25519`. The `ed448` default key size is 456. This field can only be specified when creating a new self-signed certificate. type: integer format: int32 example: 2048 locality: description: | The locality field listed in the certificate. type: string example: Toronto organization: description: | The organization field listed in the certificate. type: string example: Veridian Dynamics organizational_unit: description: | The organizational unit field listed in the certificate. type: string example: Research & Development state: description: | The state/province field listed in the certificate. type: string example: Ontario status: description: | The type of certificate. Valid values are `self-signed` and `imported`. type: string readOnly: true subject_alternative_names: description: | The alternative names that are secured by this certificate. Alternative names may be IP addresses, DNS names, or URIs. type: array items: type: string example: otherdnsname.mydomain.com valid_from: description: | The date when the certificate starts being valid. type: integer format: int64 readOnly: true example: 1491070899 valid_to: description: | The date when the certificate stops being valid. type: integer format: int64 readOnly: true example: 1524248499 Certificate: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_certificateBase' - type: object _memberWithType: type: object properties: group: $ref: '#/components/schemas/_referenceWithType' member: $ref: '#/components/schemas/_referenceWithType' CertificateUse: allOf: - $ref: '#/components/schemas/_builtIn' - type: object properties: group: description: | A reference to the certificate group that is being used, if any, where this certificate is a member of the certificate-group. Returns `null` if the referenced user object is not associated with a group and is directly using this certificate. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' use: description: A reference to an object using this certificate. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' CertificateGroup: allOf: - $ref: '#/components/schemas/_builtIn' CertificateGroupUse: allOf: - $ref: '#/components/schemas/_builtIn' - type: object properties: use: description: | A reference to an object using this certificate group. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' _referenceNoId: type: object properties: name: description: | The resource name, such as volume name, pod name, snapshot name, and so on. type: string CertificateSigningRequest: description: | SSL certificate managed by Purity//FA. type: object properties: certificate_signing_request: description: | The text of a new certificate signing request. type: string Connection: allOf: - $ref: '#/components/schemas/_context' - type: object properties: host: description: The host computer that sends and receives I/O requests to and from volumes on the FlashArray array. title: ReferenceNoId allOf: - $ref: '#/components/schemas/_referenceNoId' host_group: description: A virtual collection of hosts with common connectivity to volumes. title: ReferenceNoId allOf: - $ref: '#/components/schemas/_referenceNoId' lun: description: | The logical unit number (LUN) by which the specified hosts are to address the specified volume. A LUN is set for SCSI connections only. A LUN can be in one of two formats: a simple LUN, or a LUN and Sublun with virtual volumes. The first format is simply the LUN. The second format is a single int64 combining both ((LUN << 32) + Sublun) or (LUN * 4294967296 + Sublun). In the FA UI, a combined LUN and Sublun is represented as `LUN:Sublun`. The maximum int64 LUN:Sublun value is `17587891081215`. type: integer format: int64 example: 7 nsid: description: | Namespace identifier allocated for the NVMe namespace backing the volume. NSID is set for NVMe connections only. type: integer format: int64 example: 3856 protocol_endpoint: description: "A protocol endpoint (also known as a conglomerate volume) which acts as a proxy through which virtual volumes are created and then connected to VMware ESXi hosts or host groups. The protocol endpoint itself does not serve I/Os; instead, its job is to form connections between FlashArray volumes and ESXi hosts and host groups." title: Reference allOf: - $ref: '#/components/schemas/_reference' volume: description: A container that manages the storage space on the array. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' _default_protection_reference: allOf: - $ref: '#/components/schemas/_reference' - type: object properties: type: description: | The type of default protection. Currently, the only valid values are `protection_group` and `snapshot_policy`. type: string example: protection_group Controller: allOf: - $ref: '#/components/schemas/_builtInResourceNoId' - type: object properties: mode: description: | Mode of controller. Values include `not present`, `offline`, `primary`, and `secondary`. type: string readOnly: true example: primary mode_since: description: | The time at which the current mode of the controller was last set. It is measured in milliseconds since the UNIX epoch. If the controller mode is `not present` or `offline`, this field will be null. type: integer format: int64 readOnly: true example: 1687086901996 model: type: string readOnly: true example: FA-m50 status: description: | Status of controller. Values include `not ready`, `ready`, `unknown`, and `updating`. type: string readOnly: true example: ready type: description: | Type of controller. Values include `array_controller` and `shelf_controller`. type: string readOnly: true version: type: string readOnly: true example: 5.0.0 _workloadConfigurationReferencePost: type: object description: | The workload to which the resource is added. Set one of `id` or `name`, and `configuration` to add the resource to the workload and configure it based on the `configuration` from the preset revision the workload was originally provisioned from. allOf: - $ref: '#/components/schemas/_referenceWithFixedType' - type: object properties: configuration: description: | The name of the preset configuration object. type: string _newName: type: object properties: name: description: The new name for the resource. type: string _workloadConfigurationReferencePatch: type: object description: | The instruction for removing the resource from the workload. Setting the `id` or `name` of the workload to an empty string (`""`) removes the resource. allOf: - $ref: '#/components/schemas/_referenceWithFixedType' Directory: allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_context' - type: object properties: created: description: | The managed directory creation time, measured in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true destroyed: description: | Returns a value of `true` if the managed directory has been destroyed and is pending eradication. The `time_remaining` value displays the amount of time left until the destroyed managed directory is permanently eradicated. Once the `time_remaining` period has elapsed, the managed directory is permanently eradicated and can no longer be recovered. type: boolean directory_name: description: | The managed directory name without the file system name prefix. A full managed directory name is constructed in the form of `FILE_SYSTEM:DIR` where `FILE_SYSTEM` is the file system name and `DIR` is the value of this field. type: string readOnly: true file_system: description: | The file system that this managed directory is in. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' limited_by: description: | The quota policy that is limiting usage on this managed directory. This policy defines the total amount of space provisioned to this managed directory and its descendants. The returned value contains two parts: the name of the policy and the managed directory to which the policy is attached. title: LimitedBy allOf: - $ref: '#/components/schemas/_limitedBy' path: description: | Absolute path of the managed directory in the file system. type: string readOnly: true space: description: | Displays size and space consumption details. title: Space allOf: - $ref: '#/components/schemas/_space' time_remaining: description: | The amount of time left, measured in milliseconds until the destroyed managed directory is permanently eradicated. type: integer format: int64 readOnly: true workload: $ref: '#/components/schemas/_workloadConfigurationReference' DirectoriesGroupsResponse: 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/DirectoryGroup' DirectoryLockNlmReclamation: allOf: - $ref: '#/components/schemas/_context' - type: object properties: end: description: | End time of the NLM reclamation in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true start: description: | Start time of the NLM reclamation in milliseconds since the UNIX epoch. type: integer format: int64 DirectoryPerformance: allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_context' - type: object properties: bytes_per_op: description: | The average I/O size for both read and write (all) operations. type: integer format: int64 minimum: 0 readOnly: true bytes_per_read: description: "The average I/O size per read, measured in bytes." type: integer format: int64 minimum: 0 readOnly: true bytes_per_write: description: "The average I/O size per write, measured in bytes." type: integer format: int64 minimum: 0 readOnly: true others_per_sec: description: The number of other requests processed per second. type: integer format: int64 minimum: 0 readOnly: true read_bytes_per_sec: description: The number of bytes read per second. type: integer format: int64 minimum: 0 readOnly: true reads_per_sec: description: The number of read requests processed per second. type: integer format: int64 minimum: 0 readOnly: true time: description: | The time when the sample performance data was taken. Measured in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true usec_per_other_op: description: | The average time it takes the array to process an I/O other request, measured in microseconds. type: integer format: int64 minimum: 0 readOnly: true usec_per_read_op: description: | The average time it takes the array to process an I/O read request, measured in microseconds. type: integer format: int64 minimum: 0 readOnly: true usec_per_write_op: description: | The average time it takes the array to process an I/O write request, measured in microseconds. type: integer format: int64 minimum: 0 readOnly: true write_bytes_per_sec: description: The number of bytes written per second. type: integer format: int64 minimum: 0 readOnly: true writes_per_sec: description: The number of write requests processed per second. type: integer format: int64 minimum: 0 readOnly: true x-readOnly: true _directorypolicypostPolicies: type: object properties: policy: description: Reference to the policy to apply to the resource. title: Reference allOf: - $ref: '#/components/schemas/_reference' 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 _directorypolicyexportpostPolicies: 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. type: string policy: description: | Reference to the export policy to apply to the directory. title: Reference allOf: - $ref: '#/components/schemas/_reference' server: description: | Server to which the export policy is attached to. title: Reference allOf: - $ref: '#/components/schemas/_reference' PolicyMemberExport: allOf: - $ref: '#/components/schemas/_context' - $ref: '#/components/schemas/PolicyMember' - $ref: '#/components/schemas/ExportPolicyAttachmentMixin' - $ref: '#/components/schemas/_serverReference' ResourceDirectorySpace: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_context' - type: object properties: space: description: | Displays size and space consumption information. title: Space allOf: - $ref: '#/components/schemas/_space' time: description: | The timestamp of when the data was taken, measured in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true x-readOnly: true DirectoriesUsersResponse: 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/DirectoryUser' DirectoryExport: allOf: - $ref: '#/components/schemas/_context' - $ref: '#/components/schemas/ExportPolicyAttachmentMixin' - $ref: '#/components/schemas/_serverReference' - type: object properties: destroyed: description: | Returns a value of `true` if the managed directory of the export has been destroyed and is pending eradication. The export can be recovered by recovering the destroyed managed directory. type: boolean readOnly: true directory: description: The managed directory of the export. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' enabled: description: | Returns a value of `true` if the export policy that manages this export is enabled. type: boolean readOnly: true export_name: description: The export name for accessing this export. type: string readOnly: true name: description: | Name of the export configuration object. Combines the export containment hierarchy (server), the protocol (SMB or NFS) and the user-visible `export_name`. type: string example: server01::nfs::export01 path: description: | The path of the exported managed directory. type: string readOnly: true policy: description: | The export policy that manages this export. An export can be managed by at most one export policy. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' workload: $ref: '#/components/schemas/_workloadConfigurationFixedReference' DirectoryGroupQuotasResponse: 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/DirectoryGroupQuota' DirectoryQuotasResponse: 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/DirectoryQuota' DirectoryServiceCommon: allOf: - $ref: '#/components/schemas/_context' - description: | Configuration information for the directory service. type: object properties: base_dn: description: | Base of the Distinguished Name (DN) of the directory service groups. type: string example: "DC=mycompany,DC=com" bind_password: description: | Masked password used to query the directory. type: string example: '****' bind_user: description: | Username used to query the directory. type: string example: "CN=John,OU=Users,DC=example,DC=com" enabled: description: | The directory service is either enabled or disabled. type: boolean example: true services: description: | Services for which the directory service configuration is used. type: array readOnly: true items: type: string description: | Valid values are `data` and `management`. example: data example: - data - management uris: description: | List of URIs for the configured directory servers. type: array items: pattern: ^(ldap|ldaps) type: string example: ldaps://ad1.mycompany.com _newFqname: type: object properties: name: description: | The new name for the resource. 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,realm01::name01,realm01::pod01::name01`. type: string _directoryServiceManagement: description: Properties specific to the management service. type: object properties: ssh_public_key_attribute: description: | SSH public key attribute in the structure of the configured LDAP servers. The attribute field that holds the user's SSH public key. This attribute can represent a single-valued or multi-valued field. If this attribute resolves to a multi-valued field, all valid SSH keys will be used. If the user has specified keys under Admin endpoints, these are used as well. type: string example: sshPublicKey user_login_attribute: description: | User login attribute in the structure of the configured LDAP servers. Typically the attribute field that holds the user's unique login name. Default value is `sAMAccountName` for Active Directory or `uid` for all other directory services. type: string example: email user_object_class: description: | Value of the object class for a management LDAP user. Defaults to `User` for Active Directory servers, `posixAccount` or `shadowAccount` for OpenLDAP servers dependent on the group type of the server, or `person` for all other directory servers. type: string example: inetOrgPerson DirectoryService: allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_serverReference' - $ref: '#/components/schemas/DirectoryServiceCommon' - description: Configuration information for the directory service. type: object properties: ca_certificate: description: | The certificate of the Certificate Authority (CA) that signed the directory servers' certificate(s), which is used to validate the authenticity of the configured servers. Deprecated, please use ca_certificate_ref instead. Setting this field will result in ca_certificate_ref being updated to _legacy_ds_ca_certificate_. type: string ca_certificate_ref: description: | Reference (ID, name, and resource type) of the Certificate Authority (CA) that signed the certificates of the directory servers, which is used to validate the authenticity of the configured servers. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' check_peer: description: | Determines whether or not server authenticity is enforced when a certificate is provided. type: boolean example: false management: $ref: '#/components/schemas/_directoryServiceManagement' sources: description: | List of network interfaces used for egress. For directory services at the array level, this list can be empty. If the list is empty, the system will use VIFs with the "ds" service (or if none, the "management" service) for egress. type: array items: $ref: '#/components/schemas/_referenceWithType' _fixedNameResourceNoId: description: | An ordinary (as opposed to built-in) resource that can be created, named, or deleted by the user. This might be a virtual resource (e.g., a volume) or correspond to something in the environment, like a host or server. type: object properties: name: description: | A user-specified name. The name must be locally unique and cannot be changed. type: string readOnly: true _fixedReferenceWithType: allOf: - $ref: '#/components/schemas/_fixedReference' - type: object properties: resource_type: description: | Type of the object (full name of the endpoint). Valid values are the unique part of the resource's REST endpoint. For example, a reference to a file system would have a `resource_type` of `file-systems`. type: string readOnly: true x-aliases: - _fixedReference TestResultWithNoIdResourceMultiserverAware: allOf: - $ref: '#/components/schemas/TestResult' - $ref: '#/components/schemas/_context' - $ref: '#/components/schemas/_realmsReference' - $ref: '#/components/schemas/_serverReference' - type: object properties: resource: description: A reference to the object being tested. title: FixedReferenceNoId allOf: - $ref: '#/components/schemas/_fixedReferenceNoId' _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' LocalGroup: allOf: - $ref: '#/components/schemas/_context' - $ref: '#/components/schemas/_localDirectoryServiceReference' - $ref: '#/components/schemas/_serverReference' - type: object properties: built_in: description: | Returns a value of `true` if the local group is built in. Returns a value of `false` if the group has been created manually. type: boolean readOnly: true email: description: | The email address of the local group. type: string gid: description: | The POSIX user ID of this object (group ID). type: integer format: int32 name: description: | The local group name. type: string sid: description: | The SID (Security Identifier) of the local group. type: string readOnly: true _localgroupmembershippostMembers: type: object properties: member: description: | Reference to the resource that will be a member of the group. The `id` or `name` parameter is required, but cannot be set together. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' member_id: description: The member ID that should be mapped. type: integer format: int32 LocalMember: allOf: - $ref: '#/components/schemas/_context' - $ref: '#/components/schemas/_localDirectoryServiceReference' - $ref: '#/components/schemas/_serverReference' - type: object properties: group: description: | Reference to the group to which the member belongs. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' group_gid: description: | GID of the group to which the member belongs. type: integer format: int32 is_primary_group: description: | When a membership of `member_type` has the value `User`, this specifies whether this membership is a primary-group mapping or not. In any other case, this field will be `false`. type: boolean readOnly: true member: description: | Reference to the member of the group. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' member_id: description: | GID if the `member_type` is `Group` and UID if the `member_type` is `User`. type: integer format: int32 LocalUser: allOf: - $ref: '#/components/schemas/_context' - $ref: '#/components/schemas/_localDirectoryServiceReference' - $ref: '#/components/schemas/_serverReference' - type: object properties: built_in: description: | Returns a value of `true` if the local user is built in. Otherwise returns a value of `false` if the user has been created manually. type: boolean readOnly: true email: description: | The email address of the local user. type: string enabled: description: | Returns a value of `true` if the local user is enabled. type: boolean name: description: | The name of the local user. type: string primary_group: description: | Primary group of the local user. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' sid: description: | The SID (Security Identifier) of the local user. type: string readOnly: true uid: description: | The POSIX user ID of this object (user ID). type: integer format: int32 _localusermembershippostGroups: type: object properties: group: description: | Reference to a group of which the user is a member. The `id` or `name` parameter is required, but cannot be set together. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' group_gid: description: The group GID that should be mapped. type: integer format: int32 DirectorySnapshot: allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_context' - description: A point-in-time image of the contents of the directory. type: object properties: client_name: description: | The customizable portion of the client-visible snapshot name. A full snapshot name is constructed in the form of `DIR.CLIENT_NAME.SUFFIX` where `DIR` is the full managed directory name, `CLIENT_NAME` is the client name, and `SUFFIX` is the suffix. The client-visible snapshot name is `CLIENT_NAME.SUFFIX`. type: string created: description: | The snapshot creation time, measured in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true destroyed: description: | Returns a value of `true` if the snapshot has been destroyed and is pending eradication. The `time_remaining` value displays the amount of time left until the destroyed directory snapshot is permanently eradicated. Before the `time_remaining` period has elapsed, the destroyed directory snapshot can be recovered by setting `destroyed=false`. Once the `time_remaining` period has elapsed, the directory snapshot is permanently eradicated and can no longer be recovered. type: boolean eradication_config: $ref: '#/components/schemas/DirectorySnapshotEradicationConfig' policy: description: | The snapshot policy that manages this snapshot, if applicable. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' source: description: | The directory from which this snapshot was taken. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' space: description: | Displays size and space consumption details. title: Space allOf: - $ref: '#/components/schemas/_space' suffix: description: | The suffix that is appended to the `source_name` value and the `client_name` value to generate the full directory snapshot name in the form of `DIR.CLIENT_NAME.SUFFIX` where `DIR` is the managed directory name, `CLIENT_NAME` is the client name, and `SUFFIX` is the suffix. If the suffix is a string, this field returns `null`. See the `name` value for the full snapshot name including the suffix. type: integer format: int64 time_remaining: description: | The amount of time left until the directory snapshot is permanently eradicated, measured in milliseconds. Before the `time_remaining` period has elapsed, the snapshot can be recovered by setting `destroyed=false` if it is destroyed, by setting `policy=""` if it is managed by a snapshot policy, or by setting `keep_for=""` if it is a manual snapshot. type: integer format: int64 readOnly: true DirectoryUserQuotasResponse: 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/DirectoryUserQuota' Dns: allOf: - $ref: '#/components/schemas/_context' - $ref: '#/components/schemas/_resourceNoId' - $ref: '#/components/schemas/DnsPost' Drive: allOf: - $ref: '#/components/schemas/_builtInResourceNoId' - description: "Information about a flash, NVRAM, or cache module." type: object properties: capacity: description: | Entitled capacity of individual drive in bytes. type: integer format: int64 readOnly: true example: 10000000000000 capacity_installed: description: | Raw capacity of individual drive in bytes. type: integer format: int64 readOnly: true example: 42000000000000 details: description: | Details about the status of the module if not healthy. type: string readOnly: true example: Cache module in wrong bay. protocol: description: | Storage protocol of the module. Valid values are `NVMe` and `SAS`. type: string readOnly: true example: SAS status: description: | Current status of the module. Valid values are `empty`, `failed`, `healthy`, `identifying`, `missing`, `recovering`, `unadmitted`, `unhealthy`, `unrecognized`, and `updating`. type: string readOnly: true example: healthy type: description: | The type of the module. Valid values are `cache`, `NVRAM`, `SSD`, and `virtual`. type: string readOnly: true example: SSD FileSystem: allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_context' - type: object properties: created: description: | The file system creation time, measured in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true destroyed: description: | Returns a value of `true` if the file system has been destroyed and is pending eradication. The `time_remaining` value displays the amount of time left until the destroyed file system is permanently eradicated. Before the `time_remaining` period has elapsed, the destroyed file system can be recovered by setting `destroyed=false`. Once the `time_remaining` period has elapsed, the file system is permanently eradicated and can no longer be recovered. type: boolean eradication_config: title: ContainerEradicationConfig allOf: - $ref: '#/components/schemas/ContainerEradicationConfig' pod: description: | The reference to the pod this file systems belongs to, or `null` if it is not in a pod. title: Reference allOf: - $ref: '#/components/schemas/_reference' time_remaining: description: | The amount of time left, measured in milliseconds until the destroyed file system is permanently eradicated. Before the `time_remaining` period has elapsed, the destroyed file system can be recovered by setting `destroyed=false`. type: integer format: int64 readOnly: true workload: $ref: '#/components/schemas/_workloadConfigurationReference' Fleet: allOf: - $ref: '#/components/schemas/_resource' - type: object properties: is_local: description: | If set to `true`, the current array is a member of the fleet. type: boolean FleetKey: type: object properties: created: description: | Creation time in milliseconds since UNIX epoch. type: integer format: int64 readOnly: true example: 1706850977 expires: description: | Expiration time in milliseconds since UNIX epoch. type: integer format: int64 readOnly: true example: 1706854577 fleet_key: description: | Fleet key, used for fleet connections. After creation, listing will only show ****. type: string readOnly: true example: CAUSJDljMGM3MGY3LWFhZDEtNDRkZC05ZDQ2LTZlOTA3YzY3Yzg1YxokOWMwYzcwZjctYWFkMS00NGRkLTlkND x-readOnly: true _fleetmemberpostMembers: type: object properties: key: description: | Provide the `fleet key` generated from any array in the fleet. type: string member: $ref: '#/components/schemas/_fleetmemberpostMember' x-aliases: - _fleetMemberPostMembers FleetMember: type: object properties: coordinator_of: description: | List of array groups that the member is the coordinator of. type: array items: $ref: '#/components/schemas/_fixedReferenceWithType' fleet: $ref: '#/components/schemas/_fixedReferenceWithTypeAndLocation' member: $ref: '#/components/schemas/_fixedReferenceWithTypeAndLocation' status: description: | Current fleet membership status Valid values are one of `joining`, `joined`, or `removing`. A status of `joining` indicates that the member is attempting to join the fleet. A status of `joined` indicates that the member has joined the fleet. A status of `removing` indicates that the member is being removed from the fleet. type: string status_details: description: | Describes the error, if any. type: string example: cannot reach array Hardware: allOf: - $ref: '#/components/schemas/_builtInResourceNoId' - type: object properties: details: description: | Details about the status of the component if not healthy. type: string readOnly: true example: Temperature too high identify_enabled: description: | If `true`, the ID LED is lit to visually identify the component. type: boolean readOnly: true example: true index: description: | Number that identifies the relative position of a hardware component within the array. type: integer format: int32 readOnly: true example: 1 model: description: | Model number of the hardware component. type: string readOnly: true example: DFSC1 serial: description: | Serial number of the hardware component. type: string readOnly: true example: PSMFL1717009B slot: description: | Slot number occupied by the PCI Express card that hosts the component. type: integer format: int32 readOnly: true example: 16 speed: description: | Speed (in bytes per second) at which the component is operating. type: integer format: int64 readOnly: true example: 24000000000 status: description: | Component status. Values include `critical`, `healthy`, `identifying`, `unhealthy`, `unknown`, and `unused`. type: string readOnly: true example: critical temperature: description: | Temperature (in degrees Celsius) reported by the component. type: integer format: int32 readOnly: true example: 25 type: description: | The type of hardware component. Values include `chassis`, `cooling`, `controller`, `direct_compress_accelerator`, `drive_bay`, `eth_port`, `fc_port`, `ib_port`, `sas_module`, `sas_port`, `storage_shelf`, `temp_sensor`, and `power_supply`. type: string readOnly: true example: controller voltage: description: | Voltage (in Volts) reported by the component. type: integer format: int32 readOnly: true example: 206 _containerQosCeilings: type: object properties: bandwidth_limit: description: | The maximum QoS bandwidth limit for the container. Whenever throughput exceeds the bandwidth limit, throttling occurs. Measured in bytes per second. Maximum limit is 512 GB/s. title: Qos_bw_limit_type allOf: - $ref: '#/components/schemas/_qos_bw_limit_type' iops_limit: description: | The QoS IOPs limit for the container. title: Qos_iops_limit_type allOf: - $ref: '#/components/schemas/_qos_iops_limit_type' _containerQosCeilings_patch: type: object properties: bandwidth_limit: description: | The maximum QoS bandwidth limit for the container, measured in `bytes per second`. Throttling occurs when throughput exceeds this limit. The maximum supported limit is `512 GB/s`. Specifying an empty string `""` unsets the limit. title: ContainerQosCeilingsBandwidthLimitPatch oneOf: - $ref: '#/components/schemas/_qos_bw_limit_type' - $ref: '#/components/schemas/_limit_unset_value' iops_limit: description: | The QoS `IOPS` limit for the container. Specifying an empty string `""` unsets the limit. title: ContainerQosCeilingsIopsLimitPatch oneOf: - $ref: '#/components/schemas/_qos_iops_limit_type' - $ref: '#/components/schemas/_limit_unset_value' HostGroup: allOf: - $ref: '#/components/schemas/_resourceNoId' - $ref: '#/components/schemas/_context' - type: object properties: connection_count: description: The number of volumes connected to the host group. type: integer format: int64 readOnly: true example: 3 destroyed: description: | Returns a value of `true` if the host group has been destroyed with its container realm and is pending eradication. The `time_remaining` value displays the amount of time left until the destroyed host group is permanently eradicated. Before the `time_remaining` period has elapsed, the destroyed host group will be recovered if its container realm is recovered. Once the `time_remaining` period has elapsed, the host group is permanently eradicated and can no longer be recovered. type: boolean readOnly: true host_count: description: The number of hosts in the host group. type: integer format: int64 readOnly: true example: 3 is_local: description: Returns a value of `true` if the host or host group belongs to the current array. Returns a value of `false` if the host or host group belongs to a remote array. type: boolean readOnly: true qos: description: | Displays QoS limit information. title: ContainerQosCeilings allOf: - $ref: '#/components/schemas/_containerQosCeilings' space: description: | Displays provisioned (virtual) size and physical storage consumption information for the sum of all volumes connected to the specified host. title: Space allOf: - $ref: '#/components/schemas/_space' time_remaining: description: | The amount of time left until the destroyed host group is permanently eradicated, measured in milliseconds. type: integer format: int64 readOnly: true MemberNoIdAll: allOf: - $ref: '#/components/schemas/_context' - type: object properties: group: description: "The resource in which the host, volume, or other item in the environment is a member." title: ReferenceNoId allOf: - $ref: '#/components/schemas/_referenceNoId' member: description: The member of the resource. title: ReferenceNoId allOf: - $ref: '#/components/schemas/_referenceNoId' ResourcePerformanceNoId: allOf: - $ref: '#/components/schemas/_performance' - $ref: '#/components/schemas/_performance_others' - $ref: '#/components/schemas/_resourceNoId' - $ref: '#/components/schemas/_context' ResourcePerformanceNoIdByArray: allOf: - $ref: '#/components/schemas/ResourcePerformanceNoId' - $ref: '#/components/schemas/_context' - type: object properties: array: description: | The array on which the performance metrics were recorded. title: Resource allOf: - $ref: '#/components/schemas/_resource' MemberNoIdMember: allOf: - $ref: '#/components/schemas/_context' - type: object properties: group: description: | The resource in which the host, volume, or other item in the environment is a member. title: Reference allOf: - $ref: '#/components/schemas/_reference' member: description: | The member of the resource. title: ReferenceNoId allOf: - $ref: '#/components/schemas/_referenceNoId' QosMetricsCeilings: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_containerQosCeilings' - $ref: '#/components/schemas/_context' - type: object properties: time: description: | The timestamp of when the data was taken, measured in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true x-readOnly: true ResourceSpaceNoId: allOf: - $ref: '#/components/schemas/_builtInResourceNoId' - $ref: '#/components/schemas/_context' - type: object properties: space: description: | Displays size and space consumption information. title: Space allOf: - $ref: '#/components/schemas/_space' time: type: integer format: int64 readOnly: true x-readOnly: true _chap: description: Challenge-Handshake Authentication Protocol (CHAP). type: object properties: host_password: description: | The host password for CHAP authentication. The password must be between 12 and 255 characters (inclusive) and cannot be the same as the target password. type: string host_user: description: The host username for CHAP authentication. type: string target_password: description: | The target password for CHAP authentication. The password must be between 12 and 255 characters (inclusive) and cannot be the same as the host password. type: string target_user: description: The target username for CHAP authentication. type: string Host: allOf: - $ref: '#/components/schemas/_resourceNoId' - $ref: '#/components/schemas/_context' - type: object properties: chap: $ref: '#/components/schemas/_chap' connection_count: description: The number of volumes connected to the specified host. type: integer format: int64 readOnly: true example: 3 destroyed: description: | Returns a value of `true` if the host has been destroyed with its container realm and is pending eradication. The `time_remaining` value displays the amount of time left until the destroyed host is permanently eradicated. Before the `time_remaining` period has elapsed, the destroyed host will be recovered if its container realm is recovered. Once the `time_remaining` period has elapsed, the host is permanently eradicated and can no longer be recovered. type: boolean readOnly: true host_group: description: The host group to which the host should be associated. title: ReferenceNoId allOf: - $ref: '#/components/schemas/_referenceNoId' iqns: description: | The iSCSI qualified name (IQN) associated with the host. type: array items: type: string example: iqn.2010-06.com.purestorage:linux.393d930077be2977 is_local: description: | If set to `true`, the location reference is to the local array. If set to `false`, the location reference is to a remote location, such as a remote array or offload target. type: boolean readOnly: true nqns: description: The NVMe Qualified Name (NQN) associated with the host. type: array items: type: string example: nqn.2010-06.com.purestorage:flasharray.512f7bb185978505 nvme_stretch: description: | The configuration that determines host behavior with stretched volumes, applicable only to `NVMe` hosts. Valid values include `disallow`, `allow`, and `allow-only-with-fleet`. Host operating systems supporting `NVMe` `dispersed namespaces` typically use `allow`, while those without such support use `allow-only-with-fleet` within a fleet or `disallow` otherwise. Changing to or from the `allow-only-with-fleet` mode triggers a disconnect of all `NVMe` connections for the host. The default value is `disallow`. type: string personality: description: | Determines how the system tunes the array to ensure that it works optimally with the host. Set `personality` to the name of the host operating system or virtual memory system. Valid values are `aix`, `esxi`, `hitachi-vsp`, `hpux`, `oracle-vm-server`, `solaris`, `vms`, `nutanix-mgmt` and `nutanix-cluster`. If your system is not listed as one of the valid host personalities, do not set the option. By default, the personality is not set. type: string port_connectivity: $ref: '#/components/schemas/_host_port_connectivity' preferred_arrays: description: | For synchronous replication configurations, sets a host's preferred array to specify which array exposes active/optimized paths to that host. Enter multiple preferred arrays in comma-separated format. If a preferred array is set for a host, then the other arrays in the same pod will expose active/non-optimized paths to that host. If the host is in a host group, `preferred_arrays` cannot be set because host groups have their own preferred arrays. On a preferred array of a certain host, all the paths on all the ports (for both the primary and secondary controllers) are set up as A/O (active/optimized) paths, while on a non-preferred array, all the paths are A/N (Active/Non-optimized) paths. type: array items: $ref: '#/components/schemas/_reference' qos: description: | Displays QoS limit information. title: ContainerQosCeilings allOf: - $ref: '#/components/schemas/_containerQosCeilings' space: description: | Displays provisioned (virtual) size and physical storage consumption information for the sum of all volumes connected to the specified host. title: Space allOf: - $ref: '#/components/schemas/_space' time_remaining: description: | The amount of time left until the destroyed host is permanently eradicated, measured in milliseconds. type: integer format: int64 readOnly: true vlan: description: | The VLAN ID that the host is associated with. If set to `any`, the host can access any VLAN. If set to `untagged`, the host can only access untagged VLANs. If set to a number between `1` and `4094`, the host can only access the specified VLAN with that number. type: string example: "1" wwns: description: The Fibre Channel World Wide Name (WWN) associated with the host. type: array items: type: string example: 52:4A:93:70:4E:E5:68:00 HostPerformanceBalance: allOf: - $ref: '#/components/schemas/_resourceNoId' - $ref: '#/components/schemas/_context' - type: object properties: fraction_relative_to_max: description: | The path with the highest number of operation counts is displayed with a fraction_relative_to_max of 1.0. The fraction values of all other paths in the host are then calculated relative to the path with the highest number of operation counts. type: number format: float readOnly: true example: 0.14 initiator: title: PortCommon allOf: - $ref: '#/components/schemas/_portCommon' op_count: description: | Count of I/O operations for the host path, over the specified resolution. type: integer format: int64 readOnly: true target: title: PortInitiatorTarget allOf: - $ref: '#/components/schemas/PortInitiatorTarget' time: description: Sample time in milliseconds since UNIX epoch. type: integer format: int64 readOnly: true x-readOnly: true Kmip: 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: ca_certificate: description: | CA certificate text for the KMIP server. type: string maxLength: 3000 example: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----' certificate: description: | The certificate used to verify FlashArray authenticity to the KMIP servers. title: Kmip_certificate allOf: - $ref: '#/components/schemas/Kmip_certificate' kmip_objects: description: | List of the name and UID of the KMIP objects. type: array items: $ref: '#/components/schemas/Kmip_object' name: description: | A locally unique, system-generated name. The name cannot be modified. type: string readOnly: true uris: description: | List of URIs for the configured KMIP servers. type: array items: type: string example: - 1.1.1.1:8888 - 2.2.2.2:9999 KmipTestResult: 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: kmip-test1 description: description: Description of what is being tested. type: string example: Testing kmip connectivity. destination: description: The URI of the target server being tested. type: string example: kmip-test-server.dev.purestorage.com enabled: description: Expresses whether the service is enabled or not. type: boolean example: true result_details: description: Additional information about the test result. type: string example: KMIP test failed success: description: | Expresses whether communication between the FlashArray and the KMIP server succeeded or not. type: boolean example: true test_type: description: Description of what is being tested. type: string example: kmip _lifecycle_rule_config_base: type: object properties: abort_incomplete_multipart_uploads_after: description: | Duration of time after which incomplete multipart uploads will be aborted. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days. type: integer format: int64 example: 86400000 keep_current_version_for: description: | Time after which current versions will be marked expired. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days. type: integer format: int64 example: 86400000 keep_current_version_until: description: | Time after which current versions will be marked expired. Measured in milliseconds, time since epoch. Must be a valid date, accurate to day. type: integer format: int64 example: 1636588800000 keep_previous_version_for: description: | The time in milliseconds after which previous versions are marked expired. Must be a multiple of 86400000 to represent a whole number of days. type: integer format: int64 prefix: description: | The object key prefix identifying one or more objects in the bucket. The maximum length is 1024 characters. type: string LifecycleRule: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_lifecycleRuleBase' LogTargetsResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/LogTarget' LogTarget: allOf: - $ref: '#/components/schemas/_fixedNameResourceNoId' - $ref: '#/components/schemas/_context' - type: object properties: target_type: description: | The type of log target. Valid values include `file`, and `syslog`. type: string readOnly: true example: syslog MaintenanceWindow: allOf: - $ref: '#/components/schemas/_resourceNoId' - description: | The period of time during which maintenance will occur. Alerts are suppressed during the maintenance window. type: object properties: created: description: | The maintenance window start time, measured in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true expires: description: | The maintenance window end time, measured in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true _networkinterfacepostEth: description: Ethernet network interface properties. type: object properties: address: description: | The IPv4 or IPv6 address to be associated with the specified network interface. type: string subinterfaces: description: | List of network interfaces configured to be a subinterface of the specified network interface. type: array items: $ref: '#/components/schemas/_referenceNoId' subnet: description: | Subnet that is associated with the specified network interface. title: ReferenceNoId allOf: - $ref: '#/components/schemas/_referenceNoId' subtype: description: | The subtype of the specified network interface. Only interfaces of subtype `vif` and `lacp_bond` can be created. Configurable on POST only. Valid values are `failover_bond`, `lacp_bond`, `physical`, and `vif`. If the subtype is `vif`, the services parameter must not be set. type: string _networkinterfacepatchEth: description: Ethernet network interface properties. type: object properties: add_subinterfaces: description: | Child devices to be added to the specified bond interface. type: array items: $ref: '#/components/schemas/_referenceNoId' address: description: | The IPv4 or IPv6 address to be associated with the specified network interface. type: string gateway: description: | The IPv4 or IPv6 address of the gateway through which the specified network interface is to communicate with the network. type: string mtu: description: | Maximum message transfer unit (packet) size for the network interface in bytes. MTU setting cannot exceed the MTU of the corresponding physical interface. type: integer format: int32 netmask: description: | Netmask of the specified network interface that, when combined with the address of the interface, determines the network address of the interface. type: string remove_subinterfaces: description: | Child devices to be removed from the specified bond interface. type: array items: $ref: '#/components/schemas/_referenceNoId' subinterfaces: description: | Child devices to be added to the specified bond interface. type: array items: $ref: '#/components/schemas/_referenceNoId' subnet: description: | Subnet that is associated with the specified network interface. title: ReferenceNoId allOf: - $ref: '#/components/schemas/_referenceNoId' NetworkInterface: allOf: - $ref: '#/components/schemas/_context' - $ref: '#/components/schemas/_builtInResourceNoId' - $ref: '#/components/schemas/_serverReference' - type: object properties: attached_servers: description: | List of servers associated with the specified network interface for data ingress. type: array maxItems: 1 items: $ref: '#/components/schemas/_fixedReferenceWithType' enabled: description: | Returns a value of `true` if the specified network interface or Fibre Channel port is enabled. Returns a value of `false` if the specified network interface or Fibre Channel port is disabled. type: boolean readOnly: true eth: $ref: '#/components/schemas/_networkInterfaceEth' fc: $ref: '#/components/schemas/_networkInterfaceFc' interface_type: description: | The interface type. Valid values are `eth` and `fc`. type: string readOnly: true services: description: | The services provided by the specified network interface or Fibre Channel port. type: array readOnly: true items: type: string description: | Valid values include `iscsi`, `management`, `nvme-fc`, `nvme-roce`, `nvme-tcp`, `offload`, `replication`, and `scsi-fc`. speed: description: | Configured speed of the specified network interface or Fibre Channel port (in Gb/s). Typically this is the maximum speed of the port or bond represented by the network interface. type: integer format: int64 readOnly: true NetworkInterfaceNeighborResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/NetworkInterfaceNeighbor' NetworkInterfacePerformance: allOf: - $ref: '#/components/schemas/_resourceNoId' - type: object properties: eth: title: NetworkInterfacePerformanceEth allOf: - $ref: '#/components/schemas/_networkInterfacePerformanceEth' fc: title: NetworkInterfacePerformanceFc allOf: - $ref: '#/components/schemas/_networkInterfacePerformanceFc' interface_type: description: | The interface type. Valid values are `eth` and `fc`. type: string readOnly: true time: description: | Sample time in milliseconds since UNIX epoch. type: integer format: int64 readOnly: true x-readOnly: true NetworkInterfacesPortDetailsResponse: type: object properties: items: description: | A list of port details objects. type: array items: $ref: '#/components/schemas/NetworkInterfacesPortDetails' _referenceWithFixedType: 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 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 readOnly: true _objectStoreAccessKeyBase: allOf: - $ref: '#/components/schemas/_context' - type: object description: | The object store access key credentials that allow programmatic access to an object store account. Access keys are associated with a user and are used to authenticate and authorize operations on the object store. properties: created: description: The object store access key creation time in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true example: 1602115200000 enabled: description: | If set to `true`, the access key is enabled. If set to `false`, the access key cannot be used for authentication. The default value is `true`. type: boolean example: true secret_access_key: description: | The secret access key. This value is returned only upon creation. type: string readOnly: true user: description: The user associated with the access key. readOnly: true title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' ObjectStoreAccount: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_objectStoreAccountBase' - type: object description: | The object store account is a logical container for buckets, users, and other object store entities and resources. It provides a namespace for storing and managing these objects, allowing users to organize and access their data efficiently. properties: space: description: | The size and space consumption details. title: Space allOf: - $ref: '#/components/schemas/_space' ResourceObjectStoreAccountSpace: allOf: - $ref: '#/components/schemas/ResourceSpace' - type: object properties: object_count: description: The count of objects within the account. type: integer format: int64 readOnly: true example: 42 ObjectStoreUser: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_objectStoreUserBase' _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' ObjectStoreVirtualHost: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_context' _offload_azure: type: object properties: account_name: description: | The name of the existing Azure Blob storage account. type: string client_id: description: | Specifies the OAuth2 client ID used to identify the Offload application. Grants access to both Blob and Storage Account operations, such as handling lifecycle policies. Must be provided together with tenant_id and client_secret. Cannot be used together with secret_access_key. type: string client_secret: description: | Specifies the OAuth2 client secret used to identify the Offload application. Grants access to both Blob and Storage Account operations, such as handling lifecycle policies. Must be provided together with tenant_id and client_id. Cannot be used together with secret_access_key. type: string container_name: description: | The name of the container in the Azure Blob storage account to where the data will be offloaded. The name must be a valid DNS name. If not specified, defaults to `offload`. type: string placement_strategy: description: | Specifies the tier where data will be stored in a Microsoft Azure Blob Storage offload target. Values include azure-hot and azure-archive. If set to azure-hot, data is stored in the Hot access tier. If set to azure-archive, the data is stored in the Archive access tier and the offload is operating in archive mode. All other metadata is placed in the Hot access tier. If not specified, defaults to azure-hot when the array is initially connected to an Azure offload target. The placement_strategy cannot be changed for Azure offload targets after initialization. type: string profile: description: | The offload target profile that will be selected for this target. This option allows more granular configuration for the target on top of the `protocol` parameter. Values include `azure`. type: string secret_access_key: description: | Specifies the authentication key used for direct access to the Azure Blob Storage Account account_name. Grants authorization for blob operations only. To add Storage Account operations, such as handling lifecycle policies, use OAuth2 Authentication instead. Cannot be used together with the OAuth2 fields tenant_id, client_id, and client_secret. type: string tenant_id: description: | Azure tenant ID used to identify the Offload application, granting access to both Blob and Storage Account operations (handling lifecycle policies, ...). Must be provided together with `client_id` and `client_secret`. Cannot be used together with `secret_access_key`. type: string _offloadGoogleCloud: type: object properties: access_key_id: description: "The access key ID of the Google Cloud account used to create a connection between the array and a Google Cloud offload target. The access key ID is 24 characters in length and is only accepted when creating the connection between the array and the Google Cloud offload target. The `access_key_id`, `secret_access_key`, and `bucket` parameters must be set together." type: string bucket: description: "The name of the Google Cloud Storage bucket to which the data will be offloaded. Grant basic read and write access permissions to the bucket and verify that the bucket is empty of all objects. The `access_key_id`, `secret_access_key`, and `bucket` parameters must be set together." type: string profile: description: | The offload target profile that will be selected for this target. This option allows more granular configuration for the target on top of the `protocol` parameter. Values include `gcp`. type: string secret_access_key: description: "The secret access key that goes with the access key ID of the Google Cloud account. The secret access key is 40 characters in length is only accepted when creating the connection between the array and the Google Cloud offload target. The `access_key_id`, `secret_access_key`, and `bucket` parameters must be set together." type: string _offload_nfs: type: object properties: address: description: "The hostname or IP address of the NFS server to where the data will be offloaded. An array can be connected to one offload target at a time, while multiple arrays can be connected to the same offload target. If the protection group is in a stretched pod, for high availability, connect both arrays in the stretched pod to the offload target." type: string mount_options: description: "The custom mount options on the NFS server. Enter multiple mount options in comma-separated format. Valid values include `port`, `rsize`, `wsize`, `nfsvers`, and `tcp` or `udp`. These mount options are common to all NFS file systems." type: string mount_point: description: "The mount point of the NFS export on the NFS server. For example, `/mnt`. The `access_key_id`, `secret_access_key`, and `bucket` parameters must be set together." type: string profile: description: | The offload target profile that will be selected for this target. This option allows more granular configuration for the target on top of the `protocol` parameter. Values include `nfs`, and `nfs-flashblade`. type: string _offload_s3: type: object properties: access_key_id: description: | The access key ID of the AWS account used to create a connection between the array and an Amazon S3 offload target. The access key ID is 20 characters in length and is only accepted when creating the connection between the array and the S3 offload target. The `access_key_id`, `secret_access_key`, and `bucket` parameters must be set together. type: string auth_region: description: | The region that will be used for initial authentication request. This parameter is optional and should be used only when region autodetection fails. type: string bucket: description: | The name of the Amazon S3 bucket to where the data will be offloaded. Grant basic read and write ACL permissions to the bucket, and enable default (server-side) encryption for the bucket. Also verify that the bucket is empty of all objects and does not have any lifecycle policies. The `access_key_id`, `secret_access_key`, and `bucket` parameters must be set together. type: string placement_strategy: description: | The storage placement strategy used for the dynamic placement of data in an Amazon S3 offload target. Valid values are `aws-intelligent-tiering`, `aws-standard-class`, and `retention-based`. If set to `aws-intelligent-tiering`, data is stored in the Amazon S3 INTELLIGENT_TIERING storage class regardless of the retention period. If set to `aws-standard-access`, the data is stored in the Amazon S3 STANDARD storage class regardless of the retention period. If set to `retention-based`, the data for protection groups with longer retention periods is placed in the Amazon S3 STANDARD_IA (infrequently accessed, more cost-effective) storage class. All other data is placed in the STANDARD storage class. When the array is initially connected to an S3 offload target, `placement_strategy` is automatically set to `retention-based`. The `placement_strategy` or `uri` parameter is required, but they cannot be set together. type: string profile: description: | The offload target profile that will be selected for this target. This option allows more granular configuration for the target on top of the `protocol` parameter. Values include `s3-aws`, `s3-flashblade`, `s3-scality-ring`, `s3-wasabi-pay-as-you-go`, `s3-wasabi-rcs`, and `s3-other`. type: string secret_access_key: description: | The secret access key that goes with the access key ID (`access_key_id`) of the AWS account. The secret access key is 40 characters in length is only accepted when creating the connection between the array and the S3 offload target. The `access_key_id`, `secret_access_key`, and `bucket` parameters must be set together. type: string uri: description: | The URI used to create a connection between the array and a non-AWS S3 offload target. Storage placement strategies are not supported for non-AWS S3 offload targets. Both the HTTP and HTTPS protocols are allowed. type: string _offload_azure_patch: type: object properties: client_secret: description: | Specifies the new Azure client secret key used to obtain the authentication token. type: string Offload: allOf: - $ref: '#/components/schemas/OffloadPost' - $ref: '#/components/schemas/_resourceNoId' - $ref: '#/components/schemas/_context' - type: object properties: protocol: description: | Type of offload. Valid values include `azure`, `google-cloud`, `nfs`, and `s3`. type: string readOnly: true space: title: Space allOf: - $ref: '#/components/schemas/_space' status: description: | Offload status. Valid values are `connecting`, `connected`, `disconnecting`, `not connected`, and `scanning`. type: string readOnly: true target_id: description: | Unique ID for the offload target. When multiple connections to one offload target are created, they each have distinct IDs but share the same `target_id`. type: string readOnly: true _quota_limit_type: type: integer format: int64 minimum: 1048576 maximum: 4503599627370496 _quota_limit_patch: type: object properties: quota_limit: title: QuotaLimitPatch description: | The logical quota limit of the object, measured in `bytes`. Specifying an empty string `""` unsets the quota limit. oneOf: - $ref: '#/components/schemas/_quota_limit_type' - $ref: '#/components/schemas/_limit_unset_value' Pod: allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_context' - description: | A pod is an administrative domain, a data container, and a namespace for volumes and protection groups. type: object properties: array_count: description: | The number of arrays a pod connects to. type: integer example: 1 arrays: description: | A list of arrays over which the pod is stretched. If there are two or more arrays in the stretched pod, all data in the pod is synchronously replicated between all of the arrays within the pod. type: array minItems: 1 items: $ref: '#/components/schemas/_pod_array_status' destroyed: description: | Returns a value of `true` if the pod has been destroyed and is pending eradication. The `time_remaining` value displays the amount of time left until the destroyed pod is permanently eradicated. Before the `time_remaining` period has elapsed, the destroyed pod can be recovered by setting `destroyed=false`. Once the `time_remaining` period has elapsed, the pod is permanently eradicated and can no longer be recovered. type: boolean eradication_config: title: ContainerEradicationConfig allOf: - $ref: '#/components/schemas/ContainerEradicationConfig' failover_preferences: description: | Determines which array or realm within a stretched pod should be given priority to stay online should the arrays or realms ever lose contact with each other. The current array/realm and any peer arrays/realms that are connected to the current array/ream for synchronous replication can be added to a pod for failover preference. By default, `failover_preferences=null`, meaning no arrays or realms have been configured for failover preference. type: array items: $ref: '#/components/schemas/_reference' footprint: description: | This field has been deprecated. Use the `space.footprint` field in the future, as it contains the same information. The maximum amount of space the pod would take up on any array, ignoring any data shared outside the pod. Measured in bytes. The footprint metric is mostly used for capacity planning. type: integer format: int64 minimum: 0 link_source_count: description: | The number of source pods that link to the pod. type: integer example: 1 link_target_count: description: | The number of target pods that link to the pod. type: integer example: 1 mediator: description: | The URL of the mediator for the pod. By default, the Pure1 Cloud Mediator (`purestorage`) serves as the mediator. type: string example: https://mediator.cloud-support.purestorage.com mediator_version: description: | The mediator version. type: string example: 1.0.0 members: description: | A list of arrays or realms over which the pod is stretched. If there are two or more members in the stretched pod, all data in the pod is synchronously replicated between all of the members within the pod. type: array minItems: 1 readOnly: true items: $ref: '#/components/schemas/_referenceWithType' promotion_status: description: | Current promotion status of a pod. Values include `promoted`, `demoted`, and `promoting`. The `promoted` status indicates that the pod has been promoted. The pod takes writes from hosts instead of incorporating replicated data. This is the default mode for a pod when it is created. The `demoted` status indicates that the pod has been demoted. The pod does not accept write requests and is ready to be used as a link target. The `promoting` status indicates that the pod is in an intermediate status between `demoted` and `promoted` while the promotion process is taking place. type: string quota_limit: description: | The logical quota limit of the pod, measured in bytes. readOnly: true title: Quota_limit_type allOf: - $ref: '#/components/schemas/_quota_limit_type' requested_promotion_state: description: | Values include `promoted` and `demoted`. Patch `requested_promotion_state` to `demoted` to demote the pod so that it can be used as a link target for continuous replication between pods. Demoted pods do not accept write requests, and a destroyed version of the pod with `undo-demote` appended to the pod name is created on the array with the state of the pod when it was in the promoted state. Patch `requested_promotion_state` to `promoted` to start the process of promoting the pod. The `promotion_status` indicates when the pod has been successfully promoted. Promoted pods stop incorporating replicated data from the source pod and start accepting write requests. The replication process does not stop as the source pod continues replicating data to the pod. The space consumed by the unique replicated data is tracked by the `space.journal` field of the pod. type: string source: description: | The source pod from where data is cloned to create the new pod. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' space: description: | Displays provisioned size and physical storage consumption information for the sum of all volumes connected to the specified host. title: PodSpace allOf: - $ref: '#/components/schemas/_podSpace' time_remaining: description: | The amount of time left until the destroyed pod is permanently eradicated, measured in milliseconds. Before the `time_remaining` period has elapsed, the destroyed pod can be recovered by setting `destroyed=false`. type: integer format: int64 readOnly: true Member: allOf: - $ref: '#/components/schemas/_context' - type: object properties: group: $ref: '#/components/schemas/_reference' member: $ref: '#/components/schemas/_reference' PodMember: allOf: - $ref: '#/components/schemas/_context' - type: object properties: member: $ref: '#/components/schemas/_referenceWithType' pod: $ref: '#/components/schemas/_referenceWithType' ContainerPerformance: allOf: - $ref: '#/components/schemas/_performance' - $ref: '#/components/schemas/_performance_others' - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_context' PodPerformanceByArray: allOf: - $ref: '#/components/schemas/PodPerformance' - type: object properties: array: description: | The array on which the performance metrics were recorded. title: Resource allOf: - $ref: '#/components/schemas/_resource' member: description: | The member that shares this pod. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' PodPerformanceReplicationResponse: type: object properties: items: description: A list of pod performance replication objects. type: array items: $ref: '#/components/schemas/PodPerformanceReplication' total: description: | The aggregate value of all items after filtering. For real-time performance, the values are aggregated for the latest timestamp. For historical performance, the values are aggregated for each timestamp from `start_time` to `end_time`. When applicable, the average value is displayed instead. The values are displayed for each field if meaningful. type: array items: $ref: '#/components/schemas/PodPerformanceReplication' PodPerformanceReplicationByArrayResponse: type: object properties: items: description: "A list of pod performance replication objects, arranged by array." type: array items: $ref: '#/components/schemas/PodPerformanceReplicationByArray' total: description: | The aggregate value of all items after filtering. When applicable, the average value is displayed instead. The values are displayed for each field if meaningful. type: array items: $ref: '#/components/schemas/PodPerformanceReplicationByArray' ResourcePodSpace: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_context' - type: object properties: space: description: | Displays size and space consumption information. title: PodSpace allOf: - $ref: '#/components/schemas/_podSpace' time: description: | The timestamp of when the data was taken, measured in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true x-readOnly: true TestResultWithResourceWithId: allOf: - $ref: '#/components/schemas/TestResult' - $ref: '#/components/schemas/_context' - type: object properties: resource: description: | A reference to the object being tested. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' PodReplicaLink: allOf: - $ref: '#/components/schemas/_builtInRelationship' - $ref: '#/components/schemas/_context' - type: object properties: direction: description: | The direction of replication. Valid values include `inbound` and `outbound`. type: string readOnly: true lag: description: | Duration in milliseconds that represents how far behind the replication target is from the source. This is the time difference between current time and `recovery_point`. type: integer format: int64 readOnly: true local_pod: description: Reference to a local pod. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' local_pod_members: description: | A list of arrays or realms that are members of the local pod. type: array items: $ref: '#/components/schemas/_fixedReferenceWithType' paused: description: | Returns a value of `true` if the replica link is in a `paused` state. Returns a value of `false` if the replica link is not in a `paused` state. type: boolean recovery_point: description: | Time when the last piece of data was replicated, in milliseconds since the UNIX epoch, and the recovery point if the target pod is promoted. If the pod is currently baselining, then the value is `null`. type: integer format: int64 readOnly: true example: 1565034592494 remote_pod: description: Reference to a remote pod. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' remotes: description: A list of remote arrays or realms that share this pod. type: array items: $ref: '#/components/schemas/_fixedReferenceWithType' status: description: | Status of the replica-link. Valid values include `replicating`, `baselining`, `paused`, `quiescing`, `quiesced`, `idle`, and `unhealthy`. type: string readOnly: true PodReplicaLinkLagResponse: type: object properties: items: description: A list of pod replica link lag objects. type: array items: $ref: '#/components/schemas/PodReplicaLinkLag' PodReplicaLinkPerformanceReplicationResponse: type: object properties: items: description: A list of pod replica link performance objects. type: array items: $ref: '#/components/schemas/PodReplicaLinkPerformanceReplication' total: description: | The aggregate value of all items after filtering. For real-time performance, the values are aggregated for the latest timestamp. For historical performance, the values are aggregated for each timestamp from `start_time` to `end_time`. Where it makes more sense, the average value is displayed instead. The values are displayed for each field where meaningful. type: array items: $ref: '#/components/schemas/PodReplicaLinkPerformanceReplication' PodReplicaLinkPerformanceReplicationArrayResponse: type: object properties: items: description: A list of pod replica link performance objects, arranged by array. type: array items: $ref: '#/components/schemas/PodReplicaLinkPerformanceReplicationArray' total: description: | The aggregate value of all items after filtering. For real-time performance, the values are aggregated for the latest timestamp. For historical performance, the values are aggregated for each timestamp from `start_time` to `end_time`. Where it makes more sense, the average value is displayed instead. The values are displayed for each field where meaningful. type: array items: $ref: '#/components/schemas/PodReplicaLinkPerformanceReplicationArray' MappingPolicy: allOf: - $ref: '#/components/schemas/_builtInRelationship' - $ref: '#/components/schemas/_context' - type: object properties: direction: description: | The direction of replication. Valid values include `inbound` and `outbound`. type: string local_policy: description: | Reference to a local policy. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' mapping: description: | The mapping for this policy mapping. Valid values are `connected` and `disconnected`. type: string pod_replica_link: description: | Reference to a pod replica link. title: PodReplicaLinkReference allOf: - $ref: '#/components/schemas/_podReplicaLinkReference' policy_type: description: | The type of policies involved in this policy mapping. type: string remote_policy: description: | Reference to a remote policy. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' _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' 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' _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: 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 _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 _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 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' _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 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' _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 _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 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' _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 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' _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 _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 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 _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' ObjectStoreAccessPolicyResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/ObjectStoreAccessPolicy' ObjectStoreAccessPolicyRuleResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/PolicyRuleObjectStoreAccess' 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' _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' _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' 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 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' _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 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 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' _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 _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 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 _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' _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' 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 Port: allOf: - $ref: '#/components/schemas/_context' - $ref: '#/components/schemas/_basePort' PortInitiator: allOf: - $ref: '#/components/schemas/_context' - description: Path from an initiator port to a target port. type: object properties: encryption: $ref: '#/components/schemas/_portInitiatorEncryption' initiator: $ref: '#/components/schemas/_portCommon' target: $ref: '#/components/schemas/PortInitiatorTarget' _presetWorkloadBase: description: | Workload presets are reusable templates that provision workloads. type: object required: - placement_configurations - workload_type properties: description: description: | A brief description of the workload the preset will configure. Supports up to 1KB of unicode characters. type: string directory_configurations: description: | The file systems and managed directories that will be provisioned by the preset. type: array minItems: 1 maxItems: 20 items: $ref: '#/components/schemas/_presetWorkloadDirectoryConfiguration' export_configurations: description: | The NFS, SMB, and SMB share policy configuration specified in file system and directory exports. title: PresetWorkloadExportConfigurations allOf: - $ref: '#/components/schemas/_presetWorkloadExportConfigurations' parameters: description: The parameters to prompt the user when they deploy workloads from the preset. type: array items: $ref: '#/components/schemas/_presetWorkloadParameter' periodic_replication_configurations: description: | The periodic replication configurations that can be applied to storage resources (such as volumes) within the preset. type: array maxItems: 2 items: $ref: '#/components/schemas/_presetWorkloadPeriodicReplicationConfiguration' placement_configurations: description: | The placement configurations that can be applied to storage resources (such as volumes) within the preset. All storage resources associated with the same placement will be colocated on the same array. type: array minItems: 1 maxItems: 1 items: $ref: '#/components/schemas/_presetWorkloadPlacementConfiguration' platform_features: type: array minItems: 1 maxItems: 1 items: $ref: '#/components/schemas/_presetWorkloadPlatformFeatures' qos_configurations: description: | The QoS configurations that can be applied to storage resources (such as volumes) within the preset. type: array maxItems: 5 items: $ref: '#/components/schemas/_presetWorkloadQosConfiguration' quota_configurations: description: | The quota configurations applicable to storage resources, such as file systems and directories, within the preset. type: array maxItems: 5 items: $ref: '#/components/schemas/_presetWorkloadQuotaConfiguration' revision: description: | A counter that is automatically incremented by the server when the preset is updated. type: integer format: int64 readOnly: true snapshot_configurations: description: | The snapshot configurations that can be applied to storage resources (such as volumes) within the preset. type: array maxItems: 2 items: $ref: '#/components/schemas/_presetWorkloadSnapshotConfiguration' volume_configurations: description: | The volumes that will be provisioned by the preset. type: array minItems: 1 maxItems: 5 items: $ref: '#/components/schemas/_presetWorkloadVolumeConfiguration' workload_tags: description: The tags that will be associated with workloads provisioned by the preset. type: array items: $ref: '#/components/schemas/_presetWorkloadWorkloadTag' workload_type: description: | The type of workload the preset will configure. Valid values are `Clarity`, `Epic`, `Exchange`, `File`, `MsSQL`, `MySQL`, `Oracle`, `PostgreSQL`, `SAP-Hana`, `SAP`, `VDI`, `VSI`, `Wfs`, `Zerto`, and `Custom`. type: string PageInfoWithoutTotalItemCountResponse: type: object properties: continuation_token: description: | Continuation token that can be provided in the `continuation_token` query parameter 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: | Displays a value of `true` if subsequent items can be retrieved. type: boolean example: false ProtectionGroupEradicationConfig: description: The configuration of the eradication feature. type: object properties: manual_eradication: description: | Manual eradication status of objects like protection group and protection group snapshots. If manual_eradication is `disabled`, you cannot eradicate objects. Values include `disabled` and `enabled`. type: string readOnly: true example: enabled x-readOnly: true _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 _replication_schedule: allOf: - $ref: '#/components/schemas/_snapshot_schedule' - description: | The schedule of a replication action. type: object properties: blackout: description: | The range of time when to suspend replication. To clear the blackout period, set to an empty string (""). title: Time_window allOf: - $ref: '#/components/schemas/_time_window' _snapshot_schedule: description: The replication or snapshot schedule. type: object properties: at: description: | The time of day the snapshot is scheduled to be taken and retained on the local array or immediately replicated to the target(s). Measured in seconds since midnight. The `at` value is only used if the `frequency` parameter is in days (e.g., `259200000`, which is equal to 3 days). type: integer format: int64 example: 7200 x-minimum: 0 x-maximum: 86399 enabled: description: "If set to `true`, the policy is enabled." type: boolean example: false frequency: description: The frequency of the scheduled action. Measured in milliseconds. type: integer format: int64 example: 259200000 x-minimum: 300000 x-maximum: 34560000000 _retentionPolicy: description: The snapshot retention policy. type: object properties: all_for_sec: description: | The length of time to keep the specified snapshots. Measured in seconds. Prior to 6.8.2 the range of 60 to 34560000 is accepted. In 6.8.2 and onwards the range of 60 to 2147483647 is accepted. type: integer format: int32 example: 86400 days: description: | The number of days to keep the snapshots after the `all_for_sec` period has passed. Prior to 6.6.4 the range of 0 to 4000 is accepted. In 6.6.4 and onwards the range of 0 to 2147483647 is accepted. In 6.10.0 and onwards -1 may be used to keep snapshots forever. type: integer format: int32 example: 7 per_day: description: | Deprecated. per_day is deprecated in favor of per_period and period_length_ms. The number of snapshots to keep per day after the `all_for_sec` period has passed. Prior to 6.8.2 the range of 0 to 1440 is accepted. In 6.8.2 and onwards the range of 0 to 2147483647 is accepted. Equivalent to per_period when period_length_ms is 1 day, 86400000 type: integer format: int32 example: 3 per_period: description: | The number of snapshots to keep per period_length_ms after the `all_for_sec` period has passed. The range of 0 to 2147483647 is accepted. type: integer format: int32 example: 3 period_length_ms: description: | The length of time per_period should cover. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days. A minimum of 86400000, 1 day, is accepted. type: integer format: int64 example: 86400000 _space: type: object properties: data_reduction: description: | The ratio of mapped sectors within a volume versus the amount of physical space the data occupies after data compression and deduplication. The data reduction ratio does not include thin provisioning savings. For example, a data reduction ratio of 5:1 means that for every 5 MB the host writes to the array, 1 MB is stored on the array's flash modules. type: number format: float readOnly: true footprint: description: | The maximum amount of physical space the container consumes on an array, ignoring any data shared outside the container, measured in bytes. On Evergreen//One arrays, this is the maximum amount of effective used space. The footprint metric is mostly used for capacity planning. This field will be null in non-container contexts. type: integer format: int64 minimum: 0 readOnly: true shared: description: | The physical space occupied by deduplicated data, meaning that the space is shared with other volumes and snapshots as a result of data deduplication. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by data that is not unique to a specific volume, managed directory, or snapshot, measured in bytes. type: integer format: int64 minimum: 0 readOnly: true example: 111863360624 snapshots: description: | The physical space occupied by data unique to one or more snapshots. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by data unique to one or more snapshots, measured in bytes. type: integer format: int64 minimum: 0 readOnly: true system: description: | The physical space occupied by internal array metadata. Measured in bytes. type: integer format: int64 minimum: 0 readOnly: true thin_provisioning: description: | The percentage of volume sectors that do not contain host-written data because the hosts have not written data to them or the sectors have been explicitly trimmed. type: number format: float minimum: 0 maximum: 1 readOnly: true total_physical: description: | This field has been deprecated. Use the `total_used` field, as it contains the same information. type: integer format: int64 minimum: 0 readOnly: true total_provisioned: description: | The provisioned size of a volume for a single volume, host or host group, protocol endpoint, managed directory, and containers can be infinite or measured in bytes. Infinite is represented by `null`. The provisioned size for a host or host group, includes all volumes that are connected to the resource. The provisioned size for a protocol endpoint is `null`. The provisioned size for a managed directory is the quota limit if it or its parent has a managed directory configured, otherwise it defaults to `null`. The provisioned size for a container is the sum of the total_provisioned of the object it contains, capped by the container's quota limit (or the container's used_provisioned if current usage is above the quota limit), if any. Provisioned size represents the storage capacity reported to hosts. type: integer format: int64 minimum: 0 readOnly: true example: 19937690345472 total_reduction: description: |+ The ratio of provisioned sectors within a volume versus the amount of physical space the data occupies after reduction via data compression and deduplication and with thin provisioning savings. Total reduction is data reduction with thin provisioning savings. For example, a total reduction ratio of 10:1 means that for every 10 MB of provisioned space, 1 MB is stored on the array's flash modules. type: number format: float readOnly: true total_used: description: | The total space contributed by customer data, measured in bytes. type: integer format: int64 minimum: 0 readOnly: true unique: description: | The unique physical space occupied by customer data. Unique physical space does not include shared space, snapshots, and internal array metadata. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by unique customer data, measured in bytes. Unique data does not include shared space, snapshots, and internal array metadata. type: integer format: int64 minimum: 0 readOnly: true used_provisioned: description: | The amount of logical space a container has consumed, compared against the quota limit if the container has one configured. Used provisioned does not include destroyed objects inside the container. Used provisioned can include destroyed objects for a destroyed container and represents how much logical space it would take to recover the container. type: integer format: int64 minimum: 0 readOnly: true example: 19937690345472 virtual: description: | The amount of logically written data that a volume or a snapshot references. Measured in bytes. type: integer format: int64 minimum: 0 readOnly: true ProtectionGroupPerformance: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_aggregate_replication_performance' - $ref: '#/components/schemas/_context' - type: object properties: time: description: | The time when the sample performance data was taken. Measured in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true x-readOnly: true ProtectionGroupPerformanceArray: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_aggregate_replication_performance' - $ref: '#/components/schemas/_context' - type: object properties: source: description: | The source array from where the data is replicated. type: string readOnly: true target: description: | The target to where the data is replicated. type: string readOnly: true time: description: | The time when the sample performance data was taken. Measured in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true x-readOnly: true ResourceSpace: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_context' - type: object properties: space: description: | Displays size and space consumption information. title: Space allOf: - $ref: '#/components/schemas/_space' time: description: | The timestamp of when the data was taken, measured in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true x-readOnly: true _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 TargetProtectionGroup: allOf: - $ref: '#/components/schemas/_context' - type: object properties: allowed: description: | If set to `true`, the target array or pod allows the source array to replicate protection group data to the target. If set to `false`, the target array or pod does not allow the source array to replicate protection group data to the target. type: boolean example: true group: $ref: '#/components/schemas/_reference' member: $ref: '#/components/schemas/_referenceWithType' status: description: | The replication status of the target. Valid values are `replicating`, `suspended`, and `disallowed`. If `allowed` is `true` and protection group data is replicating to the target, `status` will display `replicating`. If `allowed` is `true`, but replication is suspended due to the target being demoted, linked, stretched or there is a missing realm connection to the target; `status` will display `suspended`. Replication will resume automatically once the conditions for suspend no longer hold. If `allowed` is `false`, `status` will display `disallowed`. type: string example: suspended ProtectionGroupsVolumes: allOf: - $ref: '#/components/schemas/_context' - type: object properties: group: $ref: '#/components/schemas/_reference' member: $ref: '#/components/schemas/_protectionGroupsVolumesMember' ProtectionGroupSnapshot: allOf: - $ref: '#/components/schemas/_resourceNoId' - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_context' - description: | A protection group snapshot is a collection of point-in-time consistent volume snapshots, for volumes associated with the protection group when the snapshot was taken. type: object properties: created: description: | The snapshot creation time of the original snapshot source. Measured in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true example: 1503520993 destroyed: description: | Returns a value of `true` if the protection group snapshot has been destroyed and is pending eradication. The `time_remaining` value displays the amount of time left until the destroyed snapshot is permanently eradicated. Before the `time_remaining` period has elapsed, the destroyed snapshot can be recovered by setting `destroyed=false`. Once the `time_remaining` period has elapsed, the snapshot is permanently eradicated and can no longer be recovered. type: boolean eradication_config: $ref: '#/components/schemas/ProtectionGroupEradicationConfig' pod: description: The pod in which the protection group of the protection group snapshot resides. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' source: description: | The original protection group from which this snapshot was taken. For a replicated protection group snapshot being viewed on the target side, the `source` is the replica protection group. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' space: description: | Displays provisioned size and physical storage consumption data for each protection group. title: Space allOf: - $ref: '#/components/schemas/_space' suffix: description: | The name suffix appended to the protection group name to make up the full protection group snapshot name in the form `PGROUP.SUFFIX`. If `suffix` is not specified, the protection group name is in the form `PGROUP.NNN`, where `NNN` is a unique monotonically increasing number. If multiple protection group snapshots are created at a time, the suffix name is appended to those snapshots. type: string time_remaining: description: | The amount of time left until the destroyed snapshot is permanently eradicated. Measured in milliseconds. Before the `time_remaining` period has elapsed, the destroyed snapshot can be recovered by setting `destroyed=false`. type: integer format: int64 readOnly: true ProtectionGroupSnapshotReplica: allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/ProtectionGroupSnapshot' - description: | Replication of specified protection snapshots. type: object ProtectionGroupSnapshotTransferResponse: 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/ProtectionGroupSnapshotTransfer' ProtectionGroupSnapshotTransfer: allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_transfer' - $ref: '#/components/schemas/_context' - description: | The transfer statistics for snapshot replication data. type: object _containerQos: allOf: - $ref: '#/components/schemas/_containerQosCeilings' - properties: bandwidth_floor: description: | The QoS bandwidth floor for the container. Traffic is granted priority until this floor is reached. Measured in bytes per second. Maximum floor is 512 GB/s. title: Qos_bw_limit_type allOf: - $ref: '#/components/schemas/_qos_bw_limit_type' iops_floor: description: | The QoS IOPs floor for the container. Traffic is granted priority until this floor is reached. Maximum floor is 100,000,000 IOs per second. title: Qos_iops_limit_type allOf: - $ref: '#/components/schemas/_qos_iops_limit_type' _containerQos_patch: allOf: - $ref: '#/components/schemas/_containerQosCeilings_patch' - properties: bandwidth_floor: description: | The QoS bandwidth floor for the container, measured in `bytes per second`. Priority is granted to traffic until this floor is reached. The maximum supported floor is `512 GB/s`. Specifying an empty string `""` unsets the floor. title: ContainerQosBandwidthLimitPatch oneOf: - $ref: '#/components/schemas/_qos_bw_limit_type' - $ref: '#/components/schemas/_limit_unset_value' iops_floor: description: | The QoS `IOPS` floor for the container. Priority is granted to traffic until this floor is reached. The maximum supported floor is `100,000,000` `IOs per second`. Specifying an empty string `""` unsets the floor. title: ContainerQosIopsLimitPatch oneOf: - $ref: '#/components/schemas/_qos_iops_limit_type' - $ref: '#/components/schemas/_limit_unset_value' Realm: allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_context' - description: | A realm is an administrative domain, a data container, and a namespace for pods, hosts, and host groups. type: object properties: created: description: | Creation timestamp of the realm. type: integer format: int64 readOnly: true destroyed: description: | Returns a value of `true` if the realm has been destroyed and is pending eradication. The realm cannot be modified while it is in the destroyed state. The `time_remaining` value displays the amount of time left until the destroyed realm is permanently eradicated. Once eradication has begun, the realm can no longer be recovered. Before the `time_remaining` period has elapsed, the destroyed realm can be recovered through the PATCH method type: boolean eradication_config: title: ContainerEradicationConfig allOf: - $ref: '#/components/schemas/ContainerEradicationConfig' qos: description: | Displays QoS limit information. title: ContainerQos allOf: - $ref: '#/components/schemas/_containerQos' quota_limit: description: | The logical quota limit of the realm, measured in bytes. type: integer format: int64 maximum: 4503599627370496 readOnly: true space: description: | Displays provisioned size and physical storage consumption information for the realm. title: SpaceNoDeprecatedPhysicalOrEffective allOf: - $ref: '#/components/schemas/_spaceNoDeprecatedPhysicalOrEffective' time_remaining: description: | Time in milliseconds before the realm is eradicated. `null` if not destroyed. type: integer format: int64 readOnly: true QosMetrics: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_containerQos' - $ref: '#/components/schemas/_context' - type: object properties: time: description: | The timestamp of when the data was taken, measured in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true x-readOnly: true ResourceRealmSpace: allOf: - $ref: '#/components/schemas/_builtIn' - type: object properties: space: description: | Displays size and space consumption information. title: SpaceNoDeprecatedPhysicalOrEffective allOf: - $ref: '#/components/schemas/_spaceNoDeprecatedPhysicalOrEffective' time: description: | The timestamp of when the data was taken, measured in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true x-readOnly: true RemoteArray: allOf: - $ref: '#/components/schemas/_resource' - type: object properties: api_versions: $ref: '#/components/schemas/_api_versions' fleet: $ref: '#/components/schemas/_remoteArrayFleet' is_local: description: | If set to `true`, this array is the current array. type: boolean example: false model: description: | Specifies the array model. type: string example: FA//X os: description: | Specifies the operating system. Valid values are `Purity`, `Purity//FA`, and `Purity//FB`. type: string example: Purity//FA version: description: | Specifies the operating system version. type: string example: 6.8.0 RemotePod: allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_context' - description: | The remote pod that is not directly stretched to this array. type: object properties: arrays: type: array minItems: 1 items: $ref: '#/components/schemas/_podRemoteArrayStatus' members: description: The list of arrays or realms over which the pod is stretched. If there are two or more members in the stretched pod, all data in the pod is synchronously replicated between all members within the pod. type: array minItems: 1 items: $ref: '#/components/schemas/_referenceWithType' StretchedTagPod: allOf: - $ref: '#/components/schemas/Tag' - type: object properties: arrays: type: array minItems: 1 items: $ref: '#/components/schemas/_stretchedTagRemoteArrayStatus' members: description: A list of arrays or realms over which the tag is stretched. type: array minItems: 1 items: $ref: '#/components/schemas/_fixedReferenceWithType' readOnly: true RemoteProtectionGroupSnapshot: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_context' - description: | A remote protection group snapshot is a collection of point-in-time consistent volume snapshots, for volumes associated with the remote protection group when the snapshot was taken. type: object properties: created: description: | The creation time of the snapshot on the original source of the snapshot. Measured in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true example: 1503520993 destroyed: description: | Destroyed and pending eradication? If not specified, defaults to false. type: boolean is_local: description: | The status of whether or not the remote protection group snapshot is replicated from the current array. type: boolean readOnly: true remote: description: | The offload target where the remote protection group snapshot is located. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' source: description: | The original protection group from which this snapshot was taken. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' suffix: description: | The suffix that is appended to the `source_name` value to generate the full remote protection group snapshot name in the form `PGROUP.SUFFIX`. If the suffix is not specified, the system constructs the snapshot name in the form `PGROUP.NNN`, where `PGROUP` is the protection group name, and `NNN` is a monotonically increasing number. type: string time_remaining: description: | The time remaining until eradication, measured in milliseconds, if the snapshot has been destroyed. type: integer format: int64 readOnly: true RemoteProtectionGroupSnapshotTransferResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/RemoteProtectionGroupSnapshotTransfer' RemoteProtectionGroupSnapshotTransfer: allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_transfer' - $ref: '#/components/schemas/_context' - description: | The transfer statistics for snapshot replication. type: object properties: source: description: | The original protection group from which this snapshot was taken. title: Reference allOf: - $ref: '#/components/schemas/_reference' RemoteRealm: allOf: - $ref: '#/components/schemas/_context' - $ref: '#/components/schemas/_resource' - description: | The realm that is on a remote array. type: object properties: arrays: type: array minItems: 1 items: $ref: '#/components/schemas/_referenceWithType' StretchedTagRealm: allOf: - $ref: '#/components/schemas/Tag' - type: object properties: arrays: type: array minItems: 1 items: $ref: '#/components/schemas/_stretchedTagRemoteArrayStatus' members: description: A list of arrays or realms over which the tag is stretched. type: array minItems: 1 items: $ref: '#/components/schemas/_fixedReferenceWithType' readOnly: true RemoteVolumeSnapshot: allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_snapshot' - $ref: '#/components/schemas/_context' - description: | A volume snapshot on a remote target. type: object properties: remote: description: | Remote target where this volume snapshot is located. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' RemoteVolumeSnapshotTransferResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/RemoteVolumeSnapshotTransfer' RemoteVolumeSnapshotTransfer: allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_transfer' - $ref: '#/components/schemas/_context' - description: | The transfer statistics for snapshot replication data. type: object RealmConnection: allOf: - $ref: '#/components/schemas/_context' - type: object properties: id: description: The ID of a realm connection object. type: string readOnly: true local_realm: description: | The local realm side of a connection. readOnly: true title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' remote_realm: description: | The remote realm side of a connection. readOnly: true title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' status: description: | The connection status. Values include connected, unreachable, and degraded. The connected status means that the connection is alive and data is replicating. The unreachable status indicates that the remote realm is not found on any array in the cluster. The degraded status indicates that the array connection was downgraded to the async-replication type while the realm connection's type is sync-replication. In that case, the realm can use the async replication feature but cannot use sync-replication features. type: string readOnly: true type: description: | Specifies the type of the realm connection. Values include async-replication and sync-replication. type: string RealmConnectionKeyResponse: type: object properties: items: description: A list of realm connection key objects. type: array items: $ref: '#/components/schemas/RealmConnectionKey' RealmConnectionKey: allOf: - $ref: '#/components/schemas/_context' - type: object properties: connection_key: description: | Specifies the unique string token used to create or update a realm connection. The key is only visible when created. The response of the POST operation and any subsequent GET requests hide the key as ****. type: string readOnly: true created: description: | The creation time in milliseconds since the UNIX epoch. type: integer format: int64 example: 1706850977000 expires: description: | The expiration time in milliseconds since the UNIX epoch. type: integer format: int64 example: 1706850977000 realm: description: | The realm to which the connection key is associated. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' type: description: | Specifies the type of realm connection that a key can create. Values include async-replication and sync-replication. A sync-replication key can also be used to create an async-replication connection. type: string ResourceAccessesStatusResponse: type: object properties: items: description: A list of resource access status objects. type: array items: $ref: '#/components/schemas/ResourceAccessStatus' Server: allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_context' - description: | Server represents a logical configuration scope, which enables utilizing array resources with different authentication providers - Active Directory or Directory Services. type: object properties: created: description: | Creation timestamp of the server. type: integer format: int64 readOnly: true directory_services: description: | The directory service configuration to be used by this server. type: array maxItems: 1 items: $ref: '#/components/schemas/_fixedReferenceWithType' dns: description: | The DNS configuration to be used by this server. type: array maxItems: 1 items: $ref: '#/components/schemas/_fixedReferenceWithType' local_directory_service: description: | The Local Directory Service associated to the server. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' Session: allOf: - $ref: '#/components/schemas/_builtIn' - description: | User session logs represent user login events performed in the Purity//FA GUI, CLI, and REST API. type: object properties: end_time: description: | Date and time the user logged out of the Purity//FA interface. Not set if the session is still active. type: integer format: int64 readOnly: true example: 1502234638 event: description: | Description of session events such as login and user session. Valid values include `failed authentication`, `user session`, `login`, `logout`, `API token obtained`, and `request without session`. type: string readOnly: true example: user session event_count: description: Number of session events. type: integer format: int32 readOnly: true example: 3 location: description: | IP address of the user client connecting to the array or console if connected through local console. type: string readOnly: true example: 10.202.101.11 method: description: | Method by which the user attempted to log in. Valid values include `API token`, `JWT`, `password`, and `public key`. type: string readOnly: true example: public key start_time: description: Date and time the user logged in to the Purity//FA interface. type: integer format: int64 readOnly: true example: 1502234212 user: description: Username of the Purity//FA user who triggered the user session event. type: string readOnly: true example: pureuser user_interface: description: | The user interface through which the user session event was performed. Valid values include `CLI`, `GUI`, and `REST`. type: string readOnly: true example: CLI x-readOnly: true _snmp_v2c: description: | The v2c configurations of SNMP. type: object properties: community: description: | Manager community ID under which Purity//FA is to communicate with the specified managers. type: string maxLength: 32 example: '****' _snmp_v3_patch: description: | The v3 configurations of SNMP. type: object properties: auth_passphrase: description: | Passphrase used by Purity//FA to authenticate the array with the specified managers. type: string maxLength: 32 example: '********' auth_protocol: description: | Hash algorithm used to validate the authentication passphrase. Valid values are `MD5` and `SHA`. type: string example: MD5 privacy_passphrase: description: Passphrase used to encrypt SNMP messages. type: string minLength: 8 maxLength: 63 example: '********' privacy_protocol: description: | Encryption protocol for SNMP messages. Valid values are `AES` and `DES`. type: string example: DES user: description: | User ID recognized by the specified SNMP managers which Purity//FA is to use in communications with them. type: string example: User1 SnmpAgent: allOf: - $ref: '#/components/schemas/_builtInResourceNoId' - type: object properties: engine_id: description: | The administration domain unique name of an SNMP agent. type: string maxLength: 32 readOnly: true example: 80009e2205d7c0bd31fef5b87f4f44da v2c: $ref: '#/components/schemas/_snmp_v2c' v3: $ref: '#/components/schemas/_snmp_v3' version: description: | Version of the SNMP protocol to be used by Purity//FA in communications with the specified manager. Valid values are `v2c` and `v3`. type: string example: v3 SnmpAgentMibResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/SnmpAgentMib' _snmp_v3_post: description: | The v3 configurations of SNMP. type: object properties: auth_passphrase: description: | Passphrase used by Purity//FA to authenticate the array with the specified managers. type: string maxLength: 32 example: '********' auth_protocol: description: | Hash algorithm used to validate the authentication passphrase. Valid values are `MD5` and `SHA`. type: string example: MD5 privacy_passphrase: description: Passphrase used to encrypt SNMP messages. type: string minLength: 8 maxLength: 63 example: '********' privacy_protocol: description: | Encryption protocol for SNMP messages. Valid values are `AES` and `DES`. type: string example: DES user: description: | User ID recognized by the specified SNMP managers which Purity//FA is to use in communications with them. type: string example: User1 _resourceNoId: 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 volume), or correspond to something in the environment, like a host or a server. type: object properties: name: description: | A user-specified name. The name must be locally unique and can be changed. type: string SnmpManager: allOf: - $ref: '#/components/schemas/_resourceNoId' - type: object properties: host: description: | DNS hostname or IP address of a computer that hosts an SNMP manager to which Purity//FA is to send trap messages when it generates alerts. type: string example: snmp.purestorage.com notification: description: | The type of notification the agent will send. Valid values are `inform` and `trap`. type: string example: trap v2c: $ref: '#/components/schemas/_snmp_v2c' v3: $ref: '#/components/schemas/_snmp_v3' version: description: | Version of the SNMP protocol to be used by Purity//FA to communicate with the specified manager. Valid values are `v2c` and `v3`. type: string example: v3 Software: allOf: - $ref: '#/components/schemas/_resourceFixedNonUniqueName' - description: Software to be installed on the array. type: object properties: details: description: | The detailed reason for the `status`. type: string payload_id: description: | A checksum hash referring to the update bundle. type: string example: 4f7b319106401d072ff94808535cb3ce progress: description: | The progress of the software upgrade. Displayed in decimal format. type: number format: float status: description: | The status of the software package. Valid values are `available`, `downloaded`, `downloading`, `download_failed`, `checking`, `installing`, `new`, `paused`, `aborting`, `abort`, `canceled`, `partially_installed`, and `installed`. A status of `available` indicates that the package is available for download. This only applies if `automatic-download` is not enabled. A status of `downloaded` indicates that the package is downloaded and ready for installation. A status of `downloading` indicates that the package is currently downloading. A status of `download_failed` indicates that the download of the package failed. A status of `checking` indicates that the package is currently running in `check-only` mode. A status of `installing` indicates that the package is currently installing. A status of `new` indicates that Pure1 cloud is still building the package. A status of `paused` indicates that the upgrade is paused and waiting for user input to proceed. A status of `aborting` indicates that the upgrade is being aborted, due to an unrecoverable error or an `abort` command issued by the user. A status of `canceled` indicates that the upgrade has been canceled. A status of `partially_installed` indicates that the upgrade has been partially installed due to an `abort`. The array has been upgraded to an intermediate version and the `software` is no longer available for installation. A status of `installed` indicates that the upgrade has finished. type: string example: Available upgrade_hops: description: | The plan by which the upgrade will be conducted. The first element is the current version, the last element is the destination version, and the elements in between are intermediate versions. type: array uniqueItems: true items: type: string example: - 5.0.0 - 5.1.6 - 5.2.3 upgrade_plan: description: | A list of steps that are planned to run during the upgrade in an optimal scenario (i.e., all upgrade checks pass, no step is retried, and the upgrade is not aborted). Steps are listed in the order that they should occur. type: array items: $ref: '#/components/schemas/_softwareUpgradePlan' version: description: | The version of the software package. type: string example: 5.2.3 SoftwareBundle: allOf: - $ref: '#/components/schemas/_builtInRelationship' - description: The software bundle to be installed on the array. type: object properties: bytes_downloaded: description: | The number of bytes downloaded. type: integer format: int64 bytes_total: description: | The total number of bytes to download. type: integer format: int64 created: description: | The creation time in milliseconds since the UNIX epoch. type: number format: integer details: description: | The detailed reason for the `status`. type: string download_progress: description: | The download progress in decimal format. type: number format: float software_name: description: | The name of the software to be tested by the upgrade checks. type: string example: Purity//FA software_version: description: | The version of the software to be tested by the upgrade checks. type: string example: 6.2.0 source: description: | The location of the upgrade bundle. type: string example: ftp://local/upgrade_bundle.sh status: description: | The status of the software bundle. Valid values are `downloading`, `failed`, `ready`, and `verifying`. A status of `downloading` indicates that the array is downloading the upgrade bundle. A status of `failed` indicates that the array has failed to download the upgrade bundle. A status of `ready` indicates that the upgrade bundle is ready to be installed. A status of `verifying` indicates that the array is verifying the upgrade bundle. type: string example: downloading SoftwareCheck: allOf: - $ref: '#/components/schemas/_resourceFixedNonUniqueName' - $ref: '#/components/schemas/_start_end_time' - description: Software upgrade check task to be run on the array. type: object properties: checks: description: | A list of checks in this check task. type: array items: $ref: '#/components/schemas/_softwareChecksChecks' details: description: | The detailed reason for the `status`. type: string software_name: description: | The name of the software the upgrade checks will test. type: string software_upgrade_hops: description: | The list of software versions the upgrade goes through. The upgrade checks also test this particular path. type: array items: type: string description: | A software version in the upgrade path. example: - 6.1.3 - 6.2.0 software_version: description: | The version of the software that the upgrade checks will test. type: string example: 6.2.0 status: description: | The status of the check task. Valid values are `queued`, `running`, `passed`, and `failed`. A status of `queued` indicates that the task is queued to run and is waiting for other check tasks to complete. A status of `running` indicates that the task is currently running. A status of `passed` indicates that all upgrade checks in the task are complete. A status of `failed` indicates that at least one upgrade check in the task has failed. type: string example: running _override_check: type: object properties: args: description: | The name of the specific check within the override check to ignore so that the system can continue with the software upgrade. The `name` parameter of the override check must be specified with the `args` parameter. For example, if the HostIOCheck check fails on hosts host01 and host02, the system displays a list of these host names in the failed check. To override the HostIOCheck checks for host01 and host02, set `name=HostIOCheck`, and set `args=host01,host02`. Enter multiple `args` in comma-separated format. Note that not all checks have `args` values. type: string example: "host1,host2,host3" name: description: | The name of the upgrade check to be overridden so the software upgrade can continue if the check failed or is anticipated to fail during the upgrade process. Overriding the check forces the system to ignore the check failure and continue with the upgrade. If the check includes more specific checks that failed or are anticipated to fail, set them using the `args` parameter. For example, the HostIOCheck check may include a list of hosts that have failed or are anticipated to fail the upgrade check. type: string example: HostIOCheck persistent: description: | If set to `true`, the system always ignores the failure of the specified upgrade check and continues with the upgrade process. If set to `false`, the system ignores the failure of the specified upgrade check until the upgrade check finishes and the upgrade process is continued. For example, the `continue` command is successfully issued in an `interactive` mode, or the first upgrade check step successfully finishes in a `one-click` mode. type: boolean _upgrade_parameters: type: object properties: name: description: | The name of the upgrade parameter to be sent to the upgrade process. type: string value: description: | The value of the upgrade parameter to be sent to the upgrade process. type: string maxLength: 1024 SoftwareInstallation: allOf: - $ref: '#/components/schemas/_resourceFixedNonUniqueName' - $ref: '#/components/schemas/_start_end_time' - description: | Interactive software upgrade attempt that contains information about the current upgrade instance, including the current step, status of the upgrade attempt, etc. type: object properties: current_step_id: description: The `id` of the current step or `null` if the upgrade is not active. type: string details: description: The detailed reason for the `status`. type: string mode: description: | Mode that the upgrade is in. Valid values are `check-only`, `interactive`, `semi-interactive`, and `one-click`. The `check_only` mode is deprecated. Use `/software-checks`. In this mode, the upgrade only runs pre-upgrade checks and returns. In `interactive` mode, the upgrade pauses at several points, at which users must enter certain commands to proceed. In `semi-interactive` mode, the upgrade pauses if there are any upgrade check failures, and functions like `one-click` mode otherwise. In `one-click` mode, the upgrade proceeds automatically without pausing. type: string example: interactive override_checks: description: | A list of upgrade checks whose failure is overridden during the upgrade. If any optional `args` are provided, they are validated later when the corresponding check script runs. type: array items: $ref: '#/components/schemas/_override_check' software: description: | Referenced `software` to which the upgrade belongs. title: Reference allOf: - $ref: '#/components/schemas/_reference' status: description: | Status of the upgrade. Valid values are `installing`, `paused`, `aborting`, `aborted`, and `finished`. A status of `installing` indicates that the upgrade is running. A status of `paused` indicates that the upgrade is paused and waiting for user input. A status of `aborting` indicates that the upgrade is being aborted. A status of `aborted` indicates that the upgrade has stopped due to an abort. A status of `finished` indicates that the upgrade has finished successfully. type: string example: Installing upgrade_parameters: description: | A list of parameters to be sent to the upgrade process. These parameters can be used to change the behavior of the upgrade process in specific ways such as enabling or disabling features in the target version or changing the attributes of the appliance at upgrade time. When there is a need or option to set an upgrade parameter, Pure Storage will provide documentation for the specific parameter. If you have been provided documentation related to a specific upgrade parameter, follow the instructions in the documentation. Otherwise, do not set any upgrade parameters. type: array items: $ref: '#/components/schemas/_upgrade_parameters' SoftwareInstallationStepsResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/SoftwareInstallationStep' SoftwarePatch: allOf: - $ref: '#/components/schemas/_resourceFixedNonUniqueName' - description: Software patch to be installed on the array. type: object properties: alert_code: description: | Alert code for the Software Patch. This code is used to uniquely identify the Software Patch. type: integer format: int64 example: 5200 description: description: The detailed description of the patch. type: string details: description: The detailed reason for the `status`. type: string ha_reduction_required: description: | If set to `true`, indicates reduction in high availability is required for Software Patch installation. If set to `false`, indicates such a reduction is not required. type: boolean example: false progress: description: "The progress of the software patch installation, displayed in decimal format." type: number format: float status: description: | The status of the software patch installation. Valid values are `available`, `downloaded`, `downloading`, `download_failed`, `installing`, `installed`, `failed`, and `not_applicable`. A status of `available` indicates that the patch is available for download. A status of `downloaded` indicates that the patch has been downloaded and will be installed. A status of `downloading` indicates that the patch is currently downloading. A status of `download_failed` indicates that the download of the patch failed. A status of `installing` indicates that the patch is currently being installed. A status of `installed` indicates that the patch has been installed. A status of `failed` indicates that the patch failed to be installed. A status of `not_applicable` indicates the patch does not need to be installed on the array. type: string example: installed SoftwareVersionsResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/SoftwareVersion' _saml2SsoIdp: description: | Properties specific to the identity provider. type: object properties: encrypt_assertion_enabled: description: | If set to `true`, SAML assertions will be encrypted by the identity provider. type: boolean entity_id: description: | A globally unique name for the identity provider. type: string example: http://myidp.mycompany.com/adfs/services/trust metadata_url: description: | The URL of the identity provider metadata. type: string example: https://myidp.mycompany.com/federationmetadata/2007-06/federationmetadata.xml sign_request_enabled: description: | If set to `true`, SAML requests will be signed by the service provider. type: boolean url: description: | The URL of the identity provider. type: string example: https://myidp.mycompany.com/adfs/ls verification_certificate: description: | The X509 certificate that the service provider uses to verify the SAML response signature from the identity provider. type: string _saml2SsoManagement: description: Properties specific to the management service. type: object properties: trust_other_saml_sps_in_fleet: description: | The configuration that defines the validation strategy for remote command execution within fleet deployments. When set to `false` (the default), the array enforces a security check to ensure that source and target arrays share identical `SAML` configurations, including the same `Identity Provider` and `SP Entity ID`. When set to `true`, the array permits remote command execution from other fleet members without verifying `SAML` consistency. Maintaining this value as `false` ensures a higher security posture by restricting execution to verified, consistent environments type: boolean default: false _saml2SsoSpCredential: type: object properties: decryption_credential: description: | The credential used by the service provider to decrypt encrypted SAML assertions from the identity provider. The credential is managed by the `certificates` endpoint and `purecert` CLI commands. title: ReferenceNoId allOf: - $ref: '#/components/schemas/_referenceNoId' entity_id: description: | The `Service Provider Entity ID` used for `SAML` authentication. If this value is not provided, it is auto-generated by the system. To enable `SAML` users to operate across `remote arrays`, all members of a fleet must be configured with the same identifier. type: string signing_credential: description: | The credential used by the service provider to sign SAML requests. The credential is managed by the `certificates` endpoint and `purecert` CLI commands. title: ReferenceNoId allOf: - $ref: '#/components/schemas/_referenceNoId' Saml2Sso: allOf: - $ref: '#/components/schemas/_resourceFixedNonUniqueName' - description: | Configuration information for SAML2-based SSO for FlashArray. type: object properties: array_url: description: | The URL of the array. type: string example: https://myarray.mycompany.com enabled: description: | If set to `true`, the SAML2 SSO configuration is enabled. type: boolean idp: $ref: '#/components/schemas/_saml2SsoIdp' management: $ref: '#/components/schemas/_saml2SsoManagement' services: description: | The list of services for which `SAML2 SSO` `authentication` is enabled. The default value is `management`, indicating that the single sign-on configuration applies to the administrative interface of the system. type: array items: type: string sp: $ref: '#/components/schemas/_saml2SsoSp' Subnet: allOf: - $ref: '#/components/schemas/_resourceNoId' - $ref: '#/components/schemas/SubnetPost' - type: object properties: interfaces: description: List of network interfaces associated with this subnet. type: array readOnly: true items: $ref: '#/components/schemas/_fixedReferenceNoId' services: description: "The services provided by this subnet, as inherited from all of its interfaces." type: array readOnly: true items: type: string description: | Valid values are `iscsi`, `management`, `nvme/fc`, `nvme/roce`, and `replication`. SubscriptionResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Subscription' SubscriptionAssetResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/SubscriptionAsset' Support: allOf: - $ref: '#/components/schemas/SupportPatch' - type: object properties: phonehome_enabled: description: | If set to `true`, enables phonehome. If set to `false`, disables phonehome. type: boolean phonehome_excludes: description: | A list of items that are excluded from phonehome data collection. type: array items: type: string example: application-insights proxy: description: | The value of the current proxy, which is used to connect to cloud services such as phonehome and remote assist. Specify the server name, including the scheme and proxy port number. type: string example: http://proxy.example.com:8080 remote_assist_active: description: | If set to `true`, enables the remote assist session. If set to `false`, disables the remote assist session. type: boolean remote_assist_duration: description: | Specifies the duration of the remote assist session in milliseconds. This parameter should only be provided when establishing a new session. It determines the length of time the session will remain active after it's initiated. type: integer format: int64 example: 86400000 remote_assist_expires: description: | The timestamp when the session expires, measured in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true example: 1574633337678 remote_assist_opened: description: | The timestamp when the session opened, measured in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true example: 1574460534674 remote_assist_paths: type: array readOnly: true items: $ref: '#/components/schemas/_supportRemoteAssistPaths' remote_assist_status: description: | The status of the remote assist session. Values include `connected`, `connecting`, `disconnected`, and `session-active`. type: string readOnly: true example: connected SupportRemoteAssistSessions: description: | Remote assist session settings. type: object properties: access_level: description: | The access level for this remote assist session. This is set to default_access_level unless access_level_override is provided. Values include `restricted` and `elevated`. type: string active: description: | The status of a remote assist session. If set to `true`, enables the remote assist session. If set to `false`, disables the remote assist session. type: boolean duration: description: | Specifies the duration of the remote assist session in milliseconds. This parameter should only be provided when establishing a new session. This parameter determines the length of time the session will remain active after initiation. Defaults to 86400000 (24h) with a min of 14400000 (4h) and a max of 172800000 (48h). type: integer format: int64 example: 86400000 expires: description: | The timestamp when the session expires, measured in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true example: 1574633337678 opened: description: | The timestamp when the session opened, measured in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true example: 1574460534674 paths: type: array readOnly: true items: $ref: '#/components/schemas/_supportRemoteAssistSessionsPaths' status: description: | The status of the remote assist session. Values include `connected`, `connecting`, `disconnected`, and `session-active`. type: string readOnly: true example: connected SupportSystemManifest: type: object description: | system manifest. properties: system-manifest: type: string description: | The system manifest for the array in JSON format. readOnly: true SupportDiagnosticsDetailsResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/SupportDiagnosticsDetails' SupportDiagnosticsSettings: description: | Diagnostics tools type: object properties: last_updated: description: | Date the diagnostics tool was last updated. type: integer format: int64 example: 1672531200000 version: description: | Version of the diagnostics tool. type: string readOnly: true example: 1.0.0 Vchost: allOf: - $ref: '#/components/schemas/_resource' - type: object properties: vcuuid: description: | The vCenter Server uuid of the vchost. type: string example: ddf43502-4e00-405e-b341-e87e7eaa13f6 VchostCertificate: type: object properties: certificate: description: | A reference to the certificate that will be presented to clients accessing the referenced `vchost` using any of the network addresses defined by `endpoints`. title: ReferenceNoIdWithType allOf: - $ref: '#/components/schemas/_referenceNoIdWithType' endpoints: description: | The IPv4 or IPv6 addresses of the endpoints to configure for the vchost, over which the configured certificate will be presented. type: array items: type: string example: 1.2.3.4 id: description: | A globally unique, system-generated ID. The ID cannot be modified. type: string example: uuid-of-association is_local: description: | Returns true if the vchost certificate is local to the array, and false otherwise. type: boolean vchost: description: | The vchost by which the certificate is to be presented over the configured endpoints. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' VchostEndpoint: type: object properties: certificates: description: | The certificate to be presented by the vchost over the configured endpoints. type: array items: $ref: '#/components/schemas/_referenceNoIdWithType' endpoint: description: | The IPv4 or IPv6 address of the endpoint. type: string example: 1.2.3.4 id: description: | A globally unique, system-generated ID. The ID cannot be modified. type: string example: 3a668af2-f63a-0110-bf4a-39e911ac6f07 is_local: description: "Returns true if the vchost endpoint is local to the array, and false otherwise." type: boolean vchost: description: | The vchost for which this endpoint is to be configured. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' VchostConnection: type: object properties: all_vchosts: description: | If set to `true`, the storage container represented by the protocol endpoint is accessible to all vchosts. If set to `false`, the storage container represented by the protocol endpoint is only accesible to the vchosts that have explicit vchost-connections to this protocol endpoint. The default is `false`. type: boolean default: false protocol_endpoint: description: | A reference to the protocol endpoint, representing a storage container that vCenter can use. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' vchost: description: | For vchost-connections, a vchost represents a vCenter. By connecting to a protocol endpoint, the corresponding vCenter gets the access to the storage container represented by this protocol endpoint. The vchost name should be null if `all_vchosts` is set to `true`, which means the storage container is accessible to all vchosts. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' VirtualMachine: type: object properties: created: description: | The virtual machine creation time, measured in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true destroyed: description: | Returns a value of `true` if the virtual machine has been destroyed and is pending eradication. type: boolean readOnly: true id: description: | The ID of the virtual machine to create or modify, as assigned by the external system. `id` is deprecated. Use `vm_id` instead. type: string name: description: | The name of the virtual machine, as assigned by the external system type: string readOnly: true recover_context: description: | A reference to any additional entities needed to recover this virtual machine. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' time_remaining: description: | The amount of time left until the destroyed volume is permanently eradicated, measured in milliseconds. Before the `time_remaining` period has elapsed, the destroyed volume can be recovered by setting `destroyed=false`. type: integer format: int64 readOnly: true vm_id: description: | The ID of the virtual machine, as assigned by the external system. type: string readOnly: true vm_type: description: | The type of virtual machine. The only valid value is `vvol`. type: string readOnly: true example: vvol VirtualMachineVolumeSnapshot: type: object properties: created: description: | The virtual machine volume snapshot creation time measured in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true destroyed: description: | Returns a value of `true` if the virtual machine volume snapshot has been destroyed and is pending eradication. type: boolean readOnly: true id: description: | A globally unique, system-generated ID. The ID cannot be modified. type: string readOnly: true name: description: | The name of the virtual machine volume snapshot. type: string readOnly: true recover_context: description: | A reference to any additional entities needed to recover this virtual machine. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' time_remaining: description: | Specifies the amount of time left until the destroyed volume snapshot is permanently eradicated, measured in milliseconds. Once the `time_remaining` period has elapsed, the volume snapshot is permanently eradicated and can no longer be recovered. type: integer format: int64 readOnly: true vm_id: description: | The ID of the virtual machine, as assigned by the external system. type: string readOnly: true vm_type: description: | The type of virtual machine. The only valid value is `vvol`. type: string readOnly: true example: vvol vvol_name: description: | The name of the virtual machine volume. type: string readOnly: true vvol_type: description: | The type of virtual machine volume. Values include `config` and `data`. type: string readOnly: true example: config _volumePostBase: allOf: - $ref: '#/components/schemas/_destroyedPatchPost' - type: object properties: priority_adjustment: description: Adjusts volume priority. title: PriorityAdjustment allOf: - $ref: '#/components/schemas/_priorityAdjustment' protocol_endpoint: description: | Sets the properties that are specific to protocol endpoints. This can only be used in conjunction to `subtype=protocol_endpoint`. title: Protocol_endpoint allOf: - $ref: '#/components/schemas/_protocol_endpoint' provisioned: description: | Sets the virtual size of the volume, measured in bytes. type: integer format: int64 maximum: 4503599627370496 qos: description: Sets QoS limits. title: Qos allOf: - $ref: '#/components/schemas/_qos' source: description: The source volume of a volume copy. title: Reference allOf: - $ref: '#/components/schemas/_reference' subtype: description: | The type of volume. Valid values are `protocol_endpoint` and `regular`. type: string tags: description: | The list of tags to be upserted with the object. type: array items: $ref: '#/components/schemas/Tag' _priorityAdjustment: type: object properties: priority_adjustment_operator: description: | Valid values are `+`, `-`, and `=`. The values `+` and `-` may be applied to volumes and volume groups to reflect the relative importance of their workloads. Volumes and volume groups can be assigned a priority adjustment of -10, 0, or +10. In addition, volumes can be assigned values of =-10, =0, or =+10. Volumes with settings of -10, 0, +10 can be modified by the priority adjustment setting of a volume group that contains the volume. However, if a volume has a priority adjustment set with the `=` operator (for example, =+10), it retains that value and is unaffected by any volume group priority adjustment settings. type: string priority_adjustment_value: description: | Adjust priority by the specified amount, using the `priority_adjustment_operator`. Valid values are 0 and +10 for `+` and `-` operators, -10, 0, and +10 for the `=` operator. type: integer format: int32 _protocol_endpoint: type: object properties: container_version: description: | Defines vCenter and EXSi host compatibility of the protocol endpoint and its associated container. Valid values include: `1`, `2`, `3`. When `container_version` is set to `1`, it's compatible with vSphere version 7.0.1 or higher. When `container_version` is set to `2`, it's compatible with vSphere version 8.0.0 or higher. When `container_version` is set to `3`, it's compatible with vSphere version 8.0.1 or higher. The default `container_version` is `1`. type: string example: "1" _qos_patch: type: object properties: bandwidth_limit: description: | The maximum QoS bandwidth limit for the volume, measured in `bytes per second`. Throttling occurs when throughput exceeds this limit. The maximum supported limit is `512 GB/s`. Specifying an empty string `""` unsets the limit. title: QosBandwidthLimitPatch oneOf: - $ref: '#/components/schemas/_qos_bw_limit_type' - $ref: '#/components/schemas/_limit_unset_value' iops_limit: description: | The QoS `IOPS` limit for the volume. Specifying an empty string `""` unsets the limit. title: QosIopsLimitPatch oneOf: - $ref: '#/components/schemas/_qos_iops_limit_type' - $ref: '#/components/schemas/_limit_unset_value' Volume: allOf: - $ref: '#/components/schemas/_volumeCommon' - $ref: '#/components/schemas/_context' - type: object properties: pod: description: | A reference to the pod. title: Reference allOf: - $ref: '#/components/schemas/_reference' priority: description: | The current priority value. Priority is calculated by combining all applicable relative `priority_adjustment` values or taking the exact value if the volume has an absolute `priority_adjustment` (specified by an `=` `priority_adjustment_operator`). type: integer format: int32 readOnly: true promotion_status: description: | Current promotion status of a volume. Values include `promoted` and `demoted`. A status of `promoted` indicates that the volume has been promoted and can accept write requests from hosts. This is the default status for a volume when it is created. A status of `demoted` indicates that the volume has been demoted and no longer accepts write requests. type: string protocol_endpoint: description: | Properties that are specific to volumes of `subtype=protocol_endpoint`. title: Protocol_endpoint allOf: - $ref: '#/components/schemas/_protocol_endpoint' requested_promotion_state: description: | Values include `promoted` and `demoted`. Patch `requested_promotion_state` to `demoted` to demote the volume so that the volume stops accepting write requests. Patch `requested_promotion_state` to `promoted` to promote the volume so that the volume starts accepting write requests. type: string source: description: | A reference to the originating volume as a result of a volume copy. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' subtype: description: | The type of volume. Values include `protocol_endpoint` and `regular`. type: string readOnly: true volume_group: description: | A reference to the volume group. title: Reference allOf: - $ref: '#/components/schemas/_reference' workload: $ref: '#/components/schemas/_workloadConfigurationReference' VolumesDiffResponse: type: object properties: items: description: A list of different chunks between specified volumes. type: array items: $ref: '#/components/schemas/VolumeDiff' ResourcePerformance: allOf: - $ref: '#/components/schemas/_performance' - $ref: '#/components/schemas/_performance_others' - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_context' ResourcePerformanceByArray: allOf: - $ref: '#/components/schemas/ResourcePerformance' - type: object properties: array: description: | The array on which the performance metrics were recorded. title: Resource allOf: - $ref: '#/components/schemas/_resource' VolumeSpace: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_context' - type: object properties: space: description: | Displays size and space consumption information. title: VolumeSpaceCommon allOf: - $ref: '#/components/schemas/_volumeSpaceCommon' time: description: | The timestamp of when the data was taken, measured in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true x-readOnly: true _qos: type: object properties: bandwidth_limit: description: | The maximum QoS bandwidth limit for the volume. Whenever throughput exceeds the bandwidth limit, throttling occurs. Measured in bytes per second. Maximum limit is 512 GB/s. title: Qos_bw_limit_type allOf: - $ref: '#/components/schemas/_qos_bw_limit_type' iops_limit: description: | The QoS IOPs limit for the volume. title: Qos_iops_limit_type allOf: - $ref: '#/components/schemas/_qos_iops_limit_type' VolumeGroup: allOf: - $ref: '#/components/schemas/_context' - $ref: '#/components/schemas/_resource' - description: | Volume groups organize FlashArray volumes into logical groupings. type: object properties: destroyed: description: | Returns a value of `true` if the volume group has been destroyed and is pending eradication. Before the `time_remaining` period has elapsed, the destroyed volume group can be recovered by setting `destroyed=false`. After the `time_remaining` period has elapsed, the volume group is permanently eradicated and cannot be recovered. type: boolean pod: description: | A reference to the pod. title: Reference allOf: - $ref: '#/components/schemas/_reference' priority_adjustment: $ref: '#/components/schemas/_priorityAdjustment' qos: $ref: '#/components/schemas/_qos' space: title: Space allOf: - $ref: '#/components/schemas/_space' time_remaining: description: | The amount of time left until the destroyed volume group is permanently eradicated, measured in milliseconds. type: integer format: int64 readOnly: true volume_count: description: The number of volumes in the volume group. type: integer format: int64 readOnly: true example: 3 workload: $ref: '#/components/schemas/_workloadConfigurationFixedReference' VolumeSnapshot: allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_snapshot' - $ref: '#/components/schemas/_context' - description: | A point-in-time image of the contents of the volume. type: object properties: serial: description: | A serial number generated by the system when the snapshot is created. The serial number is unique across all arrays. type: string readOnly: true space: description: | Displays size and space consumption information. title: SnapshotSpace allOf: - $ref: '#/components/schemas/_snapshotSpace' volume_group: description: | The volume group to which the volume that is the source of the volume snapshot belongs. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' VolumeSnapshotTransferResponse: type: object properties: items: description: | Displays a list of all items after filtering. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty. type: array items: $ref: '#/components/schemas/VolumeSnapshotTransfer' VolumeSnapshotTransfer: allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_transfer' - $ref: '#/components/schemas/_context' - description: | The transfer statistics for snapshot replication data. type: object _workloadParameter: description: The name and value of a single parameter. type: object properties: name: description: The name of the parameter. type: string value: $ref: '#/components/schemas/_workloadParameterValue' Workload: allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_context' - description: | Workloads organize storage resources (such as volumes) and their related configuration and policy objects into logical groupings. type: object properties: created: description: "The workload creation time, measured in milliseconds since the UNIX epoch." type: integer format: int64 readOnly: true destroyed: description: | Returns a value of `true` if the workload has been destroyed and is pending eradication. The `time_remaining` displays the amount of time left until the destroyed workload is permanently eradicated. Before the `time_remaining` period has elapsed, the destroyed workload can be recovered by setting `destroyed=false`. Once the `time_remaining` period has elapsed, the workload is permanently eradicated and can no longer be recovered. type: boolean readOnly: true preset: description: | A reference to the preset the workload was deployed from. If the preset has since been destroyed, `name` will be `null`. title: WorkloadPreset allOf: - $ref: '#/components/schemas/_workloadPreset' status: description: | The status of the workload. Supported values are `creating`, `ready`, `destroying`, `destroyed`, `eradicating` and `recovering`. type: string readOnly: true example: ready status_details: description: | Additional information about the workload status. For example, if the workload status is `creating`, status details might describe what resources are currently being created. type: array readOnly: true items: type: string time_remaining: description: | The amount of time left until the destroyed workload is permanently eradicated, measured in milliseconds. Before the `time_remaining` period has elapsed, the destroyed workload can be recovered by setting `destroyed=false`. type: integer format: int64 readOnly: true _workloadPlacementRecommendationAdditionalConstraints: description: | The list of targets considered for workload placement must satisfy the requirements imposed by the preset. It is also possible to specify additional constraints to further restrict the list of targets for consideration. type: object properties: required_resource_references: description: | Defines a group of resources. At least one resource from each item should be present on this target for the target to be considered an acceptable candidate for workload placement type: array items: $ref: '#/components/schemas/_workloadPlacementRecommendationResourceReference' targets: description: | If specified, only consider these targets when computing placement recommendations. If not specified, the whole fleet is used to compute the recommendation. type: array items: $ref: '#/components/schemas/_referenceWithType' _workloadPlacementRecommendationParameter: allOf: - $ref: '#/components/schemas/_workloadParameter' - description: | The single parameter passed to the recommendation API. It specifies either a fixed value for the parameter or defines constraints with a set of allowed values. type: object properties: constraints: $ref: '#/components/schemas/_workloadPlacementRecommendationParameterConstraints' _workloadPlacementRecommendationResult: description: Single workload placement recommendation result. type: object properties: parameters: description: | The parameter values passed to the preset when creating a workload based on the recommendation result. type: array items: $ref: '#/components/schemas/_workloadParameter' placements: deprecated: true description: | The placements of the preset. (Deprecated) Use 'targets' instead. type: array readOnly: true items: $ref: '#/components/schemas/_workloadPlacementRecommendationPlacement' score: description: | The score of the recommendation from Pure1. Possible values include `optimal`, `optimal-with-warnings`, and `acceptable`. type: string readOnly: true targets: description: | The list of recommended arrays. type: array readOnly: true items: $ref: '#/components/schemas/_workloadPlacementRecommendationGenericTarget' _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 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 _apiToken: description: API token type: object properties: created_at: description: Creation time in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true expires_at: description: Expiration time in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true token: type: string readOnly: true x-readOnly: true AlertEvent: allOf: - $ref: '#/components/schemas/_builtInResourceNoId' - $ref: '#/components/schemas/_context' - description: Alert timeline event. type: object properties: actual: description: Actual condition at the time the alert is created. type: string readOnly: true example: 95% alert: $ref: '#/components/schemas/_fixedReference' code: description: The parent alert number. type: integer format: int64 readOnly: true example: 7 component_name: description: The component type of the alert. type: string readOnly: true example: vm-tom component_type: description: The component name of the alert. type: string readOnly: true example: storage created: description: The time the parent alert was created. type: integer format: int64 example: 1576275532434 expected: description: Expected state and threshold under normal conditions. type: string readOnly: true example: 90% issue: description: Information about the alert cause. type: string readOnly: true example: boot drive overutilization knowledge_base_url: description: The knowledge base URL of the alert. type: string readOnly: true example: https://support.purestorage.com/?cid=Alert_0007 severity: description: | The severity level of the alert. Valid values include `info`, `warning`, `critical`, and `hidden`. type: string readOnly: true example: critical state: description: | The state of the alert. Valid values include `open`, `closing`, and `closed`. type: string readOnly: true example: open summary: description: A summary of the alert. type: string readOnly: true example: boot drive overutilization time: description: The time the event occurred. type: integer format: int64 readOnly: true example: 1578440491109 AlertRulesCatalog: allOf: - $ref: '#/components/schemas/_context' - description: | Available alerts for customization type: object properties: allowed_values: description: | The range of values allowed to set the custom alert rule to. type: string example: Range 0-100 (must be equal to or lower than Warning Threshold) code: description: | The alert code that the rule applies to. type: integer format: int32 example: 25 default_value: description: | The system default values for the alert code and parameter. type: string example: 80% parameter: description: | The parameter of the custom alert rule. type: string example: info subject: description: | The alert code description. type: string example: "Storage consumption has reached {percent_usage}% of usable capacity" AppNode: description: | An individual node of a Purity app. Nodes are indexed starting at `0`. type: object properties: app: description: A reference to the app of which this node is a part. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' index: description: An index that represents this node. type: integer readOnly: true example: 0 status: description: | The node status. Possible values are `starting`, `healthy`, `unhealthy`, `critical`, `stopping`, and `disabled`. type: string readOnly: true example: healthy version: description: The node version. type: string readOnly: true example: 1.0.0 vnc: description: | The VNC information used to access this node if VNC is enabled. type: array readOnly: true items: type: string example: 10.1.1.10:5900 x-readOnly: true _arrayencryptionDataAtRest: description: | Data at rest encryption properties. type: object properties: algorithm: description: | The algorithm used to encrypt data on the array. Values include `AES-256-CTR` and `null`. type: string example: AES-256-CTR enabled: description: | Returns a value of `true` if data at rest encryption is enabled on the array. type: boolean _cacheSpace: type: object properties: total_available_cache_size: description: The DRAM cache available on the primary controller, measured in bytes. type: integer format: int64 example: 3298534883328 total_installed_cache_size: description: The DRAM cache installed on both controllers, measured in bytes. type: integer format: int64 example: 6597069766656 CloudConfigAutomaticCapacityUpgrade: type: object properties: details: description: | This field displays error details, warnings, and progress information. The default value is an empty string. type: string example: Automatic capacity upgrade will be triggered once the array is full enabled: description: | Indicates if the automatic capacity upgrade is enabled. type: boolean example: true max_capacity: description: | The maximum capacity for the automatic upgrade in bytes. type: integer format: int64 example: 30786325577728 CloudConfigModel: type: object properties: current: description: The current model of the CBS array. type: string example: CBS-V10MP2R2 details: description: | Details about the hardware upgrade. This field can contain error details or progress information when the status is `upgrading`. The default value is an empty string. type: string example: "" override_checks: description: A list of upgrade checks to be overridden. type: array items: type: string example: - HostIOCheck - HostPathsCheck requested: description: A requested model of the CBS array. type: string example: CBS-V20MP2R2 status: description: | The status of the hardware upgrade process. Can be one of `idle`, `paused`, `upgrading`. type: string example: upgrading step: description: | The current step of the hardware upgrade process. Can be `pre-upgrade-check`, `upgrade-ct0`, `failover` and so on. The default value is an empty string. type: string example: mid-upgrade-check _performance: type: object properties: bytes_per_mirrored_write: description: | The average I/O size per mirrored write, measured in bytes. type: integer format: int64 minimum: 0 readOnly: true bytes_per_op: description: | The average I/O size for both read and write (all) operations. type: integer format: int64 minimum: 0 readOnly: true bytes_per_read: description: | The average I/O size per read, measured in bytes. type: integer format: int64 minimum: 0 readOnly: true bytes_per_write: description: | The average I/O size per write, measured in bytes. type: integer format: int64 minimum: 0 readOnly: true cached_read_bytes_per_sec: description: The number of cached bytes read, measured in bytes per second. type: integer format: int64 minimum: 0 readOnly: true cached_reads_per_sec: description: The number of cached read requests, measured in requests per second. type: integer format: int64 minimum: 0 readOnly: true mirrored_write_bytes_per_sec: description: | The number of mirrored bytes written per second. type: integer format: int64 minimum: 0 readOnly: true mirrored_writes_per_sec: description: | The number of mirrored writes per second. type: integer format: int64 minimum: 0 readOnly: true non_cached_read_bytes_per_sec: description: The number of non-cached bytes read, measured in bytes per second. type: integer format: int64 minimum: 0 readOnly: true non_cached_reads_per_sec: description: The number of non-cached read requests, measured in requests per second. type: integer format: int64 minimum: 0 readOnly: true qos_rate_limit_usec_per_mirrored_write_op: description: | The average time it takes the array to process a mirrored I/O write request, measured in microseconds. type: integer format: int64 minimum: 0 readOnly: true qos_rate_limit_usec_per_read_op: description: | The average time spent waiting due to QoS rate limiting for a read request, measured in microseconds. type: integer format: int64 minimum: 0 readOnly: true qos_rate_limit_usec_per_write_op: description: | The average time that a write I/O request spends waiting as a result of the volume reaching its QoS bandwidth limit, measured in microseconds. type: integer format: int64 minimum: 0 readOnly: true qos_scheduling_usec_per_mirrored_write_op: description: | The average time that a mirrored write I/O gets delayed due to QoS scheduling, measured in microseconds. type: integer format: int64 minimum: 0 readOnly: true qos_scheduling_usec_per_read_op: description: | The average time that a read I/O gets delayed due to QoS scheduling, measured in microseconds. type: integer format: int64 minimum: 0 readOnly: true qos_scheduling_usec_per_write_op: description: | The average time that a write I/O gets delayed due to QoS scheduling, measured in microseconds. type: integer format: int64 minimum: 0 readOnly: true queue_usec_per_mirrored_write_op: description: | The average time that a mirrored write I/O request spends in the kernel waiting to be served, measured in microseconds. type: integer format: int64 minimum: 0 readOnly: true queue_usec_per_read_op: description: | The average time that a read I/O request spends in the kernel waiting to be served, measured in microseconds. type: integer format: int64 minimum: 0 readOnly: true queue_usec_per_write_op: description: | The average time that a write I/O request spends in the kernel waiting to be served, measured in microseconds. type: integer format: int64 minimum: 0 readOnly: true read_bytes_per_sec: description: | The number of bytes read per second. type: integer format: int64 minimum: 0 readOnly: true read_cache_hit_ratio: description: The ratio of read requests served directly from the cache. type: number format: float minimum: 0 maximum: 1 readOnly: true reads_per_sec: description: | The number of read requests processed per second. type: integer format: int64 minimum: 0 readOnly: true san_usec_per_mirrored_write_op: description: | The average time required to transfer data from the initiator to the array for a mirrored write request, measured in microseconds. type: integer format: int64 minimum: 0 readOnly: true san_usec_per_read_op: description: | The average time required to transfer data from the array to the initiator for a read request, measured in microseconds. type: integer format: int64 minimum: 0 readOnly: true san_usec_per_write_op: description: | The average time required to transfer data from the initiator to the array for a write request, measured in microseconds. type: integer format: int64 minimum: 0 readOnly: true service_usec_per_mirrored_write_op: description: | The average time required for the array to service a mirrored write request, measured in microseconds. type: integer format: int64 minimum: 0 readOnly: true service_usec_per_read_op: description: | The average time required for the array to service a read request, measured in microseconds. type: integer format: int64 minimum: 0 readOnly: true service_usec_per_read_op_cache_reduction: description: | The percentage reduction in `service_usec_per_read_op` due to data cache hits. For example, a value of 0.25 indicates that the value of `service_usec_per_read_op` is 25% lower than it would have been without any data cache hits. type: number format: float minimum: 0 maximum: 1 service_usec_per_read_op_cached: description: | The average time required for the array to service a read request that is satisfied by a cache hit, measured in microseconds. type: integer format: int64 minimum: 0 readOnly: true service_usec_per_read_op_non_cached: description: | The average time required for the array to service a read request that is not satisfied by a cache hit, measured in microseconds. type: integer format: int64 minimum: 0 readOnly: true service_usec_per_write_op: description: | The average time required for the array to service a write request, measured in microseconds. type: integer format: int64 minimum: 0 readOnly: true time: description: | The time when the sample performance data was taken, measured in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true usec_per_mirrored_write_op: description: | The average time it takes the array to process a mirrored I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time. type: integer format: int64 minimum: 0 readOnly: true usec_per_read_op: description: | The average time it takes the array to process an I/O read request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time. type: integer format: int64 minimum: 0 readOnly: true usec_per_write_op: description: | The average time it takes the array to process an I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time. type: integer format: int64 minimum: 0 readOnly: true write_bytes_per_sec: description: The number of bytes written per second. type: integer format: int64 minimum: 0 readOnly: true writes_per_sec: description: The number of write requests processed per second. type: integer format: int64 minimum: 0 readOnly: true x-readOnly: true _performance_others: type: object properties: mirrored_others_per_sec: description: The number of mirrored other requests processed per second. type: integer format: int64 minimum: 0 readOnly: true others_per_sec: description: The number of other requests processed per second. type: integer format: int64 minimum: 0 readOnly: true usec_per_mirrored_other_op: description: | The average time it takes the array to process a mirrored I/O other request, measured in microseconds. type: integer format: int64 minimum: 0 readOnly: true usec_per_other_op: description: | The average time it takes the array to process an I/O other request, measured in microseconds. type: integer format: int64 minimum: 0 readOnly: true x-readOnly: true ArrayPerformanceByLink: allOf: - $ref: '#/components/schemas/ArrayPerformance' - description: | Array-level front-end I/O performance per link. A link represents a set of arrays that an I/O operation depends on. type: object properties: link: description: | List of IDs and array names for the link type: array items: $ref: '#/components/schemas/_resource' _time_window: type: object properties: end: description: "The window end time. Measured in milliseconds since midnight. The time must be set on the hour. (e.g., `28800000`, which is equal to 8:00 AM)." type: integer format: int64 example: 46800000 start: description: "The window start time. Measured in milliseconds since midnight. The time must be set on the hour. (e.g., `18000000`, which is equal to 5:00 AM)." type: integer format: int64 example: 3600000 ArrayConnectionPath: allOf: - $ref: '#/components/schemas/_builtInResourceNoId' - $ref: '#/components/schemas/_context' - description: | Path from the local array to a remote array. The `name` parameter indicates the name of the remote array. type: object properties: encryption: description: | If `encrypted`, all traffic over this array connection will be encrypted. If `unencrypted`, all traffic over this array connection will be unencrypted. type: string example: encrypted encryption_mode: description: | Cryptographic protocol, trust model, and encryption algorithm information. Will be `null` if `encrypted` is `false`. type: string example: TLS-PSK-AES-256 id: description: | A globally unique, system-generated ID of an array connection. type: string readOnly: true local_address: description: | IP address or WWN of the local port. type: string example: 10.202.101.70 local_port: description: | The local port of the path. type: string example: ct0.eth0 remote: description: | The remote array. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' remote_address: description: | IP address or WWN of the remote port. type: string example: 10.202.101.78 remote_port: description: | The remote port of the path. type: string example: ct1.eth0 replication_transport: description: | The protocol used to transport data between the local array and the remote array. Valid values are `ip` and `fc`. type: string status: description: | Status of the connection. Valid values are `connected`, `connecting`, and `quarantined`. A status of `connected` indicates that the arrays are communicating. A status of `connecting` indicates that the array is trying to establish a connection. A status of `quarantined` indicates that the path is unstable and has been temporarily embargoed for synchronous replication connections. type: string readOnly: true status_details: description: | Additional information describing any issues encountered when connecting, or `null` if the `status` is `connected`. type: string readOnly: true type: description: | The type of path. Valid values include `async-replication`, `sync-replication`, and `fleet-management`. type: string Audit: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_context' - type: object properties: arguments: description: The arguments provided to the command. type: string readOnly: true example: --size 1G vol2 command: description: The top level command that starts with the string "pure" as a convention. type: string readOnly: true example: purevol origin: description: The array from which the command originated. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' subcommand: description: | The `command` and `subcommand` combination determines which action the user attempted to perform. type: string readOnly: true example: create system_event: description: | If set to `true`, the audit record represents a system-initiated event resulting from a previous configuration. If set to `false`, the audit record represents an event invoked directly by a user. type: boolean readOnly: true example: false time: description: The time at which the command was run in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true example: 1577402821354 user: description: The user who ran the command. type: string readOnly: true example: pureuser user_interface: description: | The user interface through which the user session event was performed. Valid values are `CLI`, `GUI`, and `REST`. type: string readOnly: true example: CLI _bucketBase: allOf: - $ref: '#/components/schemas/_context' - type: object description: | The bucket in the object store. A bucket is a container for objects. properties: account: $ref: '#/components/schemas/_fixedReferenceWithType' created: description: The bucket creation time in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true example: 1602115200000 destroyed: description: | Returns `true` if the bucket has been destroyed and is pending eradication. The `time_remaining` value displays the amount of time left until the destroyed bucket is permanently eradicated. Once the `time_remaining` period has elapsed, the bucket is permanently eradicated and can no longer be recovered. type: boolean example: false object_count: description: The count of objects within the bucket. type: integer format: int64 readOnly: true example: 42 time_remaining: description: | The time in milliseconds before the bucket is eradicated. Returns `null` if the bucket is not destroyed. type: integer format: int64 readOnly: true example: 86400000 versioning: description: | The versioning state for objects within the bucket. Valid values are `none`, `enabled`, and `suspended`. type: string example: enabled _bucketPerformanceBase: type: object properties: bytes_per_op: description: | The average size of an I/O operation. This metric is calculated as: the sum of `read bytes` and `write bytes` or the sum of `read ops` and `write ops`. type: number format: double minimum: 0 readOnly: true bytes_per_read: description: The average size of a read I/O operation. type: number format: double minimum: 0 readOnly: true bytes_per_write: description: The average size of a write I/O operation. type: number format: double minimum: 0 readOnly: true others_per_sec: description: The number of miscellaneous `operations` processed `per second`. type: number format: double minimum: 0 readOnly: true read_bytes_per_sec: description: The number of `bytes read` `per second`. type: number format: double minimum: 0 readOnly: true reads_per_sec: description: The number of `read requests` processed `per second`. type: number format: double minimum: 0 readOnly: true time: description: The `sample time` represented in `milliseconds` since the `UNIX epoch`. type: integer format: int64 readOnly: true usec_per_other_op: description: | The `average time`, measured in `microseconds`, that the array takes to process `other operations`. type: number format: double minimum: 0 readOnly: true usec_per_read_op: description: | The `average time`, measured in `microseconds`, that the array takes to process a `read request`. type: number format: double minimum: 0 readOnly: true usec_per_write_op: description: | The `average time`, measured in `microseconds`, that the array takes to process a `write request`. type: number format: double minimum: 0 readOnly: true write_bytes_per_sec: description: The number of `bytes written` `per second`. type: number format: double minimum: 0 readOnly: true writes_per_sec: description: The number of `write requests` processed `per second`. type: number format: double minimum: 0 readOnly: true x-readOnly: true _workloadConfigurationReference: type: object description: | A reference to the workload that is managing this resource. The `name` and `configuration` may show as the string "(unknown)" briefly after a failover. allOf: - $ref: '#/components/schemas/_referenceWithFixedType' - type: object properties: configuration: description: | The name of the preset configuration object. type: string _limitedBy: type: object properties: member: description: Reference to the resource to which the effective quota policy is attached. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' policy: description: Reference to the effective quota policy. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' x-readOnly: true DirectoryGroup: allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_context' - type: object properties: directory_name: description: | The managed directory name without the file system name prefix. A full managed directory name is constructed in the form of `FILE_SYSTEM:DIR` where `FILE_SYSTEM` is the file system name and `DIR` is the value of this field. type: string readOnly: true file_system: description: | The file system that the managed directory occupies. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' group: description: | A group which has content in the managed directory. title: UserGroup allOf: - $ref: '#/components/schemas/UserGroup' limited_by: description: | The user-group-quota or quota policy that is limiting usage for this group in this managed directory. This policy defines the total amount of space allowed for this group or this managed directory. The returned value contains two parts: the name of the policy and the managed directory to which the policy is attached. title: UserGroupQuotaLimitedBy allOf: - $ref: '#/components/schemas/UserGroupQuotaLimitedBy' path: description: | Absolute path of the managed directory in the file system. type: string readOnly: true space: description: | The logical space owned by the group. title: UserGroupSpace allOf: - $ref: '#/components/schemas/UserGroupSpace' 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 DirectoryUser: allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_context' - type: object properties: directory_name: description: | The managed directory name without the file system name prefix. A full managed directory name is constructed in the form of `FILE_SYSTEM:DIR` where `FILE_SYSTEM` is the file system name and `DIR` is the value of this field. type: string readOnly: true file_system: description: | The file system that the managed directory is in. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' limited_by: description: | The user-group-quota or quota policy that is limiting usage for this user in this managed directory. This policy defines the total amount of space allowed for this user or this managed directory. The returned value contains two parts: the name of the policy and the managed directory to which the policy is attached. title: UserGroupQuotaLimitedBy allOf: - $ref: '#/components/schemas/UserGroupQuotaLimitedBy' path: description: | Absolute path of the managed directory in the file system. type: string readOnly: true space: description: | The logical space owned by the user. title: UserGroupSpace allOf: - $ref: '#/components/schemas/UserGroupSpace' user: description: | A user which has content in the managed directory. title: UserGroup allOf: - $ref: '#/components/schemas/UserGroup' DirectoryGroupQuota: allOf: - $ref: '#/components/schemas/_context' - type: object properties: directory: description: | The directory with the user-group-quota policy attached. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' group: description: | The group for which the user-group-quota policy rules apply. title: UserGroup allOf: - $ref: '#/components/schemas/UserGroup' group_email: description: | The email address of the group. type: string readOnly: true path: description: | Absolute path of the managed directory in the file system. type: string readOnly: true percentage_used: description: | The ratio of the quota usage to the quota limit. The usage has reached the quota limit if it reaches 1.0. type: number format: float readOnly: true quota_usage: description: | The total usage owned by the group that is accountable to the user-group-quota policy rules. The applicable rules may be enforced or unenforced. The usage is measured in bytes. type: integer format: int64 readOnly: true rule: description: | The user-group-quota rule that applies to the group. title: DirectoryUserQuotaRule allOf: - $ref: '#/components/schemas/DirectoryUserQuotaRule' DirectoryQuota: allOf: - $ref: '#/components/schemas/_context' - type: object properties: directory: description: The directory to which the quota applies. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' enabled: description: | Returns a value of `true` if the policy is enabled. type: boolean readOnly: true 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 path: description: | Absolute path of the directory in the file system. type: string readOnly: true percentage_used: description: | The percentage of the space used in the directory with respect to the quota limit. type: number format: float minimum: 0 readOnly: true policy: description: | The effective quota policy that imposes the limit. This is the policy with the lowest limit. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' quota_limit: description: | Effective quota limit imposed by the quota policy rule attached to the directory, measured in bytes. type: integer format: int64 minimum: 0 readOnly: true rule_name: description: | Name of the rule that results in this quota and behavior being applied to this directory. type: string readOnly: true usage: description: | The amount of logically written data for the directory, measured in bytes. type: integer format: int64 minimum: 0 readOnly: true _realmsReference: type: object properties: realms: description: | Reference to the realms this resource belongs to. The value is set to empty array when the resource lives outside of a realm. type: array readOnly: true items: $ref: '#/components/schemas/_fixedReferenceWithType' _localDirectoryServiceReference: description: | An object, which is contained in a local directory service. type: object properties: local_directory_service: description: | Reference to the local directory service the object belongs to. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' DirectorySnapshotEradicationConfig: description: The configuration of the eradication feature. type: object properties: manual_eradication: description: | Manual eradication status of directory snapshots. If manual_eradication is `disabled`, you cannot eradicate objects. Values include `disabled` and `enabled`. type: string readOnly: true example: enabled x-readOnly: true DirectoryUserQuota: allOf: - $ref: '#/components/schemas/_context' - type: object properties: directory: description: | The directory with the user-group-quota policy attached. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' path: description: | Absolute path of the managed directory in the file system. type: string readOnly: true percentage_used: description: | The ratio of the quota usage to the quota limit. The usage has reached the quota limit if it reaches 1.0. type: number format: float readOnly: true quota_usage: description: | The total usage owned by the user that is accountable to the user-group-quota policy rules, measured in bytes. The applicable rules may be enforced or unenforced. type: integer format: int64 readOnly: true rule: description: | The user-group-quota rule that applies to the user. title: DirectoryUserQuotaRule allOf: - $ref: '#/components/schemas/DirectoryUserQuotaRule' user: description: | The user for which the user-group-quota policy rules apply. title: UserGroup allOf: - $ref: '#/components/schemas/UserGroup' user_email: description: | The email address of the user. type: string readOnly: true ContainerEradicationConfig: description: The status of the eradication functionality type: object properties: manual_eradication: description: | The manual eradication status of the container. If `all-enabled`, the container and its contents can be eradicated. If `partially-disabled`, the container cannot be eradicated because the container contains some some entities that are eradication disabled. If `all-disabled`, the container and its contents cannot be eradicated. Values include `all-disabled`, `all-enabled`, and `partially-disabled`. type: string readOnly: true example: all-enabled _fleetmemberpostMember: type: object properties: id: description: | A globally unique, system-generated ID. The ID cannot be modified. type: string name: description: | The resource name. type: string resource_type: description: | Type of the object (e.g. remote-arrays) type: string x-aliases: - _fleetMemberPostMembersMember _fixedReferenceWithTypeAndLocation: allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' - $ref: '#/components/schemas/_referenceWithoutTypeWithIsLocal' - 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 fleet would have a `resource_type` of `fleets`. type: string x-aliases: - _fixedReferenceWithIsLocal _qos_bw_limit_type: type: integer format: int64 minimum: 1048576 maximum: 549755813888 _qos_iops_limit_type: type: integer format: int64 minimum: 100 maximum: 100000000 _limit_unset_value: type: string minLength: 0 maxLength: 0 _host_port_connectivity: description: | The connectivity status between the host and the ports on each controller. type: object properties: details: description: | The host connection status. Values include `Redundant`, `N/A`, `Redundant-Failover`, `Uneven`, `Unused Port`, `Single Controller`, `Single Controller-Failover`, and `None`. type: string readOnly: true example: Redundant status: description: | The host connection health status. Values include `healthy`, `unhealthy`, and `critical`. type: string readOnly: true example: healthy x-readOnly: true _portCommon: type: object properties: iqn: description: The iSCSI Qualified Name (or `null` if target is not iSCSI). type: string readOnly: true example: iqn.2010-06.com.purestorage:flasharray.393d930077be2977 nqn: description: NVMe Qualified Name (or `null` if target is not NVMeoF). type: string readOnly: true example: nqn.2010-06.com.purestorage:flasharray.512f7bb185978505 portal: description: IP and port number (or `null` if target is not iSCSI). type: string readOnly: true example: 10.16.200.27:3260 wwn: description: | Fibre Channel World Wide Name (or `null` if target is not Fibre Channel). type: string readOnly: true example: 52:4A:93:70:4E:E5:68:00 x-readOnly: true PortInitiatorTarget: allOf: - $ref: '#/components/schemas/_basePort' Kmip_certificate: type: object properties: name: description: | The resource name, such as volume name, pod name, snapshot name, and so on. type: string Kmip_object: type: object properties: name: description: | Name of the KMIP object. type: string uid: description: | User ID of the KMIP object. type: string _lifecycleRuleBase: allOf: - $ref: '#/components/schemas/_context' - $ref: '#/components/schemas/_lifecycle_rule_config_base' - type: object properties: bucket: description: | The bucket which this lifecycle rule is targeting. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' cleanup_expired_object_delete_marker: description: | Returns a value of `true` if the expired object delete markers will be removed. type: boolean readOnly: true example: true enabled: description: | If set to `true`, this rule will be enabled. type: boolean rule_id: description: | The identifier for the rule. It must be unique to the bucket. The maximum length is 255 characters. If not specified, an ID unique to the bucket is generated in the format `RuleId`, where `` increments starting at 1. type: string _networkInterfaceEth: description: Ethernet network interface properties. type: object properties: address: description: | The IPv4 or IPv6 address to be associated with the specified network interface. type: string gateway: description: | The IPv4 or IPv6 address of the gateway through which the specified network interface is to communicate with the network. type: string mac_address: description: | The media access control address associated with the specified network interface. type: string readOnly: true mtu: description: | Maximum message transfer unit (packet) size for the network interface, in bytes. MTU setting cannot exceed the MTU of the corresponding physical interface. type: integer format: int32 netmask: description: | Netmask of the specified network interface that, when combined with the address of the interface, determines the network address of the interface. type: string subinterfaces: description: | List of network interfaces configured to be a subinterface of the specified network interface. type: array items: $ref: '#/components/schemas/_fixedReferenceNoId' subnet: description: | Subnet that is associated with the specified network interface. title: ReferenceNoId allOf: - $ref: '#/components/schemas/_referenceNoId' subtype: description: | The subtype of the specified network interface. Only interfaces of subtype `virtual` can be created. Configurable on POST only. Valid values are `failover_bond`, `lacp_bond`, `physical`, and `virtual`. type: string vlan: description: VLAN ID type: integer format: int32 readOnly: true _networkInterfaceFc: description: Fibre Channel port properties. type: object properties: wwn: description: World Wide Name of the specified Fibre Channel port. type: string readOnly: true NetworkInterfaceNeighbor: type: object properties: initial_ttl_in_sec: description: | The initial time to live in seconds from when the local port received notice that the neighbor information is regarded as valid. The time is not measured from when this endpoint was queried. type: integer format: uint32 readOnly: true example: 120 local_port: description: | A reference to the local network interface the neighbor is connected to. title: FixedReferenceNoId allOf: - $ref: '#/components/schemas/_fixedReferenceNoId' neighbor_chassis: title: NetworkInterfaceNeighborNeighborChassis allOf: - $ref: '#/components/schemas/_networkInterfaceNeighborNeighborChassis' neighbor_port: title: NetworkInterfaceNeighborNeighborPort allOf: - $ref: '#/components/schemas/_networkInterfaceNeighborNeighborPort' x-readOnly: true _networkInterfacePerformanceEth: description: | Ethernet network interface statistics. type: object properties: flow_control_received_congestion_packets_per_sec: description: | Number of congestion control packets received per second. type: integer format: int64 minimum: 0 flow_control_received_discarded_packets_per_sec: description: | Number of received packets that were physically discarded by the NIC per second due to errors or other reasons. type: integer format: int64 minimum: 0 flow_control_received_lossless_bytes_per_sec: description: | Bytes received per second with lossless flow control settings. type: integer format: int64 minimum: 0 flow_control_received_pause_frames_per_sec: description: | Received pause frames per second. type: integer format: int64 minimum: 0 flow_control_transmitted_congestion_packets_per_sec: description: | Number of congestion control packets transmitted per second. type: integer format: int64 minimum: 0 flow_control_transmitted_discarded_packets_per_sec: description: | Number of transmitted packets that were physically discarded by the NIC per second due to errors or other reasons. type: integer format: int64 minimum: 0 flow_control_transmitted_lossless_bytes_per_sec: description: | Bytes transmitted per second with lossless flow control settings. type: integer format: int64 minimum: 0 flow_control_transmitted_pause_frames_per_sec: description: | Transmitted pause frames per second. type: integer format: int64 minimum: 0 other_errors_per_sec: description: | This field has been deprecated. Since Purity version 6.6.8, this will always return `null`. The sum of unspecified reception and transmission errors per second. type: integer format: int64 minimum: 0 rdma_received_req_cqe_errors_per_sec: description: | The number of times port detected RDMA CQEs with error per second. type: integer format: int64 minimum: 0 rdma_received_sequence_errors_per_sec: description: | The number of received RDMA packet sequence errors per second. type: integer format: int64 minimum: 0 rdma_transmitted_local_ack_timeout_errors_per_sec: description: | The number of times RDMA ack timer expired for QPs per second. type: integer format: int64 minimum: 0 received_bytes_per_sec: description: | Bytes received per second. type: integer format: int64 minimum: 0 received_crc_errors_per_sec: description: | Reception CRC errors per second. type: integer format: int64 minimum: 0 received_frame_errors_per_sec: description: | Received packet frame errors per second. type: integer format: int64 minimum: 0 received_packets_per_sec: description: | Packets received per second. type: integer format: int64 minimum: 0 total_errors_per_sec: description: | The sum of all reception and transmission errors per second. type: integer format: int64 minimum: 0 transmitted_bytes_per_sec: description: | Bytes transmitted per second. type: integer format: int64 minimum: 0 transmitted_carrier_errors_per_sec: description: | Transmission carrier errors per second. type: integer format: int64 minimum: 0 transmitted_dropped_errors_per_sec: description: | Transmitted packets dropped per second. type: integer format: int64 minimum: 0 transmitted_packets_per_sec: description: | Packets transmitted per second. type: integer format: int64 minimum: 0 _networkInterfacePerformanceFc: description: | Fibre Channel port statistics. type: object properties: received_bytes_per_sec: description: | Bytes received per second. type: integer format: int64 minimum: 0 received_crc_errors_per_sec: description: | Fibre Channel frame CRC errors per second. type: integer format: int64 minimum: 0 received_frames_per_sec: description: | Fibre Channel frames received per second. type: integer format: int64 minimum: 0 received_link_failures_per_sec: description: | Loss of connectivity errors per second. type: integer format: int64 minimum: 0 received_loss_of_signal_per_sec: description: | Loss of signal errors on Fibre Channel port per second. type: integer format: int64 minimum: 0 received_loss_of_sync_per_sec: description: | Loss of sync errors on Fibre Channel port per second. type: integer format: int64 minimum: 0 total_errors_per_sec: description: | The sum of all reception and transmission errors per second. type: integer format: int64 minimum: 0 transmitted_bytes_per_sec: description: | Bytes transmitted per second. type: integer format: int64 minimum: 0 transmitted_frames_per_sec: description: | Fibre Channel frames transmitted per second. type: integer format: int64 minimum: 0 transmitted_invalid_words_per_sec: description: | Bit errors in transmission word per second. type: integer format: int64 minimum: 0 NetworkInterfacesPortDetails: description: | Network interface SFP details. allOf: - $ref: '#/components/schemas/_builtInResourceNoId' - type: object properties: interface_type: description: | The interface type. Valid values are `eth` and `fc`. type: string readOnly: true rx_los: description: | Displays status flags for Rx LOS. A value of `true` indicates Rx Loss-of-Signal. For four-lane modules, the array contains a flag for each channel. If the transceiver does not support digital diagnostic monitoring, the array is empty. type: array readOnly: true items: $ref: '#/components/schemas/_networkInterfacePortDetailsRx_los' rx_power: description: | Displays real-time measurement of Rx input power and whether it is within range. For four-lane modules, the array contains a measurement and status for each channel. If the transceiver does not support digital diagnostic monitoring, the array is empty. type: array readOnly: true items: $ref: '#/components/schemas/_networkInterfacePortDetailsRx_power' static: title: NetworkInterfacePortDetailsStatic allOf: - $ref: '#/components/schemas/_networkInterfacePortDetailsStatic' temperature: description: | Displays real-time measurement of transceiver temperature and range. If the transceiver does not support digital diagnostic monitoring, the array is empty. type: array readOnly: true items: $ref: '#/components/schemas/_networkInterfacePortDetailsTemperature' tx_bias: description: | Displays real-time measurement of Tx bias current and whether it is within range. For four-lane modules, the array contains a measurement and status for each channel. If the transceiver does not support digital diagnostic monitoring, the array is empty. type: array readOnly: true items: $ref: '#/components/schemas/_networkInterfacePortDetailsTx_bias' tx_fault: description: | Displays status flags for Tx Fault. A value of `true` indicates transmitter/laser fault. For four-lane modules, the array contains a flag for each channel. If the transceiver does not support digital diagnostic monitoring, the array is empty. type: array readOnly: true items: $ref: '#/components/schemas/_networkInterfacePortDetailsTx_fault' tx_power: description: | Displays real-time measurement of Tx output power and whether it is within range. For four-lane modules, the array contains a measurement and status for each channel. If the transceiver does not support digital diagnostic monitoring, the array is empty. type: array readOnly: true items: $ref: '#/components/schemas/_networkInterfacePortDetailsTx_power' voltage: description: | Displays real-time measurement of supply voltage and whether it is within range. If the transceiver does not support digital diagnostic monitoring, the array is empty. type: array readOnly: true items: $ref: '#/components/schemas/_networkInterfacePortDetailsVoltage' x-readOnly: true _objectStoreAccountBase: allOf: - $ref: '#/components/schemas/_context' - type: object description: | The object store account. An account serves as a logical container for buckets, users, and other resources, providing a namespace for storing and managing these objects. properties: created: description: | The object store account creation time in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true example: 1602115200000 object_count: description: The count of objects within the account. type: integer format: int64 readOnly: true example: 42 _objectStoreUserBase: allOf: - $ref: '#/components/schemas/_context' - type: object description: | The object store user that accesses and manages resources within an account. Users utilize associated access keys for authentication and authorization when interacting with the object store. properties: access_keys: description: The references to the access keys associated with the user. type: array readOnly: true items: $ref: '#/components/schemas/_fixedReferenceWithType' account: description: The reference to the associated account. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' created: description: | The object store user creation time in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true example: 1602115200000 _pod_array_status: allOf: - $ref: '#/components/schemas/_reference' - type: object properties: frozen_at: description: | The timestamp of when the data on the pod was frozen when the array went offline. Measured in milliseconds since the UNIX epoch. Also known as the recovery point. If the pod is in sync, a value of `null` will be returned. type: integer format: int64 readOnly: true example: 1492662000 mediator_status: description: | The status of the mediator, which determines whether it is available to mediate a high availability event. Valid values are `flummoxed`, `online`, `unknown`, and `unreachable`. Only mediators in the `online` status can mediate high availability events. If set to `flummoxed`, the array can reach a mediator, but it is talking to the wrong one. Verify that the DNS in the environment is properly configured. This status might also appear if the pod has been offline on one array for an extended period of time and the peer array is unreachable. If set to `online`, the array is successfully communicating with the mediator, and the mediator is available to mediate a high availability event. If set to `unreachable`, the array cannot reach the mediator, either due to network issues or because the mediator is down. When a mediator is unreachable, synchronous replication continues to function provided all arrays are healthy and communicating, but a high availability event without mediator access can result in an outage. type: string readOnly: true member: description: | A reference to the member associated with the pod's array status. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' pre_elected: description: | If set to `true`, the array has been pre-elected to remain online in the rare event that the mediator is inaccessible on both arrays within the stretched pod, and then later, the arrays within the stretched pod become disconnected from each other. If set to `false`, either the array has been pre-elected to remain offline while its peer array remains online, or pre-election is not in effect. One and only one array within each pod is pre-elected at a given point in time, so while a pre-elected array is keeping the pod online, the pod on its non-elected peer array remains offline during the communication failure. Users cannot pre-elect arrays. type: boolean readOnly: true progress: description: | The percentage progress of the pod resyncing process for this array. The percentage is displayed as a decimal value, starting at 0.00 and ending at 1.00. type: number format: float readOnly: true example: 0.66 status: description: | The status of the array within the stretched pod. Valid values are `offline`, `online`, `resyncing`, `suspended`, and `unknown`. If set to `offline`, the array is experiencing connection problems and may not have the latest pod data. The array cannot handle I/O to the pod and cannot take over during a high availability event. If set to `online`, the array is online and has the latest pod data. The array can handle I/O to the pod and take over during a high availability event. If set to `suspended`, the array is experiencing a short connection glitch of the pod. This is a temporary status and would transition to either `online` or `offline` soon. `suspended` is a new status that is exposed, starting from version 6.6.0. If set to `resyncing`, the array is actively getting the latest pod data so that it becomes fully synchronized with its peer array. During the resyncing process, the array cannot handle I/O to the pod. Once the arrays are fully synchronized, the array changes to `online` status. If set to `unknown`, the status of the peer array is unknown because this array is offline and cannot determine the state of the pod on the peer array. Only the peer array can ever be in unknown status; this unknown status is unique to the local array and will differ when viewed from its peer array. type: string readOnly: true example: resyncing x-readOnly: true _podSpace: allOf: - $ref: '#/components/schemas/_space' - type: object properties: replication: description: | The space consumed by unique data that has not been replicated to the target pod, on source pods. The space consumed by unique data that has been replicated to the target, but not yet incorporated into the target pod, on target pods. On Evergreen//One arrays, the effective space consumed by unique data that has not been replicated to the target pod, on source pods. The effective space consumed by unique data that has been replicated to the target, but not yet incorporated into the target pod, on target pods. type: integer format: int64 minimum: 0 replication_effective: description: | This field has been deprecated. The effective space consumed by unique data that has not been replicated to the target pod, on source pods. The effective space consumed by unique data that has been replicated to the target but not yet incorporated into the target pod, on target pods. Please use the `replication` field in the future, as it contains the same information for Evergreen//One arrays. type: integer format: int64 minimum: 0 readOnly: true shared_effective: description: | This field has been deprecated. The effective space contributed by data that is not unique to a specific volume, managed directory, or snapshot, measured in bytes. Please use the `shared` field in the future, as it contains the same information for Evergreen//One arrays. type: integer format: int64 minimum: 0 readOnly: true PodPerformance: allOf: - $ref: '#/components/schemas/_performance' - $ref: '#/components/schemas/_performance_others' - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_context' PodPerformanceReplication: allOf: - $ref: '#/components/schemas/_podPerformanceReplication' PodPerformanceReplicationByArray: allOf: - $ref: '#/components/schemas/_podPerformanceReplication' - type: object properties: array: description: | Array that shares this pod. title: Resource allOf: - $ref: '#/components/schemas/_resource' member: description: | The member that shares this pod. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' _builtInRelationship: type: object properties: id: description: | A non-modifiable, globally unique ID chosen by the system. type: string readOnly: true PodReplicaLinkLag: allOf: - $ref: '#/components/schemas/_builtInRelationship' - $ref: '#/components/schemas/_context' - type: object properties: direction: description: | The direction of replication. Valid values include `inbound` and `outbound`. type: string readOnly: true lag: description: | Duration in milliseconds that indicates how far behind the replication target is from the source. title: ReplicaLinkLag allOf: - $ref: '#/components/schemas/_replicaLinkLag' local_pod: description: Reference to a local pod. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' local_pod_members: description: | A list of arrays or realms that are members of the local pod. type: array items: $ref: '#/components/schemas/_fixedReferenceWithType' recovery_point: description: | Time when the last piece of data was replicated, in milliseconds since the UNIX epoch, and the recovery point if the pod is promoted. If the pod is baselining then the value is `null`. type: integer format: int64 readOnly: true example: 1565034592494 remote_pod: description: Reference to a remote pod. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' remotes: description: Reference to a remote array. type: array items: $ref: '#/components/schemas/_fixedReferenceWithType' status: description: | Status of the replica-link. Valid values include `replicating`, `baselining`, `paused`, `quiescing`, `quiesced`, `idle`, and `unhealthy`. type: string readOnly: true time: description: Sample time in milliseconds since the UNIX epoch. type: integer format: int64 PodReplicaLinkPerformanceReplication: allOf: - $ref: '#/components/schemas/_builtInRelationship' - $ref: '#/components/schemas/_replicaLinkPerformanceReplication' - $ref: '#/components/schemas/_context' PodReplicaLinkPerformanceReplicationArray: allOf: - $ref: '#/components/schemas/_builtInRelationship' - $ref: '#/components/schemas/_replicaLinkPerformanceReplicationArray' - $ref: '#/components/schemas/_context' _podReplicaLinkReference: allOf: - $ref: '#/components/schemas/_builtInRelationship' - type: object properties: local_pod: description: | Reference to a local pod. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' remote_pod: description: | Reference to a remote pod. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' remotes: description: | Reference to remote arrays. type: array items: $ref: '#/components/schemas/_fixedReferenceWithType' _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 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 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' PolicyRuleObjectStoreAccess: allOf: - $ref: '#/components/schemas/_builtInResourceNoId' - $ref: '#/components/schemas/_policyRuleObjectStoreAccessBase' _policy_rule_user_group_quota_limit_type: type: integer format: int64 _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' 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 _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 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 _basePort: allOf: - $ref: '#/components/schemas/_builtInResourceNoId' - $ref: '#/components/schemas/_portCommon' - description: | A target port on the array enabling access to block storage (Fibre Channel or iSCSI). type: object properties: failover: description: | If the array port has failed over, returns the name of the port to which this port has failed over. type: string example: CT0.ETH2 _portInitiatorEncryption: description: | Initiator session encryption properties. type: object properties: enabled: description: | Returns a value of `true` if encryption is enabled for initiator session. type: boolean mode: description: | The encryption mode being used. Values include `hw-encrypted` and ``. type: string example: hw-encrypted _presetWorkloadDirectoryConfiguration: type: object required: - name - path - placement_configurations properties: count: description: | The number of directories or file systems to provision. If greater than one, the name, path, and export name patterns must be unique within the workload (for example, by including a `workload.configuration.index`). Supports parameterization. type: string exports: description: | THe file system or directory exports to be created as part of the workload. A maximum of four exports can be created per file system or directory across NFS and SMB. type: array minItems: 1 maxItems: 12 items: $ref: '#/components/schemas/_presetWorkloadDirectoryConfigurationExports' multi_protocol: description: Multi-protocol configuration. title: PresetWorkloadDirectoryConfigurationMultiProtocol allOf: - $ref: '#/components/schemas/_presetWorkloadDirectoryConfigurationMultiProtocol' name: $ref: '#/components/schemas/_presetWorkloadConfigurationName' naming_patterns: $ref: '#/components/schemas/_namingPatterns' parent: description: | An optional reference to either an existing file system or a directory_configuration defined within this Preset, under which this directory will be placed. This cannot be populated when path is "/" as that creates a new file system. Only one of file_system or directory_configuration can be specified and must be specified when the path is not "/". Supports parameterization. title: PresetWorkloadDirectoryConfigurationParent allOf: - $ref: '#/components/schemas/_presetWorkloadDirectoryConfigurationParent' path: description: | A directory path. A path of "/" will create a new file system. Anything other than "/" will create a directory under a file system specified by `parent`. title: PresetWorkloadDirectoryConfigurationPath allOf: - $ref: '#/components/schemas/_presetWorkloadDirectoryConfigurationPath' placement_configurations: description: | The names of the placement configurations with which to associate the file systems or directories. type: array minItems: 1 maxItems: 1 items: type: string quota_configurations: description: | The names of the quota configurations with which to associate the file systems or directories. type: array minItems: 1 maxItems: 1 items: type: string snapshot_configurations: description: | The names of the snapshot configurations to apply to the file systems or directories. type: array minItems: 1 maxItems: 2 items: type: string special_directories: description: THe special directory configuration. title: PresetWorkloadDirectoryConfigurationSpecialDirectories allOf: - $ref: '#/components/schemas/_presetWorkloadDirectoryConfigurationSpecialDirectories' _presetWorkloadExportConfigurations: type: object properties: nfs: description: | Defines NFS client export policies that can be used when specifying file system or directory exports. items: $ref: '#/components/schemas/_presetWorkloadExportConfigurationNfs' type: array smb: description: | Defines SMB client export policies that can be used when specifying file system or directory exports. items: $ref: '#/components/schemas/_presetWorkloadExportConfigurationSmb' type: array smb_share: description: | Defines SMB share export policies that can be used when specifying file system or directory exports. items: $ref: '#/components/schemas/_presetWorkloadExportConfigurationSmbShare' type: array _presetWorkloadParameter: type: object required: - name - type properties: constraints: $ref: '#/components/schemas/_presetWorkloadConstraints' metadata: $ref: '#/components/schemas/_presetWorkloadMetadata' name: description: | The name of the parameter, by which other fields in the preset can reference it. Name must be unique across all parameters in the preset. type: string example: billing-id type: description: |- The type of the parameter. Valid values include `string`, `integer`, `boolean` and `resource_reference`. String parameters can be used to collect metadata about workloads deployed from the preset, such as the environment to which they are deployed (e.g., production, development, etc.) or the billing account to which they belong for charge back and show back purposes. Integer and boolean parameters can be used to configure specific fields in the preset, such as the number or size of volumes to provision. Resource reference parameters can be used to collect references to other objects, such as storage classes or remote arrays. type: string _presetWorkloadPeriodicReplicationConfiguration: type: object required: - name - remote_targets - rules properties: name: $ref: '#/components/schemas/_presetWorkloadConfigurationName' naming_patterns: $ref: '#/components/schemas/_namingPatterns' remote_targets: description: The remote targets to which snapshots may be replicated. type: array minItems: 1 maxItems: 1 items: description: | A remote target to which snapshots may be replicated. Supports parameterization. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' rules: description: Rules describe the frequency and retention of snapshots taken by the configuration. type: array minItems: 1 maxItems: 2 items: $ref: '#/components/schemas/_presetWorkloadSnapshotRule' _presetWorkloadPlacementConfiguration: type: object required: - name - storage_class properties: name: $ref: '#/components/schemas/_presetWorkloadConfigurationName' qos_configurations: description: | The names of the QoS configurations to apply to the storage resources (such as volumes) in the placement. The limits defined in the QoS configurations will be shared across all storage resources in the placement. type: array maxItems: 1 items: type: string storage_class: description: | The storage class to which the placement and its associated storage resources may be deployed. Supports parameterization. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' _presetWorkloadPlatformFeatures: type: string description: | The collection of platform specific features that can be used in this Preset. Valid values include `fa_block`, `fa_file`, and `fb_file`. If `fa_block` is specified, the preset is used to create volumes on Purity//FA appliances. If `fa_file` is specified, the preset is used to create file systems or directories on Purity//FA appliances. If `fb_file` is specified, the preset is used to create file systems on Purity//FB appliances. Various configuration such as snapshot configuration or export configuration features are subject to the specified platform feature set. Defaults to `fa_block`. _presetWorkloadQosConfiguration: type: object required: - name properties: bandwidth_limit: description: | The maximum QoS bandwidth limit shared across all volumes in the placement. Whenever throughput exceeds the bandwidth limit, throttling occurs. Measured in bytes per second. Between 1MB/s and 512 GB/s, inclusive. Supports parameterization. type: string iops_limit: description: | The QoS IOPs limit shared across all volumes in the placement. Between 100 and 100000000, inclusive. Supports parameterization. type: string name: $ref: '#/components/schemas/_presetWorkloadConfigurationName' naming_patterns: $ref: '#/components/schemas/_namingPatterns' _presetWorkloadQuotaConfiguration: allOf: - $ref: '#/components/schemas/_presetWorkloadPolicyAction' - type: object required: - name - rules properties: name: $ref: '#/components/schemas/_presetWorkloadConfigurationName' naming_patterns: $ref: '#/components/schemas/_namingPatterns' rules: description: Rules describe the desired quota limit and enforcement. type: array minItems: 1 maxItems: 1 items: $ref: '#/components/schemas/_presetWorkloadQuotaRule' _presetWorkloadSnapshotConfiguration: allOf: - $ref: '#/components/schemas/_presetWorkloadPolicyAction' - type: object required: - name - rules properties: name: $ref: '#/components/schemas/_presetWorkloadConfigurationName' naming_patterns: $ref: '#/components/schemas/_namingPatterns' rules: description: The rules defining the frequency and retention of snapshots taken by the configuration. type: array minItems: 1 maxItems: 2 items: $ref: '#/components/schemas/_presetWorkloadSnapshotRule' _presetWorkloadVolumeConfiguration: type: object required: - count - name - placement_configurations - provisioned_size properties: count: description: The number of volumes to provision. Supports parameterization. type: string name: $ref: '#/components/schemas/_presetWorkloadConfigurationName' naming_patterns: $ref: '#/components/schemas/_namingPatterns' periodic_replication_configurations: description: | The names of the periodic replication configurations to apply to the volumes. type: array items: type: string placement_configurations: description: | The names of the placement configurations with which to associate the volumes. type: array minItems: 1 maxItems: 1 items: type: string provisioned_size: description: | The virtual size of each volume. Measured in bytes and must be a multiple of 512. The maximum size is 4503599627370496 (4PB). Supports parameterization. type: string snapshot_configurations: description: | The names of the snapshot configurations to apply to the volumes. type: array items: type: string _presetWorkloadWorkloadTag: type: object required: - key - value properties: copyable: description: | Specifies whether to include the tag when copying the parent resource. If set to `true`, the tag is included in resource copying. If set to `false`, the tag is not included. If not specified, defaults to `true`. type: string example: "true" key: description: | Key of the tag. Supports up to 64 Unicode characters. type: string example: environment namespace: description: | Optional namespace of the tag. Namespace identifies the category of the tag. Omitting the namespace defaults to the namespace `default`. The `pure*` namespaces are reserved for plugins and integration partners. It is recommended that customers avoid using reserved namespaces. type: string example: default value: description: | Value of the tag. Supports up to 256 Unicode characters. Supports parameterization. type: string example: staging _aggregate_replication_performance: type: object properties: bytes_per_sec: description: The total number of bytes of replication data transmitted and received per second. type: integer format: int64 minimum: 0 readOnly: true x-readOnly: true _protectionGroupsVolumesMember: allOf: - $ref: '#/components/schemas/_reference' - type: object properties: destroyed: description: | Returns a value of `true` if the volume has been destroyed and is pending eradication. Through the `volumes` endpoint, the user can see `time_remaining` of the destroyed volume, recover, or eradicate the destroyed volume. type: boolean _transfer: type: object properties: completed: description: | The timestamp of when the snapshot replication process completed. Measured in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true data_transferred: description: | The number of bytes transferred from the source to the target as part of the replication process. Measured in bytes. type: integer format: int64 readOnly: true destroyed: description: | Returns a value of `true` if the snapshot has been destroyed and is pending eradication. The destroyed snapshot can be recovered by setting `destroyed=false`. Once the eradication pending period has elapsed, the snapshot is permanently eradicated and can no longer be recovered. type: boolean physical_bytes_written: description: | The amount of physical/logical data written to the target due to replication. Measured in bytes. type: integer format: int64 readOnly: true progress: description: | The percentage progress of the snapshot transfer from the source array to the target. Displayed in decimal format. type: number format: float readOnly: true example: 0.66 started: description: | The timestamp of when the snapshot replication process started. Measured in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true _spaceNoDeprecatedPhysicalOrEffective: type: object properties: data_reduction: description: | The ratio of mapped sectors within a volume versus the amount of physical space the data occupies after data compression and deduplication. The data reduction ratio does not include thin provisioning savings. For example, a data reduction ratio of 5:1 means that for every 5 MB the host writes to the array, 1 MB is stored on the array's flash modules. type: number format: float footprint: description: | The maximum amount of physical space the container would take up on any array, ignoring any data shared outside the container. Measured in bytes. On Evergreen//One arrays, this is the maximum amount of effective used space, measured in bytes. The footprint metric is mostly used for capacity planning. This field will be null in non-container contexts. type: integer format: int64 minimum: 0 shared: description: | The physical space occupied by deduplicated data, meaning that the space is shared with other volumes and snapshots as a result of data deduplication, measured in bytes. On Evergreen//One arrays, this is the effective space contributed by data that is not unique to a specific volume, managed directory, or snapshot, measured in bytes. type: integer format: int64 minimum: 0 example: 111863360624 snapshots: description: | The physical space occupied by data unique to one or more snapshots, measured in bytes. On Evergreen//One arrays, this is the effective space contributed by data unique to one or more snapshots, measured in bytes. type: integer format: int64 minimum: 0 system: description: | The physical space occupied by internal array metadata, measured in bytes. type: integer format: int64 minimum: 0 thin_provisioning: description: | The percentage of volume sectors that do not contain host-written data because the hosts have not written data to them or the sectors have been explicitly trimmed. type: number format: float minimum: 0 maximum: 1 total_provisioned: description: | The provisioned size of a volume for a single volume, host or host group, protocol endpoint, managed directory, and containers can be infinite or measured in bytes. Infinite is represented by `null`. The provisioned size for a host or host group, includes all volumes that are connected to the resource. The provisioned size for a protocol endpoint is `null`. The provisioned size for a managed directory is the quota limit if it or its parent has a managed directory configured, otherwise it defaults to `null`. The provisioned size for a container is the sum of the total_provisioned of the object it contains, capped by the container's quota limit (or the container's used_provisioned if current usage is above the quota limit), if any. Provisioned size represents the storage capacity reported to hosts. type: integer format: int64 minimum: 0 readOnly: true example: 19937690345472 total_reduction: description: | The ratio of provisioned sectors within a volume versus the amount of physical space the data occupies after reduction via data compression and deduplication and with thin provisioning savings. Total reduction is data reduction with thin provisioning savings. For example, a total reduction ratio of 10:1 means that for every 10 MB of provisioned space, 1 MB is stored on the array's flash modules. type: number format: float total_used: description: | The total space contributed by customer data, measured in bytes. type: integer format: int64 minimum: 0 readOnly: true unique: description: | The unique physical space occupied by customer data. Unique physical space does not include shared space, snapshots, and internal array metadata. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by unique customer data, measured in bytes. Unique data does not include shared space, snapshots, and internal array metadata. type: integer format: int64 minimum: 0 used_provisioned: description: | The amount of logical space a container has consumed. The amount of logical space is compared against the quota limit if the container has one configured. Used provisioned does not include destroyed objects inside the container. For a destroyed container, used provisioned can include destroyed objects and represents how much logical space it would take to recover the container. type: integer format: int64 minimum: 0 readOnly: true example: 19937690345472 virtual: description: | The amount of logically written data that a volume or a snapshot references, measured in bytes. type: integer format: int64 minimum: 0 _remoteArrayFleet: allOf: - $ref: '#/components/schemas/_resource' - type: object properties: is_local: description: | If set to `true`, the current array is a member of the fleet. type: boolean example: false _podRemoteArrayStatus: allOf: - $ref: '#/components/schemas/_referenceWithType' - type: object properties: member: description: | Specifies the reference to the member associated with the pod's array status. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' x-readOnly: true _stretchedTagRemoteArrayStatus: allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' - type: object properties: member: description: | A reference to the member associated with the tag's array status. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' readOnly: true _snapshot: type: object properties: created: description: | The snapshot creation time. Measured in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true destroyed: description: | Returns a value of `true` if the snapshot has been destroyed and is pending eradication. The `time_remaining` value displays the amount of time left until the destroyed volume snapshot is permanently eradicated. Before the `time_remaining` period has elapsed, the destroyed volume snapshot can be recovered by setting `destroyed=false`. Once the `time_remaining` period has elapsed, the volume snapshot is permanently eradicated and can no longer be recovered. type: boolean pod: description: | A reference to the pod. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' provisioned: description: | The provisioned space of the snapshot. Measured in bytes. The minimum size is 1048576 (1MB), the maximum size is 4503599627370496 (4PB) type: integer format: int64 readOnly: true source: description: | The volume from which this snapshot was taken. For a replicated snapshot being viewed on the target side, the `source` is the replica volume. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' suffix: description: | The suffix that is appended to the `source_name` value to generate the full volume snapshot name in the form `VOL.SUFFIX`. If the suffix is not specified, the system constructs the snapshot name in the form `VOL.NNN`, where `VOL` is the volume name, and `NNN` is a monotonically increasing number. type: string time_remaining: description: | The amount of time left until the destroyed snapshot is permanently eradicated. Measured in milliseconds. Before the `time_remaining` period has elapsed, the destroyed snapshot can be recovered by setting `destroyed=false`. type: integer format: int64 readOnly: true ResourceAccessStatus: description: | A resource access status realizes the configuration of resource accesses. For instance, if there is a resource access for a host group to a realm, resource access status would include the explicit host group resource access as well as an implicit resource access for each host in that host group. type: object properties: created_by: description: | Reference the IDs of resource accesses that created this status. type: array readOnly: true items: $ref: '#/components/schemas/ResourceAccessStatusCreatedBy' resource: description: Resource to which the scope has access. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' scope: description: Scope which has access to the resource. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' _snmp_v3: description: | The v3 configurations of SNMP. type: object properties: auth_passphrase: description: | Passphrase used by Purity//FA to authenticate the array with the specified managers. type: string example: '****' auth_protocol: description: | Hash algorithm used to validate the authentication passphrase. Valid values are `MD5` and `SHA`. type: string example: MD5 privacy_passphrase: description: Passphrase used to encrypt SNMP messages. type: string example: '****' privacy_protocol: description: | Encryption protocol for SNMP messages. Valid values are `AES` and `DES`. type: string example: DES user: description: | User ID recognized by the specified SNMP managers which Purity//FA is to use in communications with them. type: string example: User1 SnmpAgentMib: type: object properties: mib: description: MIB text. type: string readOnly: true _resourceFixedNonUniqueName: description: | A resource with a non-unique name. type: object properties: id: description: | A globally unique, system-generated ID. The ID cannot be modified. type: string readOnly: true name: description: | Name of the resource. The name cannot be modified. type: string readOnly: true _softwareUpgradePlan: type: object properties: description: description: Description of the upgrade step. type: string hop_version: description: The version to which the step is upgrading. type: string example: 99.9.9 step_name: description: Name of the upgrade step. type: string example: Pre-upgrade check _start_end_time: description: A resource with a start time and end time. type: object properties: end_time: description: End time in milliseconds since the UNIX epoch. type: integer format: int64 example: 1567026888000 x-minimum: 0 start_time: description: Start time in milliseconds since the UNIX epoch. type: integer format: int64 example: 1567026779000 x-minimum: 0 _softwareChecksChecks: type: object properties: details: description: | Detailed result of the check used to diagnose check failures. type: string name: description: Name of the upgrade check. type: string example: HostIOCheck status: description: | Status of the check. Valid values are `running`, `failed`, and `passed`. A status of `running` indicates that the check has not finished. A status of `failed` indicates that the check has failed. A status of `passed` indicates that the check has passed. type: string SoftwareInstallationStep: allOf: - $ref: '#/components/schemas/_resourceFixedNonUniqueName' - $ref: '#/components/schemas/_start_end_time' - description: | Step needed to complete an upgrade. type: object properties: checks: description: | A list of checks in this upgrade step. type: array items: $ref: '#/components/schemas/_softwareInstallationStepsChecks' description: description: | Detailed description of the step. type: string details: description: | Detailed result of the step used to diagnose step failures. type: string hop_version: description: The version to which the current hop is upgrading. type: string example: 99.9.9 installation: description: | Referenced `software-installation` to which the step belongs. title: Reference allOf: - $ref: '#/components/schemas/_reference' status: description: | Status of the step. Valid values are `running` and `finished`. A status of `running` indicates that the step has not finished. A status of `finished` indicates that the check has finished. type: string SoftwareVersion: description: Version candidates for software upgrade. type: object properties: details: description: | The description of the version. type: string name: description: | The name of the software. type: string example: Purity//FA release_family: description: | The major and minor release number of the version. type: string example: 6.2.0 upgrade_hops: description: | The list of software versions the upgrade will go through. type: array items: type: string description: | A software version in the upgrade path. example: - 6.1.3 - 6.2.0 version: description: | The version of the software. type: string example: 6.2.0 _saml2SsoSp: allOf: - $ref: '#/components/schemas/_saml2SsoSpCredential' - description: | Properties specific to the service provider. type: object properties: assertion_consumer_url: description: | The URL where the identity provider will send its SAML response after authenticating a user. type: string example: https://myarray.mycompany.com/login/saml2/sso/myidp entity_id: description: | A globally unique name for the service provider. type: string example: https://myarray.mycompany.com/saml2/service-provider-metadata/myidp metadata_url: description: | The URL of the service provider metadata. type: string example: https://myarray.mycompany.com/saml2/service-provider-metadata/myidp Subscription: type: object properties: id: description: | A globally unique, system-generated ID. The ID cannot be modified. type: string service: description: | The service type of the subscription. type: string example: Evergreen//One SubscriptionAsset: allOf: - $ref: '#/components/schemas/_resource' - type: object properties: subscription: $ref: '#/components/schemas/_subscriptionAssetSubscription' _supportRemoteAssistPaths: type: object properties: component_name: description: | The name of the local controller that is running the remote assist session. type: string example: CT0 status: description: | The status of the remote assist session on the local controller. Values include `connected`, `connecting`, `disconnected`, and `session-active`. type: string example: connected _supportRemoteAssistSessionsPaths: type: object properties: component_name: description: | The name of the local controller running the remote assist session. type: string example: CT0 status: description: | The status of the remote assist session on the local controller. Values include `connected`, `connecting`, `disconnected`, and `session-active`. type: string example: connected SupportDiagnosticsDetails: description: | Details of diagnostics tests tasks type: object properties: result_details: description: | Additional details related to the test. This field also provides remediation information. type: string readOnly: true example: enabled severity: description: "Severity level of the test. Valid values are `info`, `warning`, and `critical`." type: string test_name: description: | Name of the test that was performed. type: string test_type: description: | The category to which the test belongs to. type: string readOnly: true example: generic _volumeCommon: allOf: - $ref: '#/components/schemas/_resource' - description: | A random access virtual storage device that a FlashArray exports to hosts via a logical unit number (LUN). For a host, a volume contains a number of 512-byte sectors in which data can be written and from which it can be read. type: object properties: connection_count: description: | The total number of hosts and host groups connected to the volume. type: integer format: int64 readOnly: true created: description: | The volume creation time, measured in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true destroyed: description: | Returns a value of `true` if the volume has been destroyed and is pending eradication. The `time_remaining` value displays the amount of time left until the destroyed volume is permanently eradicated. Before the `time_remaining` period has elapsed, the destroyed volume can be recovered by setting `destroyed=false`. Once the `time_remaining` period has elapsed, the volume is permanently eradicated and can no longer be recovered. type: boolean host_encryption_key_status: description: | The host encryption key status for this volume. Values include `none`, `detected`, and `fetched`. type: string readOnly: true example: detected priority_adjustment: description: | Priority adjustment operator and value. title: PriorityAdjustment allOf: - $ref: '#/components/schemas/_priorityAdjustment' provisioned: description: | The virtual size of the volume as a multiple of 512, measured in bytes. The maximum size is 4503599627370496 (4PB). type: integer format: int64 qos: description: | Displays QoS limit information. title: Qos allOf: - $ref: '#/components/schemas/_qos' serial: description: | A globally unique serial number generated by the FlashArray when the volume is created. type: string readOnly: true space: description: | Displays size and space consumption information. title: VolumeSpaceCommon allOf: - $ref: '#/components/schemas/_volumeSpaceCommon' time_remaining: description: | The amount of time left until the destroyed volume is permanently eradicated, measured in milliseconds. Before the `time_remaining` period has elapsed, the destroyed volume can be recovered by setting `destroyed=false`. type: integer format: int64 readOnly: true VolumeDiff: allOf: - $ref: '#/components/schemas/_context' - type: object properties: length: description: | Length of the chunk that is different, in bytes. type: integer format: int64 readOnly: true offset: description: | Absolute offset of the chunk that is different, in bytes. type: integer format: int64 readOnly: true _volumeSpaceCommon: allOf: - $ref: '#/components/schemas/_space' - type: object properties: snapshots_effective: description: | This field has been deprecated. The effective space contributed by data unique to one or more snapshots, measured in bytes. Use the `snapshots` field in the future, as it contains the same information for Evergreen//One arrays. type: integer format: int64 minimum: 0 readOnly: true total_effective: description: | This field has been deprecated. The total effective space contributed by customer data, measured in bytes. Use the `total_physical` field in the future, as it contains the same information for Evergreen//One arrays. type: integer format: int64 minimum: 0 readOnly: true unique_effective: description: | This field has been deprecated. The effective space contributed by unique customer data. Unique data does not include shared space, snapshots, and internal array metadata, measured in bytes. Use the `unique` field in the future, as it contains the same information for Evergreen//One arrays. type: integer format: int64 minimum: 0 readOnly: true _snapshotSpace: allOf: - $ref: '#/components/schemas/_space' - type: object properties: snapshots_effective: description: | This field has been deprecated. The effective space contributed by data unique to one or more snapshots, measured in bytes. Use the `snapshots` field in the future, as it contains the same information for Evergreen//One arrays. type: integer format: int64 minimum: 0 readOnly: true _workloadParameterValue: description: The value of the parameter. type: object properties: boolean: description: The value for a boolean parameter. type: boolean integer: description: The value for an integer parameter. type: integer format: int64 resource_reference: $ref: '#/components/schemas/_workloadParameterValueResourceReference' string: description: The value for a string parameter. type: string _workloadPreset: allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' - type: object properties: revision: description: | The revision of the preset from which the workload was deployed. type: integer format: int64 readOnly: true _workloadPlacementRecommendationResourceReference: description: | Defines a group of resources. At least one of them should be present on this target to use it for computation of a recommendation. Currently only hosts or host groups could be used. type: object required: - allowed_values properties: allowed_values: description: | A list of allowed values for the resource reference. For hosts and host groups, each item does not define a specific object on some target, but defines a pattern which should be matched by the target. For example, { `type`: `host`, `name`: `host1` } will match all targets that have a host with name `host1`. type: array items: $ref: '#/components/schemas/_referenceWithType' _workloadPlacementRecommendationParameterConstraints: description: The constraints applied to the parameter. type: object properties: resource_reference: $ref: '#/components/schemas/_workloadPlacementRecommendationParameterResourceReference' _workloadPlacementRecommendationPlacement: description: Placement data in the recommendation result. type: object properties: name: description: | The name of the placement. type: string targets: description: | The targets for the placement. type: array items: $ref: '#/components/schemas/_workloadPlacementRecommendationTarget' _workloadPlacementRecommendationGenericTarget: allOf: - $ref: '#/components/schemas/_referenceWithType' - description: | The data for a target in a workload placement recommendation. The target is an array that may be used for workload placement. type: object properties: capacity: description: | The usable capacity of the target, measured in bytes. type: integer format: int64 example: 10995116277760 capacity_used_projections: $ref: '#/components/schemas/_workloadPlacementRecommendationTargetCapacityUsedProjections' load_projections: $ref: '#/components/schemas/_workloadPlacementRecommendationTargetLoadProjections' model: description: | The model of the target. For example, `FA-X20R2`. type: string periodic_replication_configurations: description: | The preset periodic replication configurations supported by the array. type: array items: type: string placement_configurations: description: | The preset placement configurations supported by the array. type: array items: type: string warnings: description: | The warnings for the target. type: array items: $ref: '#/components/schemas/_workloadPlacementRecommendationWarning' UserGroup: type: object properties: id: description: | The user or group id. type: integer format: int64 readOnly: true name: description: | The name of the user or group. type: string readOnly: true sid: description: | The user or group Security Identifier (SID). type: string readOnly: true UserGroupQuotaLimitedBy: type: object properties: member: description: | Reference to the resource to which the effective user-group-quota or quota policy is attached. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' policy: description: | Reference to the effective user-group-quota or quota policy. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' x-readOnly: true UserGroupSpace: type: object properties: dynamic_limit: description: The total logical space that usage can grow before it reaches an enforced user-group-quota or directory quota limit. This depends on all the policies impacting usage and potentially usage in ancestor and descendent directories. The limit is measured in bytes. type: integer format: int64 minimum: 0 readOnly: true example: 10737418240 total_used: description: | The total logical space owned by the user or group in the managed directory and descendent directories. The usage is measured in bytes. type: integer format: int64 minimum: 0 readOnly: true example: 10737418240 x-readOnly: true DirectoryUserQuotaRule: type: object properties: effectiveness: description: | Describes whether the rule is the most effective rule that applies to the user. Possible values are `effective` and `ineffective_limit`. If the value is `effective` then the rule is the most effective rule for the user. If the value is `ineffective_limit` then there is at least one enforced rule with a lower quota limit that also applies to the user, resulting in the quota limit of the rule not being the most effective. type: string readOnly: true enabled: description: | Where the user-group-quota policy is enabled. If `true` the rules in the policy impact the amount of usage the user can own in the managed directory. If `false` the rules in the policy do not have an effect. type: boolean readOnly: true enforced: description: | Determines whether the quota limit in the rule is enforced. If `true`, the user will be out of the allowed available space when usage reaches the quota limit. If `false`, the allowed usage may grow beyond the quota limit, but the user will be notified. type: boolean readOnly: true policy: description: | The user-group-quota policy with rules impacting the usage of the user. title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' quota_limit: description: | The logical space limit assigned by the user-group-quota rule. type: integer format: int64 readOnly: true quota_type: description: | The type of the user-group-quota rule. The `user-default`, `user` and `user-group-member` types impact the user. type: string readOnly: true rule_name: description: | The unique name of the user-group-quota policy rule. type: string readOnly: true subject: description: | The rule subject if the quota type is `user` or `user-group-member`. For `user` type, the subject matches the user impacted by the quota rule. For `user-group-member` type, the subject matches a group that the user is a member of. title: PolicyRuleUserGroupQuotaSubject allOf: - $ref: '#/components/schemas/PolicyRuleUserGroupQuotaSubject' _referenceWithoutTypeWithIsLocal: allOf: - $ref: '#/components/schemas/_reference' - type: object properties: is_local: description: | If set to `true`, the location reference is to the local array. If set to `false`, the location reference is to a remote location, such as a remote array or offload target. type: boolean readOnly: true _networkInterfaceNeighborNeighborChassis: description: | The neighboring physical component incorporating one or more IEEE 802 LAN stations and their associated application functionality. type: object properties: addresses: description: Management IP addresses of the neighbor. type: array items: type: string example: 10.202.101.70 bridge: description: Bridge capability of the neighbor system. title: NetworkInterfaceNeighborCapability allOf: - $ref: '#/components/schemas/_networkInterfaceNeighborCapability' description: description: | The textual description of the neighbor. The description may include the full name and version identification of the system hardware type, software operating system, and networking software. type: string example: Example Switch iscsi-sw-100-b version 1.0 docsis_cable_device: description: DOCSIS cable device capability of the neighbor system. title: NetworkInterfaceNeighborCapability allOf: - $ref: '#/components/schemas/_networkInterfaceNeighborCapability' id: $ref: '#/components/schemas/_networkInterfaceNeighborNeighborChassisId' name: description: Administratively assigned name of the neighbour. type: string example: iscsi-sw-100-b.example.com repeater: description: Neighbor system's repeater capability. title: NetworkInterfaceNeighborCapability allOf: - $ref: '#/components/schemas/_networkInterfaceNeighborCapability' router: description: IP router capability of the neighbor system. title: NetworkInterfaceNeighborCapability allOf: - $ref: '#/components/schemas/_networkInterfaceNeighborCapability' station_only: description: Station only status of the neighbor system. title: NetworkInterfaceNeighborCapability allOf: - $ref: '#/components/schemas/_networkInterfaceNeighborCapability' telephone: description: Telephone capability of the neighbor system. title: NetworkInterfaceNeighborCapability allOf: - $ref: '#/components/schemas/_networkInterfaceNeighborCapability' wlan_access_point: description: WLAN access point capability of the neighbor system. title: NetworkInterfaceNeighborCapability allOf: - $ref: '#/components/schemas/_networkInterfaceNeighborCapability' _networkInterfaceNeighborNeighborPort: description: | The neighboring port connected to the FlashArray local port. type: object properties: description: description: A description of the neighbor port. type: string example: eth7 id: $ref: '#/components/schemas/_networkInterfaceNeighborNeighborPortId' _networkInterfacePortDetailsRx_los: type: object properties: channel: description: | The channel number if the transceiver is a multilane transceiver. If not specified, defaults to `null`. type: integer example: 0 flag: description: A value of `true` indicates Rx Loss-of-Signal. type: boolean _networkInterfacePortDetailsRx_power: type: object properties: channel: description: | The channel number if the transceiver is a multilane transceiver. If not specified, defaults to `null`. type: integer example: 0 measurement: description: | Rx input power in mW. type: number format: double status: description: | Indicates whether the measurement is outside the high alarm, low alarm, high warning, or low warning thresholds for Rx input power. Valid values are `alarm low`, `alarm high`, `warn low`, `warn high`, and `ok`. type: string example: ok _networkInterfacePortDetailsStatic: description: | Static module identity and capabilities information for the specified network interface or Fibre Channel port. type: object properties: cable_technology: description: | The SFP+ cable technology supported by the transceiver. type: array items: type: string example: Active Cable connector_type: description: | The media connector type of the transceiver. type: string example: LC encoding: description: | The serial encoding algorithm of the transceiver. type: string example: 64B/66B extended_identifier: description: | The extended identifier of the transceiver type. type: string example: GBIC/SFP function is defined by 2-wire interface ID only fc_link_lengths: description: | The Fibre Channel distance capabilities supported by the transceiver. type: array items: type: string example: short distance (S) fc_speeds: description: "The Fibre Channel speeds supported by the transceiver. Speeds are in units of 100 MBytes/sec, which correspond to GFC (Gb/s)." type: string example: 16|32|64 Gb/s fc_technology: description: | The Fibre Channel technologies supported by the transceiver. type: array items: type: string example: Electrical intra-enclosure (EL) fc_transmission_media: description: | The Fibre Channel transmission media supported by the transceiver. type: array items: type: string example: "Multimode, 62.5um (M6)" identifier: description: | The transceiver type. type: string example: SFP or SFP+ link_length: description: | Link length and cable attenuation (for active or copper cables) for the specified transceiver. Values are comma-separated lists of fields and values, where each field is separated from its corresponding value by a colon. Valid fields include `Copper Cable Attenuation (12.9 GHz)`, `Copper Cable Attenuation (25.78 GHz)`, `Copper Cable`, `SMF`, `OM2`, `OM1`, `OM4`, and `OM3`. The unit for attenuation is dB, and the units for length are meters or kilometers. Unspecified fields are omitted. type: string example: "OM2: 40 m, OM1: 20 m, OM3: 100 m" rate_identifier: description: | The type of rate select functionality of the transceiver. type: string example: "FC-PI-5 (16/8/4G Independent Rx, Tx Rate_select)" rx_power_thresholds: $ref: '#/components/schemas/_networkInterfacePortDetailsStaticRxPowerThresholds' signaling_rate: description: | The nominal signaling rate in MBd, rounded off to the nearest 100 MBd, or if greater than 25400 MBd, rounded off to the nearest 250 MBd. The value can be unspecified. type: string example: 14000 MBd signaling_rate_max: description: | The upper signaling rate limit at which the transceiver still meets its specifications, specified as a percentage above the nominal signaling rate. The value can be unspecified. type: string example: 1% signaling_rate_min: description: | The lower signaling rate limit at which the transceiver still meets its specifications, specified as a percentage below the nominal signaling rate. The value can be unspecified. type: string example: 1% specifications: description: | The Ethernet, 10G Ethernet, ESCON, Infiniband, SONET, and other specifications supported by the transceiver. type: array items: type: string example: 1000BASE-T temperature_thresholds: $ref: '#/components/schemas/_networkInterfacePortDetailsStaticTemperatureThresholds' tx_bias_thresholds: $ref: '#/components/schemas/_networkInterfacePortDetailsStaticTxBiasThresholds' tx_power_thresholds: $ref: '#/components/schemas/_networkInterfacePortDetailsStaticTxPowerThresholds' vendor_date_code: description: | The SFP vendor's manufacturing date code. The first six characters are the date in YYMMDD format, and the last two characters are the vendor specific lot code. The last two characters are optional. type: string maxLength: 8 example: "190221" vendor_name: description: The SFP vendor name. type: string maxLength: 16 example: EMULEX vendor_oui: description: The SFP vendor IEEE company ID. type: string maxLength: 8 example: 00-17-6A vendor_part_number: description: The part number provided by the SFP vendor. type: string maxLength: 16 example: ABCD-12E3FG-ELX vendor_revision: description: The revision level for the part number provided by the SFP vendor. type: string maxLength: 4 vendor_serial_number: description: The serial number provided by the SFP vendor. type: string maxLength: 16 example: AB1234C56DE voltage_thresholds: $ref: '#/components/schemas/_networkInterfacePortDetailsStaticVoltageThresholds' wavelength: description: | Laser wavelength (for optical variants) at room temperature, in units of nm. For passive and active cable variants, the value is unspecified. type: string example: 850 nm _networkInterfacePortDetailsTemperature: type: object properties: channel: description: | The channel number if the diagnostic has an associated channel number. If not specified, defaults to `null`. type: integer example: 0 measurement: description: | Temperature in degrees Celsius. type: number format: double status: description: | Indicates whether the measurement is outside the high alarm, low alarm, high warning, or low warning thresholds for temperature. Valid values are `alarm low`, `alarm high`, `warn low`, `warn high`, and `ok`. type: string example: ok _networkInterfacePortDetailsTx_bias: type: object properties: channel: description: | The channel number if the transceiver is a multilane transceiver. If not specified, defaults to `null`. type: integer example: 0 measurement: description: | Tx bias current in mA. type: number format: double status: description: | Indicates whether the measurement is outside the high alarm, low alarm, high warning, or low warning thresholds for Tx bias current. Valid values are `alarm low`, `alarm high`, `warn low`, `warn high`, and `ok`. type: string example: ok _networkInterfacePortDetailsTx_fault: type: object properties: channel: description: | The channel number if the transceiver is a multilane transceiver. If not specified, defaults to `null`. type: integer example: 0 flag: description: A value of `true` indicates transmitter/laser fault. type: boolean _networkInterfacePortDetailsTx_power: type: object properties: channel: description: | The channel number if the transceiver is a multilane transceiver. If not specified, defaults to `null`. type: integer example: 0 measurement: description: | Tx output power in mW. type: number format: double status: description: | Indicates whether the measurement is outside the high alarm, low alarm, high warning, or low warning thresholds for Tx output power. Valid values are `alarm low`, `alarm high`, `warn low`, `warn high`, and `ok`. type: string example: ok _networkInterfacePortDetailsVoltage: type: object properties: channel: description: | The channel number if the diagnostic has an associated channel number. If not specified, defaults to `null`. type: integer example: 0 measurement: description: | Supply voltage in volts. type: number format: double status: description: | Indicates whether the measurement is outside the high alarm, low alarm, high warning, or low warning thresholds for supply voltage. Valid values are `alarm low`, `alarm high`, `warn low`, `warn high`, and `ok`. type: string example: ok _podPerformanceReplication: allOf: - $ref: '#/components/schemas/_context' - type: object properties: continuous_bytes_per_sec: description: | Total bytes transmitted or received per second for continuous replication. The continuous replication feature is used for disaster recovery on FlashArray and provides a recovery point objective (RPO) of significantly less than 30s. title: ReplicationPerformanceWithTotal allOf: - $ref: '#/components/schemas/_replicationPerformanceWithTotal' periodic_bytes_per_sec: description: | Total bytes transmitted or received per second for periodic replication. title: ReplicationPerformanceWithTotal allOf: - $ref: '#/components/schemas/_replicationPerformanceWithTotal' pod: description: Reference to the pod that the performance data is associated with. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' resync_bytes_per_sec: description: | Total bytes transmitted or received per second during resync replication. Resync replication is the mechanism to bring two arrays into sync. This may occur during an initial pod stretch, or, in case of outage, when two arrays reestablish connection. After the connection is restored, the array that was online starts replicating pod data to its peer array until the pod is once again in sync. title: ReplicationPerformanceWithTotal allOf: - $ref: '#/components/schemas/_replicationPerformanceWithTotal' sync_bytes_per_sec: description: | Total bytes transmitted or received per second for synchronous replication. title: ReplicationPerformanceWithTotal allOf: - $ref: '#/components/schemas/_replicationPerformanceWithTotal' time: description: Sample time in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true total_bytes_per_sec: description: | Total bytes transmitted and received per second for all types of replication. type: integer format: int64 minimum: 0 readOnly: true x-readOnly: true _replicaLinkLag: type: object properties: avg: description: | The average time difference between the current time and `recovery_point` for a period of time. type: integer format: int64 minimum: 0 readOnly: true max: description: | The maximum time difference between the current time and `recovery_point` for a period of time. type: integer format: int64 minimum: 0 readOnly: true x-readOnly: true _replicaLinkPerformanceReplication: allOf: - $ref: '#/components/schemas/_replicaLinkPerformanceReplicationBase' - type: object properties: remotes: description: The reference to a `remote array`. This uniquely identifies the external or peered storage system involved in data replication, synchronization, or management operations. type: array readOnly: true items: $ref: '#/components/schemas/_fixedReferenceWithType' x-readOnly: true _replicaLinkPerformanceReplicationArray: allOf: - $ref: '#/components/schemas/_replicaLinkPerformanceReplicationBase' - type: object properties: local_pod_array: description: | The `local array` on which the performance metrics were recorded. This acts as the source identifier for the collected data. title: PodArrayAndMember allOf: - $ref: '#/components/schemas/_podArrayAndMember' remote_pod_array: description: | The `remote array` on which the performance metrics were recorded. This acts as the source identifier for data collected from a replicated or peered system. title: PodArrayAndMember allOf: - $ref: '#/components/schemas/_podArrayAndMember' _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* _presetWorkloadConfigurationName: type: string description: | The name of the configuration object, used by other configuration objects in the preset to reference it. The name must be unique across all configuration objects in the preset. _namingPatterns: type: array description: | The naming patterns that are applied to the storage resources that are provisioned by the workload for this configuration. minItems: 1 maxItems: 1 items: $ref: '#/components/schemas/_namingPattern' _presetWorkloadDirectoryConfigurationExports: type: object properties: export_configurations: description: | The name of NFS, SMB, or SMB share configurations defined in the preset. This can be either an NFS configuration, or an SMB configuration, or both. If an SMB share configuration is specified, SMB configuration must also be specified. title: PresetWorkloadDirectoryConfigurationExportConfigurations allOf: - $ref: '#/components/schemas/_presetWorkloadDirectoryConfigurationExportConfigurations' naming_patterns: description: | The naming pattern for the export used by clients to mount the file system or directory. The export name must be unique within the same protocol and server combination. type: array minItems: 1 maxItems: 1 items: $ref: '#/components/schemas/_namingPattern' servers: description: | The optional reference to a parameterized server resource. The default is `_array_server` if no parameter is specified. maxItems: 1 type: array items: type: string _presetWorkloadDirectoryConfigurationMultiProtocol: type: object properties: access_control_style: description: | The access control style that is utilized for client actions such as setting file and directory ACLs. Possible values include `nfs`, `smb`, `shared`, `independent`, and `mode-bits`. If `nfs` is specified, then SMB clients will be unable to set permissions on files and directories. If `smb` is specified, then NFS clients will be unable to set permissions on files and directories. If `shared` is specified, then NFS and SMB clients will both be able to set permissions on files and directories. Any client will be able to overwrite the permissions set by another client, regardless of protocol. If `independent` is specified, then NFS and SMB clients will both be able to set permissions on files and directories, and can access files and directories created over any protocol. Permissions set by SMB clients will not affect NFS clients and vice versa. NFS clients will be restricted to only using mode bits to set permissions. If `mode-bits` is specified, then NFS and SMB clients will both be able to set permissions on files and directories, but only mode bits may be used to set permissions for NFS clients. When SMB clients set an ACL, it will be converted to have the same permission granularity as NFS mode bits. Supports parameterization. type: string safeguard_acls: description: | If set to "true", prevents NFS clients from erasing a configured ACL when setting NFS mode bits. If this is "true", then attempts to set mode bits on a file or directory will fail if they cannot be combined with the existing ACL set on a file or directory without erasing the ACL. Attempts to set mode bits that would not erase an existing ACL will still succeed and the mode bit changes will be merged with the existing ACL. This must be "false" when `access_control_style` is set to either `independent` or `mode-bits`. Supports parameterization. type: string _presetWorkloadDirectoryConfigurationParent: type: object properties: directory_configuration: $ref: '#/components/schemas/_presetWorkloadDirectoryConfigurationName' file_system: description: | The reference to an existing file system. It supports parameterization. title: Reference allOf: - $ref: '#/components/schemas/_reference' _presetWorkloadDirectoryConfigurationPath: type: object properties: naming_patterns: description: | The naming pattern for the directory path. type: array minItems: 1 maxItems: 1 items: $ref: '#/components/schemas/_namingPattern' _presetWorkloadDirectoryConfigurationSpecialDirectories: type: object properties: fast_remove: description: | The flag determining if a fast removal directory is available within the mounted file system or directory. Moving directories into this location deletes them and frees space more quickly than standard removal operations. The default is `false`. It supports parameterization. type: string snapshot: description: | The flag controlling the presence of a hidden `.snapshot` directory in each directory of the mounted file system. The `.snapshot` directory provides read access to directory snapshots. The default is `true`. It supports parameterization. type: string _presetWorkloadExportConfigurationNfs: allOf: - $ref: '#/components/schemas/_presetWorkloadPolicyAction' - type: object required: - name properties: name: $ref: '#/components/schemas/_presetWorkloadConfigurationName' naming_patterns: $ref: '#/components/schemas/_namingPatterns' policy_configuration: $ref: '#/components/schemas/_presetWorkloadExportConfigurationNfsPolicy' _presetWorkloadExportConfigurationSmb: allOf: - $ref: '#/components/schemas/_presetWorkloadPolicyAction' - type: object required: - name properties: name: $ref: '#/components/schemas/_presetWorkloadConfigurationName' naming_patterns: $ref: '#/components/schemas/_namingPatterns' policy_configuration: $ref: '#/components/schemas/_presetWorkloadExportConfigurationSmbPolicy' _presetWorkloadExportConfigurationSmbShare: allOf: - $ref: '#/components/schemas/_presetWorkloadPolicyAction' - type: object required: - name properties: name: $ref: '#/components/schemas/_presetWorkloadConfigurationName' naming_patterns: $ref: '#/components/schemas/_namingPatterns' policy_configuration: $ref: '#/components/schemas/_presetWorkloadExportConfigurationSmbSharePolicy' _presetWorkloadConstraints: description: Constraints to apply to the parameter. type: object properties: boolean: $ref: '#/components/schemas/_presetWorkloadConstraintsBoolean' integer: $ref: '#/components/schemas/_presetWorkloadConstraintsInteger' resource_reference: $ref: '#/components/schemas/_presetWorkloadConstraintsResourceReference' string: $ref: '#/components/schemas/_presetWorkloadConstraintsString' _presetWorkloadMetadata: type: object properties: description: description: | A brief description of the parameter and how it is used within the preset. Supports up to 1KB of unicode characters. type: string display_name: description: | The human-friendly name of the parameter, which will be shown in the GUI instead of the standard name if configured. Supports up to 64 unicode characters. type: string example: Billing ID subtype: description: | The subtype of the parameter, which the GUI will use to contextualize the prompt for the parameter value. For example, when set to size, the GUI will display an input field with a dropdown menu that contains common size units such as MB, GB, TB, etc. Valid values include `size`, `iops`, `bandwidth`, `time` and `duration`. Subtype can only be used with integer parameters. type: string _presetWorkloadSnapshotRule: type: object required: - every - keep_for properties: at: description: | Specifies the number of milliseconds since midnight at which to take a snapshot. The `at` value cannot be set if the `every` value is not measured in days. The `at` value can only be set on the first rule. It supports parameterization. type: string client_name: description: | The snapshot file client name. For file directories, 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`. title: NamingPatterns allOf: - $ref: '#/components/schemas/_namingPatterns' every: description: | Specifies the interval between snapshots, in milliseconds. The `every` value for all rules must be multiples of one another. It supports parameterization. type: string keep_for: description: | Specifies the period that snapshots are retained before they are eradicated, in milliseconds. It supports parameterization. type: string suffix: description: | The snapshot suffix name. For file directories, 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. It supports parameterization. type: string time_zone: description: | The time zone to use with the `at` time. If not specified, defaults to the time zone of the array where the workload is provisioned. It supports parameterization. type: string example: America/Los_Angeles _presetWorkloadPolicyAction: type: object properties: policy_action: description: | A directive for how to manage policies as part of workload creation. Valid values include `always_create` and `create_or_reuse`. If set to `always_create`, then creation of a workload will require creation of policies specified in the preset. If a policy with a matching name already exists, workload creation will fail. Otherwise, a policy will be created that is exclusive to this workload. If set to `create_or_reuse`, when a workload is created, an existing policy with a matching name is searched for in order to reuse. If an existing policy is found - and there are rules specified in the preset - all preset rules must match the rules in the policy for it to be reused, otherwise workload creation will fail. If there is no policy found with a matching name, a new policy will be created. This new policy will not be exclusive to the workload and may be reused by other workloads. The default is `create_or_reuse`. Supports parameterization. type: string _presetWorkloadQuotaRule: type: object properties: 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 can be sent. No client operations are blocked when an unenforced limit is exceeded. If set to "true", the limit is enforced. Supports parameterization. type: string quota_limit: description: | The logical space limit of the quota assigned by the rule, measured in bytes. The value cannot be `0`. It supports parameterization. type: string ResourceAccessStatusCreatedBy: description: | Each Resource Access Status has a reference to the resource accesses that explain its existence. type: object properties: id: description: ID of a Resource Access. type: string implicit: description: |+ Set to `true` when this resource access status was not explicitly created, but instead, its existence is implied by another resource access. Usually, this happens when a scope has access to a group of resources (e.g., a host group). Then this scope has access to each member of the group, individual hosts. Set to `false` when a resource access status reflects explicitly created resource access. Note that if there is both implicit and explicit access of an object to a scope, there will be only one entry in the response for that object and scope pair. The `created_by` field will contain both implicit and explicit resource access references. type: boolean _softwareInstallationStepsChecks: type: object properties: details: description: | Detailed result of the check used to diagnose check failures. type: string name: description: Name of the upgrade check. type: string example: HostIOCheck overridable: description: | Whether the check failure can be overridden. type: boolean status: description: | Status of the check. Valid values are `running`, `failed`, `passed`, and `overridden`. A status of `running` indicates that the check has not finished. A status of `failed` indicates that the check has failed. A status of `passed` indicates that the check has passed. A status of `overridden` indicates that the check has failed, but the failure has been overridden. type: string _subscriptionAssetSubscription: description: | A reference to which subscription this appliance belongs. type: object properties: id: description: | A globally unique, system-generated ID. The ID cannot be modified. type: string readOnly: true x-readOnly: true _workloadParameterValueResourceReference: description: The value for a resource reference parameter. type: object properties: id: description: | The id of the resource to reference. One of `id` or `name` must be set, but they cannot be set together. type: string name: description: | The name of the resource to reference. One of `id` or `name` must be set, but they cannot be set together. type: string resource_type: description: | The type of the resource to reference. Resource type is optional, and will be automatically determined by the server if not set. type: string _workloadPlacementRecommendationParameterResourceReference: description: The constraints applied to parameters of the resource reference type. type: object properties: allowed_values: description: | The valid values accepted by the parameter to create a workload. type: array items: $ref: '#/components/schemas/_reference' _workloadPlacementRecommendationTarget: description: | Data for a target in a workload placement recommendation. Target is a FlashArray, which may be used for workload placement. allOf: - $ref: '#/components/schemas/_referenceWithType' - type: object properties: capacity: description: | The usable capacity of the target, measured in bytes. type: integer format: int64 example: 10995116277760 capacity_used_projections: $ref: '#/components/schemas/_workloadPlacementRecommendationTargetCapacityUsedProjections' load_projections: $ref: '#/components/schemas/_workloadPlacementRecommendationTargetLoadProjections' model: description: | The model of the target. For example, `FA-X20R2`. type: string warnings: description: | The warnings for the target. type: array items: $ref: '#/components/schemas/_workloadPlacementRecommendationWarning' _workloadPlacementRecommendationTargetCapacityUsedProjections: description: | Projections for the capacity consumed by customer data. type: object properties: days_until_full: description: | The number of days until the target is at full capacity. type: integer format: int32 example: 10 projection: description: | The projection of the used capacity, assuming the workload is provisioned on this target. title: WorkloadPlacementRecommendationProjection allOf: - $ref: '#/components/schemas/_workloadPlacementRecommendationProjection' projection_baseline: description: | The projection of the baseline used capacity, without the workload on this target. title: WorkloadPlacementRecommendationProjection allOf: - $ref: '#/components/schemas/_workloadPlacementRecommendationProjection' _workloadPlacementRecommendationTargetLoadProjections: description: | Load depicts the storage system utilization as a percentage from 0, when the system is completely idle, to 100, when the system is completely saturated. type: object properties: projection_avg: description: | The projected average load on the target. title: WorkloadPlacementRecommendationProjection allOf: - $ref: '#/components/schemas/_workloadPlacementRecommendationProjection' projection_baseline: description: | The projected baseline load on the target, without the workload on this target. title: WorkloadPlacementRecommendationProjection allOf: - $ref: '#/components/schemas/_workloadPlacementRecommendationProjection' projection_blended_max: description: | The projected blended maximum load on the target. title: WorkloadPlacementRecommendationProjection allOf: - $ref: '#/components/schemas/_workloadPlacementRecommendationProjection' _workloadPlacementRecommendationWarning: type: object properties: code: description: | The warning code. Possible values include `limit_volumes_count`, `limit_pods_count`, etc. type: string message: description: | The warning message. Possible values include `Adding the workload on the array would exceed the limit on volumes`, `Adding the workload on the array would exceed the limit on pods`, etc. type: string _networkInterfaceNeighborNeighborChassisId: description: | An administratively assigned identifier of the particular neighboring chassis. type: object properties: type: description: | The chassis ID subtype. Valid values are `ifname`, `ifalias`, `local`, `mac`, `ip`, and `unhandled`. type: string example: mac value: description: The specific identifier for the particular chassis. type: string example: 00:12:ab:cd:ab:cd _networkInterfaceNeighborCapability: type: object properties: enabled: description: | If true, this capability is enabled by this neighbor; false otherwise. type: boolean readOnly: true example: false supported: description: | If true, this capability is supported by this neighbor; false otherwise. type: boolean readOnly: true example: false x-readOnly: true _networkInterfaceNeighborNeighborPortId: description: | An administratively assigned identifier of the particular neighboring port. type: object properties: type: description: | The port ID subtype. Valid values are `ifname`, `ifalias`, `local`, `mac`, `ip`, and `unhandled`. type: string example: ifname value: description: The specific identifier for the particular port. type: string example: Ethernet7 _networkInterfacePortDetailsStaticRxPowerThresholds: description: | The alarm low, warn low, warn high, alarm high thresholds for Rx input power in mW. type: object properties: alarm_high: description: The alarm high threshold for Rx input power in mW. type: number format: double alarm_low: description: The alarm low threshold for Rx input power in mW. type: number format: double warn_high: description: The warn high threshold for Rx input power in mW. type: number format: double warn_low: description: The warn low threshold for Rx input power in mW. type: number format: double _networkInterfacePortDetailsStaticTemperatureThresholds: description: | The alarm low, warn low, warn high, alarm high thresholds for temperature in degrees Celsius. type: object properties: alarm_high: description: The alarm high threshold for temperature in degrees Celsius. type: number format: double alarm_low: description: The alarm low threshold for temperature in degrees Celsius. type: number format: double warn_high: description: The warn high threshold for temperature in degrees Celsius. type: number format: double warn_low: description: The warn low threshold for temperature in degrees Celsius. type: number format: double _networkInterfacePortDetailsStaticTxBiasThresholds: description: | The alarm low, warn low, warn high, alarm high thresholds for Tx bias current in mA. type: object properties: alarm_high: description: The alarm high threshold for Tx bias current in mA. type: number format: double alarm_low: description: The alarm low threshold for Tx bias current in mA. type: number format: double warn_high: description: The warn high threshold for Tx bias current in mA. type: number format: double warn_low: description: The warn low threshold for Tx bias current in mA. type: number format: double _networkInterfacePortDetailsStaticTxPowerThresholds: description: | The alarm low, warn low, warn high, alarm high thresholds for Tx output power in mW. type: object properties: alarm_high: description: The alarm high threshold for Tx output power in mW. type: number format: double alarm_low: description: The alarm low threshold for Tx output power in mW. type: number format: double warn_high: description: The warn high threshold for Tx output power in mW. type: number format: double warn_low: description: The warn low threshold for Tx output power in mW. type: number format: double _networkInterfacePortDetailsStaticVoltageThresholds: description: | The alarm low, warn low, warn high, alarm high thresholds for supply voltage (in volts). type: object properties: alarm_high: description: The alarm high threshold for supply voltage in volts. type: number format: double alarm_low: description: The alarm low threshold for supply voltage in volts. type: number format: double warn_high: description: The warn high threshold for supply voltage in volts. type: number format: double warn_low: description: The warn low threshold for supply voltage in volts. type: number format: double _replicationPerformanceWithTotal: type: object properties: from_remote_bytes_per_sec: description: | The number of bytes received per second from a remote array. The number will be zero if the arrays are unable to communicate. type: integer format: int64 minimum: 0 readOnly: true to_remote_bytes_per_sec: description: | The number of bytes transmitted per second to a remote array. The number will be zero if the arrays are unable to communicate. type: integer format: int64 minimum: 0 readOnly: true total_bytes_per_sec: description: | Total bytes transmitted and received per second. The number will be zero if the arrays are unable to communicate. type: integer format: int64 minimum: 0 readOnly: true x-readOnly: true _replicaLinkPerformanceReplicationBase: type: object properties: bytes_per_sec_from_remote: description: The number of bytes received per second from a remote array. type: integer format: int64 minimum: 0 readOnly: true bytes_per_sec_to_remote: description: The number of bytes transmitted per second to a remote array. type: integer format: int64 minimum: 0 readOnly: true bytes_per_sec_total: description: Total bytes transmitted and received per second. type: integer format: int64 minimum: 0 readOnly: true direction: description: The direction of replication relative to the local array. Valid values include `inbound`, indicating data being received, and `outbound`, indicating data being transmitted. type: string readOnly: true local_pod: description: The reference to a `local pod`. This uniquely identifies the container or grouping of resources within the local storage environment. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' remote_pod: description: The reference to a `remote pod`. This uniquely identifies the container or grouping of resources located on a peered or external storage array. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference' time: description: The timestamp of the sample, measured in `milliseconds` since the `UNIX epoch`. type: integer format: int64 readOnly: true x-readOnly: true _podArrayAndMember: allOf: - $ref: '#/components/schemas/_referenceWithType' - type: object properties: member: description: | The reference to the member on the array. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' x-readOnly: true _namingPattern: type: object required: - template properties: template: description: | A naming template is a string that defines a naming pattern using a combination of tokens (or chips), which include both static text and dynamic placeholders. Each token contributes to the final name when the template is applied. Dynamic tokens serve as placeholders that resolve to specific values, such as user-defined parameters or system-generated values. They can also support transformation functions to modify their inputs, including nesting where the output of one function is passed to another. The resulting string is a concatenation of all tokens - both static and dynamic - forming the final resource name. If a user does not specify a naming template, a default naming pattern is automatically applied to the resource. For resources that are unique to the workload (e.g. volumes), the default naming pattern is a combination of the workload name and workload configuration name separated by a hyphen. For resources that are reused across workloads (e.g. `create_or_reuse` policies), the default naming pattern is a combination of the preset name and the workload configuration name separated by a hyphen. If the resource supports a `count` in the preset configuration (e.g. volumes), the name is appended with a four digit (left-padded) index that starts at `"0001"`, also separated by a hyphen. type: string _presetWorkloadDirectoryConfigurationExportConfigurations: type: object properties: nfs: description: | The name of the NFS export configuration defined in the preset. type: string smb: description: | The name of the SMB export configuration defined in the preset. type: string smb_share: description: | The name of the SMB share export configuration defined in the preset. type: string _presetWorkloadDirectoryConfigurationName: type: object properties: name: description: | The name of the `directory_configuration` within the preset. type: string _presetWorkloadExportConfigurationNfsPolicy: type: object properties: rules: type: array items: $ref: '#/components/schemas/_presetWorkloadExportConfigurationNfsRule' user_mapping_enabled: description: | If set to "true", 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. It supports parameterization. type: string _presetWorkloadExportConfigurationSmbPolicy: type: object properties: access_based_enumeration_enabled: description: | The flag enabling access-based enumeration on the policy. When enabled, files and folders within attached exports are hidden from users without view permissions. The default is `false`. It supports parameterization. type: string continuous_availability_enabled: description: | The flag indicating if continuous availability is enabled on the policy. When enabled, file shares remain accessible during disruptive events, such as temporary network outages, controller upgrades, or failovers. The default is `true`. It supports parameterization. type: string rules: type: array items: $ref: '#/components/schemas/_presetWorkloadExportConfigurationSmbRule' _presetWorkloadExportConfigurationSmbSharePolicy: type: object properties: rules: type: array items: $ref: '#/components/schemas/_presetWorkloadExportConfigurationSmbShareRule' _presetWorkloadConstraintsBoolean: description: Constraints to apply to boolean parameters. type: object properties: default: description: The default value to use if no value is provided. type: boolean _presetWorkloadConstraintsInteger: description: Constraints to apply to integer parameters. type: object properties: allowed_values: description: | The valid values that can be supplied to the parameter. A parameter that collects the number of volumes to provision might, for example, limit the allowed values to a few fixed options. Supports up to five values. type: array items: type: integer format: int64 default: description: | The default value to use if no value is provided. Must be present in `allowed_values`, if set. Must comply with `minimum`, if set. Must comply with `maximum`, if set. type: integer format: int64 maximum: description: "The maximum acceptable value, inclusive." type: integer format: int64 minimum: description: "The minimum acceptable value, inclusive." type: integer format: int64 _presetWorkloadConstraintsResourceReference: description: Constraints to apply to resource reference parameters type: object required: - allowed_values properties: allowed_values: description: | The valid values that can be supplied to the parameter. At least one value must be specified to configure a `resource_type`. type: array maxItems: 5 items: $ref: '#/components/schemas/_presetWorkloadConstraintsResourceReferenceAllowedValues' default: description: | The default value to use if no value is provided. Must match the `resource_type` set in `allowed_values`. One of `id` or `name` must be set, but they cannot be set together. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' _presetWorkloadConstraintsString: description: Constraints to apply to string parameters. type: object properties: allowed_values: description: | The valid values that can be supplied to the parameter. A parameter that collects the name of the environment to which a workload will deploy might, for example, limit the allowed values to `production`, `testing` and `development`. Supports up to five values, with up to 64 unicode characters per value. type: array items: type: string default: description: | The default value to use if no value is provided. Must be present in `allowed_values`, if `allowed_values` is set. Supports up to 64 unicode characters. type: string _workloadPlacementRecommendationProjection: type: object properties: end: description: | The projection for the end of the projection period. Length of the projection period is defined by 'projection_months'. The percentage is displayed as a decimal value, starting at 0.00 and ending at 1.00. type: number format: float example: 0.77 start: description: | The projection for the start of the projection period (i.e., immediately after the creation of the workload on this target). The percentage is displayed as a decimal value, starting at 0.00 and ending at 1.00. type: number format: float example: 0.77 _presetWorkloadExportConfigurationNfsRule: type: object properties: access: description: | The access control specification for the export. The valid values are `root-squash`, `all-squash`, and `no-root-squash`. The `root-squash` setting prevents root privilege mapping by reassigning UID 0 and GID 0 to `anonuid` and `anongid`. The `all-squash` setting maps all UIDs and GIDs to `anonuid` and `anongid`. The `no-root-squash` setting allows access using original UIDs and GIDs. The default is `root-squash`. It supports parameterization. type: string anongid: description: | The anonymous group ID (GID) used for mapping when `access` is set to `root_squash` or `all_squash`. The default is `null`, which corresponds to `65534`. It supports parameterization. type: string anonuid: description: | The anonymous user ID (UID) used for mapping when `access` is set to `root_squash` or `all_squash`. The default is `null`, which corresponds to `65534`. It supports parameterization. type: string atime: description: | If set to `true`, after a read operation has occurred, the inode access time is updated only if any of the following conditions is true: the previous access time is less than the inode modify time, the previous access time is less than the inode change time, or the previous access time is more than 24 hours ago. If set to `false`, disables the update of inode access times after read operations. The defaults to `true`. It supports parameterization. type: string client: description: | The clients permitted to access the export. Accepted notations include a single IP address, a subnet in CIDR notation, a netgroup, a hostname (RFC-1123), a fully qualified domain name (RFC-1123, RFC 2181), wildcards, or anonymous (`*`). The default is `*`. It supports parameterization. type: string nfs_version: description: | The NFS protocol version allowed for the export. The valid values are `nfsv3` and `nfsv4`. It supports parameterization. type: array items: type: string example: nfsv3 permission: description: | The read-write client access permissions for the export. The valid values are `rw` and `ro`. The default is `ro`. It supports parameterization. type: string secure: description: | The flag preventing NFS access to client connections from non-reserved ports. It applies to NFSv3, NFSv4.1, and the auxiliary protocols MOUNT and NLM. The default is `false`. It supports parameterization. type: string security: description: | The security flavors used to access files on the mount point. The mount operation fails if the server does not support the requested flavor. The `sys` flavor trusts the client to specify the user identity. The `krb5` flavor provides cryptographic proof of user identity in each RPC request and requires additional configuration. The `krb5i` flavor adds integrity checking to prevent data tampering. The `krb5p` flavor adds integrity checking and encryption, offering the highest security but incurring the highest performance overhead. The default is `sys`. It supports parameterization. type: array items: type: string example: sys _presetWorkloadExportConfigurationSmbRule: type: object properties: anonymous_access_allowed: description: | The flag controlling access to information for anonymous users. The default is `false`. It supports parameterization. type: string client: description: | Specifies the clients that will be permitted to access the export. Accepted notation is a single IP address, subnet in CIDR notation, netgroup, hostname (see RFC-1123 part 2.1), fully qualified domain name (see RFC-1123 part 2.1, RFC 2181 part 11), wildcards with fully qualified domain name or hostname, or anonymous (`*`). The default is `*` if not specified. Supports parameterization. type: string encryption: description: | Specifies whether the remote client is required to use SMB encryption. Valid values are `required`, `disabled`, and `optional`. If not specified, defaults to `optional`. Supports parameterization. type: string example: optional permission: description: | Specifies which read-write client access permissions are allowed for the export. Valid values are `rw` and `ro`. The default is `ro` if not specified. Supports parameterization. type: string _presetWorkloadExportConfigurationSmbShareRule: type: object properties: change: description: | The state of the principal's Change access permission. Valid values are `allow` and `deny`. When not set, value is `null`. When allowed, includes all access granted by the Read permission. Users can also change data within files and add or delete files and folders. When denied, these operations are explicitly blocked. If not set for any applicable rule on any applicable policy, acts as an implicit deny. If set to `allow`, implicitly sets the Read permission to `allow`. This is incompatible with explicitly setting any permission to `deny`. If set to `deny`, implicitly sets the Read permission to `deny`. This is incompatible with explicitly setting any permission to `allow`. Defaults to `null`. Supports parameterization. type: string full_control: description: | The state of the principal's Full Control access permission. Valid values are `allow` and `deny`. When not set, value is `null`. When allowed, includes all access granted by the Change permission. Users can also change the permissions for files and folders. When denied, these operations are explicitly blocked. If not set for any applicable rule on any applicable policy, acts as an implicit deny. If set to `allow`, implicitly sets the Change and Read permissions to `allow`. This is incompatible with explicitly setting any permission to `deny`. If set to `deny`, implicitly sets the Change and Read permissions to `deny`. This is incompatible with explicitly setting any permission to `allow`. Defaults to `null`. Supports parameterization. type: string principal: description: | The user or group who is the subject of this rule, and optionally their domain. If no domain is provided, it will be derived if possible. For example, `PURESTORAGE\Administrator`, `samplegroup@PureStorage`, or `sampleuser`. Supports parameterization. type: string read: description: | The state of the principal's Read access permission. Valid values are `allow` and `deny`. When allowed, users can view file names, read the data in those files, and run some programs. When denied, these operations are explicitly blocked. When setting to `allow`, cannot explicitly set any permission to `deny`. When setting to `deny`, cannot explicitly set any permission to `allow`. Defaults to `allow`. Supports parameterization. type: string _presetWorkloadConstraintsResourceReferenceAllowedValues: type: object required: - resource_type properties: id: description: | The globally unique, system-generated ID. It cannot be modified. type: string name: description: | The name of the resource, such as a volume, pod, or snapshot. type: string resource_type: description: | The type of resource the parameter references. Valid values include `servers`, `storage-classes`, and `remote-arrays`. type: string parameters: XRequestId: name: X-Request-ID in: header description: | Supplied by client during request or generated by server. schema: 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 Filter: name: filter in: query description: | Narrows down the results to only the response objects that satisfy the filter criteria. schema: type: string Limit: name: limit in: query description: | Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. schema: type: integer format: int32 minimum: 0 example: 10 Sort: name: sort in: query description: | Sorts the response objects by the specified fields. Sorting can be applied to any field name in the response, in ascending order by default, or in descending order by prefixing the field name with a minus sign (-). Multiple fields can be specified as a comma-separated list (e.g., sort volumes by size descending, then by name ascending). If sort is provided, the response will not include a continuation_token. style: form explode: false schema: type: array items: pattern: "^[a-z]+(_[a-z]+)*-?" type: string Total_item_count: name: total_item_count in: query description: | If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`. schema: type: boolean 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 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: 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 Fqnames_required: 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`. required: true style: form explode: false schema: type: array items: type: string Join_existing_acct_ad: name: join_existing_account in: query description: | If specified as `true`, the domain is searched for a pre-existing computer account to join to, and no new account will be created within the domain. The `user` specified when joining a pre-existing account must have permissions to 'read all properties from' and 'reset the password of' the pre-existing account. `join_ou` will be read from the pre-existing account and cannot be specified when joining to an existing account. If not specified, defaults to `false`. schema: type: boolean Local_only_ad: name: local_only in: query description: | If specified as `true`, only delete the Active Directory configuration on the local array, without deleting the computer account created in the Active Directory domain. If not specified, defaults to `false`. schema: type: boolean 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 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 Ids: name: ids in: query description: | A comma-separated list of unique resource IDs. At least one resource must match each specified ID, otherwise an error is returned. This parameter is required if ids or names is not provided, but it cannot be used together with name or names. style: form explode: false schema: type: array items: type: string 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 Expose_api_token: name: expose_api_token in: query description: | If `true`, exposes the API token of the current user. schema: type: boolean 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 Expose_public_key: name: expose_public_key in: query description: | If `true`, exposes the public key of the current user. schema: type: boolean Member_ids: name: member_ids in: query description: | Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The `member_ids` or `member_names` parameter is required, but they cannot be set together. style: form explode: false schema: type: array items: type: string Member_names: name: member_names in: query description: | Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`. style: form explode: false schema: type: array items: type: string 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 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 Timeout: name: timeout in: query description: | The duration of API token validity, in milliseconds. schema: type: integer format: int64 Remove_all_entries: name: remove_all_entries in: query description: | If set to `true`, removes all entries from the administrator cache. required: true schema: type: boolean Flagged: name: flagged in: query description: | If set to `true`, lists only flagged messages. If set to `false`, lists only unflagged messages. if not specified, lists all messages. schema: type: boolean IdsSemiRequired: name: ids in: query description: | Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together. style: form explode: false schema: type: array items: type: string NamesSemiRequired: name: names in: query description: | Performs the operation on the unique name specified. For example, `name01`. Enter multiple names in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together. style: form explode: false schema: type: array items: type: string Alert_rules_code_list: name: code in: query description: | The alert code to display. schema: type: integer format: int32 Alert_rules_code: name: code in: query description: | The alert code that the rule applies to. Available alert codes for customization can be found in the alert rules catalog. required: true schema: type: integer format: int32 Alert_rules_parameter: name: parameter in: query description: | The parameter of the custom alert rule to modify. Values include `info` and `warning`. Available parameter values can be found in the alert rules catalog. required: true schema: type: string App_names: name: app_names in: query description: | The name of the installed app. Enter multiple names in comma-separated format. style: form explode: false schema: type: array items: type: string Eradicate_all_data: name: eradicate_all_data in: query description: | Set to `true` to perform a factory reset. schema: type: boolean Factory_reset_token: name: factory_reset_token in: query description: | A token required to perform a factory reset. schema: type: integer format: int64 History_end_time: name: end_time in: query description: |+ Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution. schema: type: integer format: int64 History_resolution: name: resolution in: query description: | The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution. schema: type: integer format: int64 minimum: 0 example: 30000 History_start_time: name: start_time in: query description: |+ Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution. schema: type: integer format: int64 Keys: name: keys in: query description: | A comma-separated list of tag keys. style: form explode: false schema: type: array items: type: string Eradicate_all_data_required: name: eradicate_all_data in: query description: | Set to `true` to perform a factory reset. required: true schema: type: boolean Preserve_configuration_data_required: name: preserve_configuration_data in: query description: | A comma-separated list of configuration data types to preserve. A value of `all` will preserve all configuration data types. Valid values include `all`. required: true style: form explode: false schema: type: array items: type: string Skip_phonehome_check: name: skip_phonehome_check in: query description: | A flag to skip phonehome connectivity check. If `skip_phonehome_check` is not set, the factory reset will fail if phonehome connectivity check fails. Arrays that intentionally disable phonehome or do not permit connectivity to Pure Storage's cloud servers must set this flag to `true` in order to start factory reset. schema: type: boolean Delete_sanitization_certificate_required: name: delete_sanitization_certificate in: query description: | Set to `true` to finalize factory reset and acknowledge the deletion of sanitization certificate. required: true schema: type: boolean Finalize_array_erasure_required: name: finalize in: query description: | Must be `true` to finalize factory reset. required: true schema: type: boolean Reinstall_image_required: name: reinstall_image in: query description: | Set to `true` to reinstall image, or `false` to skip reinstalling image. required: true schema: type: boolean Perf_protocol_group: name: protocol_group in: query description: | Protocol group type. Valid values are `block`, `file`, `object-store`, and `all`. schema: type: string Perf_protocol_type: name: protocol in: query description: | Protocol type. Valid values are `nfs`, `smb`, `s3`, and `all`. schema: type: string Namespaces: name: namespaces in: query description: | A comma-separated list of namespaces. style: form explode: false schema: type: array items: type: string Remote_ids: name: remote_ids in: query description: | A comma-separated list of remote array 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 `remote_names` query parameter. style: form explode: false schema: type: array items: type: string Remote_names: name: remote_names in: query description: | A comma-separated list of remote array 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 `remote_ids` query parameter. style: form explode: false schema: type: array items: type: string Refresh: name: refresh in: query description: | If set to `true`, the array will attempt to communicate with the connection peer in order to update the connection attributes on both arrays with any changes that have occurred. If set to `true`, other array connection attributes may not be modified in requests. Default value is `false`. schema: type: boolean Renew_encryption_key: name: renew_encryption_key in: query description: | If set to `true`, update array connection with a new encryption key. If set to `true`, other array connection attributes may not be modified in requests. Defaults to `false`. schema: type: boolean Encrypted: name: encrypted in: query description: | If `true`, the returned array connection key will encode an encryption key used to establish trust and secure replication traffic. If `false`, the returned array connection key will not encode an encryption key. If not specified, defaults to `false`. schema: type: boolean 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 Total_only: name: total_only in: query description: | If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty. schema: type: boolean Generate_new_key: name: generate_new_key in: query description: | If set to `true`, a new private key is generated when generating a new certificate with the specified attributes. This may not be set to `true` when importing a certificate and private key, and may not be set to `false` when generating a new self-signed certificate to replace a certificate that was imported. Default setting is `false`. schema: type: boolean Certificate_group_ids: name: certificate_group_ids in: query description: | A comma-separated list of certificate group ids. If there is not at least one resource that matches each of the elements of `certificate_group_ids`, then an error is returned. This cannot be provided in conjunction with the `certificate_group_names` parameter. style: form explode: false schema: type: array items: type: string Certificate_group_names: name: certificate_group_names in: query description: | A comma-separated list of certificate group names. If no resource matches each of the elements of `certificate_group_names`, then an error is returned. This cannot be provided in conjunction with the `certificate_group_ids` parameter. style: form explode: false schema: type: array items: type: string Certificate_ids: name: certificate_ids in: query description: | A comma-separated list of certificate ids. If there is not at least one resource that matches each of the elements of `certificate_ids`, then an error is returned. This cannot be provided in conjunction with the `certificate_names` parameter. style: form explode: false schema: type: array items: type: string Certificate_names: name: certificate_names in: query description: | The names of one or more certificates. Enter multiple names in comma-separated format. For example, `cert01,cert02`. style: form explode: false schema: type: array items: type: string Host_group_names: name: host_group_names in: query description: | Performs the operation on the host group specified. Enter multiple names in comma-separated format. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple host group names and volume names; instead, at least one of the objects (e.g., `host_group_names`) must be set to only one name (e.g., `hgroup01`). style: form explode: false schema: type: array items: type: string Host_names: name: host_names in: query description: | Performs the operation on the hosts specified. Enter multiple names in comma-separated format. For example, `host01,host02`. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple host names and volume names; instead, at least one of the objects (e.g., `host_names`) must be set to only one name (e.g., `host01`). style: form explode: false schema: type: array items: type: string Protocol_endpoint_ids: name: protocol_endpoint_ids in: query description: | Performs the operation on the protocol endpoints specified. Enter multiple IDs in comma-separated format. For example, `peid01,peid02`. A request cannot include a mix of multiple objects with multiple IDs. For example, a request cannot include a mix of multiple protocol endpoint IDs and host names. Instead, at least one of the objects (e.g., `protocol_endpoint_ids`) must be set to one ID (e.g., `peid01`). style: form explode: false schema: type: array items: type: string Protocol_endpoint_names: name: protocol_endpoint_names in: query description: | Performs the operation on the protocol endpoints specified. Enter multiple names in comma-separated format. For example, `pe01,pe02`. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple protocol endpoint names and host names; instead, at least one of the objects (e.g., `protocol_endpoint_names`) must be set to one name (e.g., `pe01`). style: form explode: false schema: type: array items: type: string Volume_ids: name: volume_ids in: query description: | Performs the operation on the specified volume. Enter multiple ids in comma-separated format. For example, `vol01id,vol02id`. A request cannot include a mix of multiple objects with multiple IDs. For example, a request cannot include a mix of multiple volume IDs and host names; instead, at least one of the objects (e.g., `volume_ids`) must be set to only one name (e.g., `vol01id`). Only one of the two between `volume_names` and `volume_ids` may be used at a time. style: form explode: false schema: type: array items: type: string Volume_names: name: volume_names in: query description: | Performs the operation on the volume specified. Enter multiple names in comma-separated format. For example, `vol01,vol02`. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple volume names and host names; instead, at least one of the objects (e.g., `volume_names`) must be set to only one name (e.g., `vol01`). style: form explode: false schema: type: array items: type: string Container_ids: name: ids in: query description: | Performs the operation on the container ID specified. Enter multiple source IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together. Specifying `ids` or `names` with no value will perform the operation on local array. style: form explode: false schema: type: array items: type: string Container_names: name: names in: query description: | Performs the operation on the unique container name specified. Enter multiple names in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together. Specifying `ids` or `names` with no value will perform the operation on local array. style: form explode: false schema: type: array items: type: string 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 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 File_system_ids: name: file_system_ids in: query description: | Performs the operation on the file system ID specified. Enter multiple file system IDs in comma-separated format. The `file_system_ids` or `file_system_names` parameter is required, but they cannot be set together. style: form explode: false schema: type: array items: type: string File_system_names: name: file_system_names in: query description: | Performs the operation on the file system name specified. Enter multiple file system names in comma-separated format. For example, `filesystem01,filesystem02`. style: form explode: false schema: type: array items: type: string Add_to_policy_ids_directory: name: add_to_policy_ids in: query description: | The managed directories will become members of the specified policies along with creation. Enter multiple ids in comma-separated format. style: form explode: false schema: type: array items: type: string Add_to_policy_names_directory: name: add_to_policy_names in: query description: | The managed directories will become members of the specified policies along with creation. Enter multiple names in a comma-separated format. style: form explode: false schema: type: array items: type: string 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 With_default_protection_policy_directory: name: with_default_protection in: query description: | If specified as `true`, the initial protection of the newly created managed directories will be the union of the container default protection policies thatare not already applied to any of their ancestors, and either `add_to_policy_names` or `add_to_policy_ids`. If specified as `false`, the default protection of the container will not be applied automatically. The initial protection of the newly created managed directories will be configured by either `add_to_policy_names` or `add_to_policy_ids`. If not specified, defaults to `true`. schema: type: boolean Group_names: name: group_names in: query description: |+ Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`. style: form explode: false schema: type: array items: type: string Group_quota_gids: name: group_ids in: query description: | Performs the operation on the groups that match the given list of gids. Enter names in a comma-separated format, e.g., `2001,2002`. style: form explode: false schema: type: array items: type: integer format: int64 Group_sids: name: group_sids in: query description: | Performs the operation on the specified group SID. Enter multiple group SIDs in comma-separated format. For example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`. style: form explode: false schema: type: array items: type: string 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 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 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 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 User_names: name: user_names in: query description: | Performs the operation on the users that match the given list of user names. Enter names in a comma-separated format, for example, `u1,u2`. style: form explode: false schema: type: array items: type: string User_quota_uids: name: user_ids in: query description: | Performs the operation on the users that match the given list of uids. Enter names in a comma-separated format, for example, `1001,1002`. style: form explode: false schema: type: array items: type: integer format: int64 User_sids: name: user_sids in: query description: | Performs the operation on the users that match the given list of user SIDs. Enter SIDs in a comma-separated format, for example, `S-1-1-20-1000,S-1-1-20-2002`. style: form explode: false schema: type: array items: type: string Directory_export_fqnames: name: names in: query description: | Performs the operation on the unique name specified. Enter multiple names in comma-separated format. Combines the export containment hierarchy (server), the protocol (smb or nfs) and the export_name. For example, `server01::smb::export01,server01::nfs::export01`. style: form explode: false schema: type: array items: type: string Directory_fqnames: name: directory_names in: query description: | Performs the operation on the managed directory names specified. Enter multiple full managed directory 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, `fs:dir01,pod01::fs:dir01`. style: form explode: false schema: type: array items: type: string Directory_ids: name: directory_ids in: query description: | Performs the operation on the unique managed directory IDs specified. Enter multiple managed directory IDs in comma-separated format. The `directory_ids` or `directory_names` parameter is required, but they cannot be set together. style: form explode: false schema: type: array items: type: string Export_names: name: export_names in: query description: | Performs the operation on the export names specified. Enter multiple names in comma-separated format. For example, `name01,name02`. style: form explode: false schema: type: array items: type: string Directory_names: name: directory_names in: query description: | Performs the operation on the managed directory names specified. Enter multiple full managed directory names in comma-separated format. For example, `fs:dir01,fs:dir02`. style: form explode: false schema: type: array items: type: string To_member_ids: name: to_member_ids in: query description: | The resource will be moved to the specified local member realm or array. Enter multiple IDs in a comma-separated format. style: form explode: false schema: type: array items: type: string To_member_names: name: to_member_names in: query description: | The resource will be moved to the specified local member realm or array. Enter multiple names in a comma-separated format. style: form explode: false schema: type: array items: type: string Group_mapping_names: name: names in: query description: | Performs the operation on the unique names specified. For example, `GroupRoleMappingName`. Enter multiple names in comma-separated format. style: form explode: false schema: type: array items: type: string Role_names: name: role_names in: query description: | This field has been deprecated. style: form explode: false schema: type: array items: type: string Group_mapping_names_required: name: names in: query description: | Performs the operation on the unique names specified. For example, `GroupRoleMappingName`. Enter multiple names in comma-separated format. required: true style: form explode: false schema: type: array items: type: string Gids: name: gids in: query description: | Performs the operation on the specified GIDs. Enter multiple GIDs in comma-separated format. For example, `4234235,9681923`. style: form explode: false schema: type: array items: type: integer format: int32 Sids: name: sids in: query description: | Performs the operation on the object SID specified. Enter multiple SIDs in comma-separated format. For example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`. style: form explode: false schema: type: array items: type: string Local_directory_service_ids: name: local_directory_service_ids in: query description: | Performs the operation on the specified local directory service. Supports exactly one value. When not specified, the local directory service connected to the `_array_server` will be used. This cannot be provided in conjunction with the `local_directory_service_names` parameter. style: form explode: false schema: type: array items: type: string Local_directory_service_names: name: local_directory_service_names in: query description: | Performs the operation on the specified local directory service. Supports exactly one value. When not specified, the local directory service connected to the `_array_server` will be used. This cannot be provided in conjunction with the `local_directory_service_ids` parameter. style: form explode: false schema: type: array items: type: string Group_gids: name: group_gids in: query description: | Performs the operation on the specified GIDs. Enter multiple GIDs in comma-separated format. For example, `4234235,9681923`. style: form explode: false schema: type: array items: type: integer format: int32 Local_group_names: name: group_names in: query description: | Performs the operation on the group names specified. Enter multiple group names in comma-separated format. For example, `group1,group2`. style: form explode: false schema: type: array items: type: string Local_member_ids: name: member_ids in: query description: | Performs the operation on the unique local member IDs specified. Enter multiple member IDs in comma-separated format. For local group IDs refer to group IDs (GID). For local user IDs refer to user IDs (UID). The `member_ids` and `member_names` parameters cannot be provided together. style: form explode: false schema: type: array items: type: integer format: int32 Member_sids: name: member_sids in: query description: | Performs the operation on the specified member SID. Enter multiple member SIDs in comma-separated format. For example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`. 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 Uids: name: uids in: query description: | A comma-separated list of local user IDs (UIDs). Enter multiple local user IDs in comma-separated format. For example, `423,51234`. style: form explode: false schema: type: array items: type: integer format: int32 KeepSessionsOpen: name: keep_open_sessions in: query description: | If set to `true`, the session does not expire. If set to `false`, when the user is disabled or password is changed, the session expires. If not specified, defaults to `false`. schema: type: boolean 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 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 Admit: name: admit in: query description: | If `true`, admits any `unadmitted` drives into the system. schema: type: boolean Add_to_policy_ids_file_system: name: add_to_policy_ids in: query description: | The root directories of the file systems will become members of the specified policies along with creation. Enter multiple ids in comma-separated format. style: form explode: false schema: type: array items: type: string Add_to_policy_names_file_system: name: add_to_policy_names in: query description: | The root directories of the file systems will become members of the specified policies along with creation. Enter multiple names in a comma-separated format. style: form explode: false schema: type: array items: type: string With_default_protection_policy_file_system: name: with_default_protection in: query description: | If specified as `true`, the initial protection of the root directories of the newly created file systems will be the union of the container default protection configuration and either `add_to_policy_names` or `add_to_policy_ids`. If specified as `false`, the default protection of the container will not be applied automatically. The initial protection of the root directories of the newly created file systems will be configured by either `add_to_policy_names` or `add_to_policy_ids`. If not specified, defaults to `true`. schema: type: boolean Overwrite: name: overwrite in: query description: | If set to `true`, overwrites an existing object during an object copy operation. If set to `false` or not set at all and the target name is an existing object, the copy operation fails. Required if the `source` body parameter is set and the source overwrites an existing object during the copy operation. schema: type: boolean Paths: name: paths in: query description: | Target file path relative to the target directory. Enter multiple target file path in a comma-separated format. For example, `/dir1/dir2/file1,/dir3/dir4/file2`. style: form explode: false schema: type: array items: type: string Names_single: name: names in: query description: | Performs the operation on the unique resource names specified. Only one value is supported. style: form explode: false schema: type: array maxLength: 1 items: type: string Ids_single: name: ids in: query description: | Performs the operation on the unique resource IDs specified. Only one value is supported. style: form explode: false schema: type: array maxLength: 1 items: type: string Fleet_ids: name: fleet_ids in: query description: | Performs the operation on the unique Fleet IDs specified. This query currently accepts only 1 ID. style: form explode: false schema: type: array items: type: string Fleet_names: name: fleet_names in: query description: | Performs the operation on the unique Fleet names specified. Enter multiple names in comma-separated format. For example, `name01,name02`. This query currently accepts only 1 name. style: form explode: false schema: type: array items: type: string Unreachable: name: unreachable in: query description: | If set to `true`, allows a one-sided disconnect when the connection status is `connecting` instead of `connected` or `partially connected`. If set to `false`, it works just like normal coordinated disconnect. If not specified, defaults to `false`. schema: type: boolean From_member_ids: name: from_member_ids in: query description: | Move the resource from the specified local member realm or array. This should be a union of all local realms and arrays from which the resource should be removed. Enter multiple IDs in a comma-separated format. style: form explode: false schema: type: array items: type: string From_member_names: name: from_member_names in: query description: | Move the resource from the specified local member realm or array. This should be a union of all local realms and arrays to be removed from the specified resource. Enter multiple names in a comma-separated format. style: form explode: false schema: type: array items: type: string Modify_resource_access_on_move: name: modify_resource_access in: query description: | Describes how to modify a resource accesses of a resource when that resource is moved. Possible values are: `none`, `create`, and `delete`. The `none` value indicates that no resource access should be modified. The `create` value is used when a resource is moving out of a realm into the array and it needs to create a resource access of the moved resource to the realm from which it is moving. The `delete` value is used when a resource that is moving from an array into a realm already has a resource access into that realm. This is a required parameter when a resource is being moved to another member. schema: type: string Group_ids: name: group_ids in: query description: | A comma-separated list of group IDs. style: form explode: false schema: type: array items: type: string Resource_ids: name: resource_ids in: query description: | A comma-separated list of resource IDs. The `resource_ids` or `resource_names` parameter is required, but they cannot be set together. style: form explode: false schema: type: array items: type: string Resource_names: name: resource_names in: query description: | A comma-separated list of resource names. The `resource_ids` or `resource_names` parameter is required, but they cannot be set together. style: form explode: false schema: type: array items: type: string Resource_destroyed: name: resource_destroyed in: query description: | If set to `true`, returns only objects from destroyed resources. Returns an error if the name of a live resource is specified in the `resource_names` query parameter. If set to `false`, returns only objects from live resources. Returns an error if the name of a destroyed resource is specified in the `resource_names` query parameter. schema: type: boolean Bucket_ids: name: bucket_ids in: query description: | A comma-separated list of bucket IDs. If after filtering, there is not at least one resource that matches each of the elements of `bucket_ids`, then an error is returned. This cannot be provided together with the `bucket_names` query parameter. This can be provided with the `ids` query parameter but not with `names`. style: form explode: false schema: type: array items: type: string Bucket_names: name: bucket_names in: query description: | A comma-separated list of bucket names. If there is not at least one resource that matches each of the elements of `bucket_names`, then an error is returned. This cannot be provided together with the `bucket_ids` query parameter. This can be provided with the `ids` query parameter but not with `names`. style: form explode: false schema: type: array items: type: string Confirm_date: name: confirm_date in: query description: | If set to `true`, then confirm the date of `keep_current_version_until` is correct. schema: type: boolean Local_port_names: name: local_port_names in: query description: | Performs the operation on the unique local port name specified. Enter multiple names in comma-separated format. For example, `ct0.eth0,ct1.eth0`. style: form explode: false schema: type: array items: type: string Protocol: name: protocol in: query description: | Protocol type. Valid values are `azure`, `google-cloud`, `nfs`, and `s3`. schema: type: string Initialize: name: initialize in: query description: | If set to `true`, initializes the Amazon S3/Azure Blob container/Google Cloud Storage in preparation for offloading. The parameter must be set to `true` if this is the first time the array is connecting to the offload target. schema: type: boolean Allow_throttle_operation: name: allow_throttle in: query description: | If set to `true`, allows operation to fail if array health is not optimal. schema: type: boolean Eradicate_contents: name: eradicate_contents in: query description: | Set to `true` to eradicate contents (e.g., volumes, protection groups, snapshots) and containers (e.g., realms, pods, volume groups). This enables you to eradicate containers with contents. schema: type: boolean Abort_quiesce: name: abort_quiesce in: query description: | Set to `true` to promote the pod when the `pod-replica-link` is in the `quiescing` state and abort when waiting for the `pod-replica-link` to complete the quiescing operation. schema: type: boolean Destroy_contents: name: destroy_contents in: query description: | Set to `true` to destroy contents (e.g., volumes, protection groups, snapshots) and containers (e.g., realms, pods, volume groups), including eradicating containers with content. schema: type: boolean Move_with_host_group_names: name: move_with_host_group_names in: query description: | The host groups to be moved together with the pods to the specified local member realm or array. All the hosts in the host groups will also be moved. Enter multiple names in a comma-separated format. style: form explode: false schema: type: array items: type: string Move_with_host_names: name: move_with_host_names in: query description: | The hosts to be moved together with the pods to the specified local member realm or array. Enter multiple names in a comma-separated format. style: form explode: false schema: type: array items: type: string Promote_from: name: promote_from in: query description: | The `undo-demote` pod that should be used to promote the pod. After the pod has been promoted, it will have the same data as the `undo-demote` pod and the `undo-demote` pod will be eradicated. schema: type: string Quiesce: name: quiesce in: query description: | Set to `true` to demote the pod after the `pod-replica-link` goes into `quiesced` state and allow the pod to become a target of the remote pod. This ensures that all local data has been replicated to the remote pod before the pod is demoted. schema: type: boolean Skip_quiesce: name: skip_quiesce in: query description: | Set to `true` to demote the pod without quiescing the `pod-replica-link` and allow the pod to become a target of the remote pod. This stops all pending replication to the remote pod. schema: type: boolean With_unknown: name: with_unknown in: query description: | If set to `true`, unstretches the specified pod from the specified array by force. Use the `with_unknown` parameter in the following rare event: the local array goes offline while the pod is still stretched across two arrays, the status of the remote array becomes unknown, and there is no guarantee that the pod is online elsewhere. schema: type: boolean Pod_ids: name: pod_ids in: query description: | A comma-separated list of pod IDs. style: form explode: false schema: type: array items: type: string Pod_names: name: pod_names in: query description: | Performs the operation on the unique pod name specified. Enter multiple names in comma-separated format. For example, `pod01,pod02`. style: form explode: false schema: type: array items: type: string Historical_total_only: name: total_only in: query description: | If set to `true`, only return the aggregate value of all items after filtering. For real-time performance, the values are aggregated for the latest timestamp. For historical performance, the values are aggregated for each timestamp from `start_time` to `end_time`. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty. schema: type: boolean Namespaces_delete: name: namespaces in: query description: | A comma-separated list of namespaces. Only one namespace is allowed per delete request. style: form explode: false schema: type: array items: type: string Local_pod_ids: name: local_pod_ids in: query description: | A comma-separated list of local pod 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 `local_pod_names` query parameter. style: form explode: false schema: type: array items: type: string Local_pod_names: name: local_pod_names in: query description: | A comma-separated list of local pod 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 `local_pod_ids` query parameter. style: form explode: false schema: type: array items: type: string Remote_array_or_realm_ids: name: remote_ids in: query description: | The comma-separated list of remote array or realm IDs. If, after filtering, there is not at least one resource that matches each of the elements, an error is returned. The remote_ids and remote_names parameters cannot be set together. style: form explode: false schema: type: array items: type: string Remote_array_or_realm_names: name: remote_names in: query description: | The comma-separated list of remote array or realm names. If, after filtering, there is not at least one resource that matches each of the elements, an error is returned. The remote_names and remote_ids parameters cannot be set together. style: form explode: false schema: type: array items: type: string Remote_pod_ids: name: remote_pod_ids in: query description: | A comma-separated list of remote pod 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 `remote_pod_names` query parameter. style: form explode: false schema: type: array items: type: string Remote_pod_names: name: remote_pod_names in: query description: | A comma-separated list of remote pod 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 `remote_pod_ids` query parameter. style: form explode: false schema: type: array items: type: string Pod_replica_link_ids: name: pod_replica_link_ids in: query description: | A comma-separated list of pod replica link IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. style: form explode: false schema: type: array items: type: string Remote_policy_ids: name: remote_policy_ids in: query description: | A comma-separated list of remote policy 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 `remote_policy_names` query parameter. style: form explode: false schema: type: array items: type: string Remote_policy_names: name: remote_policy_names in: query description: | A comma-separated list of remote policy 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 `remote_policy_ids` query parameter. style: form explode: false schema: type: array items: type: string 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 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 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 Preset_workload_skip_verify_deployable: name: skip_verify_deployable in: query description: | If set to `true`, only the most basic syntax checks are performed on the preset to ensure it is valid, but it is possible that it includes configuration that no array in the current fleet can honor when creating a workload. This is primarily useful when uploading a preset created elsewhere so it can be edited until it is deployable. If set to `false`, when a workload preset is created or updated, arrays in the fleet are queried to ensure at least one array in the fleet can deploy a workload based on the configuration specified in the preset. Defaults to `false`. schema: type: boolean Names_single_required: name: names in: query description: | Performs the operation on the unique resource names specified. Only one value is supported. required: true style: form explode: false schema: type: array maxLength: 1 items: type: string Protection_group_source_ids: name: source_ids in: query description: | The id of the protection group or protection group snapshot to be copied into a new or existing protection group. If the destination protection group and all of its volumes already exist, include the `overwrite` parameter to overwrite all of the existing volumes with the snapshot contents. If including the `overwrite` parameter, the names of the volumes that are being overwritten must match the names of the volumes that are being restored. If the source is a protection group, the latest snapshot of the protection group will be used as the source during the copy operation. style: form explode: false schema: type: array items: type: string Protection_group_source_names: name: source_names in: query description: | The name of the protection group or protection group snapshot to be copied into a new or existing protection group. If the destination protection group and all of its volumes already exist, include the `overwrite` parameter to overwrite all of the existing volumes with the snapshot contents. If including the `overwrite` parameter, the names of the volumes that are being overwritten must match the names of the volumes that are being restored. If the source is a protection group, the latest snapshot of the protection group will be used as the source during the copy operation. style: form explode: false schema: type: array items: type: string Include_remote: name: include_remote in: query description: | If set to `true` the response will include remote membership for protection groups that belong to the remote arrays or realms as well as local volumes. Defaults to `false`. schema: type: boolean Member_destroyed: name: member_destroyed in: query description: | If true, returns only destroyed member objects. Returns an error if a name of a live member object is specified in the member_names query param. If false, returns only live member objects. Returns an error if a name of a destroyed member object is specified in the member_names query param. schema: type: boolean Pgroup_group_ids: name: group_ids in: query description: | Performs the operation on the unique group id specified. Provide multiple resource IDs in comma-separated format. The group_ids or names parameter is required, but they cannot be set together. style: form explode: false schema: type: array items: type: string Allow_throttle_snapshot: name: allow_throttle in: query description: | If set to `true`, allows snapshot to fail if array health is not optimal. schema: type: boolean Apply_retention: name: apply_retention in: query description: | If `true`, applies the local and remote retention policy to the snapshots. schema: type: boolean For_replication: name: for_replication in: query description: | If `true`, destroys and eradicates the snapshot after 1 hour. schema: type: boolean Replicate: name: replicate in: query description: | If set to `true`, queues up and begins replicating to each allowed target after all earlier replication sessions for the same protection group have been completed to that target. The `replicate` and `replicate_now` parameters cannot be used together. schema: type: boolean Replicate_now: name: replicate_now in: query description: | If set to `true`, replicates the snapshots to each allowed target. The `replicate` and `replicate_now` parameters cannot be used together. schema: type: boolean Convert_source_to_baseline: name: convert_source_to_baseline in: query description: | Set to `true` to have the snapshot be eradicated when it is no longer baseline on source. schema: type: boolean On_as_target: name: "on" in: query description: | Performs the operation locally with the target names specified as the destinations of the operation. Enter multiple target names in comma-separated format. For example, `targetName01,targetName02`. style: form explode: false schema: type: array items: type: string Container_ignore_usage: name: ignore_usage in: query description: | Set to `true` to set a `quota_limit` that is lower than the existing usage. This ensures that no new volumes can be created until the existing usage drops below the `quota_limit`. If not specified, defaults to `false`. schema: type: boolean On_: name: "on" in: query description: | Performs the operation on the target name specified. Enter multiple target names in comma-separated format. For example, `targetName01,targetName02`. style: form explode: false schema: type: array items: type: string On_ids: name: "on_ids" in: query description: | Performs the operation on the specified target IDs. Enter multiple target IDs in comma-separated format. The on and on_ids parameters cannot be set together. style: form explode: false schema: type: array items: type: string OnSingle: name: "on" in: query description: | Performs the operation on the target name specified. For example, `targetName01`. schema: type: string Replication_snapshot: name: replication_snapshot in: query description: | If set to `true`, allow destruction/eradication of snapshots in use by replication. If set to `false`, allow destruction/eradication of snapshots not in use by replication. If not specified, defaults to `false`. schema: type: boolean Ids_without_names: name: ids in: query description: | Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. style: form explode: false schema: type: array items: type: string Local_realm_ids: name: local_realm_ids in: query description: | Performs the operation on the specified unique resource IDs. Enter multiple resource IDs in comma-separated format. The local_realm_ids and local_realm_names parameters cannot be set together. style: form explode: false schema: type: array items: type: string Local_realm_names: name: local_realm_names in: query description: | Performs the operation on the specified unique resource names. Enter multiple resource names in comma-separated format. The local_realm_names and local_realm_ids parameters cannot be set together. style: form explode: false schema: type: array items: type: string Remote_realm_ids: name: remote_realm_ids in: query description: | Performs the operation on the specified unique resource IDs. Enter multiple resource IDs in comma-separated format. The remote_realm_ids and remote_realm_names parameters cannot be set together. style: form explode: false schema: type: array items: type: string Remote_realm_names: name: remote_realm_names in: query description: | Performs the operation on the specified unique resource IDs. Enter multiple resource IDs in comma-separated format. The remote_realm_ids and remote_realm_names parameters cannot be set together. style: form explode: false schema: type: array items: type: string Realm_ids: name: realm_ids in: query description: | Performs the operation on the specified unique resource IDs. Enter multiple resource IDs in comma-separated format. The realm_ids and realm_names parameters cannot be set together. style: form explode: false schema: type: array items: type: string Realm_names: name: realm_names in: query description: | Performs the operation on the specified unique resource names. Enter multiple resource names in comma-separated format. The realm_names and realm_ids parameters cannot be set together. style: form explode: false schema: type: array items: type: string Create_local_directory_service: name: create_local_directory_service in: query description: | The name of the local directory service object to be created and associated to the server. This parameter cannot be used together with `local_directory_service` property in the request entity. schema: type: string Cascade_delete: name: cascade_delete in: query description: | The resource types to delete when deleting the object. It will fail if the resources are referenced by other objects. Valid values include `directory-services`. style: form explode: false schema: type: array items: type: string example: directory-services Versions: name: versions in: query description: | A comma-separated list of versions. style: form explode: false schema: type: array items: type: string Software_versions: name: software_versions in: query description: | A comma-separated list of target software versions. style: form explode: false schema: type: array items: type: string Software_names: name: software_names in: query description: | A comma-separated list of software names. style: form explode: false schema: type: array items: type: string Software_ids: name: software_ids in: query description: | A comma-separated list of software IDs. style: form explode: false schema: type: array items: type: string Software_idsRequired: name: software_ids in: query description: | A comma-separated list of software IDs. required: true style: form explode: false schema: type: array items: type: string Software_installation_command_required: name: command in: query description: | A user command that interacts with the upgrade. Commands may only be issued when the upgrade is paused. Valid values are `continue`, `retry`, and `abort`. The `continue` command continues a `paused` upgrade. The `retry` command retries the previous step. The `abort` command aborts the upgrade. required: true schema: type: string Software_installation_current_step_idRequired: name: current_step_id in: query description: | The current step `id` of the installation. required: true schema: type: string Software_installation_ids: name: software_installation_ids in: query description: | A comma-separated list of software installation IDs. style: form explode: false schema: type: array items: type: string Test_type: name: test_type in: query description: | Specifies the type of test. Valid values are `all`, `phonehome`, and `remote-assist`. If not specified, defaults to `all`. schema: type: string PurityDefault: name: purity_default in: query description: | Set diagnostics tool to default version. schema: type: boolean Vchost_ids: name: vchost_ids in: query description: | Performs the operation on the unique vchost IDs specified. Enter multiple vchost IDs in a comma-separated format. For example, `vchostid01,vchostid02`. style: form explode: false schema: type: array items: type: string Vchost_names: name: vchost_names in: query description: | Performs the operation on the unique vchost name specified. Enter multiple names in a comma-separated format. For example, `vchost01,vchost02`. style: form explode: false schema: type: array items: type: string Endpoints: name: endpoints in: query description: | Performs the operation on the unique endpoints specified. Enter multiple endpoints in a comma-separated format. style: form explode: false schema: type: array items: type: string All_vchosts: name: all_vchosts in: query description: | If set to `true`, the storage container represented by the protocol endpoint is accessible to all vchosts. Users should not specify `vchost_ids` or `vchost_names` in the request. If set to `false`, the storage container represented by the protocol endpoint is only accessible to the vchosts that have explicit vchost-connections with the protocol endpoint. Users need to specify `vchost_ids` or `vchost_names` in the request. schema: type: boolean default: false Protocol_endpoint_ids_for_vchost_connections: name: protocol_endpoint_ids in: query description: | A comma-separated list of protocol endpoint IDs. Performs the operation on the protocol endpoints specified. For example, `peid01,peid02`. Cannot be used in conjunction with `protocol_endpoint_names`. If the list contains more than one value, then `vchost_ids` or `vchost_names` must have exactly one value. style: form explode: false schema: type: array items: type: string Protocol_endpoint_names_for_vchost_connections: name: protocol_endpoint_names in: query description: | A comma-separated list of protocol endpoint names. Performs the operation on the protocol endpoints specified. For example, `pe01,pe02`. Cannot be used in conjunction with `protocol_endpoint_ids`. If the list contains more than one value, then `vchost_ids` or `vchost_names` must have exactly one value. style: form explode: false schema: type: array items: type: string Vchost_ids_for_vchost_connections: name: vchost_ids in: query description: | A comma-separated list of vchost IDs. Performs the operation on the vchosts specified. For example, `vchostid01,vchostid02`. Cannot be used in conjunction with `vchost_names`. If the list contains more than one value, then `protocol_endpoint_ids` or `protocol_endpoint_names` must have exactly one value. style: form explode: false schema: type: array items: type: string Vchost_names_for_vchost_connections: name: vchost_names in: query description: | A comma-separated list of vchost names. Performs the operation on the vchosts specified. For example, `vchost01,vchost02`. Cannot be used in conjunction with `vchost_ids`. If the list contains more than one value, then `protocol_endpoint_ids` or `protocol_endpoint_names` must have exactly one value. style: form explode: false schema: type: array items: type: string Allow_stretched_multi_vchost: name: allow_stretched_multi_vchost in: query description: | If set to `true`, users are allowed to create a new vchost-connection to a stretched container that already has a vchost-connection. In principle, a stretched container can only have one vchost-connection at a time. schema: type: boolean default: false Add_to_protection_group_ids: name: add_to_protection_group_ids in: query description: | The volumes will be added to the specified protection groups along with creation or movement across pods and array. When a volume is moved, the specified protection groups must be in the target pod or array. Enter multiple ids in comma-separated format. style: form explode: false schema: type: array items: type: string Add_to_protection_group_names: name: add_to_protection_group_names in: query description: | The volumes will be added to the specified protection groups along with creation or movement across pods and array. When a volume is moved, the specified protection groups must be in the target pod or array. Enter multiple names in a comma-separated format. style: form explode: false schema: type: array items: type: string With_default_protection: name: with_default_protection in: query description: | If specified as `true`, the initial protection of the newly created volumes will be the union of the container default protection configuration and `add_to_protection_group_names`. If specified as `false`, the default protection of the container will not be applied automatically. The initial protection of the newly created volumes will be configured by `add_to_protection_group_names`. If not specified, defaults to `true`. schema: type: boolean Remove_from_protection_group_ids: name: remove_from_protection_group_ids in: query description: | The volumes will be removed from the specified protection groups in the source pod or array along with the move. This can only be used when moving volumes across pods and arrays and must include all protection groups that the volumes are members of before the move. Enter multiple ids in a comma-separated format. style: form explode: false schema: type: array items: type: string Remove_from_protection_group_names: name: remove_from_protection_group_names in: query description: | The volumes will be removed from the specified protection groups in the source pod or array along with the move. This can only be used when moving volumes across pods and arrays and must include all protection groups that the volumes are members of before the move. Enter multiple names in a comma-separated format. style: form explode: false schema: type: array items: type: string Truncate: name: truncate in: query description: | If set to `true`, reduces the size of a volume during a volume resize operation. When a volume is truncated, Purity automatically takes an undo snapshot, providing a 24-hour window during which the previous contents can be retrieved. After truncating a volume, its provisioned size can be subsequently increased, but the data in truncated sectors cannot be retrieved. If set to `false` or not set at all and the volume is being reduced in size, the volume copy operation fails. Required if the `provisioned` parameter is set to a volume size that is smaller than the original size. schema: type: boolean Base_id: name: base_id in: query description: | ID of the volume or volume snapshot that the diff comparison is based on. If a base volume or volume snapshot is not specified, all mapped blocks for the volume or volume snapshot are displayed. The `base_name` or `base_id` parameter is required, but they cannot be set together. schema: type: string Base_name: name: base_name in: query description: | Name of the volume or volume snapshot that the diff comparison is based on. If a base volume or volume snapshot is not specified, all mapped blocks for the volume or volume snapshot are displayed. The `base_name` or `base_id` parameter is required, but they cannot be set together. schema: type: string Block_size: name: block_size in: query description: | Granularity at which to compare, in bytes. Must be a multiple of 512. required: true schema: type: integer format: int64 Next_allocated_block_hint: name: next_allocated_block_hint in: query description: | If set to `true`, appends offset of the next allocated block in bytes for the volume specified in `names` or `ids` to the output `items`. `base_name` or `base_id` must not be specified if this is set to `true`. If not specified, defaults to `false`. schema: type: boolean Segment_length: name: segment_length in: query description: | Length of the segment, in bytes, to compare. required: true schema: type: integer format: int64 Segment_offset: name: segment_offset in: query description: | Absolute offset, in bytes, of the segment to compare. Must be a multiple of block_size. schema: type: integer format: int64 Preset_ids: name: preset_ids in: query description: | Create the resource using the preset specified by the ID. Only one preset can be specified. One of the `preset_ids` or `preset_names` parameters are required, but they cannot be set together. style: form explode: false schema: type: array items: type: string Preset_names: name: preset_names in: query description: | Create the resource using the preset specified by name. Only one preset can be specified. One of the `preset_ids` or `preset_names` parameters are required, but they cannot be set together. style: form explode: false schema: type: array items: type: string Placement_names: name: placement_names in: query description: | Placements from the preset which should be used to compute recommendation. Optional parameter if preset has just one placement. style: form explode: false schema: type: array items: type: string Resource_ids_single: name: resource_ids in: query description: | Performs the operation on the unique resource ID specified. Only one value is supported. The `resource_ids` or `resource_names` parameter is required, but they cannot be set together. style: form explode: false schema: type: array maxLength: 1 items: type: string Resource_names_single: name: resource_names in: query description: | Performs the operation on the unique resource name specified. Only one value is supported. The `resource_ids` or `resource_names` parameter is required, but they cannot be set together. style: form explode: false schema: type: array maxLength: 1 items: type: string responses: OauthToken200: description: OK content: application/json: schema: title: oauth_token_response type: object properties: access_token: description: | The serialized OAuth 2.0 Bearer token used to perform authenticated requests. The access token must be added to the Authorization header of all API calls. type: string example: "eyJraWQiOiJqTlBzL1Ria2c4U2Vua3F3ZmkvbnI4bWxxQ3NPIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJhdWQiOiI5NDcyMTkwOC1mNzkyLTcxMmUtYTYzOS0wODM5ZmE4MzA5MjIiLCJzdWIiOiJqb2UiLCJyb2xlIjoic3RvcmFnZV9hZG1pbiIsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6OTAwMCIsImlhdCI6MTU0NDAzNjA1MiwiZXhwIjoxNTQ0MDcyMDUyLCJqdGkiOiJjOTg0MjgyNS1mNGM3LTRiNGUtODdkNy03OWFiZmIxYTUzNDgifQ.pnuYAx0CkmkIG0LDrMAQGRr5Ci4-t5yMto3A7BkmyKnAVHBXG5ZIWwvNkWDLhqbA4YjmG7LZmWHrCVehLy2zy2vRLahFURsd3GTnOaWSyWFIyrwpoO81jQRtOQATtseweuMT_-C8o3oa4MgBNBsuKrhwKQS3oDDpeRPaCRTGev1_xRDxh_K6CWJBTAeOP2pcR4LW6zIJkCLzzkMuyL4aTJWWUjSbl04mcFbyw8r8W1GURrmaDVOvvpT634Hk9-GGh9OMIRlS6OOq7cJKc-RRWn18IK2Gs53V_KYshXTBbnRr990Y_qOX8MaTWOJTqgzsojY02MSVuJ9XDJWoIU3TQytr4K1vM2EvwDZDgl7LuUYUn7vWhbKktFzpeZyyhOjq3eX-ViugYKpIjBcG2f_-fcTPceEWGV82rd6TyVNB5A-v9u2kxCdW198t_kesgVQfuupDeS02cZe0ABLCzEHPiVF17JfiVr6sjkciioxN7Wj_j18ga4U0mdSukauT8yhbgCW1ijTVTFu1VwWebW0s8z3BWMtXdTtZ3BhcZVAdKRF8bOq7nfEbUQGhTn9g7dK-yF050winjtp-VTL2oUtkF5j1v_N8vPNiN9ZdkGJZr7VVZ-qeOJZcjdaRbxL6YB__yT1wkTcKPh8RHz6GUq7Jbyw8VIlcBE2nvJ63d0tH9C4" expires_in: description: | The duration after which the access token will expire. Measured in seconds. This differs from other duration fields that are expressed in milliseconds. type: integer format: uint32 example: 35999 issued_token_type: description: | The type of token that is issued. The Pure Storage REST API supports OAuth 2.0 access tokens. type: string example: urn:ietf:params:oauth:token-type:access_token token_type: description: | Indicates how the API client can use the access token issued. The Pure Storage REST API supports the `Bearer` token. type: string example: Bearer OauthToken400: description: BAD REQUEST content: application/json: schema: type: object properties: error: type: string example: invalid_request error_description: type: string example: "Unsupported subject_token_type: urn:ietf:params:oauth:token-" OauthToken401: description: UNAUTHORIZED content: application/json: schema: type: object properties: error: type: string example: invalid_client error_description: type: string example: "Invalid identity: JWT validation failed."